Process Engine Web Service Reference

The Process Engine Web Service essentially wraps a subset of the Process Engine runtime API, the operations corresponding to particular Process Engine Java™ API class methods. The portType operations and associated messages are presented here in a more human-readable format than that of the Process Engine Web Service WSDL. For each operation described in this section, refer to the linked Process Engine Java API method for a complete description of the operation and its parameters.

The Process Engine Web Service WSDL is located in the Pews.jar file installed in the Content Engine EAR file. The WSDL location in the JAR file is as follows:

   Pews.jar\WASP-INF\wsdl\Definitions_filenet_vw_ws_server.wsdl

The URL for the Process Engine Web Service is as follows:

   http://content_engine_host:port/wsi/ProcessEngineWS

Where content_engine_host is the machine name of the Content Engine host, and port is the port assigned to the Content Engine.

See Code Samples for links to Process Engine Web Service code samples.

The portType operations are as follows:

The operations getQueuesWrapped, getRosterNamesWrapped, and getWorkClassNamesWrapped have been added to address the lack of WSI-compliancy of the getQueues, getRosterNames and getWorkClassNames operations. In addition, the following query operations have been added to allow passing heterogenous Value arrays for substitutionVars instead of just String arrays:

The Types Information section briefly lists the data types associated with (and linked from) each operation.

createWorkflow

Launches a workflow defined by a transferred workflow definition as specified in workflowIdentifier, and returns a step element.

Reference to related Java API documentation: VWSession.createWorkflow

Input Parameter Elements
workflowIdentifier workflowIdentifier : String
Output Parameter Elements
StepElement_Response StepElement
Fault Parameter Elements
PEWSException2 PEWSException

getMilestoneForRosterElement

Gets the milestone data for the work objects in the specified roster, for milestone elements with a level less than or equal to the milestoneLevel specified.

Reference to related Java API documentation: VWSession.fetchMilestonesFromRoster

Input Parameter Elements
getMilestoneForRosterElementRequest GetMilestoneForRosterElementRequest
Output Parameter Elements
ArrayOfMilestone_Response ArrayOfMilestone
Fault Parameter Elements
PEWSException9 PEWSException

getQueueElements

Performs a filtered fetch on a queue, returning an array of queue elements.

Reference to related Java API documentation: VWQueue.createQuery

Input Parameter Elements
getQueueElementsRequest GetQueueElementsRequest
Output Parameter Elements
ArrayOfQueueElement_Response ArrayOfQueueElement
Fault Parameter Elements
PEWSException1 PEWSException

getQueueElementsEx

Performs a filtered fetch on a queue, returning an array of queue elements. This operation was added to allow passing an array of Values for the substitutionVars input parameter in the request.

Reference to related Java API documentation: VWQueue.createQuery

Input Parameter Elements
getQueueElementsExRequest GetQueueElementsExRequest
Output Parameter Elements
ArrayOfQueueElement_Response ArrayOfQueueElement
Fault Parameter Elements
PEWSException1 PEWSException

getQueues

Returns an array of all queue definitions for the current configuration.

Reference to related Java API documentation: VWSession.fetchSystemConfiguration, VWSystemConfiguration.getQueueDefinitions

Input Parameter Elements
n/a n/a
Output Parameter Elements
ArrayOfQueueInfo_Response ArrayOfQueueInfo
Fault Parameter Elements
PEWSException PEWSException

getQueuesWrapped

Returns an array of all queue definitions for the current configuration. This operation was added for WSI-compliance, to supercede the getQueues operation (which is not WSI-compliant). In addition, a checkSecurity parameter has been added to return only the queues to which the current user has Read privileges.

Reference to related Java API documentation: VWSession.fetchSystemConfiguration, VWSystemConfiguration.getQueueDefinitions

Input Parameter Elements
getQueuesWrappedRequest GetQueuesWrappedRequest
Output Parameter Elements
ArrayOfQueueInfo_Response ArrayOfQueueInfo
Fault Parameter Elements
PEWSException PEWSException

getRosterElements

Performs a filtered fetch of roster elements.

Reference to related Java API documentation: VWRoster.createQuery

Input Parameter Elements
getRosterElementsRequest GetRosterElementsRequest
Output Parameter Elements
ArrayOfRosterElement_Response ArrayOfRosterElement
Fault Parameter Elements
PEWSException11 PEWSException

getRosterElementsEx

Performs a filtered fetch of roster elements. This operation was added to allow passing an array of Values for the substitutionVars input parameter in the request.

Reference to related Java API documentation: VWRoster.createQuery

Input Parameter Elements
getRosterElementsExRequest GetRosterElementsExRequest
Output Parameter Elements
ArrayOfRosterElement_Response ArrayOfRosterElement
Fault Parameter Elements
PEWSException11 PEWSException

getRosterNames

Gets a String array of all roster names within the isolated region.

Reference to related Java API documentation: VWSession.fetchRosterNames

Input Parameter Elements
n/a n/a
Output Parameter Elements
ArrayOfstring_Response ArrayOfstring
Fault Parameter Elements
PEWSException10 PEWSException

getRosterNamesWrapped

Gets a String array of all roster names within the isolated region. This operation was added for WSI-compliance, to supercede the getRosterNames method (which is not WS-compliant).

Reference to related Java API documentation: VWSession.fetchRosterNames

Input Parameter Elements
getRosterNamesWrappedRequest GetRosterNamesWrappedRequest
Output Parameter Elements
ArrayOfstring_Response ArrayOfstring
Fault Parameter Elements
PEWSException10 PEWSException

getStepElementsFromQueue

Performs a filtered fetch of queue items, returning an array of StepElements.

Reference to related Java API documentation: VWQueue.createQuery

Input Parameter Elements
getStepElementsFromQueueRequest GetStepElementsFromQueueRequest
Output Parameter Elements
ArrayOfStepElement_Response ArrayOfStepElement
Fault Parameter Elements
PEWSException3 PEWSException

getStepElementsFromQueueEx

Performs a filtered fetch of queue items, returning an array of StepElements. This operation was added to allow passing an array of Values for the substitutionVars input parameter in the request.

Reference to related Java API documentation: VWQueue.createQuery

Input Parameter Elements
getStepElementsFromQueueExRequest GetStepElementsFromQueueExRequest
Output Parameter Elements
ArrayOfStepElement_Response ArrayOfStepElement
Fault Parameter Elements
PEWSException3 PEWSException

getStepElementsFromRoster

Returns the step elements from a roster query.

Reference to related Java API documentation: VWRoster.createQuery

Input Parameter Elements
getStepElementsFromRosterRequest GetStepElementsFromRosterRequest
Output Parameter Elements
ArrayOfStepElement_Response ArrayOfStepElement
Fault Parameter Elements
PEWSException12 PEWSException

getStepElementsFromRosterEx

Returns the step elements from a roster query. This operation was added to allow passing an array of Values for the substitutionVars input parameter in the request.

Reference to related Java API documentation: VWRoster.createQuery

Input Parameter Elements
getStepElementsFromRosterExRequest GetStepElementsFromRosterExRequest
Output Parameter Elements
ArrayOfStepElement_Response ArrayOfStepElement
Fault Parameter Elements
PEWSException12 PEWSException

getWorkClassNames

Returns a String array of the names of all work classes within the isolated region.

Reference to related Java API documentation: VWSession.fetchWorkClassNames

Input Parameter Elements
n/a n/a
Output Parameter Elements
ArrayOfstring_Response ArrayOfstring
Fault Parameter Elements
PEWSException13 PEWSException

getWorkClassNamesWrapped

Returns a String array of the names of all work classes within the isolated region. This operation was added for WSI-compliance, to supercede the getWorkClassNames operation (which is not WSI-compliant).

Reference to related Java API documentation: VWSession.fetchWorkClassNames

Input Parameter Elements
getWorkClassNamesWrappedRequest GetWorkClassNamesWrappedRequest
Output Parameter Elements
ArrayOfstring_Response ArrayOfstring
Fault Parameter Elements
PEWSException13 PEWSException

launchWorkflow

Launches the specified workflow.

Reference to related Java API documentation: VWSession.createLiveWorkObject

Input Parameter Elements
launchWorkflowRequest LaunchWorkflowRequest
Output Parameter Elements
LaunchWorkflowResult_Response LaunchWorkflowResult
Fault Parameter Elements
PEWSException8 PEWSException

reassignStep

Reassigns (or delegates) the step to the specified user. The stepElement element contains updated data for the step prior to reassigning or delegating (see updateStep).

Reference to related Java API documentation: VWStepElement.doReassign

Input Parameter Elements
reassignStepRequest ReassignStepRequest
Output Parameter Elements
n/a n/a
Fault Parameter Elements
PEWSException7 PEWSException

retrieveStep

Retrieves and (optionally) locks a step element based on the specified work object ID.

Reference to related Java API documentation: VWQueue.createQuery, VWStepElement.doLock

Input Parameter Elements
retrieveStepRequest RetrieveStepRequest
Output Parameter Elements
StepElement_Response StepElement
Fault Parameter Elements
PEWSException4 PEWSException

unlockStep

Releases the lock on a step element based on the specified work object ID.

Reference to related Java API documentation: VWQueue.createQuery, VWStepElement.doAbort

Input Parameter Elements
unlockStepRequest UnlockStepRequest
Output Parameter Elements
n/a n/a
Fault Parameter Elements
PEWSException6 PEWSException

updateStep

Updates the step element with data, potentially overriding any locks set.

Reference to related Java API documentation: VWQueue.createQuery, VWStepElement.doSave, VWStepElement.doDispatch, VWStepElement.doReturnToSource

Input Parameter Elements
updateStepRequest UpdateStepRequest
Output Parameter Elements
n/a n/a
Fault Parameter Elements
PEWSException5 PEWSException

Types Information

The following types are used to specify parameter element values:

Type Value
ArrayOfstring (0..*) string : String
ArrayOfQueueElement (0..*) queueElement : QueueElement
QueueElement Fields : ArrayOfField
MapName : String
StepName : String
StepProcessorID : int
GetQueueElementsRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
queueName : String
substitutionVars : ArrayOfstring
GetQueueElementsExRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
queueName : String
substitutionVars : ArrayOfValue
GetQueuesWrappedRequest checkSecurity : boolean
ArrayOfQueueInfo (0..*) Queueinfo : QueueInfo
QueueInfo Name : String
Type : QueueTypeEnum
QueueTypeEnum "QUEUE_TYPE_USER_CENTRIC"
"QUEUE_TYPE_PROCESS"
ArrayOfField (0..*) field : Field
Field IsArray : boolean
IsSystemField : boolean
Modified : boolean
Name : String
Type : FieldTypeEnum
Values : ArrayOfValue
FieldTypeEnum "FIELD_TYPE_ATTACHMENT"
"FIELD_TYPE_PARTICIPANT"
"FIELD_TYPE_INTEGER"
"FIELD_TYPE_DOUBLE"
"FIELD_TYPE_STRING"
"FIELD_TYPE_BOOLEAN"
"FIELD_TYPE_TIME"
ArrayOfValue (0..*) value : Value
Value attachmentField : Attachment
booleanField : boolean
doubleField : double
integerField : int
participantField : String
stringField : String
dateField : Date
Attachment Description : String
Id : String
Library : String
LibraryType : LibraryTypeEnum
Name : String
Type : AttachmentTypeEnum
Version : String
LibraryTypeEnum "LIBRARY_TYPE_UNDEFINED"
"LIBRARY_TYPE_CONTENT_ENGINE"
"LIBRARY_TYPE_IDMDS"
"LIBRARY_TYPE_IDMIS"
AttachmentTypeEnum "ATTACHMENT_TYPE_UNDEFINED"
"ATTACHMENT_TYPE_LIBRARY"
"ATTACHMENT_TYPE_FOLDER"
"ATTACHMENT_TYPE_DOCUMENT"
"ATTACHMENT_TYPE_STORED_SEARCH"
"ATTACHMENT_TYPE_URL"
"ATTACHMENT_TYPE_CUSTOM_OBJECT"
ArrayOfQueryFlagEnum (0..*) queryFlagEnum : QueryFlagEnum
QueryFlagEnum "QUERY_NO_OPTIONS"
"QUERY_READ_BOUND"
"QUERY_READ_UNWRITABLE"
"QUERY_READ_LOCKED"
"QUERY_MIN_VALUES_INCLUSIVE"
"QUERY_MAX_VALUES_INCLUSIVE"
"QUERY_LOCK_OBJECTS"
"QUERY_GET_NO_SYSTEM_FIELDS"
"QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS"
"QUERY_RESOLVE_NAMES"
ArrayOfRosterElement (0..*) rosterElement : RosterElement
RosterElement (optional) Deadline : Date
ExceptionDescription : String
Fields : ArrayOfField
IsTracker : boolean
LaunchedBy : String
(optional) LaunchedOn : Date
OperationName : String
Overdue : Overdue
ParticipantName : String
(optional) ReceivedOn : Date
(optional) Reminder : Date
RosterName : String
StepName : String
Tag : String
WOBName : String
WOBNumber : String
WorkClassName : String
WorkflowName : String
WorkflowNumber : String
GetRosterElementsRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
rosterName : String
substitutionVars : ArrayOfstring
GetRosterElementsExRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
rosterName : String
substitutionVars : ArrayOfValue
GetRosterNamesWrappedRequest (empty)
Overdue "NotOverdue"
"ReminderPast"
"DeadlinePast"
ArrayOfStepElement (0..*) stepElement : StepElement
StepElement CanReassign : boolean
CanReturnToSource : boolean
CanViewHistory : boolean
CanViewStatus : boolean
CurrentQueueName : String
(optional) Deadline : Date
Description : String
ExceptionDescription : String
ExceptionMapName : String
IsTracker : boolean
LaunchedBy : String
(optional) LaunchedOn : String
OperationName : String
Overdue : Overdue
Parameters : ArrayOfParameter
ParticipantName : String
QueueName : String
(optional) ReceivedOn : Date
(optional) Reminder : Date
Responses : ArrayOfResponse
RosterName : String
StepName : String
Tag : String
WOBName : String
WOBNumber : String
WorkClassName : String
WorkflowIdentifier : String
WorkflowName : String
WorkflowNumber : String
GetStepElementsFromQueueRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
queueName : String
substitutionVars : ArrayOfstring
GetStepElementsFromQueueExRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
queueName : String
substitutionVars : ArrayOfValue
GetStepElementsFromRosterRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
rosterName : String
substitutionVars : ArrayOfstring
GetStepElementsFromRosterExRequest filter : String
indexName : String
maxValues : ArrayOfstring
minValues : ArrayOfstring
nToReturn : int
queryFlags : ArrayOfQueryFlagEnum
rosterName : String
substitutionVars : ArrayOfValue
ReassignStepRequest delegate : boolean
newUserName : String
stepElement : StepElement
RetrieveStepRequest bLock : boolean
bOverrideLock : boolean
queryFlags : ArrayOfQueryFlagEnum
queueName : String
wobNum : String
UnlockStepRequest queueName : String
wobNum : String
UpdateStepRequest stepElement : StepElement
updateFlag : UpdateFlagEnum
ArrayOfParameter (0..*) parameter : Parameter
Parameter CompareValue : boolean
Description : String
IsArray : boolean
IsSystemParameter : boolean
Mode : ModeTypeEnum
Modified : boolean
Name : String
Type : FieldTypeEnum
Values : ArrayOfValue
FieldTypeEnum "FIELD_TYPE_ATTACHMENT"
"FIELD_TYPE_PARTICIPANT"
"FIELD_TYPE_INTEGER"
"FIELD_TYPE_DOUBLE"
"FIELD_TYPE_STRING"
"FIELD_TYPE_BOOLEAN"
"FIELD_TYPE_TIME"
ModeTypeEnum "MODE_TYPE_IN"
"MODE_TYPE_OUT"
"MODE_TYPE_IN_OUT"
ArrayOfResponse (1) Response : ArrayOfstring
(1) Selected : String
UpdateFlagEnum "UPDATE_DISPATCH"
"UPDATE_SAVE_RETURN"
"UPDATE_SAVE_UNLOCK"
"UPDATE_SAVE"
MilestoneQueryEnum "MILESTONE_QUERY_WOBNUMBER"
"MILESTONE_QUERY_WORKFLOW_NUMBER"
ArrayOfMilestone (0..*) milestone : Milestone
Milestone Id : int
Level : int
Map : String
Message : String
Name : String
(optional) Reached : Date
StepId : int
GetMilestoneForRosterElementRequest milestoneLevel : int
queryEnum : MilestoneQueryEnum
queryValue : String
rosterName : String
LaunchWorkflowRequest fields : ArrayOfField
workflowName : String
LaunchWorkflowResult rosterName : String
workfObjectNumber : String
PEWSException message : String
GetWorkClassNamesWrappedRequest (empty)