Configuration properties for the BPMConfig command

bpm.de.authenticationAlias.2.name

bpm.de.authenticationAlias.2.user

bpm.de.authenticationAlias.2.password

bpm.de.authenticationAlias.2.description

bpm.de.authenticationAlias.2.name=BPM_DB_ALIAS
bpm.de.authenticationAlias.2.user=MyDB2UserForAll 
bpm.de.authenticationAlias.2.password=MyDB2UserForAllPW

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 roles.

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

These properties are automatically migrated. Use the appropriate user name and password that is being used for the corresponding database in the source version. For example, when migrating from WebSphere Process Server, if the alias being used for the CellScopedDB database is BPM_DB_ALIAS, then the user name and password being used for BPM_DB_ALIAS should be set to the user name and password being configured in the source version for the data source with JNDI name jdbc/WPSDB.

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 data source information that are identified by bpm.de.db.1.*.

List of components that are configured on this database.

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.

Review this list to match the databases correctly.

The name of the database (or the service name or system ID for Oracle).

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. The property is automatically migrated.

The database type. The options are 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.

If you are migrating, this property is automatically migrated.

bpm.de.db.#.hostname

bpm.de.db.#.portNumber

bpm.de.db.#.sqlServerWinAuth

bpm.de.db.1.hostname=MyDBServerHost.ibm.com
bpm.de.db.1.portNumber=50001 
bpm.de.db.1.sqlServerWinAuth=false

• The host or IP address of the database server. Do not use localhost as a host name for environments that are spread across multiple computers.
• The port number of the database server.
• Specifies whether Microsoft Windows authentication is used. It is only relevant in Windows environments when SQLServer is used as the database.

If you are migrating, these properties are automatically migrated.

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

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

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

The database role and authentication alias association. 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

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

The database role and authentication alias association. The value for bpm.de.db.#.roleMapping.2.name must always be DbUserXAR.

bpm.de.db.#.schema

bpm.de.db.1.schema=db2admin

The schema (or user on Oracle). The default value for bpm.de.db.#.schema differs according to database type. For example, the default value for DB2 databases is db2admin.

On DB2 for z/OS, the entire schema name must be uppercase. For example, 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.

• The schema name for the DB capabilities ProcessServer and PDW must match the user name of the associated DbUser authentication alias unless dbType is set to one of the following values:
  • dbType=DB2zOS
  • dbType=SQLServer and sqlServerWinAuth=true
• The schema name for the DB capability EmbeddedECM must match the user name of the associated DbUser authentication alias unless dbType is set to SQLServer and sqlServerWinAuth=true.
• When dbType is set to SQLServer, the schema name must be a Microsoft regular identifier and not contain any special characters. For more information, see Database Identifiers.

• The DB capability ProcessServer can only share the database schema with the DB capabilities EmbeddedECM and Messaging unless dbType is set to DB2zOS.
• The DB capability PDW can only share the database schema with the DB capability Messaging unless dbType is set to DB2zOS.
• The DB capabilities EmbeddedECM and BPC cannot share the database schema.

If you are migrating, this property is automatically migrated.

This property can only be set for Oracle databases and it defaults to the following Oracle Single Client Access Name (SCAN) URL:

jdbc:oracle:thin:@//host_name:port_number/serviceName

If you do not use the SCAN feature or you use an earlier version of Oracle that does not support the SCAN feature, then you must set the bpm.de.db.#.url property. The property simplifies the configuration of Oracle Real Application Clusters (RAC) or Oracle Data Guard, which enables you to use an Oracle Net connection descriptor URL instead of the default SCAN URL. For example, you can set the property to the following non-SCAN URL, which incorporates the instance name (also known as the system ID or SID):

jdbc:oracle:thin:@host_name:port_number:system_ID

 bpm.de.db.1.tssibpre
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 bpm.de.db.1.connectionLocation

These properties are specific to DB2 for z/OS.

The tssibpre property defines the prefix for messaging engine tablespace names. The prefix can be 0 to 5 characters long. The default value is BPM01.

The remaining properties are for specifying the volume for storing data, Virtual Storage Access Method (VSAM) catalog, buffer pools for tables, indexes, LOB data, storage group name, and database connection location. Use the same values for each set of these 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

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 usetablespaces property is used for both Business Process Choreographer and Business Space. 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. It is used for DB2 for z/OS, DB2 distributed, and Oracle. 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 SQL Server. (There is no Business Space table space support for 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 property is only used on DB2 distributed platforms. 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 property is only used on DB2 distributed platforms. 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 property is only used on DB2 distributed platforms and Oracle. 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. The property is only used on DB2 distributed platforms and Oracle. 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. It is only used for Oracle databases. 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 property is only used on DB2 distributed platforms and Oracle. 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 property is only used on DB2 distributed platforms and Oracle. 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 property is only used on DB2 distributed platforms and Oracle. 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 property is only used on DB2 distributed platforms and Oracle. The default value is WORKITEM.

The name of the cell. When you name 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. If you are creating multiple cells using the same product installation, use a different cell name for each cell. If you are adding a new node to this cell, specify the same cell name that was specified during deployment manager creation.

If multiple Process Server environments are connected to the same Process Center, the cell name for each Process Server must be unique. For guidance, see Naming considerations for profiles, nodes, servers, hosts, and cells.

bpm.cell.authenticationAlias.1.name

bpm.cell.authenticationAlias.1.user

bpm.cell.authenticationAlias.1.password

bpm.cell.authenticationAlias.1.description

bpm.cell.authenticationAlias.1.name=MyProcessCenterCell001AdminAlias
bpm.cell.authenticationAlias.1.user=MyProcessCenterCell001AdminUser
bpm.cell.authenticationAlias.1.password=MyProcessCenterCell001AdminPW
bpm.cell.authenticationAlias.1.description=Authentication
 Alias for Process Center Cell 001

The following properties are used to define the cell administration authentication alias:

• The name of the authentication alias.
• The user of the authentication alias.
• The password of the user.
• The description of the authentication alias.

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, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

At the cell scope, the following authentication aliases are migrated:

• Cell administrator is migrated to CellAdmin
• SCA_Auth_Alias is migrated if the migration source is IBM BPM Advanced or WebSphere® Process Server

For these cell-scoped aliases, the following properties are migrated automatically:

• bpm.cell.authenticationAlias.*.user
• bpm.cell.authenticationAlias.*.password

At the deployment environment scope, the following authentication aliases are migrated:

• Any authentication alias that is used by a database capability. These aliases are merged if the database user is the same, to reduce the number of aliases.
• Any authentication alias that you customized in the 100Custom.xml file.

For these deployment environment-scoped aliases, the following properties are migrated automatically:

• bpm.cell.authenticationAlias.*.name
• bpm.cell.authenticationAlias.*.user
• bpm.cell.authenticationAlias.*.password
• bpm.cell.authenticationAlias.*.description

bpm.cell.roleMapping.1.name

bpm.cell.roleMapping.1.alias

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 roles.

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.

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

For WebSphere 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 the data source with the JNDI name jdbc/WPSDB in the source version. For 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.

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.

If you are using an ND environment, the property is automatically migrated. If you are using a stand-alone environment, the default value is used.

Specifies which one of the following actions occurs during the creation of the deployment environment:

• Database tables are automatically created and the Process Server database is loaded with system information.
• SQL files are generated that can be used later to create the database tables.

This property is only used with the BPMConfig -create -de and BPMConfig -upgrade -de commands.

If bpm.de.deferSchemaCreation=false then tables are created during deployment environment creation and the Process Server database is loaded with system information (unless you are creating an IBM BPM AdvancedOnly deployment where the Process Server database does not exist or you are using a Microsoft SQL Server database with Windows Authentication).

Ensure that the value true is always used for migration.

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.

Based on your decision about the type of deployment environment that you want, this property will be set to the correct value when you migrate the configuration from the source environment.

Type of deployment environment: Process Center or Process Server.

When the bpm.de.environment property is set to Process Center, the Process Server bpm.de.ps* configuration properties are ignored.

However, when the bpm.de.environment property is set to Process Server, the bpm.de.ps* properties need to be set, as described in the table Process Server environment configuration properties (bpm.de.ps*).

A unique name for the process server that differentiates it from all other process servers that connect to the same Process Center.

The purpose of the Process Server environment. The valid values are:

• Development
• Test
• Staging
• Production

For Process Server environments, the bpm.de.psPurpose configuration property defines the value of the <environment-type> server property in the 99Local.xml file. The property cannot be set for Process Center environments.

The property is primarily used for development and determines how IBM BPM works with environment variables and server configurations that are specified in Process Designer, such as the iLog Rules Server, Web Service Server, ECM Server, and IBM Case Manager Server configurations.

The property also enables you to gain access to the environment type when using a governance process. For example, if the property is used to set the environment type to Staging, you can deploy the code and start some load tests.

The offline or online state of the Process Server. The value must be either true or false.

Set the value to false if the Process Server is online and can be connected to the Process Center.

When the bpm.de.psOffline property value is set to false, you need to set the following properties to specify how to connect to and communicate with the related Process Center:

• bpm.de.psProcessCenterTransportProtocol
• bpm.de.psProcessCenterHostname
• bpm.de.psProcessCenterPort
• bpm.de.psProcessCenterContextRootPrefix (optional)

bpm.de.authenticationAlias.3.name=ProcessCenterUserAlias
 bpm.de.authenticationAlias.3.user=PC_USER_NAME
bpm.de.authenticationAlias.3.password=PC_USER_PWD

The transport protocol for communicating with the Process Center environment. The value must be either http or https.

This property only needs to be specified when the bpm.de.psOffline property is set to false.

The host name of the Process Center environment. In a network deployment environment, you cannot use the default value of local host.

This property only needs to be specified when the bpm.de.psOffline property is set to false.

The port number of the Process Center environment.

This property only needs to be specified when the bpm.de.psOffline property is set to false. You do not need to specify a port number if you will be using the default port for the specified transport protocol (port 80 for http or port 443 for https).

The context root prefix of the Process Center environment. The property is optional and is only used when the bpm.de.psOffline property is set to false.

If the property is set, the value of the context root prefix requires a leading forward slash (/).

If you are migrating from IBM BPM 8.0.1.2 or later, the bpm.de.psProcessCenterContextRootPrefix property is automatically migrated.

bpm.de.authenticationAlias.#.name

bpm.de.authenticationAlias.#.user

bpm.de.authenticationAlias.#.password

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.

With the exception of z/OS, the authentication alias for the deployment environment administrator (DeAdminAlias) must not use the same user name as the authentication alias for the cell administrator (CellAdminAlias).

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, you must use an escape backslash before it, for example bpm.dmgr.installPath=c:\\IBM\\BPM85.

You need to specify the user name and password for the deployment environment user. For WebSphere Lombardi Edition, IBM BPM Standard, or IBM BPM Advanced, the user should be a member of the tw_admins group in the source version.

bpm.de.roleMapping.#.name

bpm.de.roleMapping.#.alias

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 roles.

Name of the deployment manager node.

The installation location of the BPM product.

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

Deployment manager profile name.

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.

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. You can specify multiple options, but the options and their values must be separated by a blank character rather than by an equals (=) sign, exactly as they would be specified on the manageprofiles command line. The manageprofiles command-line options are described in the WebSphere Application Server topic manageprofiles command.

If you specify the -keyStorePassword parameter, it will set the password for the following entities:

• The WebSphere CellDefaultKeyStore keystore
• The IBM BPM truststore for connections to IBM Blueworks Live (named BlueWorksLiveTrustStore)
• The IBM BPM keystore (named IBMBPMKeyStore-deployment_environment_name

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.

Instead of using the bpm.dmgr.initialPortAssignment property to assign a fixed block of port numbers, you can use bpm.dmgr.profileOptions=-defaultPorts to assign the WebSphere default ports, or you can use bpm.dmgr.profileOptions=-portsFile file_path to assign concrete values to the individual ports (where file_path is the path to the properties file that contains the port assignments). For a list of available ports and their default numbers, see the topic Port number settings.

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.

The SOAP port for the deployment manager. When you are creating the deployment manager, do not set this property. Once the deployment manager has been created, set the property to the port number for the deployment manager SOAP port before using the properties file to run BPMConfig on remote nodes. Remote nodes read this property and use it to connect to the deployment manager.

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.

Whether to log the diagnostic tracing data.

This property is migrated for each deployment manager server.

Whether to enable the IBM service log, also known as the activity log.

This property is migrated for each deployment manager server.

If you are migrating from IBM BPM 8.0.1.2 or later, this property is automatically migrated.

For a three-cluster topology, the clusters are Application, Messaging, and Support.

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.

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.

bpm.cell.virtualHost.#.name

bpm.cell.virtualHost.#.hostAlias.#.hostName

bpm.cell.virtualHost.#.hostAlias.#.port

bpm.cell.virtualHost.1.name=virtualHostName
bpm.cell.virtualHost.1.hostAlias.1.hostName=*
bpm.cell.virtualHost.1.hostAlias.1.port=portValue

The name of the virtual host.

The host name of the host alias.

The port number of the host alias.

The name of the virtual host. This property maps all of the web modules for the IBM BPM applications to the specified virtual host when the deployment environment is created. If you do not specify a virtual host name, the web modules will remain mapped to the default host name.

The version of your source product as a 4-digit number, such as 8.5.6.0.

The product type. The possible values for this property are Express, Standard, Advanced, or AdvancedOnly.

This property indicates whether Business Process Choreographer was configured in the migration source environment.

This property indicates whether Business Space was configured in the migration source environment.

This property indicates whether Business Process Choreographer Archive was configured in the migration source environment.

The merged 100Custom.xml file for IBM Process Server or Process Center.

The properties that need to move to WebSphere Application Server configuration files are automatically migrated to the target environment. Other properties in the 100Custom.xml file are moved to the target environment directly.

The merged 100Custom.xml file for Performance Data Warehouse.

The properties that need to move to WebSphere Application Server configuration files are automatically migrated to the target environment. Other properties in the 100Custom.xml file are moved to the target environment directly.

bpm.de.security.ldapOption.*.name=twUserNameAttribute
bpm.de.security.ldapOption.*.value=sAMAccountName

Adds the Business Process Archive Manager to the Support cluster.

Registers the Business Process Archive Manager database with the Support cluster.

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

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.1.profilePath=C:/WebSphere/profiles/MyCustomProfile1

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

Whether to log the diagnostic tracing data.

This property is migrated for each node agent server.

Whether to enable the IBM service log, also known as the activity log.

This property is migrated for each node agent server.

The name of the first cluster member.

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

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

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

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.

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.

Whether to log the diagnostic tracing data.

This property is migrated for each cluster member.

Whether to enable the IBM service log, also known as the activity log.

This property is migrated for each cluster member.

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.

Example:

bpm.de.cluster.1.capabilities=Application, Messaging, Support

bpm.de.cluster.1.capabilities=Application

The capabilities for this cluster are Application, Messaging, and Support. These three capabilities correspond to the three-cluster topology supported by IBM BPM. 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 helps to ensure the best order for port assignments.

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.

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.

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.*.

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.*.

The capabilities for this cluster are Application, Messaging, and Support. These three capabilities correspond to the three-cluster topology supported by IBM BPM. 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 helps to ensure the best order for port assignments.

Messaging cluster used by this cluster.

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

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.

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.*.

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.*.

The capabilities for this cluster are Application, Messaging, and Support. These three capabilities correspond to the three-cluster topology supported by IBM BPM. 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 helps to ensure the best order for port assignments.

Messaging cluster used by this cluster.

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

Support Cluster used by this cluster.

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

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).

The file name of the file registry. Do not modify. This file is in the same folder as the BPMConfig properties file.

If you are migrating and the source environment uses a file-based user registry, the fileRegistry.xml file is copied to the output directory when you run BPMConfig -migrate and merged to the target environment when you run BPMConfig -create. Do not modify this property.

The period of time during which the server credentials from another server are valid. The value for this field must be greater than the value specified for the Cache timeout field in the administrative console under Security > Global security > Authentication cache settings.

All these properties are migrated.

The name of the first LPTA key set group.

The name of the first LPTA key set.

The key alias prefix of the first key set.

The password of the first key set.

The maximum number of active keys in the first key set.

The setting for deleting old keys in the first key set.

The key generation class for the first key set.

The isKeyPair setting in the first key set.

The key alias references in the first key set.

The key reference version in the first key set.

The key alias references in the first key set.

The key reference version in the first key set.

The name of the management scope where the first key set is defined.

The scope type where the first key set is defined; for example, cell or node.

The name of the keystore for the first key set.

The password for the keystore for the first key set.

The keystore provider for the first key set.

The location of the LTPA keystore for the first key set. The ltpa.jceks file should be located in the same folder as the BPMConfig properties file.

The keystore type for the first key set.

Whether the keystore is file-based for the first key set.

The keystore host list for the first key set.

The keystore description for the first key set.

The keystore usage for the first key set.

The name of the management scope where the keystore for the first key set is defined.

The scope type where the keystore for the first key set is defined; for example, cell or node.

The name of the second LPTA key set.

The key alias prefix of the second key set.

The password of the second key set.

The maximum number of active keys in the second key set.

The setting for deleting old keys in the second key set.

The key generation class for the second key set.

The isKeyPair setting in the second key set.

The key alias references in the second key set.

The key reference version in the second key set.

The key alias references in the second key set.

The key reference version in the second key set.

The name of the management scope where the second key set is defined.

The scope type where the second key set is defined; for example cell or node.

The name of the keystore for the second key set.

The password for the keystore for the second key set.

The keystore provider for the second key set.

The location of the LTPA keystore for the second key set.

The keystore type for the second key set.

Whether the keystore for the second key set is file-based.

The keystore host list for the second key set.

The keystore description for the second key set.

The keystore usage for the second key set.

The name of the management scope where the key store for the second key set is defined.

The scope type where the keystore for the second key set is defined; for example cell or node.

The name of the management scope for the key set group.

The scope type where the key set group is defined; for example cell or node.

The unique identifier for the server.

All these properties are migrated.

The host name for the primary LDAP server.

The port number for the LDAP server.

The binding distinguished name for the LDAP server.

The binding password.

Indicates the authentication method to use. The default value is simple.

The LDAP referral. The default value is ignore.

Controls how aliases are dereferenced. The default value is always.

Indicates whether to enable SSL or not. The default value is false.

The connection pool. The default value is false.

The connection timeout in seconds. The default value is 0.

The type of LDAP server being used. The valid values are:

• IDS (IBM Tivoli Directory Server)
• ZOSDS (z/OS ISS LDAP Server)
• DOMINO (IBM Lotus Domino)
• NDS (Novell Directory Services)
• SUNONE (SUN Java Systems Directory Server)
• AD (MS Active Directory)
• ADAM (MS Active Directory Application Mode)
• CUSTOM (Custom)

The default value is IDS (IBM Tivoli Directory Server).

The SSL configuration.

Specifies whether to map X.509 certificates into a LDAP directory by exact distinguished name or by certificate filter. The default value is exactdn.

If certificateMapMode has the value FILTERDESCRIPTORMODE, then this property specifies the LDAP filter that maps attributes in the client certificate to entries in LDAP.

The unique identifier for the repository.

All these properties are migrated.

The type of LDAP server that is being used. The default value is IDS.

The default value is com.ibm.ws.wim.adapter.ldap.LdapAdapter.

Indicates if sorting is supported. The default value is false.

Indicates if paging is supported. The default value is false.

Indicates if transactions are supported. The default value is false.

Specifies whether the external ID is unique. The default value is true.

Indicates if the adapter supports asynchronous mode. The default value is false.

Indicates if external names are supported. The default value is false.

Specifies whether to map X.509 certificates into an LDAP directory by exact distinguished name or by certificate filter. The default value is exactdn. To use the certificate filter for the mapping, specify the value certificatefilter.

If the certificateMapMode parameter has the value certificatefilter, then this property specifies the LDAP filter that maps attributes in the client certificate to entries in LDAP.

Indicates the property name used for logging in.

The SSL configuration.

Indicates whether to translate to a relative distinguished name (RDN). The default value is false.

The value of the search time limit.

The value of the search count limit.

The value of the search page size.

Indicates whether to return to the primary LDAP server when it is available. The default value is true.

Indicates the polling interval for testing the primary server availability. The value of this parameter is specified in minutes. The default value is 15.

The distinguished name of a base entry.

The distinguished name in the repository that uniquely identifies the base entry name.

The name of the realm.

If you set this parameter to true, the default values will be set for the remaining configuration properties of the LDAP repository.

Whether to enable the single sign-on function. The default is true.

All these properties are migrated.

The domain name (for example, .ibm.com) for all single sign-on hosts.

Whether the single sign-on function is enabled only when requests are made over HTTPS Secure Sockets Layer (SSL) connections. The default is false.

Whether to send an interoperable cookie to the browser to support back-level servers. The default is false.

Whether to add the HttpOnly browser attribute to cookies. This attribute prevents client-side applications (such as Java scripts) from accessing cookies to prevent some cross-site scripting vulnerabilities. The attribute specifies that LTPA and WASReqURL cookies include the HTTPOnly field. The default is true.

Whether to enable web inbound security attribute propagation. When this option is enabled, security attributes are propagated to front-end application servers. When this option is disabled, the single sign-on (SSO) token is used to log in and recreate the Subject from the user registry. The default is true.

The single sign-on (SSO) cookie name when using LTPA token version 2.

The value must be different from the value of customLTPACookieName.

This property is migrated if it is present in the source environment.

The single sign-on (SSO) cookie name when using LTPA token version 1. This property is only available when interoperability mode is enabled. The default value is LtpaToken.

The value must be different from the value of customSSOCookieName.

This property is migrated if it is present in the source environment.

The name of the J2C activation specification. This property is only applicable to IBM Process Server.

The JNDI name of the J2C activation specification. You can specify one of the following values:

• sca
• WLE_AppCluster
• ActivationSpec

The maximum batch size for a message-driven bean.

The maximum number of instances of a message-driven bean.

The name of the data source.

The scope of the data source. This property identifies the target WebSphere Application Server scope to which the data source is mapped. You do not need to modify the property. The BPMConfig command will use the property to locate the correct data source for the specified scope in either of the following two scenarios:

• The deployment environment is being updated using the -update -performanceTuning command option.
• The deployment environment is being cloned, as described in the topic Cloning the deployment environment.

The JNDI name of the data source. You can specify one of the following values:

• jdbc/mashupDS
• jdbc/TeamWorksDB
• jdbc/PerformanceDB
• jdbc/WPSDB
• jdbc/CommonDB
• jdbc/BPEDB

If you are migrating, data sources with these JNDI names are automatically migrated for the Application cluster.

The description of the data source.

This property is not migrated.

The minimum number of physical connections to maintain. Until this number is exceeded, the pool maintenance thread does not discard physical connections.

These properties are migrated if they exist in your migration source.

The maximum number of physical connections to the datastore that can be created in the connection pool. When this number is reached, no new physical connections are created; requestors must wait until a physical connection that is in use is returned to the pool.

The number of statements that can be cached per connection.

The customized JVM arguments.

This property is not automatically migrated. After migration, you need to check whether the property needs to be modified.

The initial heap size available to the JVM code, in megabytes.

For multiple source nodes, if the value is the same across all nodes, it is migrated to the target. If the values are different, the maximum value is used for all nodes in the target environment.

The maximum heap size available to the JVM code, in megabytes.

For multiple source nodes, the maximum value is applied to the target environment. For example, if there are two source nodes in the source environment, the heap size values are retrieved from both the source node agents and the larger of the heap size values (if they are different) is applied to all target node agents.

Disables address caching for web services.

If your system typically runs with many client threads, and you encounter lock contention on the web services address cache, you can set this custom property to true to prevent caching of the web services data. The default value is false.

If you specify networkaddress.cache.ttl with a value of zero or any other positive integer, this property must be set to true to avoid caching of an IP address in the web services engine. networkaddress.cache.ttl is used to indicate the number of seconds to cache a successful lookup.

This is a JVM custom property. It is not required.

For multiple source nodes, if the value is the same across all nodes, it is migrated to the target. If the values are different, this property is not migrated.

Whether to use verbose debug output for garbage collection. The default is not to enable verbose garbage collection.

For multiple source nodes, if the value is the same across all nodes, it is migrated to the target. If the values are different, the default value (disabled) is used for all nodes in the target environment.

The number of seconds to wait before timing out on a request message.

These properties are not migrated.

The number of times that the ORB attempts to send a request if a server fails.

The number of milliseconds between request retries.

The maximum number of entries that can occupy the ORB connection cache before the ORB starts to remove inactive connections from the cache.

The minimum number of entries in the ORB connection cache.

The number of seconds to wait before timing out on a Locate Request message.

How the ORB passes parameters. If this option is enabled, the ORB passes parameters by reference instead of by value, to avoid making an object copy. If you do not enable this option, a copy of the parameter is passed rather than the parameter object itself. This choice can be expensive because the ORB must first make a copy of each parameter object.

The name of the thread pool. The value is either Default or WebContainer.

The value is automatically migrated. The value is either Default or WebContainer.

The minimum number of physical connections to maintain in this thread pool.

For multiple source nodes, if the value is not the same across all nodes, it is not migrated to the target. The default target value is used.

The maximum number of physical connections that can be created in this pool.

For multiple source nodes, the maximum value is applied to the target environment.

The name of the topic connection factory.

The minimum number of connections to maintain.

The maximum number of connections to be created.

The default maximum time, in seconds, allowed for a transaction that is started on this server before the transaction service initiates timeout completion. Any transaction that does not begin completion processing before this timeout occurs is rolled back.

If you set this value to 0, the timeout does not apply and the value of the maximum transaction timeout is used instead.

This property is migrated in the deployment manager and cluster member scope.

The maximum duration, in seconds, between transactional requests from a remote client. Any period of client inactivity that exceeds this timeout results in the transaction being rolled back in this application server.

If you set this value to 0, there is no timeout limit.

This property is migrated in the deployment manager and cluster member scope.

Whether to configure servlet caching to save the output of servlets and JavaServer Pages (JSP) files to the dynamic cache.

This property is not migrated.

Whether the number of sessions in memory can exceed the value specified by the maxInMemorySessionCount property. This option is valid only in non-distributed sessions mode.

This property is not migrated.

Whether session tracking uses cookies to carry session IDs. If cookies are enabled, session tracking recognizes session IDs that arrive as cookies and tries to use cookies for sending session IDs. If cookies are not enabled and URL rewriting is enabled, session tracking uses URL rewriting instead of cookies.

The default value is true.

This property is migrated for each cluster member.

Whether session tracking uses secure cookies that can only be sent back over an encrypted HTTP connection (HTTPS). When this feature is enabled, session cookies over an HTTP connection no longer work.

The default value is false.

This property is migrated for each cluster member.

This property is not migrated.

Used to enable communication with remote servers. This property is used by other channels, such as the Web container channel, to serve HTTP requests and to send HTTP specific information to servlets expecting this type of information. HTTP inbound channels are used instead of HTTP transports to establish the request queue between a WebSphere® Application Server plug-in for Web servers and a Web container in which the Web modules of an application reside.

This property is not migrated.

The number of requests that can flow over a connection before it is closed. This value should be set to a value such that most, if not all, clients always have an open connection when they make multiple requests during the same session.

The default value is 100.

This property is not migrated.

The length of time that a connection is held open before being closed because there is no activity on that connection.

The default value is 30 seconds.

This property is not migrated.

The name of the work manager. The value is either DefaultWorkManager or BPENavigationWorkManager.

The JNDI name of the default work manager.

The number of alarm threads for the default work manager.

The size of the buffer that the thread pool of the work manager uses to pull requests from.

• BPENavigationWorkManager
• DefaultWorkManager

The number of threads to be kept in the thread pool, created as needed.

The maximum number of threads to be created in the thread pool.