BPMConfigureProcessServer command-line utility

Using the BPMConfigureProcessServercommand, you can configure a server or a cluster with Process Server, Performance Data Warehouse, and Process Portal.

Purpose

The command saves you the time and effort of configuring each component individually. The BPMConfigureProcessServer command is located in the INSTALL_ROOT/profiles/profile_name/bin directory.

Required parameters

-dbDesign
Specifies the path to a database design document, which holds the database configuration for the server or cluster that you are configuring. To configure the Process Server, Performance Data Warehouse, and Process Portal database components, select the bpm.standard.nd database pattern.

The value must be the complete path name for the database design file. To create a database design document, see the related information about creating database design files.

Optional parameters

-serverName
Specifies the name of the server that you are configuring. Do not use this parameter if you are configuring a cluster.
-nodeName
Specifies the name of the node you are configuring. Do not use this parameter if you are configuring a cluster.
-psClusterName
Specifies the name of the cluster that you are configuring for the Process Server. If you are configuring a cluster, do not use -nodeName and -serverName
-perfDWClusterName
Specifies the name of the cluster for Performance Data Warehouse that you are configuring. If you are configuring a cluster, do not use -nodeName and -serverName
-processPortalClusterName
Specifies the name of the cluster for Process Portal that you are configuring. If you are configuring a cluster, do not use -nodeName and -serverName

If you do not specify the following Performance Data Warehouse deployment target parameters -perfDWNodeName, -perfDWServerName, and -perfDWClusterName, it is assumed that the Performance Data Warehouse is configured on your current deployment target.

-environmentName
Specifies the name of the environment that you are configuring. The default environmentName is the environmentType name.
-environmentType
Specifies the type of environment that you are configuring.
The following values are valid:
  • production
  • stage
  • test
The default environmentType is test.
-meServerName
Specifies the name of the messaging engine server for a remote configuration.

Include this value when the Bus Member resides on another server (not the server you are configuring currently). Do not specify if you are using - meClusterName.

-meClusterName
Specifies the name of the messaging engine node for a remote configuration.

Include this value when the Bus Member resides on another server (not the server you are configuring currently). Do not specify if you are using - meClusterName

-menodeName
Specifies the name of the messaging engine cluster for a remote configuration

Include this value when the bus member is on another cluster other than the cluster that you are configuring currently. If you are configuring a cluster , do not use -menodeName and -meserverName.

-processCenterHost
Specifies the URL of the Process Center that the Process Server will connects to.
-perfDWNodeName
Specifies the deployment target node name on which you plan to configure Performance Data Warehouse. Do not specify if you are using - meClusterName.
-perfDWServerName
Specifies the deployment target server name on which you plan to configure Performance Data Warehouse. Do not specify if you are using - meClusterName.
-perfDWClusterName
Specifies the deployment target cluster name on which you plan to configure Performance Data Warehouse. If you are configuring cluster , do not use-menodeName and -meserverName
-appNodeName
Specifies the application target node name for Process Portal you are configuring. If you are configuring a cluster, do not use -appNodeName and -appServerName.
-appServerName
Specifies the application target server name for Process Portal you are configuring. If you are configuring cluster , do not use -appNodeName and -appServerName.
-appClusterName
Specifies the application target cluster name for Process Portal you are configuring. If you are configuring cluster , do not use -appNodeName and -appServerName.

If the Performance Data Warehouse deployment target parameters -perfDWNodeName, -perfDWServerName and -perfDWClusterName are not specified, the Performance Data Warehouse is configured on your current deployment target.

The parameters are case sensitive.

Run the BPMConfigureProcessServer command using the following syntax:For Windows operating systemFor Linux operating systemFor UNIX operating system
  • For Windows operating system BPMConfigureProcessServer.bat -serverName Server1 -nodeName node1 -dbDesign C:\bpm.standard.standalone.dbDesign
  • For Linux operating systemFor UNIX operating system BPMConfigureProcessServer.sh serverNameServer1 -clusterName Cluster1 -nodeName node1 -dbDesign /opt/bpm.standard.standalone.dbDesign

Examples

Configure Process Server, Performance Data Warehouse, and Process Portal on a server or a cluster with the following default values:

For Linux operating systemFor UNIX operating systemFor Windows operating system
The following locations are for the Process Server, Performance Data Warehouse and Process Portal in a network deployment environment:
  • One Cluster - Process Server, Performance Data Warehouse, and Process Portal are deployed to the only cluster: the application cluster.
  • Two Clusters - Process Server, Process Portal, and Performance Data Warehouse are deployed to the application cluster; all the bus members are deployed to the messaging engine cluster.
  • Three Clusters - Process Server is deployed to the application cluster; Process Portal and Performance Data Warehouse are deployed to the support cluster; all the bus members are deployed to the messaging engine cluster.
  • Four Clusters - Process Server is deployed to the application cluster; Performance Data Warehouse is deployed to the support cluster; Process Portal is deployed to the web cluster; all the bus members are deployed to the messaging engine cluster.
Configure Process Server, Performance Data Warehouse, and Process Portal on server using the following example:For Linux operating systemFor UNIX operating systemFor Windows operating system
  • For Linux operating systemFor UNIX operating system BPMConfigureProcessServer.sh -serverName Server1 -nodeName node1 -dbDesign /opt/bpm.standard.standalone.dbDesign
  • For Windows operating system BPMConfigureProcessServer.bat -serverNameServer1 -nodeName node1 -dbDesign C:\bpm.standard.standalone.dbDesign

Configure Process Server, Performance Data Warehouse, and Process Portal on cluster using the following example.

For Linux operating systemFor UNIX operating systemFor Windows operating system
  • For Linux operating systemFor UNIX operating system BPMConfigureProcessServer.sh -psClusterName AppCluster -perfDWClusterName SupportCluster -processPortalClusterName WebCluster -dbDesign /opt/bpm.standard.standalone.dbDesign
  • For Windows operating system BPMConfigureProcessServer.bat -psClusterName AppCluster -perfDWClusterName SupportCluster -processPortalClusterName WebCluster -dbDesign C:\opt\bpm.standard.standalone.dbDesign