Using wsadmin commands to customize the Process Server settings used to connect to Process Center

After you install and configure IBM® Business Process Manager, you can use the wsadmin command to change the Process Server settings that are used for connecting to the Process Center.

Before you begin

Restriction: The BPMAuthor role must point to the same user in both the Process Center and the Process Server, and must have the same password.

About this task

Use the following procedure to customize the Process Server connection settings:
For example, you can complete the following tasks:
  • Update the host and port name of the Process Center connection details.
  • Change Process Server from an offline server to a Process Center connected server (online server), and vice versa.
  • Change the Process Center connection URL.

Procedure

To customize the settings that are used by Process Server to connect to a Process Center, complete the following steps.

Note: For network deployment Process Server environments, complete the following steps on the deployment manager node, synchronize the nodes, and restart the application cluster member.

  1. Stop the Process Server environment. In a network deployment environment, stop the deployment manager and the nodes.
  2. Complete the following steps to update the server settings with the WebSphere command-line administration tool (wsadmin) AdminConfig commands.
    1. Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the following command from the bin directory of the IBM BPM installation:
      wsadmin -conntype NONE -lang jython -profileName profileName
      For BPM Express, profileName is the name of the stand-alone profile (and may be omitted if this is the only profile). For BPM Standard and BPM Advanced, profileName is the name of the deployment manager profile.
    2. Get the process server configuration of the application cluster.
      • for a clustered environment, enter the following command:
        wsadmin> ps = AdminConfig.getid("/Cell:/ServerCluster:application_cluster_name/BPMClusterConfigExtension:/BPMProcessServer:/")
      • for a stand-alone environment, enter the following command:
        wsadmin> ps = AdminConfig.getid("/Cell:/Node:node_name/Server:server_name/BPMServerConfigExtension:/BPMProcessServer:/")
    3. Update the processCenterUrl variable. This setting specifies the URL that IBM Process Server uses to connect to a pre-8.5.0.1 Process Center. It uses Form-based Authentication. A pre-8.5.0.1 Process Center supports only the processCenterUrl setting and it does not support the processCenterInternalUrl setting that is described in the next step. To ensure that the Process Server can connect to a Process Center from any release of IBM BPM, this setting should always be specified.
      wsadmin> AdminConfig.modify(ps, [['processCenterUrl', 'https://new_server_name/ProcessCenter']])
    4. Update the processCenterInternalUrl variable, which is the same as ProcessCenterUrl but with the literal string Internal appended at the end for the context root. This setting specifies the URL that IBM Process Server uses to connect to an IBM BPM 8.5.0.1 or later Process Center. It uses Basic Authentication rather than Form-based Authentication. It has the same format as the processCenterUrl setting, except that it also has the literal string Internal appended at the end for the context root. An 8.5.0.1 or later Process Center supports both the processCenterUrl setting and the processCenterInternalUrl setting. However, the processCenterInternalUrl is the preferred method of communication and it is automatically used when it is available. To ensure that the Process Server can connect to a Process Center from any release of IBM BPM, this setting should always be specified. The setting should be set to the same host and port as the processCenterUrl.
      wsadmin> AdminConfig.modify(ps, [['processCenterInternalUrl', 'https://new_server_name/ProcessCenterInternal']])
    5. To change the state of an offline Process Server to online, update the heartBeatInterval value to a number that is greater than 0 (zero). The heartbeat interval is the polling interval, in seconds, that is used by the Process Server to communicate its location and characteristics to the Process Center. For example, to set the value to 60 seconds, enter the following command:
      wsadmin> AdminConfig.modify(ps, [['heartBeatInterval', '60']])
      To bring the server offline, disable polling by setting the heartBeatInterval value to a number that is less than or equal to 0 (zero). For example:
      wsadmin> AdminConfig.modify(ps, [['heartBeatInterval', '-1']])
    6. Verify your updates.
      wsadmin> print AdminConfig.show(ps)
      The output looks something like the following example:
      ...
      [heartBeatInterval 60]
      ...
      [processCenterUrl https://hostname:9082/ProcessCenter]
    7. Save the changes and exit.
      wsadmin> AdminConfig.save()
      wsadmin> exit
  3. Review the Business Process Manager security roles by navigating in the WebSphere Application Server administrative console to Servers > Deployment Environments > Deployment Environment Name > Related Items > Authentication Aliases. See IBM Business Process Manager roles.
  4. Note the authentication alias for the ProcessCenterUser and BPMAuthor roles.
  5. If it does not exist, create the ProcessCenterUserAlias, which is the default authentication alias that is used to connect from IBM Process Server to Process Center. It includes a user name and password that can be used to log into the Process Center. See Modifying authentication aliases. For ProcessCenterUserAlias, use a valid user name and password from the Process Center environment. The user will be used during the heartbeat to log into Process Center and it does not need any special authorization in Process Center.
  6. Optional: If you plan to use a user other than DeAdmin (the default) to deploy snapshots from Process Center to the runtime Process Server, create a new BPMAuthorAlias (which is the default authentication alias that is used to connect from Process Center to IBM Process Server). The BPMAuthorAlias receives a user name and password from Process Server that is used to log into Process Server. For BPMAuthorAlias, use a valid user name and password from the Process Server environment that has the authority to access and deploy snapshots to the runtime Process Server.
  7. In the Business Process Manager security roles screen, map the ProcessCenterUser role to ProcessCenterUserAlias and the appropriate alias to the BPMAuthor role.
  8. Because Process Center connects to Process Server by HTTPS by default, you must verify that the Process Server root signer SSL certificate is imported into Process Center. If you configure the processCenterUrl variable or the processCenterInternalUrl variable to use HTTPS, then you also must verify that the Process Center root signer certificated is imported in Process Server. Follow the steps in Configuring SSL communication.
    Tip: If you want to change the Process Center to connect to Process Server by HTTP, complete the following steps. Then you do not need to import the Process Center root signer certificates into Process Server.
    1. Stop the Process Center environment. In a network deployment environment, stop the deployment manager and the nodes.
    2. Update the following server settings with the wsadmin AdminConfig commands.
      1. Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the following command from the bin directory of the IBM BPM installation:
        wsadmin -conntype NONE -lang jython -profileName profileName

        For BPM Express, profileName is the name of the stand-alone profile (and may be omitted if this is the only profile). For BPM Standard and BPM Advanced, profileName is the name of the deployment manager profile.

      2. Get the Process Center configuration of the application cluster.
        • For a clustered environment, specify the following command syntax:
          wsadmin> pc = AdminConfig.getid("/Cell:/ServerCluster:application_cluster_name/BPMClusterConfigExtension:/BPMProcessCenter:/")
        • For a stand-alone environment, specify the following command syntax:
          wsadmin> pc = AdminConfig.getid("/Cell:/Node:node_name/Server:server_name/BPMServerConfigExtension:/BPMProcessCenter:/")
      3. Update the useHTTPSURLPrefixes property:
        wsadmin> AdminConfig.modify(pc, [['useHTTPSURLPrefixes', 'false']])
      4. Verify your updates:
        wsadmin> print AdminConfig.show(pc)
      5. Save the changes and exit:
        wsadmin> AdminConfig.save()
        wsadmin> exit
    3. Stop the Process Server environment. In a network deployment environment, stop the deployment manager and the nodes.
    4. Update the following server settings with the wsadmin AdminConfig commands.
      1. Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the following command from the bin directory of the IBM BPM installation:
        wsadmin -conntype NONE -lang jython -profileName profileName

        For BPM Express, profileName is the name of the stand-alone profile (and may be omitted if this is the only profile). For BPM Standard and BPM Advanced, profileName is the name of the deployment manager profile.

      2. Get the Process Server configuration of the application cluster.
        • For a clustered environment, specify the following command syntax:
          wsadmin> ps = AdminConfig.getid("/Cell:/ServerCluster:application_cluster_name/BPMClusterConfigExtension:/BPMProcessServer:/")
        • For a stand-alone environment, specify the following command syntax:
          wsadmin> ps = AdminConfig.getid("/Cell:/Node:node_name/Server:server_name/BPMServerConfigExtension:/BPMProcessServer:/")
      3. Update the useHTTPSURLPrefixes property:
        wsadmin> AdminConfig.modify(ps, [['useHTTPSURLPrefixes', 'false']])
      4. Verify your updates:
        wsadmin> print AdminConfig.show(ps)
      5. Save the changes and exit:
        wsadmin> AdminConfig.save()
        wsadmin> exit
  9. Restart the Process Server cluster or server. For network deployment Process Server environments, synchronize the nodes and restart the application cluster member.

Results

The settings that are used to connect Process Server to Process Center are now customized and the same changes are applied to the custom nodes.