Process Utils DSC

 Browse Space
Version 7 by Kendy Yus
on Oct 22, 2008 12:51.
<< Changes from 6 to 7
compared with
Current by Lachlan Aldred
on Mar 13, 2009 11:25.
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (70)

View page history
Please read [Synchronizing Business Events with the right Processes Instance in LCES], [Public:Customize User Task Escalation After Assignment] for descriptions of patterns that use Process Utils DSC.
h3. Component: com.avoka.livecycle.ProcessUtils 1.1

h3. Component: com.avoka.livecycle.ProcessUtils 1.1


h2. ProcessUtils Service

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


h3. Operation Title: Find a Process&nbsp;&nbsp;&nbsp;(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 || Editor ||
| Process Name | java.lang.String | The name of the process. | |&nbsp;|
| Correlation Variable Name | java.lang.String | The name of the variable who's value is used to correlate over. | |&nbsp;|
| Correlation Value | java.lang.Object | The value of the variable who's value is used to correlate over. | |&nbsp;|
 


|| Output Parameter || Type || Description ||
| Process ID | long | The process ID being searched for. |
 
h3. Operation: findRunningTaskByName
 


h3. Operation Title: Find Running Task By Name&nbsp;&nbsp;&nbsp;(findRunningTaskByName)
Find Running Task By Name: Find running task by name.
|| Input Parameter || Type || Description || Editor ||
| Process ID | long | The process ID. |
| Process ID | long | The name of the process. |&nbsp;|
| Action Name | java.lang.String | The name of the task. | |&nbsp;|
 
|| Output Parameter || Type || Description ||
| Task ID | long | The ID of the task. |
 
h3. 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. |
 
h3. Operation: updateProcessDataValue
 


h3. Operation Title: Update Process Data Value&nbsp;&nbsp;&nbsp;(updateProcessDataValue)
Update Process Data Value: Updates the value of a variable in a process instance.
|| Input Parameter || Type || Description || Editor ||
| Process ID | long | The ID of the process. | |&nbsp;|
| Variable Name | java.lang.String | The name of the variable. | |&nbsp;|
| New Value | java.lang.Object | The new value of the variable. | |&nbsp;|
 
h3. Operation: completeTask
 





h3. Operation Title: Force Task Completion&nbsp;&nbsp;&nbsp;(completeTask)
Force Task Completion: Force the completion of a task.
|| Input Parameter || Type || Description || Editor ||
| Task ID | long | The task instance id. | |&nbsp;|
 
h3. Operation: completeTaskWithRoute
 





h3. Operation Title: Force Task Completion Force Routing&nbsp;&nbsp;&nbsp;(completeTaskWithRoute)
Force Task Completion Force Routing: Force the completion of a task, and identify the route to take after completion.
|| Input Parameter || Type || Description || Editor ||
| Task ID | long | The task instance id. | |&nbsp;|
| Route Name | java.lang.String | The name of the route to take after completing the task with matching taskid. | |&nbsp;|
 
h3. Operation: getTaskDetails
 





h3. Operation Title: Get Task Details&nbsp;&nbsp;&nbsp;(getTaskDetails)
Get Task Details: Return all relevant information about a task that is stored in the system.
|| Input Parameter || Type || Description || Editor ||
| Task ID | long | The task instance id. | |&nbsp;|
 


|| 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\[\] 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. |
 
h3. Operation: changeProcessState
 




h3. Operation Title: Change Process State&nbsp;&nbsp;&nbsp;(changeProcessState)
Change Process State: Change the status of the process.
|| Input Parameter || Type || Description || Editor ||
| Invocation ID | java.lang.String | Please specify the invocation ID. | |&nbsp;|
| Process ID | java.lang.Long | The ID of the process. | |&nbsp;|
| Resulting State | java.lang.String | The state of the process at the end of this operation. | |&nbsp;|
 
h3. Operation: findRunningSubProcesses
 





h3. Operation Title: Find Running Subprocesses&nbsp;&nbsp;&nbsp;(findRunningSubProcesses)
Find Running Subprocesses: Finds and Returns running sub-process IDs
|| Input Parameter || Type || Description || Editor ||
| Parent Process ID | java.lang.Long | The ID of the parent process. | |&nbsp;|
| Excluded Process ID | java.lang.Long | The ID of the process which has to be excluded from process ID list. | |&nbsp;|
 


|| Output Parameter || Type || Description ||
| List of Subprocess IDs | List | The list of Subprocess IDs |
 
h5.
 
h5.
{panel:borderStyle=solid}
For how to configure license information for this component service - Process Utils, please click on the following link:
...
{panel}
 
h3. Licence Configuration:
...