Process Engine 10.7 | Process Engine Services | Summary of Elements in the WmPRT\pub Folder | pub.prt.correlate:lookupCorrelation
 
pub.prt.correlate:lookupCorrelation
WmPRT. Returns the process instance ID that is associated with the specified correlation ID or conversation ID. If no association exists, creates a new process instance ID and mapping.
Input Parameters
The following table lists the input parameters.
ProcessCorrelationID
String Correlation ID or conversation ID for which you want to return the process instance ID.
MappingType
String Optional. Flag indicating whether ProcessCorrelationID specifies a correlation ID or a conversation ID. The following values apply:
*IS — Default. ProcessCorrelationID is a correlation ID for an IS document.
*TNProcessCorrelationID is a Trading Networks conversation ID for a Trading Networks document.
Output Parameters
The following table lists the output parameters.
ProcessInstanceID
String Conditional. The process instance ID mapped to the specified correlation ID or conversation ID (if any).
success
String Flag indicating whether a process instance ID was returned. The following values apply:
*true — A process instance ID was found or created and returned.
*false— A process instance ID was not returned because the correlation ID or conversation ID was not established.
Usage Notes
Use this service to check on mappings that were established with previous calls to pub.prt.correlate:establishCorrelation or, under certain circumstances, to check on the existence of a process with a particular correlation ID or conversation ID.
See Also