This sample script file configures all the resources that are required
by Business Process Choreographer. It configures a working business process
container, human task container, Business Process Choreographer Explorer,
without using the installation wizard or administrative console. It can create
a local database, and the necessary messaging resources.
Restrictions
This script cannot create a local database
for DB2 for z/OS or for Oracle.
Purpose
Using this script configures a working business
process container, and human task container without using the installation
wizard or administrative console. It can create a local database, and the
necessary messaging resources, and also configure the Business Process Choreographer
Explorer. If the script is applied to an application server that is in a cluster,
all servers in the cluster will be configured for using Business Process Choreographer.
This
file is in the folder install_root/ProcessChoreographer/sample.
Runing the script in a stand-alone server environment
In
a stand-alone server environment:
- Include the -conntype NONE option only if the application
server is not running.
- If the server is running and global security is enabled, include the -username and -password options.
- If you are not configuring the default profile, add the -profileName option.
Runing the script in an ND environment
In
a Network Deployment environment:
- Run the bpeconfig.jacl script on the deployment manager node.
- Include the -conntype NONE option only if the deployment
manager is not running.
- If global security is enabled, include the -username and -password options.
- If you are not configuring the default profile, add the -profileName option.
Running the configuration script interactively
This
example, illustrates running the
bpeconfig script to install
and configure the business process container (that uses an existing DB2 database),
a human task container, and a Business Process Choreographer Explorer.
- On the server, or for ND, on the deployment manager, start the script:
- On UNIX® and Linux® systems, enter the command:
install_root/bin/wsadmin.sh
-f install_root/ProcessChoreographer/sample/bpeconfig.jacl
( [-username userName][-password password]|[-conntype NONE])
[-profileName profileName]
- On Windows® systems, enter the command:
install_root\bin\wsadmin.bat
-f install_root\ProcessChoreographer\sample\bpeconfig.jacl
( [-username userName][-password password]|[-conntype NONE])
[-profileName profileName]
- Interactively enter responses to the questions that are displayed:
- In an ND environment, you will be offered a cluster to configure in. If
it is not the correct cluster, enter No to be offered the next cluster.
If it is the correct cluster, enter Yes.
- For the question Install the business process container?,
enter Yes.
- For the question User(s) to add to role BPESystemAdministrator,
enter the user IDs for the users who will perform the role of business process
administrator.
- For the question Group(s) to add to role BPESystemAdministrator,
enter the groups from the domain user registry that are mapped onto the role
of business process administrator.
- For the question User(s) to add to role BPESystemMonitor,
enter the user IDs for the users who will perform the role of business process
monitor.
- For the question Group(s) to add to role BPESystemMonitor,
enter the groups from the domain user registry that are mapped onto the role
of business process monitor.
- If you get the question Use WebSphere default messaging
or WebSphere MQ, enter one of the two displayed options.
- For the question Run-as UserId for role JMSAPIUser,
enter the run-as user ID that will be used for the JMSAPIUser role.
- Enter the password for the run-as user ID.
- For the question Use
a DB2, an Informix, an Oracle, or an SQL Server database [DB2/Informix/Oracle/MSSQL]?,
for this example, enter DB2. Selecting a different database results in other
database-specific questions.
- For the question Use WebSphere default messaging
or WebSphere MQ [WPM/MQSeries]?, select the JMS provider that you
want to use.
- For the question Create the DataSource for the
Process Choreographer database?, enter Yes.
- Enter the database name.
- For the question Universal or CLI?, enter
the type of the JDBC driver.
- For the question DB2 User ID, enter the
user ID that was used to create the database tables and schema.
- For the question Database server name (may be empty,
set to use the type 4 driver), enter the name of the machine that
hosts the database.
- For the question Database server port,
enter the database server port, for example, 50000.
- For the question Create the Process Choreographer
database?, enter No if the database already
exists, otherwise, enter Yes.
- For the question DB2 tablespace directory (may
be empty) enter the directory for the table space, or leave it empty.
- For the question Create the ActivationSpecs for
the business flow manager?, enter Yes or No.
- If you get the question User ID for access to default
messaging, enter the user ID to use to access the default JMS provider.
- If you get the question Name of the message engine
cluster, enter the name of the message engine cluster.
- If you get the question Name of the message engine
database schema, enter the name of the message engine database schema.
- If you get the question Automatically create the
message engine database tables [true/false]?, enter true to
automatically create the message engine database tables, otherwise enter false.
- If you get the question Message engine datasource
JNDI name, enter the JNDI name of the message engine data source.
- For the question Install the task container?,
enter Yes.
- For the question User(s) to add to role TaskSystemAdministrator,
enter the user IDs for the users who will perform the role of task administrator.
- For the question Group(s) to add to role TaskSystemAdministrator,
enter the groups from the domain user registry that are mapped onto the role
of task administrator.
- For the question User(s) to add to role TaskSystemMonitor,
enter the user IDs for the users who will perform the role of task monitor.
- For the question Run-as UserID for role EscalationUser,
enter the run-as user ID for the role of escalation user.
- For the question Create the mail notification session
for the human task manager?, enter No if you
do not want to create the mail notification session for the human task manager.
Otherwise, enter Yes, and specify the mail transport
host and user ID.
- For the question Create the ActivationSpecs for
the human task manager?, enter Yes to create
J2EE ActivationSpecs for the human task manager Message Driven Bean (MDB),
otherwise enter No.
- If you get the question Configure in cluster 'MECluster'
[Yes/no]?, enter Yes to configure in the specified
cluster, otherwise, enter No.
- If you get the question Add JDBC provider permissions
to server.policy [Yes/no]?, enter Yes to automatically
add the permissions for the JDBC provider to the server.policy file, otherwise,
enter No.
- For the question Install the BPC Explorer?,
enter Yes to install the Business Process Choreographer
Explorer, then for the Virtual host for the BPC explorer,
enter the name of the virtual host for the BPC Explorer, for example, default_host,
then for the question Precompile JSPs?, enter Yes if you want Java Server Pages (JSPs) to be precompiled,
otherwise enter No .
- For the question Create aliases for your_server in
host your_host?, enter Yes to
create aliases for your server in the your virtual host, otherwise enter No.
- For the question Enable global security using the
Local OS user registry?, enter Yes to enable
global security using the local operating system user registry, otherwise,
enter No.
- For the question Server user ID, enter
the server user ID.
- For the question Enforce Java 2 security?,
enter Yes to enforce Java 2 security, otherwise, enter No.
- For the question Set 'com.ibm.SOAP.loginUserid'
in soap.client.props?, enter Yes to set the
login user ID in the SOAP client properties, otherwise,
enter No.
- For the question Delete the temporary directory?,
enter Yes to delete the temporary directory specified,
otherwise, enter No.
- In case of problems, check the log files.
Log files
If you have problems creating the configuration
using the bpeconfig.jacl script file, check the following log files:
- bpeconfig.log
- wsadmin.traceout
Both files can be found in the logs directory for your profile:
- On Linux and UNIX systems: In the directory install_root/profiles/profileName/logs/.
- On Windows systems: In the directory install_root\profiles\profileName\logs\.
Configuring the business process container noninteractively
If
you provide the necessary parameters on the command line, you will not be
prompted for them. To configure a business process container that uses the
default messaging JMS provider with a Cloudscape database type, enter one
of the following:
On UNIX and Linux systems, if your current directory
is install_root/ProcessChoreographer, enter the
command:
../bin/wsadmin.sh [-conntype NONE] -f bpeconfig.jacl
( [-node nodeName] [ -server serverName]
|[-cluster clusterName])
[-adminHTMUsers userList]
[-adminHTMGroups groupList]
[-monitorHTMUsers userList]
[-monitorHTMGroups groupList]
[-jmsHTMRunAsUser userID]
[-jmsHTMRunAsPwd password]
[-mqType JMSProviderType]
[-createQM ( yes | no )]
[-qmNameGet getQueueManagerName]
[-mqUser userID]
[-mqPwd password]
[-mqHome installationDirectory]
[-mqClusterName mqClusterName]
[-mqSchemaName mqSchemaName]
[-mqCreateTables ( true | false )]
[-mqDataSource datasourceName
[-mailServerName hostName]
[-mailUser userID]
[-mailPwd password]
[-profileName profileName]
On
Windows systems, if your current directory is install_root\ProcessChoreographer,
enter the command:
..\bin\wsadmin [-conntype NONE] -f bpeconfig.jacl
( [-node nodeName] [ -server serverName]
|[-cluster clusterName])
[-adminHTMUsers userList]
[-adminHTMGroups groupList]
[-monitorHTMUsers userList]
[-monitorHTMGroups groupList]
[-jmsHTMRunAsUser userID]
[-jmsHTMRunAsPwd password]
[-mqType JMSProviderType]
[-createQM ( yes | no )]
[-qmNameGet getQueueManagerName]
[-mqUser userID]
[-mqPwd password]
[-mqHome installationDirectory]
[-mqClusterName mqClusterName]
[-mqSchemaName mqSchemaName]
[-mqCreateTables ( true | false )]
[-mqDataSource datasourceName
[-mailServerName hostName]
[-mailUser userID]
[-mailPwd password]
[-profileName profileName]
Parameters
The script file can take the following parameters:
- conntype NONE
- Only include this option if the application server (for stand-alone) or
deployment manager (for ND) is not running.
- node nodeName
- Where nodeName is the name of the node. Do not specify
this option if you specify a cluster.
- server serverName
- Where serverName is the name of the server. Do not
specify this option if you specify a cluster.
- cluster clusterName
- Where clusterName is the name of the cluster. Do not
specify this option in a stand-alone server environment, nor if you specify
the node and server.
- profileName profileName
- Where profileName is
- adminHTMUsers userList
- Where userList is the list of names of users, from
the user registry, to which to map the TaskSystemAdministrator Java 2 Enterprise
Edition (J2EE) role. The separator character is |. This property is needed
to install the task container. This parameter has no default value. Either
one or both of the adminHTMUsers or adminHTMGroups options
must be set.
- adminHTMGroups groupList
- Where groupList is the list of names of groups, from
the user registry, to which to map the TaskSystemAdministrator J2EE role.
The separator character is |. This property is needed to install the task
container. This parameter has no default value. Either one or both of the adminHTMUsers or adminHTMGroups options
must be set.
- monitorHTMUsers userList
- Where userList is the list of names of users, from
the user registry, to which to map the TaskSystemMonitor J2EE role. The separator
character is |. This property is needed to install the task container. This
parameter has no default value. Either or both monitorHTMUsers or monitorHTMGroups
must be set.
- monitorHTMGroups groupList
- Where groupList is the list of names of groups, from
the user registry, to which to map the TaskSystemMonitor J2EE role. The separator
character is |. This property is needed to install the task container. This
parameter has no default value. Either or both monitorHTMUsers or monitorHTMGroups
must be set.
- jmsHTMRunAsUser userID
- Where userID is the run-as user
ID from the user registry for the task container message-driven bean. This
property is needed to install the task container. This parameter has no default
value. It must be set.
- jmsHTMRunAsPwd password
- Where password is the password for the task container
message-driven bean. This property is needed to install the task container.
This parameter has no default value. It must be set.
- mqType JMSProviderType
- Where JMSProviderType is the type of Java Message Service
(JMS) provider to use for Business Process Choreographer. It is needed to
create the queue manager and the queues, and to create the listener ports
and the queue connection factories.
Where JMSProviderType is
one of the following values:
- WPM
- For default messaging
- MQSeries
- For WebSphere MQ
- createQM ( yes | no)
- Controls whether the script creates a local WebSphere MQ queue manager.
This options has an effect when the mqType option is set to "MQSeries". The
default value for createQM is "yes". Use the value "no" if you do not want
the script to create the WebSphere MQ queue manager, for example, if you want
to create the queue manager on a different machine to the one where you are
running the script.
- qmNameGet getQueueManagerName
- Where getQueueManagerName is the name of the queue
manager for GET requests. It is used with only the JMS provider designated MQSeries.
It is needed to create the queue manager and the queues, and to create the
listener ports and the queue connection factories. It must not contain the - character.
Default
value for getQueueManagerName: BPC_nodeName_serverName
- mqUser userID
- Where userID is the user ID to access WebSphere MQ.
It is needed to create the queue manager and the queues, when using the "MQSeries"
JMS provider on non-Windows systems, and to create the listener ports and
the queue connection factories, when using the JMS provider for WPM.
Default
values for userID:
- Windows systems
- currently_logged-on_user
- Other systems
- mqm
- mqPwd password
- Where password is the password to access WebSphere
MQ. It is needed to create the queue manager and the queues, when using the
"MQSeries" JMS provider on non-Windows systems, and for creating the listener
ports and the queue connection factories, when using the JMS provider for
WPM. This parameter has no default value.
- mqHome installationDirectory
- Where installationDirectory is the installation directory
of WebSphere MQ. This is needed to create the queue manager and the queues
(Windows systems only) and for creating the listener ports and the queue connection
factories. This option is only required if the mqType has the value "MQSeries".
Default
values for installationDirectory:
- Windows systems
- current_drive\Program Files\IBM\WebSphere
MQ
- AIX platform
- /usr/mqm
- iSeries platform
- /QIBM/ProdData/mqm
- SunOS platform
- /opt/mqm
- mqClusterName mqClusterName
- Where mqClusterName denotes the name of the WebSphere
Application Server cluster where the default JMS provider's message engines
are to be created. This has nothing to do with a WebSphere MQ cluster. This option is only used when configuring
BPC in a cluster and the mqType option is set to WPM.
- mqSchemaName mqSchemaName
- Where mqSchemaName denotes the name of the database
schema to be used by the default JMS provider's messaging engine. This option is only used when configuring
BPC in a cluster and the mqType option is set to WPM.
- mqCreateTables true | false
- This Boolean flag controls whether the default JMS provider creates create
its tables in the message engine database upon the first connection. This option is only used when configuring
BPC in a cluster and the mqType option is set to WPM.
- mqDataSource datasourceName
- Where datasourceName is the JNDI name of the data source
to be used by the default JMS provider's message engine. This must be a cluster-level
data source in the WebSphere cluster denoted by mqClusterName.
The underlying database for the default JMS provider must be created manually. This option is only used when configuring
BPC in a cluster and the mqType option is set to WPM.
- mailServerName mailServerName
- Where mailServerName is the host name of the mail server
to be used to send notification mails.
- mailUser mailUserID
- Where mailUserID is the user ID to access the mail
server. It is needed to create the mail session for sending notification mails.
Default:
Empty: no authentication is required to access the mail server.
- mailPwd mailPassword
- Where mailPassword is the password to access the mail
server. It is needed to create the mail session for sending notification mails.
- profileName profileName
- Where profileName is the name of a user-defined profile.
Specify this option if you are not configuring the default profile.