Query Work Item
By using the Query Work Item activity, you can query work items based on the specified search criteria.
General
The General tab contains the following fields.
Field | Module Property? | Description |
---|---|---|
Name | No | The name of the activity in the process definition.
The default value is QueryWorkItem. |
MDM Connection | Yes | The MDM connection resource establishes a connection to an TIBCO® MDM server, allowing the plug-in to communicate with TIBCO® MDM.
Click
If no matching MDM connections are found, click Create Shared Resource to create one. |
State | Yes | Specify the state of the work items. Work items are filtered based on the selected work item’s state.
Click
|
Type | Yes | Specify the type of the work items. Work items are filtered based on the selected work item’s type.
Click
|
Document Type | Yes | Specify the document type associated with the work item. Work items are filtered based on the selected work item’s document type.
Click
|
Document Subtype | Yes | Specify document subtype associated with the work item. Work items are filtered based on the selected work item’s document subtype.
Click
|
Owner | Yes | The username of the work item owner. If the owner is not the same as the user who initiated the web service, the owner must have permissions to view the work items of other users. Work items are filtered based on the selected work item’s owner.
Click
|
Repository | No | The name of the repository associated with the work item. Work items are filtered based on the selected repository.
Click Select to open the Repository dialog. All available repositories are listed in the list of the dialog. Select one to apply to your current activity. |
Partner | Yes | Click
![]() |
Show Actions First | Yes | Select this check box to show the action work item first. Work item is sorted based on whether its type is an action item or a notification. |
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field | Module Property? | Description |
---|---|---|
Filter based on Record Attribute | No | Select the check box to filter work items based on the value of record attribute.
Note: When this check box is selected, the
RecordAttribute node appears in
WorkItem in the
Input tab.
|
Filter based on Custom Attribute | No | Select the check box to filter work items based on the custom attributes.
Note: When this check box is selected, the
CustomAttribute node appears in
WorkItem in the
Input tab.
|
Filter based on KeyWord | No | Select the check box to filter work items based on the key word.
Note: When this check box is selected, the
KeyWord node appears in
WorkItem in the
Input tab.
|
Filter based on Native Condition | No | Select the check box to filter work items based on specified search conditions.
Note: When this check box is selected, the
NativeCondition node appears in
WorkItem in the
Input tab.
|
Filter based on Data Pool | No | Select the check box to filter work items data pool.
Note: When this check box is selected, the
Datapool node appears in
WorkItem in the
Input tab.
|
Input
The following is the input for the activity.
Input Item | Description | |
---|---|---|
Pagination | Specify the pagination of queried work items.
|
|
DateRange | Specify the date range of the queried work items. Work items are filtered based on the date range, and the queried work items are created between
FromDate and
ToDate.
|
|
EventReference | Specify the event ID used to reference the event. Work items are filtered based on the Event ID. | |
RecordAttribute | Specify the value of record attributes. Work items are filtered based on the record attribute.
Note: This node appears only when the
Filter based on Record Attribute check box is selected in the
Advanced tab.
|
|
CustomAttribute | Specify user-defined attributes of the queried work items. Work items are filtered based on the custom attribute.
Note: This node appears only when the
Filter based on Custom Attribute check box is selected in the
Advanced tab.
|
|
KeyWord | Keywords are configured when a work item is created in the workflow. Work items are filtered based on the tagged keyword.
Note: This node appears only when the
Filter based on KeyWord check box is selected in the
Advanced tab.
|
|
NativeCondition | Specify the search condition. You can specify the key along with other conditions. The condition is applied as AND with other conditions and it is applied without any processing. If it is invalid, an SQL error is thrown. The application does not display the error.
Note: This node appears only when the
Filter based on Custom Attribute check box is selected in the
Advanced tab.
|
|
Datapool | Specify the data pool.
Note: This node appears only when the
Filter based on Datapool check box is selected in the
Advanced tab.
|
Output
The following is the output for the activity.
Output Item | Description | |
---|---|---|
Result | The execution result to indicate whether the execution has succeeded or not.
The node contains the following three elements:
|
|
Transaction | ||
Response | Return a list of work item information. For each work item,
WorkItemReference,
EventReference,
Organization,
State,
StateDescription,
CreationDate,
WorkItemType,
Description,
DocumentType,
DocumentTypeDescription,
DocumentSubtype,
DocumentSubtypeDescription,
Owner,
OwnerName,
OwnerType,
OriginalOwner,
OriginalOwnerName,
OriginalWorkItemID,
TaskType,
ActivityName,
Age, and Records related information including
MasterCatalogName,
ProductID,
ProductIDExt,
MODVersion are returned.
See for more information on other items. |
|
TransactionResult | Return the result of a transaction to indicate if the command has succeeded or not.
Success does not mean the successful completion of the command. However, a failure does mean that the command is aborted. The element also captures details such as Result, and SuccessCount.
|