IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced: Process Server > Install IBM BPM Advanced: Process Server > On Windows > Network deployment environment > Configure profiles and create an ND environment > Create an ND environment > Use the administrative console > Configure components > Configure optional components > Configure Business Process Choreographer

Use the bpeconfig.jacl script to configure Business Process Archive Manager

You can use the bpeconfig.jacl script to configure a Business Process Archive Manager, Business Process Archive Explorer, and all the necessary resources on a given server or cluster.

You can also use this script to configure a Business Process Choreographer configuration, that case is described in Use the bpeconfig.jacl script to configure Business Process Choreographer.

The script uses the database parameters to generate and optionally run an SQL file, which creates the necessary database objects.


Procedure

  1. Verify that you know which options and parameters you are going to use. Refer to the values you planned in Plan for the Business Process Archive Manager. For detailed information about the script, examples, its options and parameters, see bpeconfig.jacl script file.
  2. Verify that the Service Component Architecture is configured. Using the administrative console perform the following:

    1. If you want to configure Business Process Archive Manager on a server, click Servers > Server Types > WebSphere application servers > server_name, then in the Business Integration section, click Service Component Architecture.

    2. If you want to configure Business Process Archive Manager on a cluster, click Servers > Clusters > WebSphere application server clusters > cluster_name, then in the Business Integration section, click Service Component Architecture.

    3. If it is not enabled, select Support the Service Component Architecture components, select the same Bus Member Location that is used by the Business Process Choreographer runtime configuration that this Business Process Archive Manager will serve. Do not change the prefilled datastore configuration values for Database Instance or Schema. Click Apply and Save.
  3. If you want bpeconfig.jacl to create the schema in the archive database, perform the following:

    1. If your archive database does not exist yet, and you are using one of the following databases:

      • DB2 for z/OS
      • Oracle

      • A remote Microsoft SQL Server

      Create an empty database manually according to the documentation for your database.

      For example, for Oracle, make sure that the schema name matches an Oracle user ID.

    2. Verify that the database client is on the path for the scripting client.

      For example, the client for DB2 is db2.exe.

    3. Verify that the application server is stopped.
    4. Remember to use the -createDB yes option.

  4. Invoke the bpeconfig.jacl script file, either in batch mode providing the options and configuration parameters that you planned, or in interactive mode.

    For example, to configure Business Process Archive Manager on a cluster on a Windows platform, using a DB2 database, the batch mode command to run on the dmgr might be like the following:

    wsadmin -conntype none -f bpeconfig.jacl  
            -adminGroups bpcadmins 
            -cluster supportCluster
            -createDB no 
            -dbJava d:\\programs\\IBM\\SQLLIB\\java 
            -dbName BPEDB 
            -dbSchema WPRBE00 
            -dbServerName db2host.acme.com 
            -dbTablespaceDir d:\\DB2\\tablespacedir
            -dbType DB2 
            -dbUser db2user -dbPwd secret 
            -jmsBFMRunAsUser jmsuser -jmsBFMRunAsPwd secret
            -jmsHTMRunAsUser escalationuser -jmsHTMRunAsPwd secret 
            -monitorGroups bpcmonitors 
            -operationMode ARCHIVE
            -promptMode FAIL_IF_MISSING 
            -restAPIBFM http://wpshost.acme.com:80/rest/bpm/bfm 
            -restAPIHTM http://wpshost.acme.com:80/rest/bpm/htm 
    For other platforms, the file system paths would be different. For details about the script file, refer to bpeconfig.jacl script file.
  5. If you either used the -createDB no option to defer that creation of the database, or if the bpeconfig.jacl script failed create the database, you or your database administrator should perform the actions described in Use a generated script to create the database schema for Business Process Choreographer.
  6. Restart the server or cluster where you configured Business Process Archive Manager.
  7. Verify that the Business Process Archive Manager and Business Process Archive Explorer applications have started successfully.

    1. Verify that there are no error messages in the SystemOut.log file for the application server. On a cluster, check the log for all application servers in the cluster.
    2. Verify that the following applications have started:

      • BPCArchiveExplorer_ scope
      • BPArchiveMgr_ scope
      • TaskArchiveMgr_ scope

      Where, the value of scope is nodeName_ serverName, if you configured Business Process Archive Manager on an application server, or the clusterName if you configured Business Process Archive Manager on a cluster.

  8. If you want to change the JMS authentication user IDs, the run-as user IDs, or the mappings of roles onto users and groups, using the administrative console, click Security > Business Integration security to change the security settings.

  9. If you have configured the people directory provider for the Business Process Choreographer configuration that this Business Process Archive Manager will be used for, then configure the people directory provider in the same way for the Business Process Archive Manager.
  10. Map the web modules for the BPArchiveMgr and TaskArchiveMgr applications to a web server to achieve load balancing and failover. You might need to change the default context roots for the REST API and the JAX web services API so that they are unique for each combination of host name and port. To set the context roots perform the following:

    1. To set the context roots for the Business Process Archive Manager, click Applications > Application Types > WebSphere enterprise applications then BPArchiveMgr_ scope > Context Root for Web Modules, where scope is either node_name_ server_name or the cluster_name where Business Process Archive Manager is configured. Then make sure that the context root for the web modules BFMRESTAPI and BFMIF_ scopeWeb are correct and unique.

    2. To set the context roots for the Human Task Archive Manager, click Applications > Application Types > WebSphere enterprise applications then TaskArchiveMgr_ scope > Context Root for Web Modules, where scope is either node_name_ server_name or the cluster_name where Business Process Archive Manager is configured. Then make sure that the context root for the web modules HTMRESTAPI and HTMIF_ scopeWeb are correct and unique.

  11. If you use the Business Process Archive Explorer: Change the REST endpoints to match the new context roots by clicking Application servers then either server_name or cluster_name, then under Business Integration, expand Business Process Choreographer, and click Business Process Choreographer Explorer, select the BPCArchiveExplorer_ scope instance that you want to modify, and set the new value.

    For example, if the context root for the Business Flow Manager REST API is /rest/bpm/bfm then the full URL might be something like http://system7.mycompany.com:9080/rest/bpm/bfm.

    If you mapped the modules to an HTTP server, proxy server, IP sprayer, load balancer, or similar server, the URL should be based on the hostname and port number for that server.

  12. Optional: Update your virtual host configuration. By default, the web modules of the Business Process Choreographer applications are configured for the default_host virtual host. Verify that the ports associated with the host alias are correct. You might need to add host aliases for the host names and ports of additional cluster members or for the web server that is used. For more details about virtual hosts, refer to Virtual hosts.


Results

Business Process Archive Manager and Business Process Archive Explorer are configured.