Configuration properties for the BPMConfig command

The BPMConfig command uses a properties file to configure your environment according to the settings that you specify. Your BPM installation includes several sample configurations files that are provided as a starting point for your configuration. These sample files are composed of common properties and settings for different IBM BPM environments. Before you begin your configuration, select a sample file that most closely resembles the configuration that you want, copy the file, and customize it to suit your own environment.

View all | View with tabs

Properties file overview

Sample configuration files are provided in the install_root/BPM/samples/config folder.

For each of the different product configurations, there is a different folder containing sample configuration files. For example, for IBM® BPM Advanced, there is an advanced folder containing a set of sample configuration properties files. Within each folder, there is a set of files that are specific to the different database types and configuration environments. The sample files are named according to the following format: de_type[-environment_type]-topology-database_type-[-WinAuth].properties where
  • de_type is one of Express, Standard, Advanced, AdvancedOnly 
  • environment_type is PS or PC (omitted where de_type=AdvancedOnly
  • topology is one of Standalone, SingleCluster, ThreeClusters 
  • database_type is one of DB2, DB2zOS, SQLServer, Oracle 
  • WinAuth is only appended for environments using SQL Server with Windows authentication
For example, the sample configuration properties file for configuring a single cluster Process Center environment using DB2 with IBM BPM Advanced is called Advanced-PC-SingleCluster-DB2.properties.
The properties within these sample files are organized into sections that relate to the different types of environment characteristics. The following is a brief description of each section and the types of properties it contains. The file itself also contains descriptions of the properties and information about values to set.
Deployment environment basic properties
This section contains the properties that relate to the overall deployment environment, including the deployment environment name, product configuration (such as Express, Standard, Advanced) and deployment environment type (Process Center or Process Server). It also contains a setting which determines whether or not database tables should be created during the creation of the deployment environment.
Deployment environment and database administrator authentication alias and role properties
This section contains the properties for defining the authentication alias and role properties (such as username, passwords and role mappings) for the deployment environment administrator and the database administrator.
Cell properties
This section defines the cell administrator authentication alias and role mappings.
Deployment manager properties
This section contains the properties related to the deployment manager node, including deployment manager profile name, installation location for the product, deployment manager hostname, and SOAP port.
Cluster properties
This section defines the cluster capabilities (such as application, support, or messaging capabilities) and the databases used on this cluster. In a properties file that configures a single-cluster environment, there is only one of these sections. In a properties file that configures a multi-cluster environment, there is one of these sets of properties for each of the clusters. When modifying the configuration to add clusters, you need to duplicate this set of properties and specify the values for that new cluster.
Node properties
This section contains properties related to the managed nodes in a deployment environment, including the name, the install location for the product, and the node profile name, host name, and initial port assignment. To add managed nodes to a deployment environment, you create a new set of these properties and specify the properties for that node.
Cluster member properties
This section describes the cluster members for each cluster and the cluster each corresponds to. Properties include the cluster capabilities (such as application, support, or messaging capabilities) and the databases used by the cluster.
Database properties
This section defines the databases to be used for this deployment environment, the capabilities for each database, and the authentication alias and role mappings for each database. The sample properties files refers to the set of databases that are required by default.
Context root properties
This section customizes your context root by adding a prefix to the current value of your context root.

Database and cell properties

Set the values for your databases first, including the database administrator authentication alias properties and database properties.

Table 1. Database user authentication alias properties
Configuration properties Description

bpm.de.authenticationAlias.2.name

bpm.de.authenticationAlias.2.user

bpm.de.authenticationAlias.2.password

Example:
bpm.de.authenticationAlias.2.name=BPM_DB_ALIAS
bpm.de.authenticationAlias.2.user=MyDB2UserForAll 
bpm.de.authenticationAlias.2.password=MyDB2UserForAllPW
For each database that you are using for this deployment environment, specify the authentication alias you want to use. The number of aliases is dependent on the database type you are configuring. For example in DB2, you can use the same authentication for all the databases being configured and therefore only one authentication alias is required. For Oracle databases, the isolation is based on the user name and therefore a greater number of aliases is required. The value specified for bpm.de.authenticationAlias.2.name, for example, bpm.de.authenticationAlias.2.name=BPM_DB_ALIAS, should be used as the value you specify for the bpm.de.db.#.rolemapping.#.alias property for the databases. For example:
  • bpm.de.db.1.roleMapping.1.name=DbUser
  • bpm.de.db.1.roleMapping.1.alias=BPM_DB_ALIAS
  • bpm.de.db.1.roleMapping.2.name=DbUserXAR
  • bpm.de.db.1.roleMapping.2.alias=BPM_DB_ALIAS

The DbUserXAR role is used for XA recovery and this database user ID requires more permissions than the DbUser role. For more information about roles and role mappings see IBM Business Process Manager security roles.

The sample file uses same authentication alias BPM_DB_ALIAS for all database instances in some cases. If you have defined separate users for different databases in your environment, add new entries for database aliases by copying the following lines and updating the sequence number, alias name and username password. Then use the correct alias name for corresponding database role mapping entry.
  • bpm.de.authenticationAlias.#.name
  • bpm.de.authenticationAlias.#.user
  • bpm.de.authenticationAlias.#.password

If you need to use a backslash character (\) in your properties file, for example when specifying path names or passwords, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

Migration considerations: Configure the authentication alias entries to match the database configuration in the source environment. Use the appropriate username and password that is being used for the corresponding database in source version. For example, when migrating from WPS, if the alias being used for the CellScopedDB database is BPM_DB_ALIAS, then the username and password being used for BPM_DB_ALIAS should be set to the username and password being configured in source version for data source with jndi name jdbc/WPSDB, the cell scoped database in the source version.

Table 2. Database properties: bpm.de.db.#.*
Configuration properties Description
bpm.de.db.#.name
Example:
bpm.de.db.1.name=SharedDb

This is the keyword to use within this file to refer to the following set of database properties. In this example, SharedDB is the keyword to refer to all the properties and datasource information that are identified by bpm.de.db.1.*.

bpm.de.db.#.dbCapabilities
Example:
bpm.de.db.1.dbCapabilities=Messaging,BusinessSpace,CommonDB,BPC

List of components that are configured on this database.

The list of options depends on the product configuration:
  • For Advanced: ProcessServer, EmbeddedECM, PDW, CellScopedDB, Messaging, BusinessSpace, CommonDB, BPC
  • For Advanced Only: CellScopedDB, Messaging, BusinessSpace, CommonDB, BPC
  • For Standard: ProcessServer, EmbeddedECM,PDW, Messaging, BusinessSpace

If you want to put some components in a different database, for example, to put messaging into its own database, you need to adjust your values accordingly.

Migration Considerations: Review this list to match the databases correctly. If more than one capability is listed for a single database, the tables for all specified capabilities must exist in the same database and the same schema, and can be accessed using same database user credentials. The sample properties files for migration have separate databases for capabilities. If you choose to put more than one capability in one database, you can do so by configuring the same database-specific content for the corresponding database configuration properties listed below:
  • bpm.de.db.#.databaseName
  • bpm.de.db.#.hostname
  • bpm.de.db.#.portNumber
  • bpm.de.db.#.sqlServerWinAuth
For example, if you want to configure the same database for Business Process Choreographer (BPC) and Business Space (BSpace), set the database configuration properties to the same values for the database sections that map to the BSpace and BPC capabilities.
bpm.de.db.#.databaseName
Example:
bpm.de.db.1.databaseName=CMNDB01

The name of the database.

If you have multiple deployment environments, ensure that your database names are unique across all your deployment environments.

If you are migrating, this is name of the database in your source environment that contains the component-specific tables.

bpm.de.db.#.type
Example:
bpm.de.db.1.type=DB2

Database type. Options: DB2, DB2zOS, Oracle or SQLServer

The sample properties files contain properties that are specific to different database types. You should not have to change this value because you should begin with the sample properties file that matches your database type.

bpm.de.db.#.hostname

bpm.de.db.#.portNumber

bpm.de.db.#.sqlServerWinAuth

Example:
# .
bpm.de.db.1.hostname=MyDBServerHost.ibm.com
bpm.de.db.1.portNumber=50001 
bpm.de.db.1.sqlServerWinAuth=false
  • For the database hostname, do not use localhost for environments that are spread across multiple computers.
  • bpm.de.db.#.sqlServerWinAuth is relevant only to Windows environments and when using SQLServer as the database.
Database role and authentication alias association

bpm.de.db.#.roleMapping.1.name

bpm.de.db.#.roleMapping.1.alias

Example:
bpm.de.db.1.roleMapping.1.name=DbUser
bpm.de.db.1.roleMapping.1.alias=BPM_DB_ALIAS

The value for bpm.de.db.#.roleMapping.1.name must always be DbUser.

bpm.de.db.#.roleMapping.2.name

bpm.de.db.#.roleMapping.2.alias

Example:
bpm.de.db.1.roleMapping.2.name=DbUserXAR
bpm.de.db.1.roleMapping.2.alias=BPM_DB_ALIAS

The value for bpm.de.db.#.roleMapping.2.name must always be DbUserXAR.

bpm.de.db.#.schema

Example:
bpm.de.db.1.schema=db2admin

The default value for bpm.de.db.#.schema differs according to database type. For example, the default value for DB2 databases is db2admin.

If you are using SQL Server Windows authentication, the schema name must be specified and the login user must not have SYSADMIN privileges. If the login user has SYSADMIN privileges, the specified schema value is ignored for database connections by SQLServer as the 'sysadmin' user's default schema is always dbo.

Migration Considerations: Use the following mapping between the source databases and the target environment. The database capability represents value being used for the bpm.de.db.#.dbCapabilities property. If the source does not have the jndi name mapped below represents its a new database configured in target environment. For more information about which scenarios have which new database configured, see the bpm.de.type parameter description.

Database capability Source datasource jndi name
CellScopedDB jdbc/WPSDB
CMNDB jdbc/WPSDB

(Do not use this mapping if you have configured a new database for CMNDB in target environment)

BSpace jdbc/mashupDS
BPC jdbc/BPEDB
ProcessServer jdbc/TeamworksDB
PDW jdbc/PerformanceDB
Messaging (Optional) Use the data source you would want to use from source environment to host new ME tables. ME tables get recreated so any existing or a new database can be used.
bpm.de.db.1.volumes
 bpm.de.db.1.vcat
 bpm.de.db.1.bptable4k
 bpm.de.db.1.bptable8k
 bpm.de.db.1.bptable16k
 bpm.de.db.1.bptable32k
 bpm.de.db.1.bpindex
 bpm.de.db.1.bplob4k
 bpm.de.db.1.stogrp

These properties are specific to DB2 for z/OS.

Specify the volume for storing data, Virtual Storage Access Method (VSAM) catalog, buffer pools for tables, indexes, and LOB data, and the storage group name. Use the same values for each set of database properties that is defined in the properties file.

bpm.de.db.1.usetablespaces

bpm.de.db.1.tspre

bpm.de.db.1.tsbpctemp8k

bpm.de.db.1.tsbpc8k

bpm.de.db.1.tsbpcauditlog

bpm.de.db.1.tsbpcindexts

bpm.de.db.1.tsbpcinstance

bpm.de.db.1.tsbpclob

bpm.de.db.1.tsbpcsched

bpm.de.db.1.tsbpcstaffqry

bpm.de.db.1.tsbpctemplate

bpm.de.db.1.tsbpcworkitem

Example:
bpm.de.db.1.usetablespaces=true
bpm.de.db.1.tspre=BSP
bpm.de.db.1.tsbpctemp8k=BPETEMP8K
bpm.de.db.1.tsbpc8k=BPETS8K
bpm.de.db.1.tsbpcauditlog=AUDITLOG
bpm.de.db.1.tsbpcindexts=INDEXTS
bpm.de.db.1.tsbpcinstance=INSTANCE
bpm.de.db.1.tsbpclob=LOBTS
bpm.de.db.1.tsbpcsched=SCHEDTS
bpm.de.db.1.tsbpcstaffqry=STAFFQRY
bpm.de.db.1.tsbpctemplate=TEMPLATE
bpm.de.db.1.tsbpcworkitem=WORKITEM

These properties support the use of table spaces for Business Space and Business Process Choreographer. The tspre property is a Business Space property. The tsbpc* properties are Business Process Choreographer properties. The properties only affect the generated SQL files. A DB administrator needs to create the specified table spaces explicitly before the generated files can be run to create the DB tables.

The usetablespaces property defines whether user table spaces are used. The default value for DB2 for z/OS is true. The default value for all other database types is false, which means that all table space properties are ignored and the DBMS system table spaces are used for the tables.

The tspre property defines the table space prefix for Business Space. The maximum length allowed for this string is 3 characters. This property is used for both DB2 for z/OS and DB2 for distributed operating systems, but it is not used for Oracle or SQL Server. (There is no Business Space table space support for either Oracle and SQL Server.) The default value is BSP.

The tsbpctemp8k property defines the temporary table space to support the 8 KB buffer pools that are needed when migrating the database schema. The default value is BPETEMP8K.

The tsbpc8k property defines the table space to support the 8 KB buffer pools that are needed when migrating the database schema. The default value is BPETS8K.

The tsbpcauditlog property defines the table space for the audit trail tables for processes and tasks that are used to store audit events (mainly for compatibility with earlier versions). Depending on the degree of auditing that is used, access to tables in this table space can be significant. If auditing is turned off, tables in this table space are not accessed. The default value is AUDITLOG.

The tsbpcindexts property defines the table space that is used to store indexes. It is used intensively and its growth rate correlates with the number of instances. It is only used for Oracle databases. The default value is INDEXTS.

The tsbpcinstance property defines the table space that holds process instances and task tables. It is always used intensively, regardless of the kind of long-running process that is run. It's growth rate depends on your business applications. Where possible, place this table space on its own disk to separate the traffic from the rest of the process database. It is only created for Oracle databases. The default value is INSTANCE.

The tsbpclob property defines the large object (LOB) table space that stores large data objects of instances of business processes and human tasks. It is used intensively and its growth rate correlates with the number of instances. The default value is LOBTS.

The tsbpcsched property defines the table space for the tables that are used by the WebSphere scheduling component. The tables store scheduler information that is related to business processes and human tasks. Access to tables in the scheduler table space is usually low because of the caching mechanisms that are used in the scheduler. The table space growth rate correlates to the number of instances. The default value is SCHEDTS.

The tsbpcstaffqry property defines the table space for the tables that are used to temporarily store staff query results that are obtained from staff registries, such as the Lightweight Directory Access Protocol (LDAP). When business processes contain many person activities, tables in this table space are frequently accessed. The table space growth rate depends on how authorization has been modeled. The default value is STAFFQRY.

The tsbpctemplate property defines the table space for the tables that are used to store template information for processes and tasks. The tables are populated during the deployment of an application. The table space is used frequently and its growth rate correlates to the number and size of installed business process and human task applications. At run time, the access rate is low. The data is not updated and only new data is inserted during deployment. The default value is TEMPLATE.

The tsbpcworkitem property defines the table space for the tables that are required for work item processing. Work items are used for human task interaction. Depending on the number of human tasks in the business processes, access to the tables in this table space can vary from a low access rate to a significantly high access rate. The access rate is not zero, even when no explicit human tasks are used, because work items are also generated to support administration of long-running processes. The default value is WORKITEM.

Table 3. Cell properties
Configuration properties Description
bpm.cell.name
Example:
bpm.cell.name=MyProcessCenterCell001 

The name of the cell. If you are adding a new node to this cell, specify the same cell name that was specified during deployment manager creation. If you are creating multiple cells using the same product installation, use a different cell name for each cell.

It is recommended that you specify a different name for each cell. When naming your cells, develop a naming convention that makes it easy to assign values to the properties that relate to this cell elsewhere in the properties file.

Cell (WAS) administration authentication alias

bpm.cell.authenticationAlias.1.name

bpm.cell.authenticationAlias.1.user

bpm.cell.authenticationAlias.1.password

Example:
bpm.cell.authenticationAlias.1.name=MyProcessCenterCell001AdminAlias
bpm.cell.authenticationAlias.1.user=MyProcessCenterCell001AdminUser
bpm.cell.authenticationAlias.1.password=MyProcessCenterCell001AdminPW

The values defined for the cell administrator name and alias (bpm.cell.authenticationAlias.1.name andbpm.cell.authenticationAlias.1.user) cannot be the same as the deployment environment administrator name and alias (bpm.de.authenticationAlias.1.name andbpm.de.authenticationAlias.1.user)

You must specify values for bpm.cell.authenticationAlias.#.user and bpm.cell.authenticationAlias.#.password or BPMConfig will fail when run.

If you need to use a backslash character (\) in your properties file, for example when specifying path names or passwords, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

Migration considerations: If you are migrating from IBM BPM Standard or IBM BPM Advanced, then the username and password used for the cell administrator should map to a user who is part of the tw_admin group in the source version.

bpm.cell.roleMapping.1.name

bpm.cell.roleMapping.1.alias

Example:
bpm.cell.roleMapping.1.name=CellAdmin
bpm.cell.roleMapping.1.alias=MyProcessCenterCell001AdminAlias

The value for bpm.cell.roleMapping.1.name cannot be changed from CellAdmin. The value specified for cell aliases should match the cell alias specified for any other deployment environments created in the same cell.

For more information about roles and role mappings see IBM Business Process Manager security roles.

bpm.cell.db
Example:
bpm.cell.db=CellOnlyDb

Database at the cell level. This is valid for Advanced and AdvancedOnly deployment environment types and only needs to be created for the first deployment environment you create in the cell.

In this example, the value CellOnlyDb is a keyword to use to refer to this set of database properties.

By default, the sample properties file contains properties for setting up three databases: CMNDB, BPMDB, and PDWDB. Refer to Planning the number of databases.

Migration Considerations: If you are migrating, the CellOnlyDb must be set to the common database used by the migration source environment.

For IBM Process Server or IBM BPM Advanced source environment migrations, the name used here should reference the database section in the properties file that maps to data source with jndi name jdbc/WPSDB in the source version. For IBM WebSphere Lombardi Edition or IBM BPM Standard to IBM BPM Advanced V8.5.x migrations, use this property to map to the new database that is configured for the CellScopedDB database capability.

Deployment environment properties

Set the values for your deployment environment second, including the deployment environment basic properties, the deployment environment administrator authentication alias properties, the deployment manager properties, and the context root properties.

Table 4. Deployment environment basic properties
Configuration properties Description
bpm.de.name
Example:
bpm.de.name=MyDepEnv001

The name of the deployment environment defined by this properties file.

Each deployment environment requires its own properties file. For example, if bpm.de.name=MyDepEnv001 then this properties file describes an deployment environment named MyDepEnv001. If another deployment environment is later added into this cell, another properties file must be created.

bpm.de.deferSchemaCreation
Example:
bpm.de.deferSchemaCreation=true

Specifies whether the database tables are to be created during the deployment environment creation or whether only the sql files are to be generated for later table creation.

If bpm.de.deferSchemaCreation=false then tables are created during deployment environment creation.

bpm.de.type
Example:
bpm.de.type=Advanced

Type of product configuration: Express, Standard, Advanced or AdvancedOnly

Each sample properties file is pre-built for a particular product configuration. If you use the file that applies to your own environment, you do not have to update this value.

The value for this property is restricted based on your product license.
  • In a IBM BPM Express® installation, bpm.de.type can only be Express.
  • In a IBM BPM Standard installation, bpm.de.type can only be Standard.
  • In a IBM BPM Advanced installation, bpm.de.type can be Standard, Advanced, or AdvancedOnly.

Migration considerations: You might have to configure additional databases depending on what the source product type is. The following is the mapping:

Migration type New databases to create
IBM BPM Advanced to IBM BPM Advanced
  • Business Space database (BSpace) if not configured in source
  • Separate DE scoped Common database (CommonDB) to configure DE scoped advanced components Failed Event Manager and Event Sequencing.
IBM BPM Standard to IBM BPM Advanced
  • Business Space database (BSpace) if not configured in source
  • Business Process Choreographer database (BPC)
  • Cell-scoped database
  • DE Scoped Common database (CommonDB)
IBM BPM Standard to IBM BPM Standard
  • Business Space database (BSpace) if not configured in source
WebSphere® Process Server to IBM BPM Advanced
  • Business Space database (BSpace) if not configured in source
  • DE Scoped Common database (CommonDB)
  • Process database
  • Performance Data Warehouse database
WebSphere Process Server to IBM BPM Advanced: Process Server
  • Business Space database (BSpace) if not configured in source
  • DE Scoped Common database (CommonDB)
WebSphere Lombardi Edition to IBM BPM Advanced
  • Business Space database (BSpace)
  • Business Process Choreographer database (BPC)
  • Cell-scoped database
  • DE Scoped Common database (CommonDB)
WebSphere Lombardi Edition to IBM BPM Standard
  • Business Space database (BSpace)
  • DE Scoped Common database (CommonDB)
bpm.de.environment
Example:
bpm.de.environment=Process Center

Type of deployment environment: Process Center or Process Server.

bpm.de.psProcessCenterName

bpm.de.psProcessCenterTransportProtocol

bpm.de.psProcessCenterHostname

bpm.de.ps ProcessCenterPort

Example:
bpm.de.psProcessCenterName=Process Center
bpm.de.psProcessCenterTransportProtocol=http
bpm.de.psProcessCenterHostname=
bpm.de.psProcessCenterPort=
When setting up an online Process Server environment (bpm.de.psOffline=false) these values specify how to connect to and communicate with the related Process Center. You also need to specify the username and password for ProcessCenterUserAlias, for example:
bpm.de.authenticationAlias.3.name=ProcessCenterUserAlias
 bpm.de.authenticationAlias.3.user=PC_USER_NAME
bpm.de.authenticationAlias.3.password=PC_USER_PWD

Note that the value for bpm.de.psProcessCenterTransportProtocol must be either http or https.

In a network deployment environment, you cannot use the default value of local host for bpm.de.psProcessCenterHostname.

If you are setting up an offline Process Server environment, you do not need to specify values for these properties.

Table 5. Deployment environment administrator authentication alias properties
Configuration properties Description

bpm.de.authenticationAlias.#.name

bpm.de.authenticationAlias.#.user

bpm.de.authenticationAlias.#.password

Example:
bpm.de.authenticationAlias.1.name=DepEnv001Alias
bpm.de.authenticationAlias.1.user=MyDepEnv001User 
bpm.de.authenticationAlias.1.password=MyDepEnv001UserPW

You might want to make this alias name clearly unique in cases where you have more than one deployment environment in the cell.

If you change the value for bpm.de.authenticationAlias.#.alias from the default DeAdminAlias, you must update it everywhere that references that alias, for example bpm.de.roleMapping.#.alias

If you need to use a backslash character (\) in your properties file, for example when specifying path names or passwords, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

Migration considerations:

If you are migrating from IBM BPM Standard or IBM BPM Advanced, then the username and password used for the deployment environment administrator should map to a user who is part of the tw_admin group in the source version.

Table 6. Deployment environment administrator role and authentication alias association properties
Configuration properties Description

bpm.de.roleMapping.#.name

bpm.de.roleMapping.#.alias

Example:
bpm.de.roleMapping.1.name=DeAdmin
bpm.de.roleMapping.1.alias=DepEnv001Alias

The value for bpm.de.roleMapping.#.name cannot be changed from DeAdmin.

Note that the value for bpm.de.roleMapping.#.alias must match the value specified for bpm.de.authenticationAlias.#.name.

For more information about roles and role mappings see IBM Business Process Manager security roles.

Table 7. Deployment manager properties. All bpm.dmgr.* properties are omitted when bpm.de.type= Express.
Configuration properties Description
bpm.dmgr.nodeName
Example:
bpm.dmgr.nodeName=MyDmgrNode

Name of the deployment manager node.

bpm.dmgr.hostname
Example:
bpm.dmgr.hostname=MyDmgrHost.ibm.com
Deployment manager hostname.
Important: Do not use localhost for environments that are spread across multiple computers.
bpm.dmgr.installPath
Example:
bpm.dmgr.installPath=C:/WebSphere/BPM

The installation location of the BPM product.

If you need to use a backslash character (\) in your properties file, for example when specifying path names or passwords, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

bpm.dmgr.profileName
Example:
bpm.dmgr.profileName=MyDmgrProfile 

Deployment manager profile name.

bpm.dmgr.profilePath
Example:
bpm.dmgr.profilePath=/usr/IBM/bpm85/profiles/DmgrProfile 

Optional: Specifies the fully qualified path to the deployment manager profile. The default value is based on the bpm.dmgr.installPath directory, the profiles subdirectory, and the name of the profile bpm.dmgr.profileName.

For Microsoft Windows, you can use double backslashes or forward slashes. For example:
  • bpm.dmgr.profilePath=c:/IBM/BPM85/profiles/DmgrProfile
  • bpm.dmgr.profilePath=c:\\IBM\\BPM85\\profiles\\DmgrProfile
bpm.dmgr.profileOptions
Example:
bpm.dmgr.profileOptions=-defaultPorts

Deployment manager profile options. These can be any manageprofiles command-line options that are not already available as properties in the BPM configuration file that is input to the BPMConfig tool. The manageprofiles command-line options are described in the WebSphere Application Server topic manageprofiles command.

bpm.dmgr.initialPortAssignment
Example:
bpm.dmgr.initialPortAssignment=
OR
bpm.dmgr.initialPortAssignment=44000

The starting port number to be used when configuring ports.

In most cases, the default port assignments should be sufficient and you can leave this value unspecified. If the default ports are not suitable, you can overwrite them.

To overwrite the default port assignments, specify the starting port number for generating and assigning all ports for the deployment manager profile. Port numbers are reserved and assigned to each node for the cluster members using the port number that is specified. If you specify an initial port number, that initial port number is assigned to the first cluster member. Subsequent cluster groups are assigned port numbers that increment by 20. For example, if the port number for the first cluster group is 2000, the port numbers of the cluster members would be 2000, 2001, 2002, and so on. The port number of the second cluster group would be 2020 and the port numbers for the members of the second cluster group would be 2020, 2021, 2022, and so on. The port number of the third cluster group would be 2040.

Migration Considerations: Depending on the value of this property, the port numbers assigned to the deployment manager server process might not patch the port numbers in the source version. If there are systems or applications that depend on a particular port number, you might need to update them to work in the new environment.

bpm.dmgr.soapPort
Example:
bpm.dmgr.soapPort=8879

If the deployment manager resides on the computer where BPMConfig is invoked then BPMConfig will run successfully even when this property is set incorrectly. A warning regarding the incorrect setting will appear in the log files. Before using this same property file to run BPMConfig on other computers, check the log files to ensure there are no warnings about incorrect settings for SOAP port numbers.

Migration Considerations: Depending on the value of this property, the port numbers assigned to the deployment manager server process might not match the port numbers in the source version. If there are systems or applications that depend on a particular port number, you might need to update them to work in the new environment.

Table 8. Context root prefix property for all components
Configuration property Description
bpm.de.contextRootPrefix
Example:
bpm.de.contextRootPrefix=/deLevelContextRootValue
This property sets the deployment environment level context root prefix. The value requires a leading forward slash (/). If you set this value and run the BPMConfig -de *.properties command, all of the components in the deployment environment will have this prefix.
Important: If you update the value of bpm.de.contextRootPrefix, you must change any hard-coded URLs in your existing applications. To successfully deploy applications, the Process Center must at least be at the V8.5.0.1 level.
Table 9. Context root prefix property for the Process Portal component
Configuration properties Description
bpm.de.cluster.#.capability.#.component.#.name
Example:
bpm.de.cluster.1.capability.1.component.1.name=ProcessPortal

This property is used to set up the Process Portal context root prefix. The only value is ProcessPortal.

Note that this property does not change the Process Portal context root. The next property creates the context root prefix for Process Portal.
bpm.de.cluster.#.capability.#.component.#.contextRootPrefix
Example:
bpm.de.cluster.1.capability.1.component.1.contextRootPrefix=/processPortalMyCorp

This property sets the prefix of the context root for Process Portal. The value requires a leading forward slash (/). After setting this value, run the BPMConfig -de *.properties command to set the prefix across the Process Portal component.

You can set the deployment level context root prefix and the Process Portal context root prefix together. Then only Process Portal will have a different prefix.

Managed-node and cluster properties

Define your topology next, including managed-node properties, cluster properties, and cluster member properties.

Table 10. Managed-node properties
Configuration properties Description
bpm.de.node.#.name
Example:
bpm.de.node.1.name=MyNode01

Managed node name. These values must be unique within the cell.

bpm.de.node.#.hostname

bpm.de.node.#.installPath

bpm.de.node.#.profileName

bpm.de.node.#.profileOptions

bpm.de.node.#.initialPortAssignment

bpm.de.node.#.profilePath

Examples:
bpm.de.node.1.hostname=MyNodeHost.ibm.com
bpm.de.node.1.installPath=C:/WebSphere/BPM
bpm.de.node.1.profileName=MyNode01Profile 
bpm.de.node.1.profileOptions=-defaultPorts
bpm.de.node.1.initialPortAssignment=55000
bpm.de.node.#.profilePath=C:/WebSphere/BPM/profiles/MyCustomProfile1
  • If the host name specified is the same as the deployment manager (bpm.bmgr.hostname), this node will be created on the same computer.
  • If the deployment manager and managed node are on the same machine, the value for install path should be the same.
  • The managed node profile options. These can be any manageprofiles command-line options that are not already available as properties in the BPM configuration file that is input to the BPMConfig tool. The manageprofiles command-line options are described in the WebSphere Application Server topic manageprofiles command.
  • The initial port assignment is for the node agent process.

If you need to use a backslash character (\) in your properties file, for example when specifying path names or passwords, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

Important: Do not use localhost for host names in environments that are spread across multiple computers.
Table 11. Cluster member properties
Configuration properties Description
bpm.de.node.#.clusterMember.1.name
Example:
bpm.de.node.1.clusterMember.1.name=MyAppTargetCluster001.Member1

The name of the first cluster member.

bpm.de.node.#.clusterMember.1.weight

bpm.de.node.1.clusterMember.#.initialPortAssignment

bpm.de.node.#.clusterMember.#.cluster

Example:
bpm.de.node.1.clusterMember.1.weight=2
bpm.de.node.1.clusterMember.1.initialPortAssignment=
bpm.de.node.1.clusterMember.1.cluster=MyAppTargetCluster001

The cluster member weight represents the proportion of requests that are sent to this cluster member. You can leave this value as the default value.

bpm.de.node.#.clusterMember.#.name
Example:
bpm.de.node.1.clusterMember.2.name=MyMECluster001.Member1

The name of the second cluster member.

bpm.de.node.#.clusterMember.#.weight

bpm.de.node.#.clusterMember.#.initialPortAssignment

bpm.de.node.#.clusterMember.#.cluster

Example:
bpm.de.node.1.clusterMember.2.weight=2
bpm.de.node.1.clusterMember.2.initialPortAssignment=
bpm.de.node.1.clusterMember.2.cluster=MyMECluster001

The cluster member weight represents the proportion of requests that are sent to this cluster member. You can leave this value as the default value.

bpm.de.node.#.clusterMember.#.name
Example:
bpm.de.node.1.clusterMember.3.name=MySupportCluster001.Member1

The name of the third cluster member.

bpm.de.node.#.clusterMember.#.weight

bpm.de.node.#.clusterMember.#.initialPortAssignment

bpm.de.node.#.clusterMember.#.cluster

Example:
bpm.de.node.1.clusterMember.2.weight=2
bpm.de.node.1.clusterMember.2.initialPortAssignment=
bpm.de.node.1.clusterMember.2.cluster=MySupportCluster001

The cluster member weight represents the proportion of requests that are sent to this cluster member. You can leave this value as the default value.

Table 12. Cluster properties
Configuration properties Description
bpm.de.cluster.#.name
Example:
bpm.de.cluster.1.name=DE1.AppCluster

If you plan to have more than one deployment environment in a cell, it is recommended that you adhere to a clear naming convention for your nodes and related clusters to be able to easily identify the resources associated with the cell. For example, you can use the deployment environment name as the prefix for the related artifacts, for example De1.AppCluster, De2.AppCluster.

If you are migrating from a stand-alone environment, leave all values for bpm.de.cluster.*.name unspecified.

bpm.de.cluster.#.capabilities

Example:

Single cluster example:
bpm.de.cluster.1.capabilities=Application, Messaging, Support
Three-cluster example, specifying the first cluster as the application cluster::
bpm.de.cluster.1.capabilities=Application

Capabilities for this cluster: Application, Messaging, Support. If this is a single cluster environment, specify all three: Application, Messaging and Support.

If you are defining a multi-cluster environment, it is recommended that you specify the first cluster as the application cluster, the second as the messaging cluster, and the third as support. This order helps to ensure the best order for port assignments.

Migration Considerations: If you are migrating from either a stand-alone, a single cluster, or a two-cluster configuration to a three- cluster configuration, and your applications are dependent on IBM BPM configurations that are missing on the application cluster, such as WebSphere Application Server environment variables, data sources, or JMS configurations, the applications might fail in the new environment. These missing configurations must be manually added to the new application cluster to resolve such issues.

bpm.de.cluster.#.usesMessagingCluster
Example:
bpm.de.cluster.1.usesMessagingCluster=DE1.Cluster

Messaging cluster used by this cluster. If you are configuring a single cluster environment, leave this property unspecified. Otherwise, specify the name of the cluster that has been identified as having messaging capabilities.

bpm.de.cluster.#.usesSupportCluster
Example:
bpm.de.cluster.1.usesSupportCluster=DE1.SupportCluster

Support cluster used by this cluster. If you are configuring a single cluster environment, leave this property unspecified. Otherwise, specify the name of the cluster that has been identified as having support capabilities.

bpm.de.cluster.#.db
Example:
bpm.de.cluster.1.db=ProcessServerDB,SharedDb

List of databases that are used on this cluster. For a single cluster topology, this should list all the databases that are used, with the exception of the CellOnlyDb in Advanced environments. For a three-cluster topology, the application cluster databases are all the databases that are not used for messaging and performance data warehousing as these go into separate clusters.

The values are based on the keys specified elsewhere in the properties file. For example, if bpm.de.db.2.name is set to ProcessServerDB, then the value ProcessServerDB specified here refers to set of database properties identified with bpm.de.db.2.*.

bpm.de.cluster.#.name
Example:
bpm.de.cluster.2.name=DE1.MECluster

The name of the second cluster. The properties associated with this cluster (in the example, DE1.MECluster) are all identified with the same cluster index, bpm.de.cluster.2.*.

If you are migrating from a stand-alone environment, leave all values for bpm.de.cluster.*.name unspecified.

bpm.de.cluster.#.capabilities
Example:
bpm.de.cluster.2.capabilities=Messaging

The capabilities for this cluster. In this example, this cluster is the messaging cluster.

bpm.de.cluster.#.usesMessagingCluster
Example:
bpm.de.cluster.2.usesMessagingCluster=

Messaging cluster used by this cluster.

In this example, DE1.MECluster is the messaging cluster, so the property is left unspecified.

bpm.de.cluster.#.usesSupportCluster
Example
bpm.de.cluster.2.usesSupportCluster=

Support cluster used by this cluster.

In this example, DE1.MECluster is a messaging cluster and because messaging clusters do not depend on a support cluster, no support cluster is specified.

bpm.de.cluster.#.db
Example:
bpm.de.cluster.2.db=SharedDb

List of databases that are used on this cluster.

The values are based on the keys specified elsewhere in the properties file. For example, if bpm.de.db.2.name is set to ProcessServerDB, then the value ProcessServerDB specified here refers to set of database properties identified with bpm.de.db.2.*.

bpm.de.cluster.#.name
Example:
bpm.de.cluster.3.name=DE1.SupportCluster

The name of the third cluster. The properties associated with this cluster (in the example, DE1.SupportCluster) are all identified with the same cluster index, bpm.de.cluster.3.*.

If you are migrating from a stand-alone environment, leave all values for bpm.de.cluster.*.name unspecified.

bpm.de.cluster.#.capabilities
bpm.de.cluster.3.capabilities=Support

The capabilities for this cluster. In this example, this cluster is the support cluster.

bpm.de.cluster.#.usesMessagingCluster
Example:
bpm.de.cluster.3.usesMessagingCluster=DE1.MECluster

Messaging cluster used by this cluster.

Because support clusters require use of messaging, this example cluster points to the DE1.MECluster.

bpm.de.cluster.#.usesSupportCluster
Example:
bpm.de.cluster.3.usesSupportCluster=

Support Cluster used by this cluster.

In this example, DE1.SupportCluster is the support cluster, so the property is left unspecified.

bpm.de.cluster.#.db
Example:
bpm.de.cluster.3.db=PerformanceDB

List of databases that are used on this cluster. The values are based on the keys specified elsewhere in the properties file. For example, if bpm.de.db.3.name is set to PerformanceDB, then the value PerformanceDB specified here refers to set of database properties identified with bpm.de.db.2.*.

The support cluster uses the database with performance data warehouse capabilities (that is, the cluster with bpm.de.db.x.dbCapabilities=PDW).