WFGetNextUnlockedWorkitem WFGetNextUnlockedWorkitemThis call returns Next Unlocked Workitem and lock it. You can view the XML input and output parameters, which have to be passed for fetching unlock workitem and locking it. There is a list of errors and warning that can occur in the execution.
* implies for the mandatory parameter.
|
Name |
Parent Tag |
Description |
Valid Value |
|
Option * |
Root |
It refers to the case sensitive call name. |
case sensitive call name. |
|
EngineName * |
Root |
It is the cabinet or database name, which has to be connected. |
NA |
|
SessionID * |
Root |
It is the logged in user session id |
NA |
|
Type |
Filter |
Type of the filter criteria specified. Filter type can be SQL string or an attribute. If you are filtering on attributes, then filter string contains the value of the attribute. 0-255 are reserved , if it is 256 than its SQL type filter. Then you Filter string will contains an SQL query. |
NA |
|
AttributeName |
Filter |
It is the name of attribute for filtering. |
NA |
|
Comparision |
Filter |
It is operator for the filter |
1 for > ; 2 for >= ;3 for =; 4 <> ; 5 for <; 6 for <=; 7 for like, 8 for not like. |
|
FilterString |
Filter |
It is string specified for the filtering |
NA |
|
Length |
Filter |
It is the length of the filter string |
NA |
|
OrderBy |
BatchInfo |
It is the field on which the sorting has to be done. |
NA |
|
SortOrder |
BatchInfo |
It is the order in which the records are to be displayed. |
A- ascending "D"- descending |
|
LastValue |
BatchInfo |
It is the last value in the list. |
NA |
|
LastProcessInstance |
BatchInfo |
It is the last process instance id. |
NA |
|
LastWorkItem |
BatchInfo |
It is the last workitem |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
EngineName |
Root |
Error code specified by WAPI. |
|
SessionID |
Root |
It is the logged in user session id |
|
ProcessInstanceId |
Instrument |
It is process instance id that has to be locked.. |
|
WorkItemName |
Instrument |
It is workitem name that has to be locked.. |
|
RouteId |
Instrument |
It is route id that has to be locked. |
|
RouteName |
Instrument |
It is the route name that has to be locked |
|
WorkStageId |
Instrument |
It is the work stage id of the locked workitem |
|
ActivityName |
Instrument |
It is the Activity Name of the locked workitem |
|
PriorityLevel |
Instrument |
It is the Priority level of the locked workitem |
|
InstrumentStatus |
Instrument |
It is the Instrument status of the locked workitem |
|
LockStatus |
Instrument |
It is the Lock status of the locked workitem (whether locked or unlocked) |
|
LockedByUserName |
Instrument |
It is the locked by user name who has locked the workitem |
|
CreatedByUserName |
Instrument |
It is the user name which has created the locked workitem |
|
CreationDateTime |
Instrument |
It is the creation date time of the locked workitem |
|
WorkitemState |
Instrument |
It is the workitem state of the locked workitem |
|
CheckListCompleteFlag |
Instrument |
It is the flag for the check list. |
|
EntryDateTime |
Instrument |
It is the entry date time for the locked workitem |
|
LockedTime |
Instrument |
It is the time at which the workitem is locked. |
|
IntroductionDateTime |
Instrument |
It is the introduction date time of the locked workitem |
|
IntroducedBy |
Instrument |
It is the introduced by user for the workitem |
|
WorkItemId |
Instrument |
It is the work item id |
|
QueueName |
Instrument |
It is the Queue name of the locked workitem |
|
AssignmentType |
Instrument |
It is the Assignment Type of the locked workitem |
|
Name |
QueueData |
It is the name of the queue whose workitem has to be locked. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
15 |
WM_INVALID_FILTER |
The requested filter is invalid. |