configureProcessServer command

Use the configureProcessServer command to configure a server or cluster as a Process Server.

Purpose

This command provides a command line method to configure a server or cluster as a Process Server.

After using the command, save your changes to the master configuration using one of the following commands:
  • For Jython:
    AdminConfig.save()
  • For Jacl:
    $AdminConfig save

Required parameters

-serverName
Specifies the name of the server you are configuring.
-nodeName
Specifies the name of the node you are configuring.
-clusterName
Specifies the name of the cluster you are configuring.
-dbDesign
Specifies the path to a database design document, which holds the Process Server and Performance Data Warehouse database configuration for the server or cluster you are configuring.

The value must be the complete path name for the database design file.

-environmentName
Specifies the name of the environment you are configuring. This parameter has no default value, and it must not be empty.

Optional parameters

-environmentType
Specifies the type of environment you are configuring.
Valid values are as follows:
  • production
  • stage
  • 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).

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

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

Include this value when the Bus Member resides on another cluster (not the cluster you are configuring currently).

-processCenterHost
Specifies the URL of the Process Center that the Process Server will connect to.
-perfDWNodeName
Specifies the deployment target node name on which you plan to configure Performance Data Warehouse.
-perfDWNodeName
Specifies the deployment target node name on which you plan to configure Performance Data Warehouse.
-perfDWServerName
Specifies the deployment target server name on which you plan to configure Performance Data Warehouse.
-perfDWClusterName
Specifies the deployment target cluster name on which you plan to configure Performance Data Warehouse.
Note: If the Performance Data Warehouse deployment target parameters (-perfDWNodeName, -perfDWServerName and -perfDWClusterName) are not specified, then the assumption is that the Performance Data Warehouse is going to be configured on this deployment target itself.

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.
The following example uses configureProcessServer to configure server AppServer as a Process Server.
  • Jython example:
    AdminTask.configureProcessServer('[-serverName AppServer -nodeName node1 
      -meNodeName me_node1 -meServerName Psvr -perfDWNodeName pdw_node1 
    -perfDWServerName pdw_Psvr -dbDesign C:\dbDesigns\psvr.dbDesign
    -processCenterHost ProcessCenterURL]')
  • Jacl example:
    $AdminTask configureProcessServer { -serverName AppServer -nodeName node1 
       -meNodeName me_node1 -meServerName Psvr -perfDWNodeName pdw_node1 
    -perfDWServerName pdw_Psvr -dbDesign C:\dbDesigns\psvr.dbDesign
    -processCenterHost ProcessCenterURL}
The following example uses configureProcessServer to configure cluster Cluster1 as a Process Server.
  • Jython example:
    AdminTask.configureProcessServer('[-clusterName Cluster1 
     -meClusterName MessagingEngine1 -perfDWClusterName pdw_cluster1 
    -dbDesign C:\dbDesigns\psvr.dbDesign -processCenterHost ProcessCenterURL]')
  • Jacl example:
    $AdminTask configureProcessServer { -clusterName Cluster1 
     -meClusterName MessagingEngine1 -perfDWClusterName pdw_cluster1 
    -dbDesign C:\dbDesigns\psvr.dbDesign -processCenterHost ProcessCenterURL}