Please read Synchronizing Business Events with the right Processes Instance in LCES, Customize User Task Escalation After Assignment for descriptions of patterns that use Process Utils DSC.

Component: com.avoka.livecycle.ProcessUtils 1.1

ProcessUtils Service

Process Utils: Enables finding, querying and updating process instances, task instances, and data inside process instances.

Operation: findProcess

Find a Process: Find a process instance based on it's name and the value of a correlation variable. If the parameters end up matching more than one process instance then this operation returns the ID of the first one.

Input Parameter	Type	Description
Process Name	java.lang.String	The name of the process.
Correlation Variable Name	java.lang.String	The name of the variable who's value is used to correlate over.
Correlation Value	java.lang.Object	The value of the variable who's value is used to correlate over.

Output Parameter	Type	Description
Process ID	long	The process ID being searched for.

Operation: findRunningTaskByName

Find Running Task By Name: Find running task by name.

Input Parameter	Type	Description
Process ID	long	The process ID.
Action Name	java.lang.String	The name of the task.

Output Parameter	Type	Description
Task ID	long	The ID of the task.

Operation: findLatestRunningTask

Find Latest Running Task: Find the latest running task in process.

Input Parameter	Type	Description
Process ID	long	The process ID.

Output Parameter	Type	Description
Task ID	long	The ID of the task.

Operation: updateProcessDataValue

Update Process Data Value: Updates the value of a variable in a process instance.

Input Parameter	Type	Description
Process ID	long	The ID of the process.
Variable Name	java.lang.String	The name of the variable.
New Value	java.lang.Object	The new value of the variable.

Operation: completeTask

Force Task Completion: Force the completion of a task.

Input Parameter	Type	Description
Task ID	long	The task instance id.

Operation: completeTaskWithRoute

Force Task Completion Force Routing: Force the completion of a task, and identify the route to take after completion.

Input Parameter	Type	Description
Task ID	long	The task instance id.
Route Name	java.lang.String	The name of the route to take after completing the task with matching taskid.

Operation: getTaskDetails

Get Task Details: Return all relevant information about a task that is stored in the system.

Input Parameter	Type	Description
Task ID	long	The task instance id.

Output Parameter	Type	Description
ActionID	long	The action identifier that corresponds to this task.
AssignmentCreateTime	java.util.Date	The date when the task was assigned.
AssignmentStatus	short	The assignment status.
CreateTime	java.util.Date	The date when a task was created.
Deadline	java.util.Date	The deadline for this task.
Description	java.lang.String	This task's description.
Instructions	java.lang.String	This task's instructions.
NextReminder	java.util.Date	The reminder date for this task.
ProcessInstanceId	long	The process instance identifer associated with this task.
ProcessName	String	The process name for a task if it is part of a process.
RouteList	java.lang.String[]	The route list for this task.
SelectedRoute	java.lang.String	The selected route.
StepName	java.lang.String	This task's step name.
TaskStatus	short	The status for this task.

Operation: changeProcessState

Change Process State: Change the status of the process.

Input Parameter	Type	Description
Invocation ID	java.lang.String	Please specify the invocation ID.
Process ID	java.lang.Long	The ID of the process.
Resulting State	java.lang.String	The state of the process at the end of this operation.

Operation: findRunningSubProcesses

Find Running Subprocesses: Finds and Returns running sub-process IDs

Input Parameter	Type	Description
Parent Process ID	java.lang.Long	The ID of the parent process.
Excluded Process ID	java.lang.Long	The ID of the process which has to be excluded from process ID list.

Output Parameter	Type	Description
List of Subprocess IDs	List	The list of Subprocess IDs

Licence Configuration:

Parameter	Type	Description
License Key	java.lang.String	The license key provided to you when you purchased a production license for this Solution Component. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time.
License Organisation	java.lang.String	The organization name you provided to Avoka for which you are licensing this Solution Component.