Copyright © Cloud Software Group, Inc. All Rights Reserved

WorkQ

The following table lists the requests available in the WorkQ group. Click on the request name to view request parameter information.

 

Request Name	Description
GetWorkQ	Get the work queue
GetWorkItems MakeWorkItemList FetchWorkItemList FetchWorkItemListDelta FetchWorkItemListIfChanged GetAWorkItems MakeAWorkItemList FetchAWorkItemList FetchAWorkItemListDelta FetchAWorkItemListIfChanged MakeAWorkItemListJMS StartWorkQDeltaJMSPublish FetchAWorkItemListJMS	Get work items from the queue                     ,
StartCase	Start a case
LockItems LockFirstWorkItem LockFirstAWorkItem KeepItems ReleaseItems UndoItems UnlockItems	Process work items
GetForwardToWorkQIds ForwardItems	Forward work items
GetDefaultCriteria ChangeDefaultCriteria ClearDefaultCriteria	Manage default filter / sort criteria
GetForm	Get iProcess form information
AddCaseAuditEntry GetCustomAuditMsgDefs	Manage case audit trail

The Action Processor requests listed in this section must be enclosed in a <WorkQ> element.

 

 

WorkQ Group
Request Name	Parameters
GetWorkQ	WorkQTag
GetWorkItems	WorkQTag WorkItemTags WIContent
MakeWorkItemList	WorkQTag WICriteria WIContent StartIndex ReturnCount Hold
FetchWorkItemList	WorkQTag HeldId StartIndex ReturnCount Hold Refresh
FetchWorkItemListDelta	WorkQTag HeldId MaxCount Hold
FetchWorkItemListIfChanged	WorkQTag HeldId StartIndex ReturnCount Hold
GetAWorkItems	WorkQTag WorkItemTags AWIContent
MakeAWorkItemList	WorkQTag WICriteria AWIContent StartIndex ReturnCount Hold
FetchAWorkItemList	WorkQTag HeldId StartIndex ReturnCount Hold Refresh
FetchAWorkItemListDelta	WorkQTag HeldId MaxCount Hold
FetchAWorkItemListIfChanged	WorkQTag HeldId StartIndex ReturnCount Hold
MakeAWorkItemListJMS	WorkQTag WICriteria TopicName
StartWorkQDeltaJMSPublish	WICriteria HeldId WorkQDeltaId WorkQSyncId
FetchAWorkItemListJMS	WICriteria HeldId StartIndex ReturnCount
StartCase	WorkQTag ProcTag Description SubProcPrecedence StartStepName Fields ReleaseItem ValidateFields
LockItems	WorkQTag WorkItemTags WIFGContent
LockFirstWorkItem	HeldId StartIndex WIFGContent
LockFirstAWorkItem	HeldId StartIndex WIFGContent
KeepItems	WorkQTag WIFieldData ValidateFields
ReleaseItems	WorkQTag WIFieldData ValidateFields
UndoItems	WorkQTag WorkItemTags
UnlockItems	WorkQTag WorkItemTags
GetForwardToWorkQIds	WorkQTag WorkItemTag
ForwardItems	WorkQTag WorkItemTags DestWorkQTag
GetDefaultCriteria	WorkQTag
ChangeDefaultCriteria	WorkQTag WICriteria
ClearDefaultCriteria	WorkQTag
GetForm	WorkQTag ProcTag StepName
AddCaseAuditEntry	WorkQTag CaseTag StepName StepDescription UserName MessageId
GetCustomAuditMsgDefs	WorkQTag

 

Copyright © Cloud Software Group, Inc. All Rights Reserved