Correlation Service Input and Output Variables
Refer to the following tables for input and output variables you can use when creating correlation services.
When a correlation service receives control, it passes the following inputs:
Input variable | Description |
ProcessModelID | String ID of the process model with which this invocation of the correlation service is involved. |
ProcessModelVersion | String Version of the process model with which this invocation of the correlation service is involved. Note: | Because a single correlation service can be associated with steps from more than one process model version, you can use the ProcessModelID and ProcessModelVersion to identify the process model version using the correlation service at run time. |
|
LogicalServer | String Name of the logical server that is associated with the step in the process model version with which this invocation of the correlation service is involved. In other words, the name of the logical server on which this correlation service is running. Because a single correlation service can be used with steps that execute on different servers, you can use LogicalServer to identify a specific server at run time. |
ProcessStepID | String ID of the step in the process model version with which this invocation of the correlation service is involved (for example, N3). Because a single correlation service can be associated with multiple steps in a process model version, you can use ProcessStepID to identify the specific step at run time. |
DocumentName | String Name of this document as used in the process model version (for example, "OrderDocument"). |
DocumentType | String Name of this document type (for example, "orders.sap:OrderDocument"). |
Document | Document The document. |
Your correlation service should return the following output:
Output variable | Description |
ProcessCorrelationID | String Conditional. An abstract ID that correlates to the actual process instance ID of the running process. For example: "CUSTOMER-0003456977::ORDER-19477593-AR9-1000". All documents bound for the same instance of the process must return the same correlation ID. Similarly, correlation IDs must be unique across all process instances. |
CorrelateAsTN | String Conditional. Flag that indicates whether the correlation ID in ProcessCorrelationID is a conversation ID.  A value of true indicates that ProcessCorrelationID is a Trading Networks conversation ID. A value of false indicates that ProcessCorrelationID is not a Trading Networks conversation ID. |
For more information, see
pub.prt:CorrelationService and
pub.prt.correlate:establishCorrelation. This information is also available in the PDF publication
Administering webMethods Process Engine.
