You are on page 1of 7

Using the bpeconfig.

jacl script to configure Business Process Choreographer
Describes how to use the bpeconfig.jacl script to configure Business Process Choreographer and all the necessary resources on a given server or cluster. Procedure 1. Make sure that you know which options and parameters you are going to use. Refer to the values you planned in Planning to configure Business Process Choreographer. You must include all the required parameters and options in the batch file or on the command line. Otherwise, any required parameters that are not provided will be prompted for. For detailed information about the script, examples, its options and parameters, see bpeconfig.jacl script file. Option If the server (or in a network deployment environment, the deployment manager) is not running If administrative security is enabled If you are not using the default profile If you are not configuring Business Process Choreographer on the default server Because the script always creates a Business Process Choreographer configuration Description Use the option: -conntype NONE Do not use this option if the server (or deployment manager) is running. Include the parameters: -user userName -password userPassword Include the parameter: -profileName profileName Include either the parameter: -cluster clusterName or both parameters: -node nodeName -server serverName Include the parameters required for the Business Flow Manager and Human Task Manager: {-adminBFMUsers userList | -adminBFMGroups groupList} {-monitorBFMUsers userList | -monitorBFMGroups groupList} -jmsBFMRunAsUser userID -jmsBFMRunAsPwd password {-adminHTMUsers userList | -adminHTMGroups groupList} {-monitorHTMUsers userList | -monitorHTMGroups groupList} -jmsHTMRunAsUser userID -jmsHTMRunAsPwd password -contextRootBFMWS contextRootBFMWS -contextRootBFMREST contextRootBFMREST -contextRootHTMWS contextRootHTMWS

Option

Description -contextRootHTMREST contextRootHTMREST For the parameter pairs ending in Users and Groups you must specify either one or both parameters. The two parameters starting with contextRoot are optional.

If you want to enable a simple mail transfer protocol (SMTP) server for sending escalation emails Because you can either have the script file create the database, or just have it generate the SQL script without running the scripts

Include the parameter: -mailServerName mailServerName If the mail server requires authentication, also include the parameters: -mailUser mailUserID -mailPwd mailPassword Use the option -createDB { yes | no } If you select yes, the bpeconfig.jacl script will generate and run an SQL file to create the database objects in the default table space, which is not suitable for a high-performance system. In this case also plan to stop the server and use the -conntype NONE option. If you select no, and the database does not already exist, then you or your database administrator must run the generated SQL script. For a high-performance system, specify no, because you will need to customize the SQL script before running it. Also specify no if you do not have the authority to create the database yourself, so that you can provide the SQL script to your database administrator to customize and run. You must also specify no if you are using a database which has restricted support. Restriction: The script cannot create the following types of databases: o o o o DB2® for z/OS® Oracle A remote Microsoft® SQL Server A remote Informix® Dynamic Server

If you select yes and you are running the script in connected mode, creating the database or schema can fail if it takes longer than the a default timeout of 3 minutes. Because every Business Process Choreographer configuration requires access to a database Include the parameter: -dbType databaseType Also provide the parameters required for your database type (see bpeconfig.jacl script file for

Option

Description details): -dbVersion version -dbHome databaseInstallPath -dbJava JDBCDriverPath -dbName databaseName -dbUser databaseUser -dbPwd databasePassword -dbAdmin databaseAdministratorUserID -driverType JDBCDriverType -dbTablespaceDir databaseTablespacePath -dbServerName databaseServerName -dbServerPort databaseServerPort -dbStorageGroup DB2zOSStorageGroup -dbConnectionTarget DB2zOSSubSystem -dbSchema schemaQualifier -dbInstance InformixInstance When running the script in batch mode on a cluster, if your database requires the -dbJava parameter, specify the parameter for each node that hosts a cluster member in the following way: -dbJava.nodeName JDBCDriverPath_on_nodeName Note: If you are using one of the following databases, bpeconfig.jacl can also create the database instance: o o o o A local DB2 for Linux®, UNIX®, or Windows® DB2 on iSeries™ Derby Embedded Derby Network database and the server is running

Because every Business Process Choreographer configuration uses a JMS provider

Include the parameter: -mqType { WPM | MQSeries } Also provide the parameters required for your JMS provider (see bpeconfig.jacl script file for details). -createQM { yes | no } -qmNameGet getQueueManagerName -mqClusterName mqClusterName -qmNamePut putQueueManagerName -mqHome MQInstallationDirectory -mqUser JMSProviderUserID -mqPwd JMSProviderPassword Note: The MQSeries® option is deprecated. Include the following parameters: -meStoreType { FILESTORE | DATASTORE } -mqCreateTables { true | false } -mqSchemaName mqSchemaName -medbUser meDatabaseUser -medbPwd meDatabasePassword and optionally include:

If you are using the mqType WPM option, specify the message engine store settings

Option

Description -mqDataSource datasourceName

Because the script always configures a Business Process Choreographer Explorer

Include any of these optional parameters: -contextRootExplorer explorerContextRoot -explorerHost explorerURL -hostName explorerVirtualHostname -maxListEntries maximum -remoteCluster clusterName -remoteNode nodeName -remoteServer serverName -restAPIBFM restAPIURL -restAPIHTM restAPIURL For more information about these parameters, including default values, see Using the clientconfig.jacl script file to configure the Business Process Choreographer Explorer. Use the options: -createEventCollector { yes | no } -createObserver { yes | no } These options can only be used when running bpeconfig.jacl in batch mode, and are not suitable for a high performance system. For a production system, perform Configuring the Business Process Choreographer Observer.

Know whether you want to install and configure the Business Process Choreographer Observer, or event collector applications on the deployment target

2. If you selected the Business Process Choreographer sample configuration option when you created a default profile, the Business Flow Manager, Human Task Manager, Business Process Choreographer Explorer, and Business Process Choreographer Observer are already configured. You can check if they are configured, by looking in the administrative console for enterprise applications with names that start with: o o o o o o BPCECollector BPCExplorer BPCObserver BPEContainer HTM_PredefinedTasks TaskContainer

The sample configuration uses a Derby database, and is not suitable for a production system. Because you can only have one Business Process Choreographer configuration on a deployment target, you must remove the sample configuration, as described in Removing the Business Process Choreographer configuration before you can continue configuring Business Process Choreographer. 3. If you have a network deployment environment, make sure that the Service Component Architecture (SCA) is configured:

a. If you want to configure Business Process Choreographer on a server, click Servers > Application servers > serverName, then in the Business Integration section, click Service Component Architecture. b. If you want to configure Business Process Choreographer on a cluster, click Servers > Clusters > clusterName, then in the Business Integration section, click Service Component Architecture. c. If it is not enabled, select Support the Service Component Architecture components. 4. If you are using WebSphere® Platform Messaging (WPM) as the JMS provider, and did not use either of the options -meStoreType DATASTORE with a Derby Embedded database, or -meStoreType FILESTORE then create the database for the data store for the Business Process Choreographer messaging engine: o If you want to use the -mqCreateTables yes option to have the messaging engine create the default schema the first time that it uses the database, perform the following: a. If the database does not already exist, create it. b. Grant the database user ID the rights to create tables and views in the schema that you planned to use. o Otherwise, if you will use the -mqCreateTables no option, create the tables before the default messaging provider tries to access the database. You can use the sibDDLGenerator utility that is in the bin subdirectory of your install_root directory to generate a DDL file that can be used to create the tables. 5. If you plan to use the option -createDB yes to run the generated SQL scripts to create the database schema: . If you are using one of the following databases:  DB2 for z/OS  Oracle  a remote Microsoft SQL Server  a remote Informix Dynamic Server and your database does not already exist, create an empty database manually according to the documentation for your database. a. Make sure that the database client, for example db2.exe, is on the path for the scripting client. b. Make sure that the application server is stopped. 6. Invoke the bpeconfig.jacl script file, either in batch mode providing the options and configuration parameters that you planned, or in interactive mode, For details about the script file, refer to bpeconfig.jacl script file. 7. If you are using the WebSphere MQ Java™ Message Service (JMS) provider, and you used the -createQM no option to prevent the script from creating the queue manager and queues, create the queue manager and queues now by performing Creating the queue manager and queues for Business Process Choreographer. 8. 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 Using a generated SQL script to create the database schema for Business Process Choreographer before you activate Business Process Choreographer in step 9. Note: If your database is local, and it will exist by the time you activate Business Process Choreographer in step 9, and you do not perform the actions described in

Using a generated SQL script to create the database schema for Business Process Choreographer, the default schema will be created the first time that Business Process Choreographer accesses the database. 9. Activate Business Process Choreographer: Perform Activating Business Process Choreographer. 10. Optional: Verify that the basic Business Process Choreographer configuration works: Perform Verifying that Business Process Choreographer works. 11. Optional: If you want to change the JMS authentication user IDs, the run-as user IDs, or the mappings of roles onto users and groups, click Security > Business Integration security to change the security settings. 12. Optional: Change settings for the Human Task Manager: o If you want to change any of the Human Task Manager settings for the escalation e-mails, such as the sender address or the URL prefix for the Business Process Choreographer Explorer, click Servers > Application servers > server_name or Servers > Clusters > cluster_name if Business Process Choreographer is configured on a cluster, then under Business Integration, expand Business Process Choreographer Container, click Human Task Manager, and make your changes. o If you want to change the e-mail server address, port number, the user ID, or password for the e-mail server, click Resources > Mail > Mail sessions , select Cell scope, then click HTM mail session, and make your changes. 13. Depending on the type of people directory provider that you use for people assignment, you might need to configure it: o The system and user registry people directory providers can be used without configuring them. o If you are using Lightweight Directory Access Protocol (LDAP), perform Configuring the LDAP people directory provider. o If you are using the Virtual Member Manager (VMM), perform Configuring the Virtual Member Manager people directory provider. 14. Optional: If you configured VMM, and you want to use people substitution, perform Configuring people substitution. 15. Optional: If you want to use group work items, use the administrative console to enable them. Click Servers > Application servers > server_name or Servers > Clusters > cluster_name if Business Process Choreographer is configured on a cluster, then under Business Integration, expand Business Process Choreographer Container, click Human Task Manager, and select Enable group work items. 16. If you have WebSphere application security enabled and you have a long-running process that calls a remote EJB method, make sure that your Common Secure Interoperability Version 2 (CSIv2) inbound authentication configuration has CSIv2 identity assertion enabled. For more information about this, refer to Configuring Common Secure Interoperability Version 2 inbound authentication. 17. If you configured Business Process Choreographer in a clustered environment, and you will use the Business Process Choreographer Explorer, the Business Space, or a client that uses the Representational State Transfer (REST) API, you must change the default context roots for the REST API so that they are unique for each combination of host name and port. To set the context roots perform the following: . In the administrative console click Applications > Enterprise Applications > BPEContainer_node_server > Context Root for Web Modules a. Make sure that the context roots for the Web modules BFMRESTAPI and HTMRESTAPI are correct and unique.

Note: If you change these context roots, you must make sure that the environment entries for the REST API URLs used by Web modules such as the Business Process Choreographer Explorer and the Business Space match the new context root values. 18. Optional: If you have not yet installed and configured Business Process Choreographer Explorer, you can configure it now. Perform Configuring Business Process Choreographer Explorer. 19. Optional: If you have not yet installed and configured Business Process Choreographer Observer, you can configure it now. Perform, Configuring the Business Process Choreographer Observer. 20. Optional: If you want to configure a remote Business Process Choreographer client that uses the WebSphere Process Server client, perform, Configuring a remote client application. Results Business Process Choreographer is configured.