Configuration properties for the BPMConfig command
The BPMConfig command uses a properties file to configure your environment according to the settings that you specify. 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. This topic provides descriptions for the properties in the sample properties files. It also provides descriptions for many properties that are not contained in the sample properties files but that can be manually added to the files.
To select a sample properties file, see Sample configuration.properties files.
Topology
Set the values for your databases first, including the database administrator authentication alias properties and database properties.
The database administrator authentication alias properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
Example:
|
For each database that you are using for
this deployment environment, specify the authentication alias that
you want to use. The number of aliases is dependent on the database
type that 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 that you specify for the bpm.de.db.#.rolemapping.#.alias property
for the databases. For example:
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 Business Automation Workflow security roles. In
some cases, the sample file uses the same authentication alias BPM_DB_ALIAS for
all database instances. 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 user name password. Then use the correct alias name for the
corresponding database role mapping entry.
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\\BPM_ |
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. |
The database configuration 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 include the set of databases that are required by default. The database configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations | ||
---|---|---|---|---|
bpm.de.db.#.name Example:
|
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.*. |
|||
bpm.de.db.#.dbCapabilities Example:
|
The list of components that are configured on this database. The list of components depends on the product configuration:
Note:
For the EmbeddedECM component, there is no support if the operating
system for the IBM Business Automation Workflow environment is z/OS.
If you want to put some components in a different database, for example, to put the Messaging component into its own database, you need to adjust your values accordingly. There are currently five case management components:
The TargetObjectStore, CaseAnalyzer, and CaseHistory components can share the same database and schema. However, the ContentNavigator and DesignObjectStore components should set different schema or use a different database. The five case management components do not support Db2® for z/OS®. |
The IBM® Business Automation
Workflow data source
configuration is migrated automatically and the previous databases
are reused by the new deployment environment. You do not need to enter
the database information for each component manually in the BPMConfig
properties file.
Review this list to match the databases correctly. |
||
bpm.de.db.#.databaseName Example:
|
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. |
||
bpm.de.db.#.type Example:
|
The database type.
The options are 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 Example:
|
|
If you are migrating, these properties are automatically migrated. |
||
bpm.de.db.#.roleMapping.1.name bpm.de.db.#.roleMapping.1.alias Example:
|
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 Example:
|
The database role and authentication alias association. The value for bpm.de.db.#.roleMapping.2.name must always be DbUserXAR. |
|||
bpm.de.db.#.schema Example:
|
The database schema. 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. Restriction: The following restrictions exist for schema names:
Restriction: The following restrictions exist
for the sharing of database schemas by DB capabilities:
|
If you are migrating, this property is automatically migrated. |
||
bpm.de.db.#.url Example:
|
This property can only be set for Oracle databases and it defaults to the following Oracle Single Client Access Name (SCAN) URL:
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):
|
|||
|
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.#.usetablespaces
bpm.de.db.#.tspre bpm.de.db.#.tsbpctemp8k bpm.de.db.#.tsbpc8k bpm.de.db.#.tsbpcauditlog bpm.de.db.#.tsbpcindexts bpm.de.db.#.tsbpcinstance bpm.de.db.#.tsbpclob bpm.de.db.#.tsbpcsched bpm.de.db.#.tsbpcstaffqry bpm.de.db.#.tsbpctemplate bpm.de.db.#.tsbpcworkitem Example:
|
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. |
|||
bpm.de.db.#.tsicn Example:
|
This property supports the use of table spaces for IBM Content Navigator. If the property is not set, the default value is WFICNTS. The property supports Db2 and Oracle but does not support Db2 for z/OS. |
This property is automatically migrated. |
||
bpm.de.db.#.tsdosdata
bpm.de.db.#.tsdoslob bpm.de.db.#.tsdosidx Examples
|
These properties support the use of table spaces for the design object store. The default values are shown in the examples in the left column. The properties support the following database products:
The properties do not support Db2 for z/OS. |
These properties are automatically migrated. |
||
bpm.de.db.#.tstosdata
bpm.de.db.#.tstoslob bpm.de.db.#.tstosidx Examples
|
These properties support the use of table spaces for the target object store. The default values are shown in the examples in the left column.
The properties do not support Db2 for z/OS. |
These properties are automatically migrated. |
||
bpm.de.db.#.databaseDataDirectoryPath Example
|
A directory on the database server that should be the same value for the ContentNavigator, DesignObjectStore, and TargetObjectStore database settings. This parameter is used when generating the database creation scripts to supply the root directory where various database artifacts will be generated. It is a required parameter only for the ContentNavigator, DesignObjectStore, and TargetObjectStore database settings. This directory must exist on the database server before the database creation scripts run. |
The cell configuration properties define the cell administrator authentication alias and role mappings. The cell configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.cell.name Example:
|
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 Example:
|
The following properties are used to define the cell administration 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\\BPM_ |
If you are migrating to a version earlier
than Business Automation Workflow V19.0.0.3 cumulative
fix 2017.03, at the cell scope, the following authentication aliases
are migrated:
In 2017.03 and later, the SCA_Auth_Alias in the target environment uses the DeAdmin user name by default. At the deployment environment
scope, the following authentication aliases are migrated:
For these deployment environment-scoped aliases, the
following properties are migrated automatically:
For database-related aliases, the properties are:
For non-database-related aliases, the properties are:
|
bpm.cell.roleMapping.1.name bpm.cell.roleMapping.1.alias Example:
|
The value for bpm.cell.roleMapping.1.name cannot
be changed from For more information about roles and role mappings see Business Automation Workflow security roles. |
|
bpm.cell.db Example:
|
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 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. |
After setting the database properties, set the values for your deployment environment, including the following properties:
- Deployment environment basic configuration properties
- Process Server environment configuration properties
- Administrator authentication alias properties for the deployment environment
- Deployment manager properties
- Context root properties
The deployment environment basic configuration properties 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). They also contain a setting that determines whether or not database tables should be created during the creation of the deployment environment. The deployment environment basic configuration properties are shown in the following table.
Configuration property | Description | Migration considerations |
---|---|---|
bpm.de.name Example:
|
The name of the deployment environment defined by this properties file. Each deployment environment requires
its own properties file. For example, if |
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. |
bpm.de.deferSchemaCreation Example:
|
Specifies which one of the following actions occurs during the creation of the deployment environment:
This property is only used with the BPMConfig -create -de and BPMConfig -upgrade -de commands. If |
Ensure that the value |
bpm.de.type Example:
|
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.
|
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. |
bpm.de.useExternalCPE Example:
|
Specifies whether to use an external Content Platform Engine. The default is false. Property file templates for using an external Content Platform Engine are in install_root/BPM/samples/config/externalcpe. |
Ensure that the value |
bpm.de.useExternalNavigator Example:
|
Specifies whether to use an external IBM Content Navigator. The default is false. Property file templates for using an external IBM Content Navigator are in install_root/BPM/samples/config/externalicn. |
Ensure that the value |
bpm.de.environment Example:
|
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 ( |
The environment type will be automatically migrated. |
The Process Server environment configuration properties are only used when the bpm.de.environment property is set to Process Server. The Process Server environment configuration properties are shown in the following table.
Configuration property | Description | Migration considerations |
---|---|---|
bpm.de.psServerName Example:
|
A unique name for the process server that differentiates it from all other process servers that connect to the same Process Center. |
|
bpm.de.psPurpose Example:
|
The purpose of the Process Server environment. The valid values are:
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 Business Automation Workflow works with environment variables and server configurations that are specified in Process Designer, such as the IBM Operational Decision Manager 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. |
|
bpm.de.psOffline Example:
|
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:
When the bpm.de.psOffline property value
is set to false, you also need to specify the
user name and password for
ProcessCenterUserAlias ,
as described in the table Authentication
alias configuration properties for the deployment environment administrator
(bpm.de.authenticationAlias.#.* ). For example:
|
|
bpm.de.psProcessCenterTransportProtocol Example:
|
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. |
|
bpm.de.psProcessCenterHostname Example:
|
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. |
|
bpm.de.psProcessCenterPort Example:
|
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). |
|
bpm.de.psProcessCenterContextRootPrefix Example:
|
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. |
The authentication alias configuration properties for the deployment environment administrator are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.authenticationAlias.#.name bpm.de.authenticationAlias.#.user bpm.de.authenticationAlias.#.password Example:
|
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\\BPM_ |
You need to specify the user name and password for the deployment environment user. For WebSphere Lombardi Edition, Business Automation Workflow Standard, or Business Automation Workflow Advanced, the user should be a member of the tw_admins group in the source version. |
The deployment environment administrator role and authentication alias association properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.roleMapping.#.name bpm.de.roleMapping.#.alias Example:
|
The value for bpm.de.roleMapping.#.name cannot
be changed from 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 Business Automation Workflow security roles. |
The deployment manager properties include the deployment manager profile name, installation location for the product, deployment manager host name, and SOAP port. The deployment manager properties are shown in the following table. You must update the value for bpm.dmgr.hostname and bpm.dmgr.installPath. Update other properties as required.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.dmgr.nodeName Example:
|
Name of the deployment manager node. |
|
bpm.dmgr.hostname Example:
|
Deployment manager hostname.
Important: Do not use localhost for environments that
are spread across multiple computers.
To use an external Content Platform Engine, the hostname property value must have a domain name suffix, for example MyDmgrHost.my_domain.com. |
|
bpm.dmgr.installPath Example:
|
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\\BPM_ |
|
bpm.dmgr.profileName Example:
|
Deployment manager profile name. |
|
bpm.dmgr.profilePath Example:
|
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:
The value for this parameter must be a valid path for the target system and must not be currently in use. You must have permission to write to the directory. |
|
bpm.dmgr.profileOptions Example:
|
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:
|
|
bpm.dmgr.initialPortAssignment Example:
OR
|
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 |
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. |
bpm.dmgr.soapPort Example:
|
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. |
bpm.dmgr.jdbcDriverPath Example:
|
The following WebSphere environment variables
are set based on the specified value.
|
This property is set to its default value for the deployment manager node. For DB2, the default value is "${WAS_INSTALL_ROOT}/jdbcdrivers/DB2". For Oracle and SQL Server, there is no default value and a value must be specified, because this property cannot be empty. |
bpm.dmgr.diagnosticTraceEnable Example:
|
Whether to log the diagnostic tracing data. |
This property is migrated for the deployment manager server. |
bpm.dmgr.ibmServiceLogEnable Example:
|
Whether to enable the IBM service log, also known as the activity log. |
This property is migrated for the deployment manager server. |
You can customize your context root by adding a prefix to the current value of your context root. The context root prefix property for all deployment environment components is shown in the following table.
Configuration property | Description | Migration considerations |
---|---|---|
bpm.de.contextRootPrefix Example:
|
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 Note: IBM Business Automation
Workflow applications
are handled differently than case applications. For example, if the bpm.de.contextRootPrefix parameter
was set to /abc, the Process Center application
context root would be changed from /ProcessCenter to /abc/ProcessCenter.
However, the Case Builder application would be changed from /CaseBuilder to /abcCaseBuilder without
the forward slash character (/) between abc and CaseBuilder.
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 Workflow Center must
at least be at the V8.5.0.1 level.
|
If you are migrating from IBM BPM 8.0.1.2 or later, this property is automatically migrated. |
The context root prefix property for the Process Portal component is shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.cluster.#.capability.#.name Example:
|
For a three-cluster topology, the clusters are Application, Messaging, and Support. |
|
bpm.de.cluster.#.capability.#.component.#.name Example:
|
This property is used to set up the Process
Portal context root prefix. The only value is |
|
bpm.de.cluster.#.capability.#.component.#.contextRootPrefix Examples
|
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 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. |
The virtual host configuration properties add a new virtual host and configuration when the deployment environment is created. The mapping property maps the web modules of Business Automation Workflow applications to the specified virtual host when the deployment environment is created.
The virtual host configuration properties and mapping configuration property are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.cell.virtualHost.#.name bpm.cell.virtualHost.#.hostAlias.#.hostName bpm.cell.virtualHost.#.hostAlias.#.port Example:
|
The name of the virtual host. The host name of the host alias. The port number of the host alias. |
|
bpm.de.virtualHost Example:
|
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 source information configuration properties are automatically obtained from your source environment. These properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.sourceInfo.versionInfo Example:
|
The version of your source product as a
4-digit number, such as |
The property that is migrated is the version
of your source environment from which you migrate the configuration.
It will be a 4-digit number, such as 7.5.0.0 or 8.0.1.0 . |
bpm.de.sourceInfo.productType Example:
|
The product type. The possible values for
this property are |
The property that is migrated is the product
type for the migration source environment, such as Express , Standard , Advanced , WPS62x , WPS7x ,
or WLE7x . |
bpm.de.sourceInfo.bpcConfigured Example:
|
This property indicates whether Business Process Choreographer was configured in the migration source environment. |
|
bpm.de.sourceInfo.bspaceConfigured Example:
|
This property indicates whether Business Space was configured in the migration source environment. |
|
bpm.de.sourceInfo.bpcArchiveConfigured Example:
|
This property indicates whether Business Process Choreographer Archive was configured in the migration source environment. |
Most of the WebSphere Lombardi Edition XML configuration properties in the 100Custom.xml file are merged into the 100SourceCustomMerged.xml file and directly copied to the target environment. These WebSphere Lombardi Edition XML configuration properties are shown in the following table.
Configuration property | Description | Migration considerations |
---|---|---|
bpm.de.sourceInfo.psCustomFile Example:
|
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. |
PDW_100SourceCustomMerged.xml Example:
|
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. |
The other WebSphere Lombardi Edition XML properties are automatically migrated to WebSphere Application Server configuration files. These properties are used for migration purposes only. If needed, you can also change the value of these properties during the migration procedure. Additional information is found in the topic Security configuration properties. When you check for migration readiness with the BPMMigrationPreValidation command in your source environment, you see warning messages and detailed information in the migration prevalidation report.
These properties are shown in the following table.
XML File | Source in WebSphere Lombardi Edition XML | Property Name in Configuration Model |
---|---|---|
99Local.xml | server/webservices/guest-user-auth-alias | bpm.de.roleMapping.4.name Example:
|
server/bpd-engine/system-lane-users/user/login-auth-alias | bpm.de.roleMapping.5.name Example:
|
|
server/bpd-engine/user-to-close-task | bpm.de.security.userToCloseTask Example:
|
|
server/bpd-engine/user-to-create-task | bpm.de.security.userToCreate Example:
|
|
authoring-environment/process-help-access-role | bpm.de.security.processHelpAccessGroup Example:
|
|
server/debug/debug-role | bpm.de.security.debugGroup Example:
|
|
server/show-xml-meta-data/show-xml-meta-data-role | bpm.de.security.showXmlMetadataGroup Example:
|
|
server/web-images/prefix | bpm.de.processServer.webImagePrefix Example:
|
|
authoring-environment/images-prefix | bpm.de.processServer.imagePrefix Example:
|
|
authoring-environment/portal-prefix | bpm.de.processServer.authoringEnvironmentPortalPrefix Example:
|
|
authoring-environment/repository-prefix | bpm.de.processServer.repositoryPrefix Example:
|
|
authoring-environment/servlet-prefix | bpm.de.processServer.servletPrefix Example:
|
|
authoring-environment/webapi-prefix | bpm.de.processServer.webApiPrefix Example:
|
|
common/process-admin-prefix | bpm.de.processServer.processAdminPrefix Example:
|
|
common/teamworks-webapp-prefix | bpm.de.processServer.teamworksWebAppPrefix Example:
|
|
common/portal-prefix | bpm.de.processServer.commonPortalPrefix Example:
|
|
common/webservices/base-url | bpm.de.processServer.baseUrl Example:
|
|
common/xml-serialization/default-namespace-uri | bpm.de.processServer.defaultNamespaceUri Example:
|
|
common/coach-designer-xsl-url | bpm.de.processServer.coachDesignerXslUri Example:
|
|
server/email/mail-template/client-link | bpm.de.processServer.clientLink Example:
|
|
authoring-environment/process-help-wiki-url-view | bpm.de.security.processHelpAccessGroup Example:
|
|
authoring-environment/process-help-wiki-url-edit | bpm.de.security.processHelpAccessGroup Example:
|
|
server/repository-server-interval | bpm.de.processServer.heartBeatInterval Example:
|
|
server/portal/default-action-policy | bpm.de.processServer.policyAction.* | |
00Static.xml | common/user-list-limit-from-external-security-provider | bpm.de.security.externalUserQueryLimit Example:
|
common/collaboration/collaboration-admin | bpm.de.security.collaborationAdminGroup
tw_admins Example:
|
|
common/bpm-admins-security-group | bpm.de.security.bpmAdminGroup Example:
|
|
common/bpm-authors-security-group | bpm.de.security.bpmAuthorGroup Example:
|
|
50AppServer.xml | common/security/security-name-transformer | bpm.de.security.securityNameTransformer |
common/security/ldap-options/ldap-option | bpm.de.security.ldapOption.*.name=twUserNameAttribute
bpm.de.security.ldapOption.*.value=sAMAccountName |
|
common/jms-auth/jms-user-auth-alias | bpm.de.roleMapping.6.name Example:
|
|
100Custom.xml | server/process-center-install-group | bpm.de.security.processCenterInstallGroup Example:
|
server/offline-install-group | bpm.de.security.offlineInstallGroup Example:
|
|
80EventManager.xml | event-manager/notify-error | bpm.de.security.userToNotifyError Example:
|
event-manager/login-name-auth-alias | bpm.de.roleMapping.7.name Example:
|
|
console.xml | folder/item[@name='***'] | bpm.de.consoleSection.* Example:
|
The configuration properties related to Business Process Archive Manager are shown in the following table.
Configuration property | Description | Migration considerations |
---|---|---|
bpm.de.cluster.#.capability.#.component.#.name Example:
|
Adds the Business Process Archive Manager to the Support cluster. |
These properties are automatically migrated to the target environment. They are required when a BPM configuration is being migrated that has the Business Process Archive Manager configured. Information about the Business Process Archive Manager is found in the topic "Configuring Business Process Archive Manager." |
bpm.de.cluster.#.db Example:
|
Registers the Business Process Archive Manager database with the Support cluster. |
The managed-node configuration properties are properties related to the managed nodes in a deployment environment, including the name, the installation 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. The managed-node configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.node.#.name Example:
|
Managed node name. These values must be unique within the cell. |
The default value is used, but you can update it as needed. |
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
|
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\\BPM_ Important: Do not use localhost for
host names in environments that are spread across multiple computers.
|
You must update the install path and host name. For the other properties, the default values are used, but you can update them as needed. |
bpm.de.node.#.jdbcDriverPath Example:
|
The following WebSphere environment variables
are set based on the specified value.
|
This property is set to its default value for each managed node. For DB2, the default value is "${WAS_INSTALL_ROOT}/jdbcdrivers/DB2". For Oracle and SQL Server, there is no default value and a value must be specified, because this property cannot be empty. |
bpm.de.node.#.diagnosticTraceEnable Example:
|
Whether to log the diagnostic tracing data. |
This property is migrated for each node agent server. |
bpm.de.node.#.ibmServiceLogEnable Example:
|
Whether to enable the IBM service log, also known as the activity log. |
This property is migrated for each node agent server. |
The cluster member configuration properties include the cluster capabilities (such as application, support, or messaging capabilities) and the databases used by the cluster. The cluster member configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.node.#.clusterMember.1.name Example:
|
The name of the first cluster member. |
The default value is used, but you can update it as needed. |
bpm.de.node.#.clusterMember.#.weight bpm.de.node.#.clusterMember.#.initialPortAssignment bpm.de.node.#.clusterMember.#.cluster Example:
|
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. |
|
bpm.de.node.#.clusterMember.#.diagnosticTraceEnable Example:
|
Whether to log the diagnostic tracing data. |
This property is migrated for each cluster member. |
bpm.de.node.#.clusterMember.#.ibmServiceLogEnable Example:
|
Whether to enable the IBM service log, also known as the activity log. |
This property is migrated for each cluster member. |
The cluster configuration properties 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 must duplicate this set of properties and specify the values for that new cluster. The cluster configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.cluster.#.name Example:
|
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 |
For migrating to an Advanced or AdvancedOnly deployment environment, you must keep the same application cluster name. |
bpm.de.cluster.#.capabilities Example: Single
cluster example:
Three-cluster
example, specifying the first cluster as the application cluster:
|
The possible capabilities for an Business Automation Workflow cluster
are Application, Messaging, and Support. You must specify the capabilities
according to the following supported topology choices:
|
The default value is used, but you can update it as needed. |
bpm.de.cluster.#.usesMessagingCluster Example:
|
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:
|
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:
|
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 The
values are based on the keys specified elsewhere in the properties
file. For example, if |
|
bpm.de.cluster.#.name Example:
|
The name of the second cluster. The properties
associated with this cluster (in the example, |
|
bpm.de.cluster.#.capabilities Example:
|
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. |
|
bpm.de.cluster.#.usesMessagingCluster Example:
|
Messaging cluster used by this cluster. In
this example, |
|
bpm.de.cluster.#.usesSupportCluster Example
|
Support cluster used by this cluster. In
this example, |
|
bpm.de.cluster.#.db Example:
|
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.cluster.#.name Example:
|
The name of the third cluster. The properties
associated with this cluster (in the example, |
|
bpm.de.cluster.#.capabilities Example:
|
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. |
|
bpm.de.cluster.#.usesMessagingCluster Example:
|
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:
|
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:
|
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 The
support cluster uses the database with performance data warehouse
capabilities (that is, the cluster with |
Security
This section contains the security properties.
The source file registry path property is shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.security.sourcefileRegistryPath Example:
|
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 Lightweight Third-Party Authentication (LTPA) configuration properties are used to merge the key set group to the target. The values are taken automatically from your source environment. If you are migrating or copying the source environment and it uses LTPA, all LTPA key sets, including active and historical, are automatically migrated to the target. Do not modify these properties.
For
the bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.location=ltpa.jceks,
the ltpa.jceks file should be located in the
same folder as the BPMConfig properties file. The
LTPA.jceks file is copied to the output directory when you run BPMConfig
-migrate
and merged to the target environment when you run BPMConfig
-create
.
The Lightweight Third-Party Authentication (LTPA) configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.security.ltpaTimeout Example:
|
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 . |
All these properties are migrated. |
bpm.de.security.ltpaKeySetGroup.name Example:
|
The name of the first LPTA key set group. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.name Example:
|
The name of the first LPTA key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.aliasPrefix Example:
|
The key alias prefix of the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.password Example:
|
The password of the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.maxKeyReferences Example:
|
The maximum number of active keys in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.deleteOldKeys Example:
|
The setting for deleting old keys in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyGenerationClass Example:
|
The key generation class for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.isKeyPair Example:
|
The isKeyPair setting in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyReferences.1.alias Example:
|
The key alias references in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyReferences.1.version Example:
|
The key reference version in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyReferences.2.alias Example:
|
The key alias references in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyReferences.2.version Example:
|
The key reference version in the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.managementScope.scopeName Example:
|
The name of the management scope where the first key set is defined. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.managementScope.scopeType Example:
|
The scope type where the first key set is
defined; for example, |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.name Example:
|
The name of the keystore for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.password Example:
|
The password for the keystore for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.provider Example:
|
The keystore provider for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.location Example:
|
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. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.type Example:
|
The keystore type for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.fileBased Example:
|
Whether the keystore is file-based for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.hostList | The keystore host list for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.description Example:
|
The keystore description for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.usage Example:
|
The keystore usage for the first key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.managementScope.scopeName Example:
|
The name of the management scope where the keystore for the first key set is defined. |
|
bpm.de.security.ltpaKeySetGroup.keySet.1.keyStore.managementScope.scopeType Example:
|
The scope type where the keystore for the
first key set is defined; for example, |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.name Example:
|
The name of the second LPTA key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.aliasPrefix Example:
|
The key alias prefix of the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.password Example:
|
The password of the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.maxKeyReferences Example:
|
The maximum number of active keys in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.deleteOldKeys Example:
|
The setting for deleting old keys in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyGenerationClass Example:
|
The key generation class for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.isKeyPair Example:
|
The isKeyPair setting in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyReferences.1.alias Example:
|
The key alias references in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyReferences.1.version Example:
|
The key reference version in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyReferences.2.alias Example:
|
The key alias references in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyReferences.2.version Example:
|
The key reference version in the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.managementScope.scopeName Example:
|
The name of the management scope where the second key set is defined. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.managementScope.scopeType Example:
|
The scope type where the second key set
is defined; for example |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.name Example:
|
The name of the keystore for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.password Example:
|
The password for the keystore for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.provider Example:
|
The keystore provider for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.location Example:
|
The location of the LTPA keystore for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.type Example:
|
The keystore type for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.fileBased Example:
|
Whether the keystore for the second key set is file-based. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.hostList | The keystore host list for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.description Example:
|
The keystore description for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.usage Example:
|
The keystore usage for the second key set. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.managementScope.scopeName Example:
|
The name of the management scope where the key store for the second key set is defined. |
|
bpm.de.security.ltpaKeySetGroup.keySet.2.keyStore.managementScope.scopeType Example:
|
The scope type where the keystore for the
second key set is defined; for example |
|
bpm.de.security.ltpaKeySetGroup.managementScope.scopeName Example:
|
The name of the management scope for the key set group. |
|
bpm.de.security.ltpaKeySetGroup.managementScope.scopeType Example:
|
The scope type where the key set group is
defined; for example |
The Lightweight Directory Access Protocol (LDAP) server configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.cell.ldapRepository.ldapServer.id Example:
|
The unique identifier for the server. |
All these properties are migrated. |
bpm.cell.ldapRepository.ldapServer.host Example:
|
The host name for the primary LDAP server. |
|
bpm.cell.ldapRepository.ldapServer.port Example:
|
The port number for the LDAP server. |
|
bpm.cell.ldapRepository.ldapServer.bindDN Example:
|
The binding distinguished name for the LDAP server. |
|
bpm.cell.ldapRepository.ldapServer.bindPassword Example:
|
The binding password. |
|
bpm.cell.ldapRepository.ldapServer.authentication Example:
|
Indicates the authentication method to use. The default value is simple. |
|
bpm.cell.ldapRepository.ldapServer.referal Example:
|
The LDAP referral. The default value is ignore. |
|
bpm.cell.ldapRepository.ldapServer.derefAliases Example:
|
Controls how aliases are dereferenced. The default value is always. |
|
bpm.cell.ldapRepository.ldapServer.sslEnabled Example:
|
Indicates whether to enable SSL or not. The default value is false. |
|
bpm.cell.ldapRepository.ldapServer.connectionPool Example:
|
The connection pool. The default value is false. |
|
bpm.cell.ldapRepository.ldapServer.connectTimeout Example:
|
The connection timeout in seconds. The default value is 0. |
|
bpm.cell.ldapRepository.ldapServer.ldapServerType Example:
|
The type of LDAP server being used. The valid values are:
The default value is IDS (IBM Security Directory Suite). |
|
bpm.cell.ldapRepository.ldapServer.sslConfiguration | The SSL configuration. |
|
bpm.cell.ldapRepository.ldapServer.certificateMapMode Example:
|
Specifies whether to map X.509 certificates into a LDAP directory by exact distinguished name or by certificate filter. The default value is exactdn. |
|
bpm.cell.ldapRepository.ldapServer.certificateFilter | If certificateMapMode has the value FILTERDESCRIPTORMODE, then this property specifies the LDAP filter that maps attributes in the client certificate to entries in LDAP. |
If you are migrating or copying a source environment that
uses Lightweight Directory Access Protocol (LDAP), the configuration
is automatically moved to the target environment. If you are using
federated LDAP, the configuration is moved to the target when you
run BPMConfig -create
and is unchanged from the source.
The Lightweight Directory Access Protocol (LDAP) repository configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.cell.ldapRepository.id Example:
|
The unique identifier for the repository. |
All these properties are migrated. |
bpm.cell.ldapRepository.ldapServerType Example:
|
The type of LDAP server that is being used. The default value is IDS. |
|
bpm.cell.ldapRepository.adapterClassName Example:
|
The default value is com.ibm.ws.wim.adapter.ldap.LdapAdapter. |
|
bpm.cell.ldapRepository.supportSorting Example:
|
Indicates if sorting is supported. The default value is false. |
|
bpm.cell.ldapRepository.supportPaging Example:
|
Indicates if paging is supported. The default value is false. |
|
bpm.cell.ldapRepository.supportTransactions Example:
|
Indicates if transactions are supported. The default value is false. |
|
bpm.cell.ldapRepository.isExtIdUnique Example:
|
Specifies whether the external ID is unique. The default value is true. |
|
bpm.cell.ldapRepository.supportAsyncMode Example:
|
Indicates if the adapter supports asynchronous mode. The default value is false. |
|
bpm.cell.ldapRepository.supportExternalName Example:
|
Indicates if external names are supported. The default value is false. |
|
bpm.cell.ldapRepository.certificateMapMode Example:
|
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. |
|
bpm.cell.ldapRepository.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. |
|
bpm.cell.ldapRepository.loginProperties Example:
|
Indicates the property name used for logging in. |
|
bpm.cell.ldapRepository.sslConfiguration | The SSL configuration. |
|
bpm.cell.ldapRepository.translateRDN Example:
|
Indicates whether to translate to a relative distinguished name (RDN). The default value is false. |
|
bpm.cell.ldapRepository.searchTimeLimit Example:
|
The value of the search time limit. |
|
bpm.cell.ldapRepository.searchCountLimit Example:
|
The value of the search count limit. |
|
bpm.cell.ldapRepository.searchPageSize Example:
|
The value of the search page size. |
|
bpm.cell.ldapRepository.returnToPrimaryServer Example:
|
Indicates whether to return to the primary LDAP server when it is available. The default value is true. |
|
bpm.cell.ldapRepository.primaryServerQueryTimeInterval Example:
|
Indicates the polling interval for testing the primary server availability. The value of this parameter is specified in minutes. The default value is 15. |
|
bpm.cell.ldapRepository.baseEntryName Example:
|
The distinguished name of a base entry. |
|
bpm.cell.ldapRepository.baseEntryNameInRepository Example:
|
The distinguished name in the repository that uniquely identifies the base entry name. |
|
bpm.cell.ldapRepository.realmName Example:
|
The name of the realm. |
|
bpm.cell.ldapRepository.useDefault Example:
|
If you set this parameter to true, the default values will be set for the remaining configuration properties of the LDAP repository. |
The single sign-on (SSO) configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.cell.singlesignon.enabled Example:
|
Whether to enable the single sign-on function. The default is true. |
All these properties are migrated. |
bpm.cell.singlesignon.domainName Example:
|
The domain name (for example, .ibm.com) for all single sign-on hosts. |
|
bpm.cell.singlesignon.requiresSSL Example:
|
Whether the single sign-on function is enabled only when requests are made over HTTPS Secure Sockets Layer (SSL) connections. The default is false. |
|
bpm.cell.singlesignon.ssoInteropModeEnabled Example:
|
Whether to send an interoperable cookie to the browser to support back-level servers. The default is false. |
|
bpm.cell.singlesignon.addHttpOnlyAttributeToCookies Example:
|
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. |
|
bpm.cell.singlesignon.webInboundPropagationEnabled Example:
|
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. |
|
bpm.cell.singlesignon.customSSOCookieName Example:
|
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. |
bpm.cell.singlesignon.customLTPACookieName Example:
|
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 The value must be different from the value of customSSOCookieName. |
This property is migrated if it is present in the source environment. |
Performance tuning
This section contains the performance tuning properties. These values are automatically obtained from your source environment.
The J2C activation specification performance tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.cluster.#.activationSpec.#.name Example:
|
The name of the J2C activation specification. This property is only applicable to IBM Process Server. |
These properties are migrated
only in the application cluster and support cluster scope. Properties
for the following JNDI names might be migrated, depending on the source
environment:
|
bpm.de.cluster.#.activationSpec.#.jndiName Example:
|
The JNDI name of the J2C activation specification. You can specify one of the following values:
|
|
bpm.de.cluster.#.activationSpec.#.maxBatchSize Example:
|
The maximum batch size for a message-driven bean. |
|
bpm.de.cluster.#.activationSpec.#.maxConcurrency Example:
|
The maximum number of instances of a message-driven bean. |
The data source performance tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.db.#.dataSource.#.name Example:
|
The name of the data source. |
|
bpm.de.db.#.dataSource.#.scope Example:
Example:
|
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:
|
|
bpm.de.db.#.dataSource.#.jndiName Example:
|
The JNDI name of the data source. You can specify one of the following values:
|
If you are migrating, data sources with these JNDI names are automatically migrated for the Application cluster. |
bpm.de.db.#.dataSource.#.description Example:
|
The description of the data source. |
This property is not migrated. |
bpm.de.db.#.dataSource.#.minConnections Example:
|
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. These properties are
migrated for the following data source in the cell scope:
|
bpm.de.db.#.dataSource.#.maxConnections Example:
|
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. |
|
bpm.de.db.#.dataSource.#.statementCacheSize Example:
|
The number of statements that can be cached per connection. |
The Java Virtual Machine (JVM) settings are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.node.#.clusterMember.#.jvmSettings.#.jvmArgs Example:
|
The customized JVM arguments. |
This property is not automatically migrated. After migration, you need to check whether the property needs to be modified. |
bpm.de.node.#.clusterMember.#.jvmSettings.#.initialHeapSize Example:
|
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. |
bpm.de.node.#.clusterMember.#.jvmSettings.#.maximumHeapSize Example:
|
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. |
bpm.de.node.#.clusterMember.#.jvmSettings.#.disableWSAddressCaching Example:
|
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 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. |
bpm.de.node.#.clusterMember.#.jvmSettings.#.verboseModeGarbageCollection Example:
|
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 ORB (Object Request Broker) performance tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.dmgr.objectRequestBroker.requestTimeout Example:
|
The number of seconds to wait before timing out on a request message. |
These properties are not migrated. |
bpm.dmgr.objectRequestBroker.requestRetriesCount Example:
|
The number of times that the ORB attempts to send a request if a server fails. |
|
bpm.dmgr.objectRequestBroker.requestRetriesDelay Example:
|
The number of milliseconds between request retries. |
|
bpm.dmgr.objectRequestBroker.connectionCacheMaximum Example:
|
The maximum number of entries that can occupy the ORB connection cache before the ORB starts to remove inactive connections from the cache. |
|
bpm.dmgr.objectRequestBroker.connectionCacheMinimum Example:
|
The minimum number of entries in the ORB connection cache. |
|
bpm.dmgr.objectRequestBroker.locateRequestTimeout Example:
|
The number of seconds to wait before timing out on a Locate Request message. |
|
bpm.dmgr.objectRequestBroker.noLocalCopies Example:
|
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 thread pool performance tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.node.1.clusterMember.1.threadPool.2.name Example:
|
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. |
bpm.de.node.1.clusterMember.1.threadPool.1.minimumSize Example:
|
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. This property is migrated
for each cluster member. It is migrated for the following thread pools:
|
bpm.de.node.1.clusterMember.1.threadPool.1.maximumSize Example:
|
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. This property is migrated for each cluster member.
It is migrated for the following thread pools:
|
The JMS topic connection factory performance tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.cluster.#.activationSpec.#.name Example:
|
The name of the topic connection factory. |
These properties are migrated
only in the application cluster scope. They are migrated for the following
topic connection factories:
|
bpm.de.cluster.#.connectionFactory.#.minConnections Example:
|
The minimum number of connections to maintain. |
|
bpm.de.cluster.#.connectionFactory.#.maxConnections Example:
|
The maximum number of connections to be created. |
The transaction service performance tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.dmgr.transactionService.totalTransactionLifetimeTimeout Example:
|
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. |
bpm.dmgr.transactionService.clientInactivityTimeout Example:
|
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. |
The web container properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.node.#.clusterMember.#.webContainer.enableServletCaching Example:
|
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. |
bpm.de.node.#.clusterMember.#.webContainer.allowOverflow Example:
|
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. |
bpm.de.node.1.clusterMember.1.webContainer.enableCookies Example:
|
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. |
bpm.de.node.#.clusterMember.#.webContainer.restrictCookiesToHttpsSessions Example:
|
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. |
bpm.de.node.#.clusterMember.#.webContainer.maxInMemorySessionCount Example:
|
The maximum number of sessions to maintain
in memory for each web module. For in-memory sessions, this value
specifies the number of sessions in the base session table for a web
module. Use the allowOverflow property to specify
whether to limit sessions to this number for the entire session management
facility or to allow additional sessions to be stored in secondary
tables. For distributed sessions, this value specifies the size of
the memory cache for sessions of each web module. When the session
cache has reached its maximum size and a new session is requested,
the session management facility removes the least recently used session
from the cache to make room for the new one.
Note: Do not set this
value to a number less than the maximum thread pool size for your
server.
|
This property is not migrated. |
bpm.de.node.#.clusterMember.#.webContainer.httpInboundChannel.#.name Example:
|
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. |
bpm.de.node.#.clusterMember.#.webContainer.httpInboundChannel.#.maximumPersistentRequests Example:
|
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. |
bpm.de.node.#.clusterMember.#.webContainer.httpInboundChannel.#.persistentTimeout Example:
|
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 work manager information tuning properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.cluster.#.workManager.#.name Example:
|
The name of the work manager. The value is either DefaultWorkManager or BPENavigationWorkManager. |
This property is automatically migrated
for the following work managers:
|
bpm.de.cluster.#.workManager.#.jndiName Example:
|
The JNDI name of the default work manager. |
This property is automatically migrated
for the following work managers:
|
bpm.de.cluster.#.workManager.#.numAlarmThreads Example:
|
The number of alarm threads for the default work manager. |
This property is not migrated. |
bpm.de.cluster.#.workManager.#.workReqQSize Example:
|
The size of the buffer that the thread pool of the work manager uses to pull requests from. |
These properties are migrated
only in the application cluster scope. They are migrated for the following
work managers:
|
bpm.de.cluster.#.workManager.#.minThreads Example:
|
The number of threads to be kept in the thread pool, created as needed. |
|
bpm.de.cluster.#.workManager.#.maxThreads Example:
|
The maximum number of threads to be created in the thread pool. |
Case management properties
The case management configuration properties are shown in the following table.
Configuration properties | Description | Migration considerations |
---|---|---|
bpm.de.caseManager.networkSharedDirectory Example:
|
This property is automatically migrated. |
|
bpm.de.caseManager.formsType Example:
|
Specify the type of forms that you want to integrate into your case solutions.
The valid values are:
The default value is eForms. To integrate IBM Forms into your case solutions, specify ibmForms. For more information, see Integrating forms into your solution. |
This property is automatically migrated. |
bpm.de.caseManager.ibmFormsDirectory Example:
|
The IBM Forms directory where IBM Forms is installed. Specify the full path to the directory. The following directory is the default directory: C:\Program Files\IBM\Forms Server\8.0 This parameter is not applicable when the bpm.de.caseManager.formsType parameter is set to eForms. |
This property is automatically migrated. |
bpm.de.caseManager.ibmFormsRenderApp Example:
|
The IBM Forms rendering application that
displays forms to the user. The valid values are:
This parameter is not applicable when the bpm.de.caseManager.formsType parameter is set to eForms. |
This property is automatically migrated. |
bpm.de.caseManager.ibmFormsTranslatorURL Example:
|
The IBM Forms translator URL. This parameter is not applicable when the bpm.de.caseManager.formsType parameter is set to eForms. |
This property is automatically migrated. |
bpm.de.caseManager.enablePD Example:
|
The enabled or disabled status of IBM FileNet Process Designer. The default value is false, which means that FileNet Process Designer is not enabled. For information about FileNet Process Designer, see Running FileNet Process Designer. |
This property is automatically migrated. |
bpm.de.caseManager.enableVCS Example:
|
The enabled or disabled state of version control system (VCS) integration. The default value is false, which means that VCS integration is not enabled. For more information, see Integrating with a version control system (VCS). |
This property is automatically migrated. |
bpm.de.caseManager.vcsSandboxPath Example:
|
The fully qualified path to the sandbox used for VCS integration. If Case Builder is in a cluster environment, the sandbox must be on a shared file system that is available to all nodes in the cluster. This parameter is not applicable if VCS integration is disabled (i.e. the bpm.de.caseManager.enableVCS parameter is set to false). |
This property is automatically migrated. |
bpm.de.caseManager.vcsAdditionalParameters Example:
|
Additional custom parameters for VCS integration for which users are prompted during a commit or deliver operation. To prompt users for the custom parameters that Case Builder passes to your commit or deliver script, specify a label for each parameter. Type the values in a comma-separated list, as shown in the following example: VCS ID,Project Name,Approving Manager This parameter is not applicable if no additional parameters are required or if VCS integration is disabled (i.e. the bpm.de.caseManager.enableVCS parameter is set to false). |
This property is automatically migrated. |
bpm.de.caseManager.vcsHeartbeatInterval Example:
|
The time in seconds that must elapse between periodic updates from a VCS integration commit or deliver script before the commit or deliver operation is marked as a failure. The default value is 60. If you do not specify a value, the heartbeat is disabled. This parameter is not applicable if VCS integration is disabled (i.e. the bpm.de.caseManager.enableVCS parameter is set to false). |
This property is automatically migrated. |
bpm.de.caseManager.vcsCommitTimeout Example:
|
The time in seconds for a VCS integration commit script to run before the commit operation is marked as a failure. The default value is 120. This parameter is not applicable if VCS integration is disabled (i.e. the bpm.de.caseManager.enableVCS parameter is set to false). |
This property is automatically migrated. |
bpm.de.caseManager.vcsDeliverTimeout Example:
|
The time in seconds for a VCS integration deliver script to run before the deliver operation is marked as a failure. The default value is 600. This parameter is not applicable if VCS integration is disabled (i.e. the bpm.de.caseManager.enableVCS parameter is set to false). |
This property is automatically migrated. |