Transferring and installing an installation package

After you create and extract an installation package, you need to transfer it to the offline server. Then, use administrative commands on the server to install the package.

Before you begin

Complete the following tasks before you install a snapshot on an offline process server.
  • Create and extract an installation package.
  • Ensure the offline server supports the capabilities in the snapshot. If you intend to install a snapshot of a business process application that contains an Advanced Integration Service, you can install the snapshot only on an IBM® Business Process Manager Advanced offline server. Additional information about server capabilities is in the topic Capabilities of IBM Business Process Manager configurations.
  • Ensure you have the correct permission to perform the installation. You must be a member of the offline-install-group and the tw_admins groups. If you do not have these permissions, you can see the error User user_name is not authorized to install the snapshot. Ensure that the <offline-install-group> is a valid group and that user_name is a member of the group.

About this task

Do not try to install process application snapshots from two Process Centers to the same Process Server environment. If you are developing process applications in multiple Process Centers, ensure that you import the snapshots into a common Process Center before installing them on a Process Server.

Installation packages are available on the Process Center Server as long as the selected offline server exists. If you remove the offline server, the installation packages for that server are also deleted.

To transfer an installation package and then install that package on an offline server, perform the following steps.

Procedure

  1. Transfer the installation package to the offline process server using FTP or a similar utility.
  2. Optional: Limit the offline installation to specific groups:
    1. Open the 100Custom.xml file.
    2. Create a new element called <offline-install-group> in the <server> element.
      <offline-install-group>$(Install-Group1)</offline-install-group>
    3. Ensure that the user who is performing the offline installation is part of the $(Install-Group1) group. If there are multiple users who can perform offline installation and they belong to different groups, then specify these as shown below:
      <offline-install-group>$(Install-Group1)</offline-install-group>
      <offline-install-group>$(Install-Group2)</offline-install-group>
      The following rules apply for the <offline-install-group>:
      • The value of <offline-install-group> element is a group name. The group must exist in a user registry that is configured on the server.
      • If the <offline-install-group> element is not present or is empty, then all users with default installation permission can install on the offline process server.
      • If there are multiple elements specified and one is empty, then the empty element is ignored and the value from the other elements is used.
  3. Run the BPMInstallOfflinePackage command on the offline process server.

Example

The following example illustrates how to install a snapshot of the BillingDispute process application. The snapshot installation package (BillingDispute.zip) was created and extracted on the Process Center Server and is being installed on the offline Process Server ProcessServer01.

In the example, the user establishes a SOAP connection to the Process Center server.

  • Jython example
    wsadmin -conntype SOAP -port 4080 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython
    
    AdminTask.BPMInstallOfflinePackage('[-inputFile C:\myProcessApps\BillingDispute.zip]')
  • Jacl example
    wsadmin -conntype SOAP -port 4080 -host ProcessServer01.mycompany.com -user admin -password admin
    
    $AdminTask BPMInstallOfflinePackage {-inputFile C:\myProcessApps\BillingDispute.zip}

What to do next

If you log into Business Space, you can navigate to the dashboard for the process application.

If you experience problems with your installation, check the process-installer.log file. See Troubleshooting snapshot installations for more information about where issues can occur.