Provides methods to manage the activities such as allocate, reassign, take, complete, save, update, reset and cancel, and to retrieve activities of the current user’s work queue. More...
Public Member Functions | |
void | AddActivityResources (string sessionId, JobActivityIdentity jobActivityIdentity, ResourceIdentityCollection resourceIdentityCollection) |
Adds worker and/or group resources to a live activity. More... | |
void | AllocateActivities (string sessionId, ResourceIdentity resource, JobActivityIdentityCollection activities) |
Allocates one or more specified activities to the specified resource. More... | |
void | AllocateActivity (string sessionId, ResourceIdentity resource, JobActivityIdentity jobActivityIdentity) |
Allocates a specified activity of a job to a specified resource. More... | |
void | CancelActivity (string sessionId, JobActivityIdentity jobActivityIdentity) |
Cancels an activity in a job that has been selected for completion. More... | |
void | CompleteActivity (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityOutput jobActivityOutput) |
Completes an activity once it has been taken and subsequently performed by the appropriate resource. More... | |
JobProgressOutput | CompleteActivityAndProgress (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityOutput jobActivityOutput) |
Completes an activity once it has been taken and subsequently performed by the appropriate resource. In addition, any subsequent automatic activities are performed until the job is finished or only manual activities are pending. More... | |
void | CompleteActivityWithDocuments (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityWithDocumentsOutput jobActivityWithDocumentsOutput) |
Completes an activity once it has been taken and subsequently performed by the appropriate resource. More... | |
JobProgressOutput | CompleteActivityWithDocumentsAndProgress (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityWithDocumentsOutput jobActivityWithDocumentsOutput) |
Completes an activity with documents once it has been taken and subsequently performed by the appropriate resource. In addition, any subsequent automatic activities are performed until the job is finished or only manual activities are pending. More... | |
void | CompletePendingActivity (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityOutput jobActivityOutput) |
Completes a pending activity without having to take the activity first. More... | |
void | CompletePendingActivityWithDocuments (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityWithDocumentsOutput jobActivityWithDocumentsOutput) |
Completes the pending activity with documents without having to take the activity first. More... | |
void | CreateAdhocActivity (string sessionId, AdhocActivity adhocActivity) |
Creates an adhoc activity (an activity that is not normally part of the jobs associated process map) by dynamically inserting a new activity into an active job or case. This task then becomes available in the relevant resource’s work queue who can then take and complete it when required. More... | |
void | CreateAlertActivity (string sessionId, AlertActivity alertActivity) |
Creates an Alert activity on the specified job. Alert activities are not defined in the business process associated with the job i.e.; this API dynamically inserts a new alert activity into an active job. More... | |
void | DeleteActivityResources (string sessionId, JobActivityIdentity jobActivityIdentity, ResourceIdentityCollection resourceIdentityCollection) |
Deletes worker and/or group resources that are assigned to a live actvity. More... | |
ActivityList | GetActivities (string sessionId, JobActivityFilter2 jobActivityFilter) |
Please note that this function is deprecated. Please use GetActivities2 instead. Retrieves all the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority, on a list of job id's. More... | |
ActivityList | GetActivities2 (string sessionId, JobActivityFilter3 jobActivityFilter) |
Retrieves all the activities assigned to a resource based on the specified job activity filter criteria, such as activity name, priority or job ID. More... | |
int | GetActivitiesCountWithQuery (string sessionId, QueryIdentity queryIdentity, JobActivityQueryFilter jobActivityFilter) |
Retrieves a count of the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. More... | |
JobActivityInfoCollection | GetActivitiesInJobWithStatus (string sessionId, JobIdentity jobIdentity, short liveActivityStatus) |
Retrieves all the activities in a specified job that have a specified activity status. More... | |
JobActivitiesSummaryCollection | GetActivitiesSummary (string sessionId, JobActivitySummaryFilter activitySummaryFilter) |
Gets summary of activities using an activity filter. This API is used to get summary information in suitable format for dashboard charts. More... | |
ActivitiesSummaryResults | GetActivitiesSummaryWithQuery (string sessionId, QueryIdentity queryIdentity, ActivityField groupByField) |
Executes a supplied WorkQueue or System Query and based on the groupByField passed in, returns a summary of the query results and an overall total count. The query specifies filter criteria that are applied to the results. e.g. can filter on activity name, priority or Case Ref. More... | |
ActivityQueryResult | GetActivitiesWithQuery (string sessionId, bool useDefaultQuery, QueryIdentity queryIdentity, JobActivityQueryFilter jobActivityFilter) |
Please note that this function is deprecated. Please use GetActivitiesWithQuery2 instead. Retrieves all the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" are not specified, criteria specified in JobActivityFilter is considered. More... | |
ActivityQueryResult2 | GetActivitiesWithQuery2 (string sessionId, bool useDefaultQuery, QueryIdentity queryIdentity, JobActivityQueryFilter jobActivityFilter) |
Retrieves all the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. Optionally can request the activities count as well in the filter parameter. When select to return the activity count the number returned will be the number of activities and will not be restrained by the maximum number of activities to return filter parameter. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered. If "usedefaultquery" is false and "queryIdentity.Id" is not specified, and queryIdentity.QueryType is specified, criteria specified in JobActivityFilter is considered. More... | |
ActivityQueryResult2 | GetActivitiesWithQueryAndFilter (string sessionId, QueryIdentity queryIdentity, ActivityFieldValue activityFieldValue) |
Retrieves activities based on the specified query and a dynamic filter criteria defined in the ActivityFieldValue parameter. The ActivityFieldValue is used to update the filter parameters of the query with a dynamic value and allows the results to be further filtered based on this value. More... | |
ActivityNotification | GetActivityEmailSettings (string sessionId, ProcessIdentity processIdentity, NodeIdentity nodeIdentity, JobIdentity jobIdentity) |
Gets the settings for an e-mail activity in a specified job. More... | |
ResourceIdentityCollection | GetActivityUsableResources (string sessionId, JobActivityIdentity jobActivityIdentity) |
Retrieves the activity usable resources for the specified activity in a job. More... | |
JobActivityInfoCollection | GetAllTakenActivities (string sessionId) |
Retrieves all current taken activities in Kofax TotalAgility. More... | |
int | GetAssignedActivityCountForResource (string sessionId, ResourceIdentity resourceIdentity, ActivityCountFilter activityCountFilter) |
Retrieves the number of activities assigned to a specified resource. More... | |
ActivitySettings | GetCaptureActivitySettings (string sessionId, ProcessActivityIdentity activityIdentity) |
Gets the settings of a specified capture activity. More... | |
JobHistoryCollection | GetCompletedActivitiesForResource (string sessionId, ResourceIdentity resourceIdentity, CompletedActivitiesFilter activitiesFilter) |
Retrieves a collection of activities completed for a specified resource. More... | |
TimePeriod | GetExpectedDurationForActivities (string sessionId, JobActivityIdentityCollection jobActivityIdentityCollection) |
Retrieves the sum of the expected duration for the specified activities. More... | |
JobActivityInfo | GetJobActivityInfo (string sessionId, JobActivityIdentity jobActivityIdentity, string simulationId) |
Please note that this function is deprecated. Please use GetJobActivityInfo4 instead. Retrieves details of a specified activity in a job. Only applies to normal activities, not automatic. More... | |
JobActivityInfo2 | GetJobActivityInfo2 (string sessionId, JobActivityIdentity2 jobActivityIdentity, string simulationId) |
Please note that this function is deprecated. Please use GetJobActivityInfo4 instead. Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic. More... | |
JobActivityInfo3 | GetJobActivityInfo3 (string sessionId, JobActivityIdentity2 jobActivityIdentity) |
Please note that this function is deprecated. Please use GetJobActivityInfo4 instead. Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic. More... | |
JobActivityInfo4 | GetJobActivityInfo4 (string sessionId, JobActivityIdentity2 jobActivityIdentity) |
Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic. More... | |
string | GetLiveUsableResourceEmailAddresses (string sessionId, JobActivityIdentity jobActivityIdentity, short sendTo) |
Retrieves the email addresses of the usable resources for a specified activity. More... | |
int | GetNumberOfActivities (string sessionId, JobActivityCountFilter jobActivityCountFilter) |
Returns a count of the live activities based on the filter specified. More... | |
JobActivityInfoCollection | GetTakenActivitiesForResource (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the taken activities for the specified resource. More... | |
WorkQueue | GetWorkQueue (string sessionId, JobActivityFilter jobActivityFilter) |
Please note that this function is deprecated. Please use GetWorkQueue2 instead. Retrieves a collection of live activities for a resource. Only activities that the resource has the relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered. More... | |
WorkQueue2 | GetWorkQueue2 (string sessionId, JobActivityFilter3 jobActivityFilter) |
Retrieves a collection of live activities for a resource. Only activities that the resource has the relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered. More... | |
int | GetWorkQueueCountWithQuery (string sessionId, QueryIdentity queryIdentity, JobActivityQueryFilter jobActivityFilter) |
Retrieves a count of the workqueue activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. The number returned will be the number of activities and will not be restrained by the maximum number of activities to return filter parameter. If "queryIdentity" is specified, criteria specified in query is considered. If "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered. More... | |
WorkQueueOverview | GetWorkQueueOverview (string sessionId, ResourceIdentity resource, WorkQueueOverviewFilter activityFilter) |
Retrieves details of the activity workloads for the specified resource. More... | |
WorkQueueQueryResult | GetWorkQueueWithQuery (string sessionId, bool useDefaultQuery, QueryIdentity queryIdentity, JobActivityQueryFilter jobActivityFilter) |
Please note that this function is deprecated. Please use GetWorkQueueWithQuery2 instead. Retrieves a collection of live activities for a resource. Only those activities that the resource has relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered. More... | |
WorkQueueQueryResult2 | GetWorkQueueWithQuery2 (string sessionId, bool useDefaultQuery, QueryIdentity queryIdentity, JobActivityQueryFilter jobActivityFilter) |
Retrieves a collection of live activities for a resource. Only activities that the resource has the relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered. Can optionally request to return the actvities count using filter parameter. When select to return the activity count the number returned will be the number of activities and will not be restrained by the maximum number of activities to return filter parameter. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered. More... | |
WorkSummary | GetWorkSummary (string sessionId, WorkSummaryFilter filter) |
Please note that this function is deprecated. Please use GetWorkSummary2 instead. Retrieves the work summary for the current logged on user based on the filter criteria. More... | |
WorkSummary | GetWorkSummary2 (string sessionId, WorkSummaryFilter2 filter) |
Retrieves the work summary based on the filter criteria. More... | |
void | PartiallyCompleteActivity (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityOutput jobActivityOutput) |
Partially completes the automatic capture activity for which the partial completion property is set to true. More... | |
void | PerformAutoWorkAllocation (string sessionId, AutoWorkAllocationOptions filter) |
Performs automatic work allocation based on the specified allocation options in the filter parameter. More... | |
void | ReassignActivities (string sessionId, ResourceIdentity originalResource, ResourceIdentity newResource, JobActivityIdentityCollection jobActivityIdentities) |
Reassigns one or more activities from one resource to another resource. More... | |
void | ReassignActivity (string sessionId, ResourceIdentity originalResource, ResourceIdentity newResource, JobActivityIdentity jobActivityIdentity) |
Reassigns a specified activity of a specified job from one resource to another resource. More... | |
void | ReassignAllActivities (string sessionId, ResourceIdentity originalResource, ResourceIdentity newResource) |
Reassigns all live activities assigned to a resource to a different resource. More... | |
void | ResetTakenActivities (string sessionId, JobActivityIdentityCollection activitiesToReset) |
Resets the specified taken activities. The activities will be reset from Taken to Pending status. More... | |
void | ResetTakenActivitiesForResource (string sessionId, ResourceIdentity resource) |
Resets the taken activities for the specified resource. More... | |
void | SaveActivity (string sessionId, JobActivityIdentity jobActivityIdentity, JobActivityOutput jobActivityOutput) |
Saves the taken activity with the output variable values. More... | |
JobActivity | TakeActivity (string sessionId, JobActivityIdentity jobActivityIdentity) |
Takes an activity for completion. More... | |
JobActivity | TakeActivityFromJob (string sessionId, JobIdentity jobIdentity) |
Takes an activity from the work queue of the logged on user for a specified job. More... | |
JobActivity | TakeAnyActivity (string sessionId) |
Takes any activity from the work queue of the logged on user. More... | |
NextActivity | TakeNextActivity (string sessionId, bool useCombinedWorkQueue) |
Please note that this function is deprecated. Please use TakeNextActivity2 instead. Takes the next activity from the workqueue of the current logged on user. More... | |
NextActivity | TakeNextActivity2 (string sessionId, TakeNextActivityFilter filter) |
Retrieves the next activity based on the work allocation rule associated with the logged on resource's working group. More... | |
void | UpdateActivityDueDate (string sessionId, JobActivityIdentity jobActivityIdentity, DateTime dueDate, bool resetException) |
Updates the due date of a specified activity. More... | |
void | UpdateActivityPriority (string sessionId, JobActivityIdentity jobActivityIdentity, short activityPriority) |
Updates the priority of a specified activity in a job. More... | |
void | UpdateActivityResources (string sessionId, JobActivityIdentity jobActivityIdentity, ResourceIdentityCollection resourceIdentityCollection) |
Updates the assigned resources on a live activity, by removing the current resources and replacing with new resources. More... | |
Provides methods to manage the activities such as allocate, reassign, take, complete, save, update, reset and cancel, and to retrieve activities of the current user’s work queue.
void AddActivityResources | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
ResourceIdentityCollection | resourceIdentityCollection | ||
) |
Adds worker and/or group resources to a live activity.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity in a job to which the resources are to be added.
| ||||||||||||||||||||
resourceIdentityCollection | A ResourceIdentityCollection collection object of resources to assign to the activity. ResourceIdentity members.
|
void AllocateActivities | ( | string | sessionId, |
ResourceIdentity | resource, | ||
JobActivityIdentityCollection | activities | ||
) |
Allocates one or more specified activities to the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
resource | A ResourceIdentity identity object containing the resource to allocate to the activities. ResourceIdentity can be null.
| ||||||||||||||||||||
activities | A JobActivityIdentityCollection collection object that contains one or more activities of type JobActivityIdentity to allocate.
|
void AllocateActivity | ( | string | sessionId, |
ResourceIdentity | resource, | ||
JobActivityIdentity | jobActivityIdentity | ||
) |
Allocates a specified activity of a job to a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
resource | A ResourceIdentity object that contains the resource to allocate to the activity. ResourceIdentity can be null..
| ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify an activity in a job that is to be allocated.
|
void CancelActivity | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity | ||
) |
Cancels an activity in a job that has been selected for completion.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to cancel in an active job.
|
void CompleteActivity | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityOutput | jobActivityOutput | ||
) |
Completes an activity once it has been taken and subsequently performed by the appropriate resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to complete in an active job.
| ||||||||||||||||||||
jobActivityOutput | A JobActivityOutput object which contains a collection of 0 or more variable values to update in the job. Once the activity is complete, the variables in the job are updated with the corresponding values.
|
JobProgressOutput CompleteActivityAndProgress | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityOutput | jobActivityOutput | ||
) |
Completes an activity once it has been taken and subsequently performed by the appropriate resource. In addition, any subsequent automatic activities are performed until the job is finished or only manual activities are pending.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to complete in an active job.
| ||||||||||||||||||||
jobActivityOutput | A JobActivityOutput object which contains 0 or more variable values to update in the job. Once the activity is complete, the variables in the job are updated with the corresponding values.
|
void CompleteActivityWithDocuments | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityWithDocumentsOutput | jobActivityWithDocumentsOutput | ||
) |
Completes an activity once it has been taken and subsequently performed by the appropriate resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to complete in an active job.
| ||||||||||||||||||||
jobActivityWithDocumentsOutput | A JobActivityWithDocumentsOutput object that contains a collection of 0 or more variable values to update in the job. Once the activity is complete, the variables in the job are updated with the corresponding values.
|
JobProgressOutput CompleteActivityWithDocumentsAndProgress | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityWithDocumentsOutput | jobActivityWithDocumentsOutput | ||
) |
Completes an activity with documents once it has been taken and subsequently performed by the appropriate resource. In addition, any subsequent automatic activities are performed until the job is finished or only manual activities are pending.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to complete in an active job.
| ||||||||||||||||||||
jobActivityWithDocumentsOutput | A JobActivityWithDocumentsOutput object that contains a collection of 0 or more variable values to update in the job. Once the activity is complete, the variables in the job are updated with the corresponding values.
|
void CompletePendingActivity | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityOutput | jobActivityOutput | ||
) |
Completes a pending activity without having to take the activity first.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to complete in an active job.
| ||||||||||||||||||||
jobActivityOutput | A JobActivityOutput object which contains a collection of 0 or more variable values to update in the job. Once the activity is complete, the variables in the job are updated with the corresponding values.
|
void CompletePendingActivityWithDocuments | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityWithDocumentsOutput | jobActivityWithDocumentsOutput | ||
) |
Completes the pending activity with documents without having to take the activity first.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity to complete in an active job.
| ||||||||||||||||||||
jobActivityWithDocumentsOutput | A JobActivityWithDocumentsOutput object which contains a collection of 0 or more variable values to update in the job. Once the activity is complete the variables in the job with be updated with the corresponding values.
|
void CreateAdhocActivity | ( | string | sessionId, |
AdhocActivity | adhocActivity | ||
) |
Creates an adhoc activity (an activity that is not normally part of the jobs associated process map) by dynamically inserting a new activity into an active job or case. This task then becomes available in the relevant resource’s work queue who can then take and complete it when required.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||
adhocActivity | An AdhocActivity object that contains the job to add the activity to and the details of the actual ad hoc activity.
|
void CreateAlertActivity | ( | string | sessionId, |
AlertActivity | alertActivity | ||
) |
Creates an Alert activity on the specified job. Alert activities are not defined in the business process associated with the job i.e.; this API dynamically inserts a new alert activity into an active job.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||
alertActivity | An AlertActivity object that contains the job to which to add the activity and the details of the actual alert activity.
|
void DeleteActivityResources | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
ResourceIdentityCollection | resourceIdentityCollection | ||
) |
Deletes worker and/or group resources that are assigned to a live actvity.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity in a job from where to delete resources.
| ||||||||||||||||||||
resourceIdentityCollection | A ResourceIdentityCollection collection object that contains a collection of resources to remove from the activity. ResourceIdentity members.
|
ActivityList GetActivities | ( | string | sessionId, |
JobActivityFilter2 | jobActivityFilter | ||
) |
Please note that this function is deprecated. Please use GetActivities2 instead.
Retrieves all the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority, on a list of job id's.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A comprehensive JobActivityFilter2 object that is used to filter the list of activities returned.
|
Enumeration | Description |
---|---|
1 | Manual Ordinary |
4 | Manual Script |
8 | Manual Create New Job |
32 | Manual Web Service |
64 | Manual CSharp |
128 | Manual VBNet |
256 | Manual Adhoc |
512 | Manual Mobile |
1024 | Manual Alert Task |
2048 | Manual Document Review |
4096 | Manual Validation Capture |
8192 | Manual Verification Capture |
16384 | Manual Scan Capture |
32768 | All Manual Activities |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
Enumeration | Description |
---|---|
0 | Pending Activity |
1 | Active Activity |
2 | Offered Activity |
3 | Suspended Activity |
4 | Activity Locked |
5 | Active Activity No Evaluation |
128 | All Live Activities |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
ActivityList GetActivities2 | ( | string | sessionId, |
JobActivityFilter3 | jobActivityFilter | ||
) |
Retrieves all the activities assigned to a resource based on the specified job activity filter criteria, such as activity name, priority or job ID.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A comprehensive JobActivityFilter3 object that is used to filter the list of activities returned. See the JobActivityFilter3 class for a description of filter options.
|
Enumeration | Description |
---|---|
0 | SLA Status 1 |
1 | SLA Status 2 |
2 | SLA Status 3 |
3 | SLA Status 4 |
4 | SLA Status 5 |
Enumeration | Description |
---|---|
1 | Manual Ordinary |
4 | Manual Script |
8 | Manual Create New Job |
32 | Manual Web Service |
64 | Manual CSharp |
128 | Manual VBNet |
256 | Manual Adhoc |
512 | Manual Mobile |
1024 | Manual Alert Task |
2048 | Manual Document Review |
4096 | Manual Validation Capture |
8192 | Manual Verification Capture |
16384 | Manual Scan Capture |
32768 | All Manual Activities |
Enumeration | Description |
---|---|
0 | SLA Status 1 |
1 | SLA Status 2 |
2 | SLA Status 3 |
3 | SLA Status 4 |
4 | SLA Status 5 |
Enumeration | Description |
---|---|
0 | The exclude MFP only |
1 | The MFP friendly and MFP only |
Enumeration | Description |
---|---|
0 | Activities are filtered based on activity priority due date |
1 | Activities are filtered based on job priority due date |
Enumeration | Description |
---|---|
1 | Pending Activity |
2 | Active Activity |
4 | Suspended Activity |
8 | Offered Activity |
16 | On Hold |
32 | Active But Not Awaiting Events (Deprecated. It is now the same as Active Activity enum value. Active no longer filters on AwaitingEvents.) |
64 | Awaiting Allocation |
128 | Awaiting Events |
256 | Saved |
512 | Active Activity Pending Completion |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
int GetActivitiesCountWithQuery | ( | string | sessionId, |
QueryIdentity | queryIdentity, | ||
JobActivityQueryFilter | jobActivityFilter | ||
) |
Retrieves a count of the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryIdentity | The QueryIdentity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityQueryFilter object. An extension of the comprehensive JobActivityFilter3 object that is used to filter the list of activities returned. Look at JobActivityFilter3 class to see description of filter options. The additional options over those supplied by the JobActivityFilter3 class are the AssignedResourceFilter and DueDateFilterType options.
|
Enumeration | Description |
---|---|
0 | None |
1 | Ordinary Activity node |
2 | Decision node |
3 | Embedded Process node |
4 | Library node |
5 | Start Point node |
6 | End Point node |
7 | Script Activity node |
8 | COM Activity node |
9 | Transactional Activity node |
10 | DotNet Activity node |
11 | Web Service Activity node |
12 | Xml Activity node |
13 | CSharp Activity node |
14 | VBNet Activity node |
15 | Create New Job Activity node |
16 | Create Sub Job Activity node |
17 | Data Access Activity node |
18 | Design Activity node |
19 | Event Activity node |
20 | Resource Info Activity node |
21 | Job Owner Activity node |
22 | Job Variable Info Activity node |
23 | Sleep Activity node |
24 | Synchronization Activity node |
25 | Extraction Capture Activity node |
26 | Separation Classification Capture Activity node |
27 | Scan Capture Activity node |
28 | Validation Capture Activity node |
29 | Verification Capture Activity node |
30 | Document Review Capture Activity node |
32 | Loop Activity node. Skipped value 31 deliberately |
33 | Expression Activity node |
34 | SharePoint Create Site node |
35 | SharePoint Create Folder node |
36 | SharePoint Add Item node |
37 | SharePoint DeleteItem node |
38 | SharePoint UpLoader node |
39 | SharePoint Move Item node |
40 | SharePoint Get Document node |
41 | PDF Generation Activity node |
99 | Custom node |
101 | Business Rule node |
102 | Email Activity node |
103 | Customer Data node |
104 | RESTful Service node |
105 | Document Generation Activity node |
106 | Dynamics CRM node |
107 | Ready For Review node |
108 | Image Processing node |
109 | Composite node |
110 | CMIS Get Document node |
111 | Trim Create Folder node |
112 | Trim Add Document node |
113 | CMIS Add Document node |
114 | CMIS Update Document node |
115 | Trim Get Document node |
116 | CMIS Create Folder node |
117 | CMIS Check In Document node |
118 | CMIS Cancel Checkout Document node |
119 | CMIS Find Document node |
120 | Exchange Server Get Attachments node |
121 | Capture Delete node |
122 | Capture Export node |
123 | Dynamics AX node |
124 | Dynamics AX Search node |
125 | RPA node |
126 | Transfer Activity node |
127 | Document State node |
128 | Document Received node |
129 | Evaluate Document Set node |
130 | Add DocumentType node |
131 | Softpro Sign Documents node |
132 | CCM Compose node |
133 | CCM Distribute node |
Enumeration | Description |
---|---|
1 | ManualOrdinary |
4 | ManualScript |
8 | ManualCreateNewJob |
32 | ManualWebService |
64 | ManualCSharp |
128 | ManualVBNet |
256 | ManualAdhoc |
512 | ManualMobile |
1024 | ManualAlertTask |
Enumeration | Description |
---|---|
-1 | None |
0 | The resource |
1 | The resource and its groups |
2 | The direct subordinates of the resource |
3 | The resource and its direct subordinates |
4 | The indirect subordinates of the resource |
5 | The resource and its indirect subordinates |
6 | The core worker service |
7 | The transformation server service |
8 | The export service |
9 | The system. Includes core worker, transformation server and export services |
10 | A worker or a group resource |
11 | Any role, resource or group |
Enumeration | Description |
---|---|
0 | All |
1 | Due date since |
2 | Due date between |
3 | Due date of today |
4 | Due date of this week |
5 | Due date of this month |
6 | Due date of this year |
Enumeration | Description |
---|---|
0 | The exclude MFP only |
1 | The MFP friendly and MFP only |
Enumeration | Description |
---|---|
0 | All i.e. do not use the pending time filter |
1 | Activity has been pending for less than five minutes |
2 | Activity has been pending for more than five minutes |
3 | Activity has been pending for less than fifteen minutes |
4 | Activity has been pending for more than fifteen minutes |
5 | Activity has been pending for less than thirty minutes |
6 | Activity has been pending for more than thirty minutes |
7 | Activity has been pending for less than sixty minutes |
8 | Activity has been pending for more than sixty minutes |
9 | Activity has been pending for less than one day |
10 | Activity has been pending for more than one day |
11 | Activity has been pending for less than one week |
12 | Activity has been pending for more than one week |
13 | Activity has been pending for less than one month |
14 | Activity has been pending for more than one month |
Enumeration | Description |
---|---|
0 | Activities are filtered based on activity priority due date. |
1 | Activities are filtered based on job priority due date. |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
JobActivityInfoCollection GetActivitiesInJobWithStatus | ( | string | sessionId, |
JobIdentity | jobIdentity, | ||
short | liveActivityStatus | ||
) |
Retrieves all the activities in a specified job that have a specified activity status.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||
jobIdentity | A JobIdentity identity object which the required list of activities is associated with.
| ||||||||||||||||||||||||||
liveActivityStatus | Get all activities that have this activity status.
|
JobActivitiesSummaryCollection GetActivitiesSummary | ( | string | sessionId, |
JobActivitySummaryFilter | activitySummaryFilter | ||
) |
Gets summary of activities using an activity filter. This API is used to get summary information in suitable format for dashboard charts.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activitySummaryFilter | A comprehensive JobActivitySummaryFilter object that is used to filter activities. Can specify to filter on process, activity, activity status etc. The filter itself needs to be not null, but none of the various filter settings is required.
|
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
Enumeration | Description |
---|---|
1 | Pending Activity |
2 | Active Activity |
4 | Suspended Activity |
8 | Offered Activity |
16 | On Hold |
32 | Active But Not Awaiting Events |
64 | Awaiting Allocation |
128 | Awaiting Events |
256 | Saved |
512 | Active Activity Pending Completion |
Enumeration | Description |
---|---|
0 | Individual Only |
1 | Group Only |
2 | Both |
Enumeration | Description |
---|---|
0 | Field Not Used |
1 | Status |
2 | Assigned To |
3 | Process Name |
4 | Process Version |
5 | Activity Name |
6 | Due Date |
7 | Priority |
8 | Sla |
9 | Job Sla |
10 | Job State |
Enumeration | Description |
---|---|
0 | Count |
1 | Sum |
2 | Average |
3 | Minimum |
4 | Maximum |
Enumeration | Description |
---|---|
-1 | None |
0 | Pending |
1 | Active |
2 | Offered |
3 | Suspended |
4 | Locked |
5 | Active Activity Pending Completion |
7 | On Hold |
8 | Awaiting Event |
9 | Awaiting Allocation |
10 | Saved |
128 | Live |
129 | In History |
ActivitiesSummaryResults GetActivitiesSummaryWithQuery | ( | string | sessionId, |
QueryIdentity | queryIdentity, | ||
ActivityField | groupByField | ||
) |
Executes a supplied WorkQueue or System Query and based on the groupByField passed in, returns a summary of the query results and an overall total count.
The query specifies filter criteria that are applied to the results. e.g. can filter on activity name, priority or Case Ref.
sessionId | A string that uniquely identifies the session for the current logged on user. If the sessionId is invalid then an exception will be raised. | ||||||||||||||||
queryIdentity | A QueryIdentity object that can be used to specify a WorkQueue or System Query.
| ||||||||||||||||
groupByField | A ActivityField object used to specify the field to group the results by. See Remarks section of this API to get more information.
|
Enumeration | Description |
---|---|
1 | Activity Status Field |
2 | Activity Assigned To Field |
3 | Activity Process Name Field |
5 | Activity Name Field |
7 | Priority Field (GroupBy is based on PriorityType in the selected query. For example, if the PriorityType is "Job", grouping is on Job priorities. |
8 | Activity RAG Field |
9 | Job RAG Field |
10 | Job State Field |
11 | Case Reference |
12 | Activity Type |
13 | Work Type |
14 | Pending Time |
15 | Design Activity Type |
16 | The Activity WorkType Field |
ActivityQueryResult GetActivitiesWithQuery | ( | string | sessionId, |
bool | useDefaultQuery, | ||
QueryIdentity | queryIdentity, | ||
JobActivityQueryFilter | jobActivityFilter | ||
) |
Please note that this function is deprecated. Please use GetActivitiesWithQuery2 instead.
Retrieves all the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" are not specified, criteria specified in JobActivityFilter is considered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useDefaultQuery | if set to true [use default query]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryIdentity | The QueryIdentity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityQueryFilter object. An extension of the comprehensive JobActivityFilter3 object that is used to filter the list of activities returned.
|
Enumeration | Description |
---|---|
0 | None |
1 | Ordinary Activity node |
2 | Decision node |
3 | Embedded Process node |
4 | Library node |
5 | Start Point node |
6 | End Point node |
7 | Script Activity node |
8 | COM Activity node |
9 | Transactional Activity node |
10 | DotNet Activity node |
11 | Web Service Activity node |
12 | Xml Activity node |
13 | CSharp Activity node |
14 | VBNet Activity node |
15 | Create New Job Activity node |
16 | Create Sub Job Activity node |
17 | Data Access Activity node |
18 | Design Activity node |
19 | Event Activity node |
20 | Resource Info Activity node |
21 | Job Owner Activity node |
22 | Job Variable Info Activity node |
23 | Sleep Activity node |
24 | Synchronization Activity node |
25 | Extraction Capture Activity node |
26 | Separation Classification Capture Activity node |
27 | Scan Capture Activity node |
28 | Validation Capture Activity node |
29 | Verification Capture Activity node |
30 | Document Review Capture Activity node |
32 | Loop Activity node. Skipped value 31 deliberately |
33 | Expression Activity node |
34 | SharePoint Create Site node |
35 | SharePoint Create Folder node |
36 | SharePoint Add Item node |
37 | SharePoint DeleteItem node |
38 | SharePoint UpLoader node |
39 | SharePoint Move Item node |
40 | SharePoint Get Document node |
41 | PDF Generation Activity node |
99 | Custom node |
101 | Business Rule node |
102 | Email Activity node |
103 | Customer Data node |
104 | RESTful Service node |
105 | Document Generation Activity node |
106 | Dynamics CRM node |
107 | Ready For Review node |
108 | Image Processing node |
109 | Composite node |
110 | CMIS Get Document node |
111 | Trim Create Folder node |
112 | Trim Add Document node |
113 | CMIS Add Document node |
114 | CMIS Update Document node |
115 | Trim Get Document node |
116 | CMIS Create Folder node |
117 | CMIS Check In Document node |
118 | CMIS Cancel Checkout Document node |
119 | CMIS Find Document node |
120 | Exchange Server Get Attachments node |
121 | Capture Delete node |
122 | Capture Export node |
123 | Dynamics AX node |
124 | Dynamics AX Search node |
125 | RPA node |
126 | Transfer Activity node |
127 | Document State node |
128 | Document Received node |
129 | Evaluate Document Set node |
130 | Add DocumentType node |
131 | Softpro Sign Documents node |
132 | CCM Compose node |
133 | CCM Distribute node |
Enumeration | Description |
---|---|
1 | ManualOrdinary |
4 | ManualScript |
8 | ManualCreateNewJob |
32 | ManualWebService |
64 | ManualCSharp |
128 | ManualVBNet |
256 | ManualAdhoc |
512 | ManualMobile |
1024 | ManualAlertTask |
Enumeration | Description |
---|---|
-1 | None |
0 | The resource |
1 | The resource and its groups |
2 | The direct subordinates of the resource |
3 | The resource and its direct subordinates |
4 | The indirect subordinates of the resource |
5 | The resource and its indirect subordinates |
6 | The core worker service |
7 | The transformation server service |
8 | The export service |
9 | The system. Includes core worker, transformation server and export services |
10 | A worker or a group resource |
11 | Any role, resource or group |
Enumeration | Description |
---|---|
0 | All |
1 | Due date since |
2 | Due date between |
3 | Due date of today |
4 | Due date of this week |
5 | Due date of this month |
6 | Due date of this year |
Enumeration | Description |
---|---|
0 | The exclude MFP only |
1 | The MFP friendly and MFP only |
Enumeration | Description |
---|---|
0 | All i.e. do not use the pending time filter |
1 | Activity has been pending for less than five minutes |
2 | Activity has been pending for more than five minutes |
3 | Activity has been pending for less than fifteen minutes |
4 | Activity has been pending for more than fifteen minutes |
5 | Activity has been pending for less than thirty minutes |
6 | Activity has been pending for more than thirty minutes |
7 | Activity has been pending for less than sixty minutes |
8 | Activity has been pending for more than sixty minutes |
9 | Activity has been pending for less than one day |
10 | Activity has been pending for more than one day |
11 | Activity has been pending for less than one week |
12 | Activity has been pending for more than one week |
13 | Activity has been pending for less than one month |
14 | Activity has been pending for more than one month |
Enumeration | Description |
---|---|
0 | Activities are filtered based on activity priority due date. |
1 | Activities are filtered based on job priority due date. |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
1 | Status. This can be used in sorting for system query only and is invalid for work queue query |
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
12 | Activity Type. This can be used in sorting for system query only and is invalid for work queue query. |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
ActivityQueryResult2 GetActivitiesWithQuery2 | ( | string | sessionId, |
bool | useDefaultQuery, | ||
QueryIdentity | queryIdentity, | ||
JobActivityQueryFilter | jobActivityFilter | ||
) |
Retrieves all the activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. Optionally can request the activities count as well in the filter parameter. When select to return the activity count the number returned will be the number of activities and will not be restrained by the maximum number of activities to return filter parameter. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered. If "usedefaultquery" is false and "queryIdentity.Id" is not specified, and queryIdentity.QueryType is specified, criteria specified in JobActivityFilter is considered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useDefaultQuery | if set to true [use default query]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryIdentity | The QueryIdentity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityQueryFilter object. An extension of the comprehensive JobActivityFilter3 object that is used to filter the list of activities returned.
|
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for PendingTimeFilter setting follows.
Enumeration | Description |
---|---|
0 | All i.e. do not use the pending time filter |
1 | Activity has been pending for less than five minutes |
2 | Activity has been pending for more than five minutes |
3 | Activity has been pending for less than fifteen minutes |
4 | Activity has been pending for more than fifteen minutes |
5 | Activity has been pending for less than thirty minutes |
6 | Activity has been pending for more than thirty minutes |
7 | Activity has been pending for less than sixty minutes |
8 | Activity has been pending for more than sixty minutes |
9 | Activity has been pending for less than one day |
10 | Activity has been pending for more than one day |
11 | Activity has been pending for less than one week |
12 | Activity has been pending for more than one week |
13 | Activity has been pending for less than one month |
14 | Activity has been pending for more than one month |
The enumeration for AssignedResourceFilter setting follows.
Enumeration | Description |
---|---|
-1 | None |
0 | The resource |
1 | The resource and its groups |
2 | The direct subordinates of the resource |
3 | The resource and its direct subordinates |
4 | The indirect subordinates of the resource |
5 | The resource and its indirect subordinates |
6 | The core worker service |
7 | The transformation server service |
8 | The export service |
9 | The system. Includes core worker, transformation server and export services |
10 | A worker or a group resource |
11 | Any role, resource or group |
The enumeration for DueDateFilterType setting follows.
Enumeration | Description |
---|---|
0 | All |
1 | Due date since |
2 | Due date between |
3 | Due date of today |
4 | Due date of this week |
5 | Due date of this month |
6 | Due date of this year |
The enumeration for ActivityTypeFilters filter setting follows. If, for example you wanted only activities of type ManualOrdinary and ManualAdhoc you would supply 257 (i.e. 1 + 256)
Enumeration | Description |
---|---|
1 | ManualOrdinary |
4 | ManualScript |
8 | ManualCreateNewJob |
32 | ManualWebService |
64 | ManualCSharp |
128 | ManualVBNet |
256 | ManualAdhoc |
512 | ManualMobile |
1024 | ManualAlertTask |
The enumeration for UsePrioritySetting filter setting follows.
Enumeration | Description |
---|---|
0 | NotUsingPriority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | UsingPriority - The work queue will be returned in order of priority. |
2 | UsingStartPriority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | UsingSpecificPriority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
The enumeration for StatusFilter setting follows.
Enumeration | Description |
---|---|
1 | PendingActivity |
2 | ActiveActivity |
4 | SuspendedActivity |
8 | OfferedActivity |
16 | OnHold |
32 | ActiveButNotAwaitingEvents |
64 | AwaitingAllocation |
128 | AwaitingEvents |
256 | Saved |
512 | ActiveActivityPendingCompletion |
The enumeration for ActivityDesignType setting follows.
Enumeration | Description |
---|---|
0 | None |
1 | Ordinary Activity node |
2 | Decision node |
3 | Embedded Process node |
4 | Library node |
5 | Start Point node |
6 | End Point node |
7 | Script Activity node |
8 | COM Activity node |
9 | Transactional Activity node |
10 | DotNet Activity node |
11 | Web Service Activity node |
12 | Xml Activity node |
13 | CSharp Activity node |
14 | VBNet Activity node |
15 | Create New Job Activity node |
16 | Create Sub Job Activity node |
17 | Data Access Activity node |
18 | Design Activity node |
19 | Event Activity node |
20 | Resource Info Activity node |
21 | Job Owner Activity node |
22 | Job Variable Info Activity node |
23 | Sleep Activity node |
24 | Synchronization Activity node |
25 | Extraction Capture Activity node |
26 | Separation Classification Capture Activity node |
27 | Scan Capture Activity node |
28 | Validation Capture Activity node |
29 | Verification Capture Activity node |
30 | Document Review Capture Activity node |
32 | Loop Activity node. Skipped value 31 deliberately |
33 | Expression Activity node |
34 | SharePoint Create Site node |
35 | SharePoint Create Folder node |
36 | SharePoint Add Item node |
37 | SharePoint DeleteItem node |
38 | SharePoint UpLoader node |
39 | SharePoint Move Item node |
40 | SharePoint Get Document node |
41 | PDF Generation Activity node |
99 | Custom node |
101 | Business Rule node |
102 | Email Activity node |
103 | Customer Data node |
104 | RESTful Service node |
105 | Document Generation Activity node |
106 | Dynamics CRM node |
107 | Ready For Review node |
108 | Image Processing node |
109 | Composite node |
110 | CMIS Get Document node |
111 | Trim Create Folder node |
112 | Trim Add Document node |
113 | CMIS Add Document node |
114 | CMIS Update Document node |
115 | Trim Get Document node |
116 | CMIS Create Folder node |
117 | CMIS Check In Document node |
118 | CMIS Cancel Checkout Document node |
119 | CMIS Find Document node |
120 | Exchange Server Get Attachments node |
121 | Capture Delete node |
122 | Capture Export node |
123 | Dynamics AX node |
124 | Dynamics AX Search node |
125 | RPA node |
126 | Transfer Activity node |
127 | Document State node |
128 | Document Received node |
129 | Evaluate Document Set node |
130 | Add DocumentType node |
131 | Softpro Sign Documents node |
132 | CCM Compose node |
133 | CCM Distribute node |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
1 | Status. This can be used in sorting for system query only and is invalid for work queue query |
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
12 | Activity Type. This can be used in sorting for system query only and is invalid for work queue query. |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
ActivityQueryResult2 GetActivitiesWithQueryAndFilter | ( | string | sessionId, |
QueryIdentity | queryIdentity, | ||
ActivityFieldValue | activityFieldValue | ||
) |
Retrieves activities based on the specified query and a dynamic filter criteria defined in the ActivityFieldValue parameter. The ActivityFieldValue is used to update the filter parameters of the query with a dynamic value and allows the results to be further filtered based on this value.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
queryIdentity | The unique identity of the query. This will be used to get the filter of the query to which the dynamic field will be applied
| ||||||||||||||||
activityFieldValue | Contains the filter field and value that will be used to dynamically update the query filter parameters and only have results returned that match the updated filter parameters. |
Name | Type | Comment | Required |
---|---|---|---|
FieldType | short | The field type that the dynamic filter applies to. See table below for valid values | Yes |
MetaDataFieldName | string | This field should be populated if the FieldType is a WorkType Field and should hold the Name of the work type field | Yes |
FieldValue | object | The value of the field that should be used to update the filter | Yes |
Enumeration | Description |
---|---|
1 | ActivityStatusField |
2 | ActivityAssignedToField |
3 | ActivityProcessNameField |
5 | ActivityNameField |
7 | ActivityPriorityField |
8 | ActivitySlaField |
9 | JobSlaField |
10 | JobStateField |
11 | CaseReference |
12 | ActivityType |
13 | WorkType |
14 | PendingTime |
15 | DesignActivityType |
16 | WorkTypeFields |
Enumeration | Description |
---|---|
0 | JobList |
1 | WorkQueue |
2 | All |
3 | System |
ActivityNotification GetActivityEmailSettings | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
NodeIdentity | nodeIdentity, | ||
JobIdentity | jobIdentity | ||
) |
Gets the settings for an e-mail activity in a specified job.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
processIdentity | A ProcessIdentity identity object containing the processid and version information of the process.
| ||||||||||||||||
nodeIdentity | A NodeIdentity identity object containing the node id of the activity.
| ||||||||||||||||
jobIdentity | A JobIdentity identity object containing the job id of the job or case.
|
ResourceIdentityCollection GetActivityUsableResources | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity | ||
) |
Retrieves the activity usable resources for the specified activity in a job.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity in a job for which we get the configured resources.
|
JobActivityInfoCollection GetAllTakenActivities | ( | string | sessionId | ) |
Retrieves all current taken activities in Kofax TotalAgility.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
int GetAssignedActivityCountForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ActivityCountFilter | activityCountFilter | ||
) |
Retrieves the number of activities assigned to a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
resourceIdentity | The ResourceIdentity identity object containing the resource id information to retrieve the count of assigned activities.
| ||||||||||||||||||||||||
activityCountFilter | An ActivityCountFilter object that can be used to filter which activities get counted.
The ResourcesToIncludeType enumeration is:
|
ActivitySettings GetCaptureActivitySettings | ( | string | sessionId, |
ProcessActivityIdentity | activityIdentity | ||
) |
Gets the settings of a specified capture activity.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
activityIdentity | A ProcessActivityIdentity identity object containing details about the required activity.
|
JobHistoryCollection GetCompletedActivitiesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
CompletedActivitiesFilter | activitiesFilter | ||
) |
Retrieves a collection of activities completed for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
resourceIdentity | The ResourceIdentity object containing the resource id to get the completed activity details for.
| ||||||||||||||||||||
activitiesFilter | A CompletedActivitiesFilter object that can be used to filter which of the completed activity details are retrieved.
|
TimePeriod GetExpectedDurationForActivities | ( | string | sessionId, |
JobActivityIdentityCollection | jobActivityIdentityCollection | ||
) |
Retrieves the sum of the expected duration for the specified activities.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentityCollection | A JobActivityIdentityCollection collection object containing activities. JobActivityIdentity members.
|
JobActivityInfo GetJobActivityInfo | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
string | simulationId | ||
) |
Please note that this function is deprecated. Please use GetJobActivityInfo4 instead.
Retrieves details of a specified activity in a job. Only applies to normal activities, not automatic.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing details about a specified activity of a job.
| ||||||||||||||||||||
simulationId | The simulation id. Not required generally. Used by KTA when running simulations. |
JobActivityInfo2 GetJobActivityInfo2 | ( | string | sessionId, |
JobActivityIdentity2 | jobActivityIdentity, | ||
string | simulationId | ||
) |
Please note that this function is deprecated. Please use GetJobActivityInfo4 instead.
Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity2 identity object that is used to identify the activity in an active job to get the activity details.
| ||||||||||||||||||||||||
simulationId | The simulation Id. Not required generally. Used by KTA when running simulations. |
JobActivityInfo3 GetJobActivityInfo3 | ( | string | sessionId, |
JobActivityIdentity2 | jobActivityIdentity | ||
) |
Please note that this function is deprecated. Please use GetJobActivityInfo4 instead.
Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity2 object that is used to identify the activity in an active job to get the activity details.
|
JobActivityInfo4 GetJobActivityInfo4 | ( | string | sessionId, |
JobActivityIdentity2 | jobActivityIdentity | ||
) |
Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity2 object that is used to identify the activity in an active job to get the activity details.
|
string GetLiveUsableResourceEmailAddresses | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
short | sendTo | ||
) |
Retrieves the email addresses of the usable resources for a specified activity.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity object containing the activity information and the job to which it belongs to.
| ||||||||||||||||||||
sendTo | The email address of the group and individual. If GroupMemberAddress (the value 1) is specified, then the API gets the email address of each member of the group. If GroupAddress (the value 0) is specified, then we return the group email address.
|
int GetNumberOfActivities | ( | string | sessionId, |
JobActivityCountFilter | jobActivityCountFilter | ||
) |
Returns a count of the live activities based on the filter specified.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
jobActivityCountFilter | A JobActivityCountFilter object that can be used to filter the activities to count. If the JobIdentity member is populated then the count will reflect only live activities within that job. If the UseActivityStatus member is true then only activities with the statuses supplied in the ActivityStatus member will be counted. If no criteria is supplied then a count of all live activities will be returned.
|
Enumeration | Description |
---|---|
0 | Pending |
1 | Active |
2 | Offered |
3 | Suspended |
4 | Locked |
5 | Active Activity Pending Completion |
7 | On Hold |
8 | Awaiting Event |
9 | Awaiting Allocation |
10 | Saved |
128 | Live |
129 | Activity In History |
JobActivityInfoCollection GetTakenActivitiesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the taken activities for the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | The ResourceIdentity identity object containing the resource id for which to retrieve all taken activities.
|
WorkQueue GetWorkQueue | ( | string | sessionId, |
JobActivityFilter | jobActivityFilter | ||
) |
Please note that this function is deprecated. Please use GetWorkQueue2 instead.
Retrieves a collection of live activities for a resource. Only activities that the resource has the relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityFilter object containing the search criteria to filter the list of activities.
|
Enumeration | Description |
---|---|
1 | Manual Ordinary |
4 | Manual Script |
8 | Manual Create New Job |
32 | Manual Web Service |
64 | Manual CSharp |
128 | Manual VBNet |
256 | Manual Adhoc |
512 | Manual Mobile |
1024 | Manual Alert Task |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Priority parameter. |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
WorkQueue2 GetWorkQueue2 | ( | string | sessionId, |
JobActivityFilter3 | jobActivityFilter | ||
) |
Retrieves a collection of live activities for a resource. Only activities that the resource has the relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityFilter3 object containing the search criteria to filter the list of activities.
|
Enumeration | Description |
---|---|
0 | SLA Status 1 |
1 | SLA Status 2 |
2 | SLA Status 3 |
3 | SLA Status 4 |
4 | SLA Status 5 |
Enumeration | Description |
---|---|
1 | Manual Ordinary |
4 | Manual Script |
8 | Manual Create New Job |
32 | Manual Web Service |
64 | Manual CSharp |
128 | Manual VBNet |
256 | Manual Adhoc |
512 | Manual Mobile |
1024 | Manual Alert Task |
2048 | Manual Document Review |
4096 | Manual Validation Capture |
8192 | Manual Verification Capture |
16384 | Manual Scan Capture |
32768 | All Manual Activities |
Enumeration | Description |
---|---|
0 | SLA Status 1 |
1 | SLA Status 2 |
2 | SLA Status 3 |
3 | SLA Status 4 |
4 | SLA Status 5 |
Enumeration | Description |
---|---|
0 | The exclude MFP only |
1 | The MFP friendly and MFP only |
Enumeration | Description |
---|---|
0 | Activities are filtered based on activity priority due date |
1 | Activities are filtered based on job priority due date |
Enumeration | Description |
---|---|
1 | Pending Activity |
2 | Active Activity |
4 | Suspended Activity |
8 | Offered Activity |
16 | On Hold |
32 | Active But Not Awaiting Events |
64 | Awaiting Allocation |
128 | Awaiting Events |
256 | Saved |
512 | Active Activity Pending Completion |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), starting with or ending at the priority specified in the Prioritiy member, See remarks section on paging for more information on how to apply paging with Priority. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
int GetWorkQueueCountWithQuery | ( | string | sessionId, |
QueryIdentity | queryIdentity, | ||
JobActivityQueryFilter | jobActivityFilter | ||
) |
Retrieves a count of the workqueue activities assigned to a resource based on the specified job activity filter criteria e.g. can filter on activity name, priority or a list of job id's. The number returned will be the number of activities and will not be restrained by the maximum number of activities to return filter parameter. If "queryIdentity" is specified, criteria specified in query is considered. If "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryIdentity | The QueryIdentity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityQueryFilter object. An extension of the comprehensive JobActivityFilter3 object that is used to filter the list of activities returned. Look at JobActivityFilter3 class to see description of filter options. The additional options over those supplied by the JobActivityFilter3 class are the AssignedResourceFilter and DueDateFilterType options.
|
Enumeration | Description |
---|---|
-1 | None |
0 | The resource |
1 | The resource and its groups |
2 | The direct subordinates of the resource |
3 | The resource and its direct subordinates |
4 | The indirect subordinates of the resource |
5 | The resource and its indirect subordinates |
The enumeration for DueDateFilterType setting follows.
Enumeration | Description |
---|---|
0 | All |
1 | Due date since |
2 | Due date between |
3 | Due date of today |
4 | Due date of this week |
5 | Due date of this month |
6 | Due date of this year |
The enumeration for ActivityTypeFilters filter setting follows. If, for example you wanted only activities of type ManualOrdinary and ManualAdhoc you would supply 257 (i.e. 1 + 256)
Enumeration | Description |
---|---|
1 | ManualOrdinary |
4 | ManualScript |
8 | ManualCreateNewJob |
32 | ManualWebService |
64 | ManualCSharp |
128 | ManualVBNet |
256 | ManualAdhoc |
512 | ManualMobile |
1024 | ManualAlertTask |
The enumeration for UsePrioritySetting filter setting follows.
Enumeration | Description |
---|---|
0 | NotUsingPriority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | UsingPriority - The work queue will be returned in order of priority. |
2 | UsingStartPriority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | UsingSpecificPriority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
The enumeration for StatusFilter setting follows.
Enumeration | Description |
---|---|
1 | PendingActivity |
2 | ActiveActivity |
4 | SuspendedActivity |
8 | OfferedActivity |
16 | OnHold |
32 | ActiveButNotAwaitingEvents |
64 | AwaitingAllocation |
128 | AwaitingEvents |
256 | Saved |
512 | ActiveActivityPendingCompletion |
When searching on string meta data fields, the LIKE and NOT LIKE operators can be used to perform wildcard search. The supported wildcard functions are *,?,~. The same wildcard functions are supported for search on Case Reference (the operator is always LIKE).
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
WorkQueueOverview GetWorkQueueOverview | ( | string | sessionId, |
ResourceIdentity | resource, | ||
WorkQueueOverviewFilter | activityFilter | ||
) |
Retrieves details of the activity workloads for the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||
resource | A ResourceIdentity identity object specifiying the resource whose workqueue overview will be retrieved.
| ||||||||||||||||||||||||||||
activityFilter | A WorkQueueOverviewFilter object that is used to filter the activities to base the workload on.
|
WorkQueueQueryResult GetWorkQueueWithQuery | ( | string | sessionId, |
bool | useDefaultQuery, | ||
QueryIdentity | queryIdentity, | ||
JobActivityQueryFilter | jobActivityFilter | ||
) |
Please note that this function is deprecated. Please use GetWorkQueueWithQuery2 instead.
Retrieves a collection of live activities for a resource. Only those activities that the resource has relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useDefaultQuery | if set to true uses default query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryIdentity | The QueryIdentity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityFilter3 object containing the search criteria to filter the list of activities.
|
Enumeration | Description |
---|---|
0 | SLA Status 1 |
1 | SLA Status 2 |
2 | SLA Status 3 |
3 | SLA Status 4 |
4 | SLA Status 5 |
Enumeration | Description |
---|---|
1 | Manual Ordinary |
4 | Manual Script |
8 | Manual Create New Job |
32 | Manual Web Service |
64 | Manual CSharp |
128 | Manual VBNet |
256 | Manual Adhoc |
512 | Manual Mobile |
1024 | Manual Alert Task |
2048 | Manual Document Review |
4096 | Manual Validation Capture |
8192 | Manual Verification Capture |
16384 | Manual Scan Capture |
32768 | All Manual Activities |
Enumeration | Description |
---|---|
0 | SLA Status 1 |
1 | SLA Status 2 |
2 | SLA Status 3 |
3 | SLA Status 4 |
4 | SLA Status 5 |
Enumeration | Description |
---|---|
0 | The exclude MFP only |
1 | The MFP friendly and MFP only |
Enumeration | Description |
---|---|
0 | Activities are filtered based on activity priority due date |
1 | Activities are filtered based on job priority due date |
Enumeration | Description |
---|---|
1 | Pending Activity |
2 | Active Activity |
4 | Suspended Activity |
8 | Offered Activity |
16 | On Hold |
32 | Active But Not Awaiting Events |
64 | Awaiting Allocation |
128 | Awaiting Events |
256 | Saved |
512 | Active Activity Pending Completion |
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
WorkQueueQueryResult2 GetWorkQueueWithQuery2 | ( | string | sessionId, |
bool | useDefaultQuery, | ||
QueryIdentity | queryIdentity, | ||
JobActivityQueryFilter | jobActivityFilter | ||
) |
Retrieves a collection of live activities for a resource. Only activities that the resource has the relevant skills and permissions to work on are retrieved. The list contains activities that are pending, saved or offered. Can optionally request to return the actvities count using filter parameter. When select to return the activity count the number returned will be the number of activities and will not be restrained by the maximum number of activities to return filter parameter. If "usedefaultquery" is true, criteria specified in default query is considered. If "usedefaultquery" is false and "queryIdentity" is specified, criteria specified in query is considered. If "usedefaultquery" is false and "queryIdentity" is not specified, criteria specified in JobActivityFilter is considered.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useDefaultQuery | if set to true uses default query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryIdentity | The QueryIdentity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobActivityFilter | A JobActivityFilter3 object containing the search criteria to filter the list of activities.
|
Enumeration | Description |
---|---|
1 | ManualOrdinary |
4 | ManualScript |
8 | ManualCreateNewJob |
32 | ManualWebService |
64 | ManualCSharp |
128 | ManualVBNet |
256 | ManualAdhoc |
512 | ManualMobile |
1024 | ManualAlertTask |
The enumeration for UsePrioritySetting filter setting follows.
Enumeration | Description |
---|---|
0 | NotUsingPriority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | UsingPriority - The work queue will be returned in order of priority. |
2 | UsingStartPriority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | UsingSpecificPriority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
The enumeration for StatusFilter setting follows.
Enumeration | Description |
---|---|
0 | PendingActivity |
1 | ActiveActivity |
2 | OfferedActivity |
3 | SuspendedActivity |
4 | ActivityLocked |
5 | ActiveActivityNoEvaluation |
128 | AllLiveActivities |
When searching on string meta data fields, the LIKE and NOT LIKE operators can be used to perform wildcard search. The supported wildcard functions are *,?,~. The same wildcard functions are supported for search on Case Reference (the operator is always LIKE).
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
Enumeration | Description |
---|---|
2 | Assigned To |
3 | Process Name |
4 | Process version |
5 | Activity Name |
6 | Due date |
7 | Priority |
10 | State |
11 | Case Reference |
14 | Pending time |
16 | Work type field. To use a work type field for sorting, specify FieldType as 16 and populate MetaDataFieldName with the name of work type field |
17 | JobId |
18 | Supporting Info |
19 | Help Text |
The enumeration for SortOrder in SortOptions setting follows.
Enumeration | Description |
---|---|
0 | Ascending |
1 | Descending |
WorkSummary GetWorkSummary | ( | string | sessionId, |
WorkSummaryFilter | filter | ||
) |
Please note that this function is deprecated. Please use GetWorkSummary2 instead.
Retrieves the work summary for the current logged on user based on the filter criteria.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
filter | A WorkSummaryFilter object containing the filter criteria to retrieve the work summary.
|
WorkSummary GetWorkSummary2 | ( | string | sessionId, |
WorkSummaryFilter2 | filter | ||
) |
Retrieves the work summary based on the filter criteria.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
filter | A WorkSummaryFilter2 object containing the filter criteria to retrieve the work summary.
|
void PartiallyCompleteActivity | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityOutput | jobActivityOutput | ||
) |
Partially completes the automatic capture activity for which the partial completion property is set to true.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing the activity information for which the partial completion property is turned on.
| ||||||||||||||||||||
jobActivityOutput | A JobActivityOutput object which contains a collection of 0 or more variable values to update in the job. Once the activity is complete the variables in the job will be updated with the corresponding values.
|
void PerformAutoWorkAllocation | ( | string | sessionId, |
AutoWorkAllocationOptions | filter | ||
) |
Performs automatic work allocation based on the specified allocation options in the filter parameter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||
filter | An AutoWorkAllocationOptions object containing the filter criteria to be used for the auto work allocation.
|
void ReassignActivities | ( | string | sessionId, |
ResourceIdentity | originalResource, | ||
ResourceIdentity | newResource, | ||
JobActivityIdentityCollection | jobActivityIdentities | ||
) |
Reassigns one or more activities from one resource to another resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
originalResource | A ResourceIdentity identity object containing the resource id from whom the activity has to be assigned to other resource.
| ||||||||||||||||||||
newResource | A ResourceIdentity identity object containing the resource id to whom the activity has to be assigned.
| ||||||||||||||||||||
jobActivityIdentities | A JobActivityIdentityCollection collection object that contains of activities to reassign. JobActivityIdentity members.
|
void ReassignActivity | ( | string | sessionId, |
ResourceIdentity | originalResource, | ||
ResourceIdentity | newResource, | ||
JobActivityIdentity | jobActivityIdentity | ||
) |
Reassigns a specified activity of a specified job from one resource to another resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
originalResource | A ResourceIdentity identity object containing the resource id from whom the activity has to be assigned to other resource.
| ||||||||||||||||||||
newResource | A ResourceIdentity identity object containing the resource id to whom the activity has to be assigned.
| ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object that is used to identify the activity in a job to reassign.
|
void ReassignAllActivities | ( | string | sessionId, |
ResourceIdentity | originalResource, | ||
ResourceIdentity | newResource | ||
) |
Reassigns all live activities assigned to a resource to a different resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
originalResource | A ResourceIdentity identity object containing the resource id from whom the activity has to be assigned to other resource.
| ||||||||||||||||
newResource | A ResourceIdentity identity object containing the resource id to whom the activity has to be assigned.
|
void ResetTakenActivities | ( | string | sessionId, |
JobActivityIdentityCollection | activitiesToReset | ||
) |
Resets the specified taken activities. The activities will be reset from Taken to Pending status.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
activitiesToReset | A JobActivityIdentityCollection collection object that contains the list of activities that needs to be reset i.e. returned to Pending state that will allow it be re-taken by some resource. JobActivityIdentity members.
|
void ResetTakenActivitiesForResource | ( | string | sessionId, |
ResourceIdentity | resource | ||
) |
Resets the taken activities for the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resource | A ResourceIdentity identity object containing the resource id for which the activities need to be reset.
|
void SaveActivity | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
JobActivityOutput | jobActivityOutput | ||
) |
Saves the taken activity with the output variable values.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing the activity information that needs to be saved.
| ||||||||||||||||||||
jobActivityOutput | A JobActivityOutput object which contains the a collection of variable values to update in the job. Once the activity is saved the variables in the job will be updated with the corresponding values.
|
JobActivity TakeActivity | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity | ||
) |
Takes an activity for completion.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing details of an activity that needs to be taken..
|
JobActivity TakeActivityFromJob | ( | string | sessionId, |
JobIdentity | jobIdentity | ||
) |
Takes an activity from the work queue of the logged on user for a specified job.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
jobIdentity | The JobIdentity identity object containing the job id for which the activity has to be taken.
|
JobActivity TakeAnyActivity | ( | string | sessionId | ) |
Takes any activity from the work queue of the logged on user.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
NextActivity TakeNextActivity | ( | string | sessionId, |
bool | useCombinedWorkQueue | ||
) |
Please note that this function is deprecated. Please use TakeNextActivity2 instead.
Takes the next activity from the workqueue of the current logged on user.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
useCombinedWorkQueue | If set to true, then get combined workqueue. Otherwise use individual workqueue. Combined workqueue means activities that are assigned to the individual and activities assigned to groups that they are a member of. |
NextActivity TakeNextActivity2 | ( | string | sessionId, |
TakeNextActivityFilter | filter | ||
) |
Retrieves the next activity based on the work allocation rule associated with the logged on resource's working group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filter | A TakeNextActivityFilter object containing the filter criteria information to take the next activity.
|
Enumeration | Description |
---|---|
1 | Manual Ordinary |
4 | Manual Script |
8 | Manual Create New Job |
32 | Manual Web Service |
64 | Manual CSharp |
128 | Manual VBNet |
256 | Manual Adhoc |
512 | Manual Mobile |
1024 | Manual Alert Task |
The enumeration for UsePrioritySetting filter setting follows.
Enumeration | Description |
---|---|
0 | Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead. |
1 | Using Priority - The work queue will be returned in order of priority. |
2 | Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the Prioritiy member. |
3 | Using Specific Priority - The work queue will only return activities of the specific priority provided in the Prioritiy member. |
When searching on string meta data fields, the LIKE and NOT LIKE operators can be used to perform wildcard search. The supported wildcard functions are *,?,~. The same wildcard functions are supported for search on Case Reference (the operator is always LIKE).
? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
* | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
void UpdateActivityDueDate | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
DateTime | dueDate, | ||
bool | resetException | ||
) |
Updates the due date of a specified activity.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing the activity information for which the due date needs to be updated.
| ||||||||||||||||||||
dueDate | The new due date for the specified activity. | ||||||||||||||||||||
resetException | If set to true the Activity Due exception will be reset so it can be re-raised for this activity. |
void UpdateActivityPriority | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
short | activityPriority | ||
) |
Updates the priority of a specified activity in a job.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing the activity information for which the priority needs to be updated.
| ||||||||||||||||||||
activityPriority | The new activity priority for the specified activity. |
void UpdateActivityResources | ( | string | sessionId, |
JobActivityIdentity | jobActivityIdentity, | ||
ResourceIdentityCollection | resourceIdentityCollection | ||
) |
Updates the assigned resources on a live activity, by removing the current resources and replacing with new resources.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
jobActivityIdentity | A JobActivityIdentity identity object containing the activity information for which the resources needs to be updated.
| ||||||||||||||||||||
resourceIdentityCollection | A ResourceIdentityCollection collection of resources to assign to the activity. ResourceIdentity members.
|