Installing snapshots onto an offline server by using Business Automation Studio

You can install snapshots onto an offline IBM® Workflow Server by using Business Automation Studio to create the installation package and by using IBM Business Automation Workflow Operations REST Interface to install the snapshots using the packages.

Before you begin

Export a snapshot. For more information, see Importing projects External link opens a new window or tab.

See the prerequisites in Installing snapshots.

If you plan to migrate running instances, check that there is a migration policy for the snapshot. The migration policy defines how to handle orphaned tokens if any exist. If a migration policy is not listed for the source snapshot, notify the owner of the snapshot that your are installing to create the migration policy. The snapshot owner can use Business Automation Studio to generate the migration policy file and use the migration policy editor to modify it. For information, see Defining the instance migration policy by using the Process Center consoleExternal link opens a new window or tab.

Procedure

  1. Log in to Business Automation Studio.
  2. On the Workflow Automations page, select the project and then select Versions tab in the Project details.
  3. Click Install next to the version you want to install.
    The Install a version to a server window opens.
  4. In the window, select the offline Workflow Server that you want to install the snapshot to.

    If the process application or case solution already has an installation package for a that snapshot for the offline Workflow Server, the window displays a message indicating the snapshot is already installed. If not, you can select the snapshot and the click Install. After you do this, you get a notification that you successfully installed the snapshot to your offline server.

  5. Select the snapshot you created the installation package for.
  6. On the snapshot page, select the Installation details and select Export Installation Package for the offline server in question.
  7. Transfer the installation package to the offline Workflow Server by using FTP or a similar utility. If you exported migration policy files, transfer them as well.
  8. On the offline workflow server, install the application version that you exported by using POST /std/bpm/containers/install. Ensure that you are using the ACCESS_TOKEN_HEADER and CSRF_TOKEN_HEADER for the offline server, for example:
    curl -X POST -H "$ACCESS_TOKEN_HEADER" -H "$CSRF_TOKEN_HEADER" -H 'Content-Type: 
    multipart/form-data' -H 'Accept: application/json' -F 'install_file=@C:\MyFiles\PA1 - 1.zip' 
    {"type":"formData"}' 
    'https://zen-front-door-hostname/instance_prefix/ops/std/bpm/containers/install?inactive=false&caseOverwrite=false
    External link opens a new window or tab'

    You get a response such as this:

    {"description":"Your request to import the specified file was submitted. You can check the progress of the import in the system log or by calling the returned url.","url":"https://zen-front-door-hostname/instance_prefix/ops/system/queue/9?key=d2772760f7bd30006e877164ba8a6ee9"}
  9. Optional: If necessary, set environment variables.
    For example, the correct value for a particular environment (such as test or production) might not be known during the design phase. In these situations, provide the value after installing the snapshot in the new environment.
  10. Optional: If necessary, establish runtime teams.
    For example, after you install a snapshot in a new environment (such as test or production), you might need to add or remove users in the teams for that project. That is, users in the test environment might not have been available in the development environment.
    For information, see Configuring runtime teams.
  11. Optional: If necessary, control exposed processes and services.
    For example, after you install a snapshot in a new environment (such as test or production), you might need to disable a particular exposed process or service within that process application

Results

The last snapshot that you install becomes the default snapshot and it is automatically active.