public class WorkflowService_JAXWS extends Object
WorkflowService defines the API for the Workflow Management Service in Content Server.
Workflow services provide a web service interface to the Content Server Workflow Engine. The API is concerned with the monitoring and control of Workflow Processes. At present, it does not provide an interface to design workflows.
The Workflow service uses terminology defined by the Workflow Management Coalition (WfMC) instead of the Content Server terminology. The table below maps the WfMC terminology to the Content Server terminology. The Workflow service has a strongly typed object (SDO) that represents each one of the WfMC types. In general, the notion of a SubWork has been eliminated from the API. There are only ProcessInstances, which may be nested.
Content Server WorkflowTerminology | Workflow Management Coalition Terminology (WfMC) |
---|---|
Workflow Map | Process Definition |
Work | Process Instance |
SubWork | Process Instance |
Task (in a Workflow Map) | Activity |
Task (in a running workflow) | Activity Instance |
Task (assigned to a user) | Work Item |
Work Package -Attachment Record -Comment Record -Attribute Record |
Application Data -AttachmentData -CommentData -AttributeData |
Audit Records | Process Event |
Constructor and Description |
---|
WorkflowService_JAXWS() |
Modifier and Type | Method and Description |
---|---|
void |
acceptWorkItem(long processID,
long subProcessID,
int activityID)
Accepts a WorkItem assigned to a group and assigns it to the current user
|
void |
archiveProcess(long processID)
Archives a stopped process instance.
|
void |
completeWorkItem(long processID,
long subProcessID,
int activityID,
String disposition)
Completes a WorkItem, sets the disposition and sends it on to the next activity
|
ProcessInstance |
createProcess(ProcessDefinition processDef,
String processName,
long[] attachments,
long[] memberRoleIDs)
CreateProcess loads the ProcessDefinition (Workflow Map) identified by the ProcessDefinition object and starts the workflow processes with the specified processName.
|
void |
delegateWorkItem(long processID,
long subProcessID,
int activityID,
long memberID)
Delegates a WorkItem to a user or group.
|
void |
deleteProcess(long processID)
Delete the workflow process identified by the processID
|
ProcessResult |
getListProcessesResults(PageHandle pageHandle)
Search for process instances in the system
|
ApplicationData[] |
getProcessData(long processID,
long subProcessID)
Gets the application data associated with a process instance
|
ProcessDefinition |
getProcessDefinition(long objectID)
Gets a process definition (workflow map).
|
ProcessDefinition |
getProcessDefinitionEx(long objectID)
Gets a process definition (workflow map), including activity permissions.
|
ProcessStartData |
getProcessStartData(long objectID)
Retrieves the data required for starting a Process for the specified ProcessDefinition using the StartProcess method.
|
ProcessInstance |
getProcessStatus(long processID,
long subProcessID)
Gets the status of a process instance
|
ApplicationData[] |
getWorkItemData(long processID,
long subProcessID,
int activityID)
Gets the application data associated with a WorkItem
|
WorkItemDetails |
getWorkItemDetails(long processID,
long subProcessID,
int activityID)
Gets the application data and actions associated with a WorkItem
|
ProcessDefinition |
importProcessDefinition(long parentID,
String name,
String comment,
boolean attachmentData,
boolean resetMembers,
Attachment attach)
Create a new process definition based on an exported process definition file.
|
PageHandle |
listProcesses(ProcessSearchOptions options)
Setup a search for process instances in the system
|
ProcessEvent[] |
listProcessHistory(long processID,
long subProcessID,
Integer activityID)
Gets the history of a process
|
WorkItemResult |
listWorkItems(PageHandle pageHandle)
Lists the WorkItems assigned to the current user
|
WorkItemResult |
listWorkItemsEx(PageHandle pageHandle)
Lists the WorkItems assigned to the current user, including the workflow title and WorkItem priority
|
void |
reassignActivity(long processID,
long subProcessID,
int activityID,
long memberID)
Reassigns an activity in the process to a different member
|
void |
resumeProcess(long processID)
Resumes a suspended process instance.
|
void |
sendWorkItemForGroupReview(long processID,
long subProcessID,
int activityID,
long groupID,
String title,
String instructions,
int duration,
WorkItemPriority priority,
GroupOptions groupOptions)
Sends a WorkItem to a group for review.
|
void |
sendWorkItemForReview(long processID,
long subProcessID,
int activityID,
long memberID,
String title,
String instructions,
int duration)
Sends a WorkItem to a user or group for review.
|
void |
sendWorkItemForSubmapReview(long processID,
long subProcessID,
int activityID,
long submapID)
Sends a WorkItem to a submap for review.
|
void |
sendWorkItemForUserReview(long processID,
long subProcessID,
int activityID,
long userID,
String title,
String instructions,
int duration,
WorkItemPriority priority)
Sends a WorkItem to a user for review.
|
ProcessInstance |
startProcess(ProcessStartData startData,
long[] attachments,
long[] memberRoleIDs)
Creates and starts a Process based on the provided data.
|
void |
stopProcess(long processID)
Stops the process instance.
|
void |
suspendProcess(long processID)
Suspends the process instance.
|
void |
updateProcessData(long processID,
long subProcessID,
ApplicationData[] applicationData)
Updates the application data on a Process
|
void |
updateWorkItemData(long processID,
long subProcessID,
int activityID,
ApplicationData[] applicationData)
Updates the application data on a WorkItem
|
public void acceptWorkItem(long processID, long subProcessID, int activityID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancepublic void archiveProcess(long processID)
processID
- ID of the process instancepublic void completeWorkItem(long processID, long subProcessID, int activityID, String disposition)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancedisposition
- One of the valid dispositions for this workflow (e.g. Approve, Reject)public ProcessInstance createProcess(ProcessDefinition processDef, String processName, long[] attachments, long[] memberRoleIDs)
processDef
- the ProcessDefinition objectprocessName
- Name to be assigned to the newly created process instanceattachments
- A list of objectIDs that will be added to the attachments of this process or null if no attachments are to be added.memberRoleIDs
- A list of memberIDs that will be mapped to any roles defined on this process or null if no roles are defined.public void delegateWorkItem(long processID, long subProcessID, int activityID, long memberID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancememberID
- ID of the member to be assigned the WorkItempublic void deleteProcess(long processID)
processID
- ID of the process instancepublic ProcessResult getListProcessesResults(PageHandle pageHandle)
pageHandle
- paged search resultspublic ApplicationData[] getProcessData(long processID, long subProcessID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.public ProcessDefinition getProcessDefinition(long objectID)
objectID
- The ID of the workflow map node or the ID of a process instance.SoapFaultException
- with fault codes:public ProcessDefinition getProcessDefinitionEx(long objectID)
objectID
- The ID of the workflow map node or the ID of a process instance.SoapFaultException
- with fault codes:public ProcessStartData getProcessStartData(long objectID)
objectID
- the ID of the process definitionpublic ProcessInstance getProcessStatus(long processID, long subProcessID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.public ApplicationData[] getWorkItemData(long processID, long subProcessID, int activityID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancepublic WorkItemDetails getWorkItemDetails(long processID, long subProcessID, int activityID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancepublic ProcessDefinition importProcessDefinition(long parentID, String name, String comment, boolean attachmentData, boolean resetMembers, Attachment attach)
parentID
- ParentID of node in which the new process definition will be createdname
- Name of the process definition.comment
- Description of the process definition.attachmentData
- Indicate whether this process definition should have an AttachmentData package created during import.resetMembers
- Indicate whether the member names/ids should be reset during the importfileAtts
- Description of the file uploaded as the process definition content.inStream
- Contentspublic PageHandle listProcesses(ProcessSearchOptions options)
options
- Options used to search for process instancespublic ProcessEvent[] listProcessHistory(long processID, long subProcessID, Integer activityID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity. Set to null or 0 to retrieve all of the activitiespublic WorkItemResult listWorkItems(PageHandle pageHandle)
pageHandle
- Controls the pagination of the results. Use null for all resultspublic WorkItemResult listWorkItemsEx(PageHandle pageHandle)
pageHandle
- Controls the pagination of the results. Use null for all resultspublic void reassignActivity(long processID, long subProcessID, int activityID, long memberID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancememberID
- ID of the member to be assigned the WorkItempublic void resumeProcess(long processID)
processID
- ID of the process instancepublic void sendWorkItemForGroupReview(long processID, long subProcessID, int activityID, long groupID, String title, String instructions, int duration, WorkItemPriority priority, GroupOptions groupOptions)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancegroupID
- ID of the group to review the WorkItemtitle
- Title of the WorkItem for the reviewerinstructions
- Instructions for the reviewer of the WorkItemduration
- Length of time allocated, in hours, for this WorkItem to be reviewedpriority
- Priority of the review for this WorkItem.groupOptions
- Group options for the review. Valid group options: Member Accept, One Level Expand, Full Expandpublic void sendWorkItemForReview(long processID, long subProcessID, int activityID, long memberID, String title, String instructions, int duration)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancememberID
- ID of the member to review the WorkItemtitle
- Title of the WorkItem for the reviewerinstructions
- Instructions for the reviewer of the WorkItemduration
- Length of time allocated, in hours, for this WorkItem to be reviewedpublic void sendWorkItemForSubmapReview(long processID, long subProcessID, int activityID, long submapID)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instancesubmapID
- ID of the submappublic void sendWorkItemForUserReview(long processID, long subProcessID, int activityID, long userID, String title, String instructions, int duration, WorkItemPriority priority)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instanceuserID
- ID of the user to review the WorkItemtitle
- Title of the WorkItem for the reviewerinstructions
- Instructions for the reviewer of the WorkItemduration
- Length of time allocated, in hours, for this WorkItem to be reviewedpriority
- Priority of the review for this WorkItem.public ProcessInstance startProcess(ProcessStartData startData, long[] attachments, long[] memberRoleIDs)
startData
- the data to use for starting the Process.attachments
- A list of objectIDs that will be added to the attachments of this Process or null if no attachments are to be added.memberRoleIDs
- A list of memberIDs that will be mapped to any roles defined on this Process or null if no roles are defined.public void stopProcess(long processID)
processID
- ID of the process instancepublic void suspendProcess(long processID)
processID
- ID of the process instancepublic void updateProcessData(long processID, long subProcessID, ApplicationData[] applicationData)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.applicationData
- ApplicationData objects for the Processpublic void updateWorkItemData(long processID, long subProcessID, int activityID, ApplicationData[] applicationData)
processID
- ID of the process instancesubProcessID
- ID of the subprocess. The main subprocess has the same ID as the process.activityID
- ID of the activity instanceapplicationData
- ApplicationData objects for the WorkItem© Copyright 2017 OpenText Corp. All Rights Reserved.