ActivityService Class Reference

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	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 the total count of activities assigned to a resource based on the specified query OR job activity filter criteria e.g. can specify a query to filter based of query criteria OR 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...
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...
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...
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...
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	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	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...

Description

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.

Member Functions

void AddActivityResources	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		ResourceIdentityCollection	resourceIdentityCollection
	)

Adds worker and/or group resources to a live activity.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
resourceIdentityCollection	A ResourceIdentityCollection collection object of resources to assign to the activity. ResourceIdentity members. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No

Remarks

If no resources are specified in the resourceIdentityCollection parameter, an exception is raised.
If the activity uses the advanced workflow rules and you try to assign additional resources using this API, an exception is raised.

Security

No restrictions apply.

void AllocateActivities	(	string	sessionId,
		ResourceIdentity	resource,
		JobActivityIdentityCollection	activities
	)

Allocates one or more specified activities to the specified resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
activities	A JobActivityIdentityCollection collection object that contains one or more activities of type JobActivityIdentity to allocate. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Remarks

If the resource parameter is null, the activities are allocated to the design-time usable resources configured in the process map, otherwise the activities are assigned to the resource specified.
If the resource parameter is populated, it must contain a valid resource, otherwise an exception is thrown.
Once an activity is successfully allocated, its status changes from Awaiting Allocation to Pending.
If auditing is enabled, a new audit entry is created with details of each allocated activity.

Security

No restrictions apply.

void AllocateActivity	(	string	sessionId,
		ResourceIdentity	resource,
		JobActivityIdentity	jobActivityIdentity
	)

Allocates a specified activity of a job to a specified resource.

Parameters

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.. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
jobActivityIdentity	A JobActivityIdentity identity object that is used to identify an activity in a job that is to be allocated. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Remarks

If the resource parameter is null, the activity is allocated to the design-time usable resources configured in the process map, otherwise the activity is assigned to the resource specified.
If the resource parameter is populated, it must contain a valid resource, otherwise an exception is thrown.
Once an activity is successfully allocated, its status changes from Awaiting Allocation to Pending.
If auditing is enabled, a new audit entry is created with details of the allocated activity.

Security

No restrictions apply.

void CancelActivity	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity
	)

Cancels an activity in a job that has been selected for completion.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Remarks

Any changes to output variables are discarded, however the Job History is updated to reflect the activity that was canceled, who canceled it, when it was canceled, the time spent on it before it was canceled, and the associated cost.
If auditing is enabled, a new audit entry is created with details of the canceled activity.

Security

No restrictions apply.

void CompleteActivity	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		JobActivityOutput	jobActivityOutput
	)

Completes an activity once it has been taken and subsequently performed by the appropriate resource.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No LoggingData string This is for internal use only. No

Remarks

The Job History is updated to reflect the name of the activity that was completed, who completed it, when it was completed, the time spent on it, and the associated cost.
The variables in the job are updated accordingly with the values of the output variables in the jobActivityOutput parameter.
If auditing is enabled, a new audit entry is created with details of the completed activity.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No LoggingData string This is for internal use only. No

Returns

A JobProgressOutput object with the remaining manual activities and current job status.

Remarks

The Job History is updated to reflect the activity that was completed, who completed it, when it was completed, the time spent on it, and the associated cost.
The variables in the job are updated accordingly with the values of the output variables in jobActivityOutput .
If auditing is enabled, a new audit entry is created with details of the completed activity.

Security

No restrictions apply.

void CompleteActivityWithDocuments	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		JobActivityWithDocumentsOutput	jobActivityWithDocumentsOutput
	)

Completes an activity once it has been taken and subsequently performed by the appropriate resource.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required Documents Collection A collection of RuntimeDocument. Yes OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No

Remarks

Must have at least one RuntimeDocument object supplied.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required Documents Collection A collection of RuntimeDocument. Yes OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No

Returns

A JobProgressOutput object with the remaining manual activities and current job status.

Remarks

Must have at least one RuntimeDocument object.
The documents (one document created per document in the documents collection) from the jobActivityWithDocumentsOutput parameter are created by document services. If the FolderId member of a document in the documents collection is specified, the document is created in the specified folder.
The Job History is updated to reflect the activity that was completed, who completed it, when it was completed, the time spent on it, and the associated cost.
The variables in the job are updated accordingly with the values of the output variables in jobActivityWithDocumentsOutput .
If auditing is enabled, a new audit entry is created with details of the completed activity.

Security

No restrictions apply.

void CompletePendingActivity	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		JobActivityOutput	jobActivityOutput
	)

Completes a pending activity without having to take the activity first.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No LoggingData string This is for internal use only. No

Remarks

The Job History is updated to reflect the activity that was completed, who completed it, when it was completed, the time spent on it, and the associated cost.
The variables in the job are updated accordingly with the values of the output variables in jobActivityOutput .
If auditing is enabled, a new audit entry is created with details of the completed activity.

Security

No restrictions apply.

void CompletePendingActivityWithDocuments	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		JobActivityWithDocumentsOutput	jobActivityWithDocumentsOutput
	)

Completes the pending activity with documents without having to take the activity first.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required Documents Collection A collection of RuntimeDocument. Yes OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No

Remarks

Must have at least one RuntimeDocument object supplied.
The documents (1 document created per document in the documents collection) from jobActivityWithDocumentsOutput parameter will be created by document services. If the FolderId member of a document in the documents collection is specified, then the document will be created in the specified folder.
The Job History will be updated to reflect the activity that was completed, who completed it, when it was completed, how long it took and the associated cost.
The variables in the job will be updated accordingly with the values of the output variables in parameter jobActivityWithDocumentsOutput.
If auditing is enabled, a new audit entry will be created with details of the completed activity.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required JobIdentity Identity The id of the job which to add the activity. Yes NodeName String Name of the new activity. Maximum length: 40 characters Yes Priority Int16 Priority of the activity. Highest priority = 1; Lowest priority = 10 Yes DueDate DateTime The datetime when the activity is due to be completed. Yes UsableResources ResourceIdentityCollection A collection of resources that can perform the activity. Yes AssociatedFile String Associated file for the activity. No HelpText String Help text for the activity. No

Remarks

You cannot add an adhoc activity to a suspended, on hold, terminated or a completed job.
Once an adhoc activity is completed, the history and associated costs and time of its completion are recorded against the job.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required JobIdentity Identity The id of the job which to add the activity. Yes NodeName String Name of the new activity. Maximum length: 40 characters Yes Priority Int16 Priority of the activity. Highest priority = 1; Lowest priority = 10 Yes DueDate DateTime The datetime when the activity is due to be completed. Yes UsableResources ResourceIdentityCollection A collection of resources that can perform the activity. Yes AssociatedFile String Associated file for the activity. No HelpText String Help text for the activity. No

Remarks

The LiveActivityType member of the alertActivity parameter is automatically set to the value of 1048576 indicating an Alert activity type

Security

No restrictions apply.

void DeleteActivityResources	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		ResourceIdentityCollection	resourceIdentityCollection
	)

Deletes worker and/or group resources that are assigned to a live actvity.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
resourceIdentityCollection	A ResourceIdentityCollection collection object that contains a collection of resources to remove from the activity. ResourceIdentity members. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No

Remarks

If the activity identified uses the advanced workflow rules, the resources cannot be deleted using this API nd an exception is raised.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required ActivityName String If set, only gets activities with the specified name. No ActivitySlaStatus Int16 Only gets activities for the specified Service Level Agreements. No ActivityTypeFilters Int32 You can specify one or more types of activities to return. See the Remarks section of this API for more information. No Case Identity If specified, gets activities using the case ID. No CaseActivitiesOnly Boolean If set to true, only gets activites for the specified case. No Category Identity If populated, gets activities within this category. No DueDateType Int16 Filters activities based on priority due date. 0 filters by activity and 1 filters by job. No EndDueDateTime DateTime Can supply the latest due date of an activity that will be returned. If EndDueDateTime is null, the filter is not considered. No JobIdsFilter JobIdentityCollection If supplied, only gets activities for the specified jobs. No JobSlaStatus Int16 Only gets activities which meet the jobs' Service Level Agreements. No JobState String If set, only gets activities from jobs for the specified state. States can be used to monitor the status or percentage complete of a particular job. No LoanResource ResourceIdentity If set, also gets activities assigned to a loaned resource. No MaxActivitiesCount Int32 Maximum number of activities to return. If not specified no activities are returned. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No MFPFilterCriteria Int16 If set, filters based on whether MFP Friendly. See Remarks section of this API to get more information. No NodeId Int16 Gets activities with this node ID. No PageDirection Int16 Specify which direction to get next group of activities. 0 indicates retrieve next page, 1 indicates retrieve previous page No Priority Int16 Priority of the activity. Highest priority = 1; Lowest priority = 10 No PriorityType Int16 If set, filters by the type of the priority. See Remarks section of this API to get more information. No Process Identity If specified, gets activities from jobs created on the specified process. No Resource Identity Only required if the work queue is being retrieved for a group and the caller is a member of that group. No ReturnJobIds Boolean Returns Job IDs with results. No ScoreFilter ScoreFilter If populated, gets activities from jobs that have reached a specified score. No StartDueDateTime DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, the filter is not considered. No StatusFilter Int16 Use status for filtering. See the Remarks section of this API for more information. No UseActivitySlaStatus Boolean If set to true, uses the activity SLA status. No UseCombinedWorkQueue Boolean If a resource is specified, then gets activities for the worker's groups as well. No UseJobSlaStatus Boolean If set to true, uses the job SLA status. No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If the ID member is populated, you can filter on the specified work type. No SortOptions ActivitySortOptionsCollection If supplied and system level custom sorting is enabled, activities are sorted based on the specified sort fields; otherwise, default sorting will be performed. Maximum 3 sort fields should be specified, exceeding which, only the first 3 fields will be considered for sorting. An exception is thrown when an invalid sort field is specified. No

Returns

An ActivityList object that represents the list of activities based on the specified search criteria for the logged-on resource.

Remarks

The enumeration for ActivitySlaStatus filter setting follows.

Enumeration	Description
0	SLA Status 1
1	SLA Status 2
2	SLA Status 3
3	SLA Status 4
4	SLA Status 5

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	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

The enumeration for JobSlaStatus filter setting follows.

Enumeration	Description
0	SLA Status 1
1	SLA Status 2
2	SLA Status 3
3	SLA Status 4
4	SLA Status 5

The enumeration for MFPFilterCriteria setting follows.

Enumeration	Description
0	The exclude MFP only
1	The MFP friendly and MFP only

The enumeration for PriorityType setting follows.

Enumeration	Description
0	Activities are filtered based on activity priority due date
1	Activities are filtered based on job priority due date

The enumeration for StatusFilter setting follows. If, for example you wanted only activities with status Pending and Active you would supply 3 (i.e. 1 + 2)

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
2048	Evaluation Failed Activity

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~*"

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

Security

No restrictions apply.

int GetActivitiesCountWithQuery	(	string	sessionId,
		QueryIdentity	queryIdentity,
		JobActivityQueryFilter	jobActivityFilter
	)

Retrieves the total count of activities assigned to a resource based on the specified query OR job activity filter criteria e.g. can specify a query to filter based of query criteria OR filter on activity name, priority or a list of job id's.

Parameters

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. Name Type Comment Required ActivityDesignType Int16 Can specify the activity design node type filter. See remarks section below for more information No ActivityName String If set, only get activities with this name No ActivitySlaStatus Int16 Only gets activities which meet the activities Service Level Agreements No ActivityTypeFilters Int32 You can supply one or more types of activity to return. See Remarks section of this API to get more information. No AssignedResourceFilter Int16 Can specify the assigned resource filter. See remarks section below for more information No Case Identity If specified, will get activities using the case id. No CaseActivitiesOnly Boolean If set to true, then only get activites from the specified case No Category Identity If populated, get activities within this category. No DueDateFilterType Int16 Can specify the due date filter type. See remarks section below for more information No DueDateType Int16 Filters activities based on priority due date. 0 filters by activity and 1 filters by job. No EndDueDateTime DateTime Can supply the latest due date of an activity that will be returned. If EndDueDateTime is null, then the filter is not considered. No JobIdsFilter JobIdentityCollection If supplied, will only get activities from the specified jobs No JobSlaStatus Int16 Only gets activities which meet the jobs Service Level Agreements No JobState String If set, will only get activities from jobs that are in the specified state. States can be used to monitor the status or percentage complete of a particular job. No LoanResource ResourceIdentity If set, then we also get activities assigned to the on loan resource. No MaxActivitiesCount Int32 Can specify the maximum number of activities to return. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No MFPFilterCriteria Int16 If set, filters based on whether MFP Friendly. See Remarks section of this API to get more information. No NodeId Int16 Get activities with this node Id. No PageDirection Int16 Specify which direction to get next group of activities. 0 indicates retrieve next page, 1 indicates retrieve previous page No PendingTimeFilter Int16 Can specify the pending time filter. See remarks section below for more information No Priority Int16 Priority level of activity. Highest Priority is 1. Lowest Priority is 10 No PriorityType Int16 If set, filters by the type of the priority. See Remarks section of this API to get more information. No Process Identity If populated, get activities from jobs created on the specified process. No Resource Identity This is required only if it is a group that the workqueue is being retrieved for and the the caller must be a member of the specified group. No ReturnJobIds Boolean Return Job Ids with results No ScoreFilter ScoreFilter If populated, get activities from jobs that have reached a specified score. No StartDueDateTime DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, then the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, then the filter is not considered. No StatusFilter Int16 Use status for filtering. See Remarks section of this API to get more information. No UseActivityDesignType Boolean Use value in ActivityDesignType filter property No UseActivitySlaStatus Boolean If set to true, then uses the ActivitySlaStatus No UseCombinedWorkQueue Boolean If a resource supplied, then gets activities for the workers groups as well No UseJobSlaStatus Boolean If set to true, then uses the JobSlaStatus No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If Id member is populated, then we will filter on the specified work type. No SortOptions ActivitySortOptionsCollection If supplied and system level custom sorting is enabled, activities are sorted based on the specified sort fields; otherwise, default sorting will be performed. Maximum 3 sort fields should be specified, exceeding which, only the first 3 fields will be considered for sorting. An exception is thrown when an invalid sort field is specified. No

Returns

The total number of activities based on query filter or query Id.

Remarks

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 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 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 MFPFilterCriteria setting follows.

Enumeration	Description
0	The exclude MFP only
1	The MFP friendly and MFP only

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 PriorityType setting follows.

Enumeration	Description
0	Activities are filtered based on activity priority due date.
1	Activities are filtered based on job priority due date.

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~*"

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

Security

No restrictions apply.

JobActivityInfoCollection GetActivitiesInJobWithStatus	(	string	sessionId,
		JobIdentity	jobIdentity,
		short	liveActivityStatus
	)

Retrieves all the activities in a specified job that have a specified activity status.

Parameters

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. Name Type Comment Required Id String The Id of the job Yes
liveActivityStatus	Get all activities that have this activity status. 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 All Activity In History

Returns

A collection of type JobActivityInfo that contains all the activities in the specified job that have the specified activity status.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required StatusFilter Int16 Use status for filtering. See Remarks section of this API to get more information. No Resource Identity This is required only if it is a group that the workqueue is being retrieved for and the the caller must be a member of the specified group. No Grouping Int16 What type of resource filtering to use. See Remarks section of this API to get more information. No Process Identity If populated, get activity summaries from jobs created on the specified process. No NodeName String If set, only get activities with this name No StartDateTime DateTime Can supply the earliest due date for an activity summary that will be returned. If StartDateTime is null, then the filter is not considered. No EndDateTime DateTime Can supply the latest due date of an activity summary that will be returned. If EndDueDateTime is null, then the filter is not considered. No Category Identity If populated, get activity summaries within this category. No WorkQueueDefinition WorkQueueDefinitionIdentity If Id member is populated, then we will filter on the specified work type. No FieldFilter FieldFilter If supplied, will be 1 or more workqueue definition fields to filter on. No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No Priority Int16 Priority level of activity. Highest Priority is 1. Lowest Priority is 10 No JobIdsFilter JobIdentityCollection If supplied, will only get activities from the specified jobs No JobRagStatus Int16 Only gets activities which meet the jobs Service Level Agreements No ActivityRagStatus Int16 Only gets activities which meet the activities Service Level Agreements No JobState String If set, will only get activities from jobs that are in the specified state. States can be used to monitor the status or percentage complete of a particular job. No LoanResource ResourceIdentity If set, then we also get activities assigned to the on loan resource. No GroupByStandardField Int16 Indicates what standard field to use. See Remarks section of this API to get more information. No GroupByMetadataField String If want to group by a workqueue definition field, then set GroupByStandardField to 0 and supply the workqueue definition field id here. No AggregateStandardField Int16 Indicates what standard field to use (same enumeration as shown for GroupByStandardField). See Remarks section of this API to get more information. No AggregateMetadataField String If want to aggregate by a workqueue definition field, then set AggregateMetadataField to 0 and supply the workqueue definition field id here. No AggregateType Int16 Sets the aggregation type we want e.g. SUM, COUNT etc. See Remarks section of this API to get more information. No ActivityStatus Int16 Use status for filtering. See Remarks section of this API to get more information. No

Returns

A collection of type JobActivitiesSummary which represents the job activities summary.

Remarks

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.

The enumeration for StatusFilter setting follows.

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

The enumeration for Grouping setting follows.

Enumeration	Description
0	Individual Only
1	Group Only
2	Both

The enumeration for GroupByStandardField setting follows.

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

The enumeration for AggregateType setting follows.

Enumeration	Description
0	Count
1	Sum
2	Average
3	Minimum
4	Maximum

The enumeration for ActivityStatus setting follows.

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

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required Id String Id of the Query Yes - if Name is not specified Name String Name of the Query Yes - if Id is not specified QueryType Int16 Type of the Query No
groupByField	A ActivityField object used to specify the field to group the results by. See Remarks section of this API to get more information. Name Type Comment Required FieldType Int16 Field Type Enumeration Yes MetaDataFieldName String WorkType Field Name No - Unless FieldType is set to 16

Returns

An object of type ActivitiesSummaryResults containing the results. This ActivitiesSummaryResults class contains the following...
A collection of JobActivitiesSummary objects.
A TotalCount which contains the total of AggregateValue in each JobActivitiesSummary.

Each JobActivitiesSummary contains the following...
A GroupByValue, e.g. the name of a process if the FieldType in ActivityField is set to '3' (Activity Process Name Field - see remarks below for more).
An AggregateValue, e.g. the number of activities found for the process specified in the GroupByValue.
A GroupByHiddenValue, e.g. a processID for the process specified in the GroupByValue.

Remarks

The FieldType specified in ActivityField is an enumeration, and must be one of the following.

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
23	The Machine Name

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required UseActivityDesignType Boolean Use value in ActivityDesignType filter property No ActivityDesignType Int16 Can specify the activity design node type filter. See remarks section below for more information No PendingTimeFilter Int16 Can specify the pending time filter. See remarks section below for more information No AssignedResourceFilter Int16 Can specify the assigned resource filter. See remarks section below for more information No DueDateFilterType Int16 Can specify the due date filter type. See remarks section below for more information No MaxActivitiesCount Int32 Can specify the maximum number of activities to return. No StartDueDateTime DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, then the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, then the filter is not considered. No ActivityTypeFilters Int32 You can supply one or more types of activity to return. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If Id member is populated, then we will filter on the specified work type. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No ReturnJobIds Boolean Return Job Ids with results No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No Priority Int16 Priority level of activity. Highest Priority is 1. Lowest Priority is 10 No ActivityName String If set, only get activities with this name No Resource Identity This is required only if it is a group that the workqueue is being retrieved for and the the caller must be a member of the specified group. No UseCombinedWorkQueue Boolean If a resource supplied, then gets activities for the workers groups as well No UseJobSlaStatus Boolean If set to true, then uses the JobSlaStatus No JobSlaStatus Int16 Only gets activities which meet the jobs Service Level Agreements No JobState String If set, will only get activities from jobs that are in the specified state. States can be used to monitor the status or percentage complete of a particular job. No PageDirection Int16 Specify which direction to get next group of activities. 0 indicates retrieve next page, 1 indicates retrieve previous page No UseActivitySlaStatus Boolean If set to true, then uses the ActivitySlaStatus No ActivitySlaStatus Int16 Only gets activities which meet the activities Service Level Agreements No Process Identity If populated, get activities from jobs created on the specified process. No Case Identity If specified, will get activities using the case id. No CaseActivitiesOnly Boolean If set to true, then only get activites from the specified case No Category Identity If populated, get activities within this category. No ScoreFilter ScoreFilter If populated, get activities from jobs that have reached a specified score. No EndDueDateTime DateTime Can supply the latest due date of an activity that will be returned. If EndDueDateTime is null, then the filter is not considered. No JobIdsFilter JobIdentityCollection If supplied, will only get activities from the specified jobs No StatusFilter Int16 Use status for filtering. See Remarks section of this API to get more information. No NodeId Int16 Get activities with this node Id. No LoanResource ResourceIdentity If set, then we also get activities assigned to the on loan resource. No SortOptions ActivitySortOptionsCollection If supplied and system level custom sorting is enabled, activities are sorted based on the specified sort fields; otherwise, default sorting will be performed. Maximum 3 sort fields should be specified, exceeding which, only the first 3 fields will be considered for sorting. An exception is thrown when an invalid sort field is specified. No

Returns

An ActivityQueryResult2 object that represents the list of activities based on the specified search criteria for the logged on resource. Can also request the return of total activities count (i.e. result will be greater than -1)

Remarks

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 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

Security

No restrictions apply.

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.

Parameters

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 Name Type Comment Required Id string Id of the query Yes, if Name is not specified. Name string Name of the query Yes, if Id is not specified. QueryType short The query Type No
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

Returns

Returns ActivityQueryResult2 object containing activities that match the query criteria.

Remarks

Enumeration for FieldType

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 for QueryType

Enumeration	Description
0	JobList
1	WorkQueue
2	All
3	System

Security

No restrictions apply.

ActivityNotification GetActivityEmailSettings	(	string	sessionId,
		ProcessIdentity	processIdentity,
		NodeIdentity	nodeIdentity,
		JobIdentity	jobIdentity
	)

Gets the settings for an e-mail activity in a specified job.

Parameters

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. Name Type Comment Required Id String The id of the process Yes Version Double The version number of the process. Yes Name String Name of activity. NOT used by this API No
nodeIdentity	A NodeIdentity identity object containing the node id of the activity. Name Type Comment Required Id Int16 The id of the node Yes NodeType Int16 The type of node e.g. Manual Ordinary etc. NOT used by this API No Name String Name of node. NOT used by this API No
jobIdentity	A JobIdentity identity object containing the job id of the job or case. Name Type Comment Required Id String The job id Yes

Returns

An object of type ActivityNotification which contains email settings.

Security

No restrictions apply.

ResourceIdentityCollection GetActivityUsableResources	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity
	)

Retrieves the activity usable resources for the specified activity in a job.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Returns

A collection of type ResourceIdentity which represents the usable resources for an activity.

Security

No restrictions apply.

JobActivityInfoCollection GetAllTakenActivities

(

string

sessionId

)

Retrieves all current taken activities in Kofax TotalAgility.

Parameters

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.

Returns

An instance of JobActivityInfo that contains a collection of activities that were taken by the resource (identified by the sessionId parameter) but not yet marked as complete.

Security

No restrictions apply.

int GetAssignedActivityCountForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ActivityCountFilter	activityCountFilter
	)

Retrieves the number of activities assigned to a specified resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
activityCountFilter	An ActivityCountFilter object that can be used to filter which activities get counted. Name Type Comment Required ActivityName String Can specify activity name to only search for activities with this name. No ProcessIdentity Identity Can specify Id to just search for a particular process Name is NOT used by this API Version is NOT used by this API No ResourcesToIncludeType Int16 Specify what type of resource filter to use. Yes The ResourcesToIncludeType enumeration is: Enumeration Description 0 Individual Only 1 Group Only 2 Both

Returns

Number of activities assigned to the specified resource.

Remarks

Individual Only - Only activities assigned to the actual resource are counted
Group Only - Only activities assigned to groups that the resource belongs to are counted
Both - Activities associated with both the individual resource and groups that they belong to are counted
If one activity is assigned to both an individual resource and a group that they belong to it will only be counted once, even though it appears twice on the resource’s work queue

Security

No restrictions apply.

ActivitySettings GetCaptureActivitySettings	(	string	sessionId,
		ProcessActivityIdentity	activityIdentity
	)

Gets the settings of a specified capture activity.

Parameters

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. Name Type Comment Required ProcessIdentity Identity Id member is required Version member is required Name is NOT used by this API Yes NodeId Int16 The id of the activity within a process Yes ActivityName String Name of activity. NOT used by this API No

Returns

An ActivitySettings object that gives details of the required activity.

Remarks

If supply a process version of 0, the latest released version of the map will be used.

Security

No restrictions apply.

JobHistoryCollection GetCompletedActivitiesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		CompletedActivitiesFilter	activitiesFilter
	)

Retrieves a collection of activities completed for a specified resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
activitiesFilter	A CompletedActivitiesFilter object that can be used to filter which of the completed activity details are retrieved. Name Type Comment Required Date DateTime Time to look from for completed activities. N.B. This member is NOT used by this API. No DatabaseConnectionType Int16 What database(s) to check Yes The DatabaseConnectionType enumeration is: Enumeration Description 1 Live Database 2 Archive Database 3 Either Database

Returns

A collection of type JobHistory, which holds the details of completed activities.

Security

No restrictions apply.

TimePeriod GetExpectedDurationForActivities	(	string	sessionId,
		JobActivityIdentityCollection	jobActivityIdentityCollection
	)

Retrieves the sum of the expected duration for the specified activities.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Returns

Returns a TimePeriod object which contains the sum of the expected duration of the activities in the collection.

Security

No restrictions apply.

JobActivityInfo4 GetJobActivityInfo4	(	string	sessionId,
		JobActivityIdentity2	jobActivityIdentity
	)

Retrieves details of a specified activity of a job. Only applies to normal activities, not automatic.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes SubNodeId Int16 NOT used by this API. No EmbeddedProcessCount Int16 The map level on which the activity resides. If this parameter is 0 the map is the parent map, if it is 1 it is a child map and so on. Yes JobId String The job that the activity belongs to. Yes ActivityName String Name of activity. No

Returns

An instance of type JobActivityInfo4, which holds the details of the activity specified.

Security

No restrictions apply.

string GetLiveUsableResourceEmailAddresses	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		short	sendTo
	)

Retrieves the email addresses of the usable resources for a specified activity.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Enumeration Description 0 Group Address 1 Group Member Address

Returns

The email addresses of the usable resources. Returned as a string with each email address separated by a semi-colon.

Security

No restrictions apply.

int GetNumberOfActivities	(	string	sessionId,
		JobActivityCountFilter	jobActivityCountFilter
	)

Returns a count of the live activities based on the filter specified.

Parameters

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. Name Type Comment Required JobIdentity JobIdentity If populated, only get count for that particular job No UseActivityStatus Boolean Should activity status be used to filter. No ActivityStatus Int16 The activity status to filter for, if UseActivityStatus is True. No

Returns

The number of live activities of the specified activity status or the number of live activites if no activity status specified.

Remarks

The ActivityStatus enumeration is:

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

Security

No restrictions apply.

JobActivityInfoCollection GetTakenActivitiesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the taken activities for the specified resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No

Returns

A collection of type JobActivityInfo which contains the details of the taken activities for the specified resource.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required ActivityName String If set, only gets activities with the specified name. No ActivitySlaStatus Int16 Only gets activities for the specified Service Level Agreements. No ActivityTypeFilters Int32 You can specify one or more types of activities to return. See the Remarks section of this API for more information. No Case Identity If specified, gets activities using the case ID. No CaseActivitiesOnly Boolean If set to true, only gets activites for the specified case. No Category Identity If populated, gets activities within this category. No DueDateType Int16 Filters activities based on priority due date. 0 filters by activity and 1 filters by job. No EndDueDateTime DateTime Can supply the latest due date of an activity that will be returned. If EndDueDateTime is null, the filter is not considered. No JobIdsFilter JobIdentityCollection If supplied, only gets activities for the specified jobs. No JobSlaStatus Int16 Only gets activities which meet the jobs' Service Level Agreements. No JobState String If set, only gets activities from jobs for the specified state. States can be used to monitor the status or percentage complete of a particular job. No LoanResource ResourceIdentity If set, also gets activities assigned to a loaned resource. No MaxActivitiesCount Int32 Maximum number of activities to return. If not specified no activities are returned. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No MFPFilterCriteria Int16 If set, filters based on whether MFP Friendly. See Remarks section of this API to get more information. No NodeId Int16 Gets activities with this node ID. No PageDirection Int16 Specify which direction to get next group of activities. 0 indicates retrieve next page, 1 indicates retrieve previous page No Priority Int16 Priority of the activity. Highest priority = 1; Lowest priority = 10 No PriorityType Int16 If set, filters by the type of the priority. See Remarks section of this API to get more information. No Process Identity If specified, gets activities from jobs created on the specified process. No Resource Identity Only required if the work queue is being retrieved for a group and the caller is a member of that group. No ReturnJobIds Boolean Returns Job IDs with results. No ScoreFilter ScoreFilter If populated, gets activities from jobs that have reached a specified score. No StartDueDateTime DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, the filter is not considered. No StatusFilter Int16 Use status for filtering. See the Remarks section of this API for more information. No UseActivitySlaStatus Boolean If set to true, uses the activity SLA status. No UseCombinedWorkQueue Boolean If a resource is specified, then gets activities for the worker's groups as well. No UseJobSlaStatus Boolean If set to true, uses the job SLA status. No UsePrioritySetting Int16 Tells the API how to use the Priority parameter. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If the ID member is populated, you can filter on the specified work type. No SortOptions ActivitySortOptionsCollection If supplied and system level custom sorting is enabled, activities are sorted based on the specified sort fields; otherwise, default sorting will be performed. Maximum 3 sort fields should be specified, exceeding which, only the first 3 fields will be considered for sorting. An exception is thrown when an invalid sort field is specified. No

Returns

An object of type WorkQueue2, which represents the work queue of a resource.

Remarks

The GetWorkQueue2 API supports pagination. For paging to work specify the DueDateTime or Priority or Pending time for the first or last activity on your current page, depending on the direction (Previous or Next) to page. Set MaxActivitiesCount (page size) to the number of items you want returned on a single page.

Apply Paging using Due date and Pending Time:
Specify the PageDirection.
Specify StartDueDate to indicate from where you want to start the next page or end the previous page.
Specify StartPendingTime. When there are activities with same due date, the next or previous page is determined using the StartPendingTime
Activities will be ordered by Due date, Priority and pending time.
Apply Paging using Priority, Due date and pending time:
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
Specify StartDueDate. When there are activities with same Priority, the next or previous page is determined using the StartDueDate.
Specify StartPendingTime. When there are activities with same Priority and due date, the next or previous page is determined using the StartPendingTime.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using Priority and Due date :
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
Specify StartDueDate. When there are activities with same Priority, the next or previous page is determined using the StartDueDate. We recommend to specify StartPendingTime also for the paging to work as expected when there are activities with same priority and due date.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using Priority and Pending Time :
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
Specify StartPendingTime. When there are activities with same Priority, the next or previous page is determined using the StartPendingTime.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using Priority :
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
We recommend to specify StartPendingTime for the paging to work as expected when there are activities with same priority.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using DueDate :
Specify the PageDirection.
Specify StartDueDate to indicate from where you want to start the next page or end the previous page.
We recommend to specify StartPendingTime for the paging to work as expected when there are activities with same due date.
Activities will be ordered by Due date, Priority and pending time.
Apply Paging using Start Pending Time :
Specify the PageDirection.
Specify StartPendingTime to indicate from where you want to start the next page or end the previous page.
We recommend to use StartPendingTime with UsingStartPriority and/or StartDuedate for the paging to work as expected
Activities will be ordered by Due date, Priority and pending time.
For example, assuming your page size is 20, the first page would be obtained by setting MaxActivitiesCount = 20. When Meta data is not specified then activities are ordered by the due date, priority and pending time.
To get page 2, recall GetWorkQueue2 by passing the following details:

MaxActivitiesCount = 20

PageDirection = 0

StartDueDateTime = WorkQueue2.LastDueDate (Starts the next page from the last activity of the current page, specify this to apply paging with DueDate)

Priority = WorkQueue2.LastPriority (Starts the next page from the last activity of the current page, specify this to apply paging with Priority)

StartPendingTime = WorkQueue2.LastPendingTime
To get the previous page from page 2, call GetWorkQueue2 again by passing the following details:

MaxActivitiesCount = 20

PageDirection = 1

StartDueDateTime = WorkQueue2.FirstDueDate (Ends the previous page at the first activity of the current page, specify this to apply paging with DueDate)

Priority = WorkQueue2.FirstPriority (Ends the previous page at the first activity of the current page, specify this to apply paging with Priority)

StartPendingTime = WorkQueue2.FirstPendingTime
Note: If you are currently on page 2 and an activity on the previous page (page 1) has been completed and is no longer available to the resource, this call could result in less than the MaxActivitiesCount being returned.

The enumeration for ActivitySlaStatus filter setting follows.

Enumeration	Description
0	SLA Status 1
1	SLA Status 2
2	SLA Status 3
3	SLA Status 4
4	SLA Status 5

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	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

The enumeration for JobSlaStatus filter setting follows.

Enumeration	Description
0	SLA Status 1
1	SLA Status 2
2	SLA Status 3
3	SLA Status 4
4	SLA Status 5

The enumeration for MFPFilterCriteria setting follows.

Enumeration	Description
0	The exclude MFP only
1	The MFP friendly and MFP only

The enumeration for PriorityType setting follows.

Enumeration	Description
0	Activities are filtered based on activity priority due date
1	Activities are filtered based on job priority due date

The enumeration for StatusFilter setting follows. If, for example you wanted only activities with status Pending and Active you would supply 3 (i.e. 1 + 2)

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

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), 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.

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

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required AssignedResourceFilter Int16 Can specify the assigned resource filter. See remarks section below for more information No DueDateFilterType Int16 Can specify the due date filter type. See remarks section below for more information No MaxActivitiesCount Int32 Can specify the maximum number of activities to return. No StartDueDateTime DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, then the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, then the filter is not considered. No ActivityTypeFilters Int32 You can supply one or more types of activity to return. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If Id member is populated, then we will filter on the specified work type. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No ReturnJobIds Boolean Return Job Ids with results No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No Priority Int16 Priority level of activity. Highest Priority is 1. Lowest Priority is 10 No ActivityName String If set, only get activities with this name No Resource Identity This is required only if it is a group that the workqueue is being retrieved for and the the caller must be a member of the specified group. No UseCombinedWorkQueue Boolean If a resource supplied, then gets activities for the workers groups as well No UseJobSlaStatus Boolean If set to true, then uses the JobSlaStatus No JobSlaStatus Int16 Only gets activities which meet the jobs Service Level Agreements No JobState String If set, will only get activities from jobs that are in the specified state. States can be used to monitor the status or percentage complete of a particular job. No PageDirection Int16 Specify which direction to get next group of activities. 0 indicates retrieve next page, 1 indicates retrieve previous page No UseActivitySlaStatus Boolean If set to true, then uses the ActivitySlaStatus No ActivitySlaStatus Int16 Only gets activities which meet the activities Service Level Agreements No Process Identity If populated, get activities from jobs created on the specified process. No Case Identity If specified, will get activities using the case id. No CaseActivitiesOnly Boolean If set to true, then only get activites from the specified case No Category Identity If populated, get activities within this category. No ScoreFilter ScoreFilter If populated, get activities from jobs that have reached a specified score. No EndDueDateTime DateTime Can supply the latest due date of an activity that will be returned. If EndDueDateTime is null, then the filter is not considered. No JobIdsFilter JobIdentityCollection If supplied, will only get activities from the specified jobs No StatusFilter Int16 Use status for filtering. See Remarks section of this API to get more information. No NodeId Int16 Get activities with this node Id. No LoanResource ResourceIdentity If set, then we also get activities assigned to the on loan resource. No SortOptions ActivitySortOptionsCollection If supplied and system level custom sorting is enabled, activities are sorted based on the specified sort fields; otherwise, default sorting will be performed. Maximum 3 sort fields should be specified, exceeding which, only the first 3 fields will be considered for sorting. An exception is thrown when an invalid sort field is specified. No

Returns

The number of activities based on query filter or query Id.

Remarks

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

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

Security

No restrictions apply.

WorkQueueOverview GetWorkQueueOverview	(	string	sessionId,
		ResourceIdentity	resource,
		WorkQueueOverviewFilter	activityFilter
	)

Retrieves details of the activity workloads for the specified resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
activityFilter	A WorkQueueOverviewFilter object that is used to filter the activities to base the workload on. Name Type Comment Required StartDate DateTime Can supply the earliest due date for an activity that will be returned. If StartDate is null, then the filter is not considered. No EndDate DateTime Can supply the latest due date for an activity that will be returned. If EndDate is null, then the filter is not considered. No Category Identity If populated, only get activities within this category. No GetWorkQueueDefinitionWorkloads Boolean NOT used by this API No GetIndividualWorkload Boolean Will only get activities assigned to the resource No GetCombinedWorkload Boolean Will get activities assigned to the resource and groups they are a member of No

Returns

A WorkQueueOverview object that has the workload for activities assigned directly to the resource, the workload for activities assigned to resource as a results of group membership, the workload for particular worktypes (if that filter parameter was supplied) and the workload based on the service level agreement thresholds.

Remarks

At least 1 of GetWorkQueueDefinitionWorkloads, GetIndividualWorkload or GetCombinedWorkload must be set to true.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required MaxActivitiesCount Int32 Can specify the maximum number of activities to return. No StartDueDateTime DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, then the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, then the filter is not considered. No ActivityTypeFilters Int32 You can supply one or more types of activity to return. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If Id member is populated, then we will filter on the specified work type. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No ReturnJobIds Boolean Return Job Ids with results No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No Priority Int16 Priority level of activity. Highest Priority is 1. Lowest Priority is 10 No ActivityName String If set, only get activities with this name No Resource Identity This is required only if it is a group that the workqueue is being retrieved for and the the caller must be a member of the specified group. No UseCombinedWorkQueue Boolean If a resource supplied, then gets activities for the workers groups as well No UseJobSlaStatus Boolean If set to true, then uses the JobSlaStatus No JobSlaStatus Int16 Only gets activities which meet the jobs Service Level Agreements No JobState String If set, will only get activities from jobs that are in the specified state. States can be set in job to indicate where they are in the process No PageDirection Int16 Specify which direction to get next group of activities. 0 indicates retrieve next page, 1 indicates retrieve previous page No UseActivitySlaStatus Boolean If set to true, then uses the ActivitySlaStatus No ActivitySlaStatus Int16 Only gets activities which meet the activities Service Level Agreements No Process Identity If populated, get activities from jobs created on the specified process. No Case Identity If specified, will get activities using the case id. No CaseActivitiesOnly Boolean If set to true, then only get activites from the specified case No Case Identity If populated, get activities within this category. No ScoreFilter ScoreFilter If populated, get activities from jobs that have reached a specified score. No EndDueDateTime DateTime Can supply the latest due date of an activity that will be returned. If EndDueDateTime is null, then the filter is not considered. No JobIdsFilter JobIdentityCollection If supplied, will only get activities from the specified jobs No StatusFilter Int16 Use status for filtering. See Remarks section of this API to get more information. No NodeId Int16 Get activities with this node Id. No LoanResource ResourceIdentity If set, then we also get activities assigned to the on loan resource. No SortOptions ActivitySortOptionsCollection If supplied and system level custom sorting is enabled, activities are sorted based on the specified sort fields; otherwise, default sorting will be performed. Maximum 3 sort fields should be specified, exceeding which, only the first 3 fields will be considered for sorting. An exception is thrown when an invalid sort field is specified. No

Returns

An object of type WorkQueueQueryResult2, which represents the work queue of a resource.

Remarks

The GetWorkQueueWithQuery2 API supports pagination. For paging to work specify the DueDateTime or Priority or Pending time for the first or last activity on your current page, depending on the direction (Previous or Next) to page. Set MaxActivitiesCount (page size) to the number of items you want returned on a single page.

Apply Paging using Due date and Pending Time:
Specify the PageDirection.
Specify StartDueDate to indicate from where you want to start the next page or end the previous page.
Specify StartPendingTime. When there are activities with same due date, the next or previous page is determined using the StartPendingTime
Activities will be ordered by Due date, Priority and pending time.
Apply Paging using Priority, Due date and pending time:
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
Specify StartDueDate. When there are activities with same Priority, the next or previous page is determined using the StartDueDate.
Specify StartPendingTime. When there are activities with same Priority and due date, the next or previous page is determined using the StartPendingTime.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using Priority and Due date :
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
Specify StartDueDate. When there are activities with same Priority, the next or previous page is determined using the StartDueDate. We recommend to specify StartPendingTime also for the paging to work as expected when there are activities with same priority and due date.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using Priority and Pending Time :
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
Specify StartPendingTime. When there are activities with same Priority, the next or previous page is determined using the StartPendingTime.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using Priority :
Specify the PageDirection.
Specify the UsePrioritySetting as 2 to indicate UsingStartPriority.
Specify Priority to indicate from where you want to start the next page or end the previous page.
We recommend to specify StartPendingTime for the paging to work as expected when there are activities with same priority.
Activities will be ordered by Priority, Due date and pending time.
Apply Paging using DueDate :
Specify the PageDirection.
Specify StartDueDate to indicate from where you want to start the next page or end the previous page.
We recommend to specify StartPendingTime for the paging to work as expected when there are activities with same due date.
Activities will be ordered by Due date, Priority and pending time.
Apply Paging using Start Pending Time :
Specify the PageDirection.
Specify StartPendingTime to indicate from where you want to start the next page or end the previous page.
We recommend to use StartPendingTime with UsingStartPriority and/or StartDuedate for the paging to work as expected
Activities will be ordered by Due date, Priority and pending time.
For example, assuming your page size is 20, the first page would be obtained by setting MaxActivitiesCount = 20. When Meta data is not specified then activities are ordered by the due date, priority and pending time.
To get page 2, recall GetWorkQueue2 by passing the following details:

MaxActivitiesCount = 20

PageDirection = 0

StartDueDateTime = WorkQueue2.LastDueDate (Starts the next page from the last activity of the current page, specify this to apply paging with DueDate)

Priority = WorkQueue2.LastPriority (Starts the next page from the last activity of the current page, specify this to apply paging with Priority)

StartPendingTime = WorkQueue2.LastPendingTime
To get the previous page from page 2, call GetWorkQueue2 again by passing the following details:

MaxActivitiesCount = 20

PageDirection = 1

StartDueDateTime = WorkQueue2.FirstDueDate (Ends the previous page at the first activity of the current page, specify this to apply paging with DueDate)

Priority = WorkQueue2.FirstPriority (Ends the previous page at the first activity of the current page, specify this to apply paging with Priority)

StartPendingTime = WorkQueue2.FirstPendingTime
Note: If you are currently on page 2 and an activity on the previous page (page 1) has been completed and is no longer available to the resource, this call could result in less than the MaxActivitiesCount being returned.

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
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

Security

No restrictions apply.

WorkSummary GetWorkSummary2	(	string	sessionId,
		WorkSummaryFilter2	filter
	)

Retrieves the work summary based on the filter criteria.

Parameters

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. Name Type Comment Required DateTime Date Used to find activities whose due date is after the supplied DateTime member Yes WorkQueueDefinition WorkQueueDefinitionIdentity If supplied, get the work queue definition information as well No GetIndividualSummary Boolean If set to true, only get the work summary for the resource and don't get work summary for groups they are a member of. If set to false, then get the work summary for the resource and for all groups they are a member of Yes ResourceIdentity ResourceIdentity If supplied, then filter based on the resource identity passed in, otherwise use the current logged on user resource identity No

Returns

Object of type WorkSummary, which represents the details of the work summary for the specified user.

Security

No restrictions apply.

void PartiallyCompleteActivity	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		JobActivityOutput	jobActivityOutput
	)

Partially completes the automatic capture activity for which the partial completion property is set to true.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No LoggingData string This is for internal use only. No

Remarks

After a successful partial completion, the activity is not deleted and stays taken for subsequent PartiallyCompleteActivity call. If the specified precondition configured on the activity is met, then the next activity will be available to progess.

Security

No restrictions apply.

void PerformAutoWorkAllocation	(	string	sessionId,
		AutoWorkAllocationOptions	filter
	)

Performs automatic work allocation based on the specified allocation options in the filter parameter.

Parameters

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. Name Type Comment Required StartDate DateTime Look for activities whose Due Date is greater than StartDate value Yes EndDate DateTime Look for activities whose Due Date is less than EndDate value Yes UseDesignTimeResource Boolean Use design time resources if true No UCMAPresenceServiceURL String If not empty then check presence of workers. No ResourceSkillUsage Int16 The resource skill setting to be used No The ResourceSkillUsage enumeration is: Enumeration Description 0 Server Level 1 Process Level 2 Not Used

Remarks

Performs automatic work allocation of AwaitingAllocation activities to resources with due dates in the date range specified and where the resources have the correct skill and security settings
If UseDesignTimeResource member of filter parameter is set to true, then we use the design time resources i.e. not runtime/dynamic resources.
If WcfUrl member of filter parameter has a value, then we check to see if the user is available.
If ResourceSkillUsage member is supplied then server level skill usage settings will be overridden.
If ResourceSkillUsage member is supplied with value -1 and UseDesignTimeResource member is false then there will not be any change in work allocation.

Security

No restrictions apply.

void ReassignActivities	(	string	sessionId,
		ResourceIdentity	originalResource,
		ResourceIdentity	newResource,
		JobActivityIdentityCollection	jobActivityIdentities
	)

Reassigns one or more activities from one resource to another resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
newResource	A ResourceIdentity identity object containing the resource id to whom the activity has to be assigned. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
jobActivityIdentities	A JobActivityIdentityCollection collection object that contains of activities to reassign. JobActivityIdentity members. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Remarks

The newResource parameter must refer to a resource of type worker, group or role (fixed or floating).
If auditing is enabled, a new audit entry will be created with details of each reassigned activity.

Security

No restrictions apply.

void ReassignActivity	(	string	sessionId,
		ResourceIdentity	originalResource,
		ResourceIdentity	newResource,
		JobActivityIdentity	jobActivityIdentity
	)

Reassigns a specified activity of a specified job from one resource to another resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
newResource	A ResourceIdentity identity object containing the resource id to whom the activity has to be assigned. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
jobActivityIdentity	A JobActivityIdentity identity object that is used to identify the activity in a job to reassign. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Remarks

The newResource parameter must refer to a resource of type worker, group or role (fixed or floating).
If the activity is no longer pending then an exception will be raised.
If auditing is enabled, a new audit entry will be created with details of the reassigned activity.

Security

No restrictions apply.

void ReassignAllActivities	(	string	sessionId,
		ResourceIdentity	originalResource,
		ResourceIdentity	newResource
	)

Reassigns all live activities assigned to a resource to a different resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No
newResource	A ResourceIdentity identity object containing the resource id to whom the activity has to be assigned. Name Type Comment Required Id String The ID of the resource that is being assigned to this activity. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No

Security

No restrictions apply.

void ResetTakenActivities	(	string	sessionId,
		JobActivityIdentityCollection	activitiesToReset
	)

Resets the specified taken activities. The activities will be reset from Taken to Pending status.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Security

No restrictions apply.

void ResetTakenActivitiesForResource	(	string	sessionId,
		ResourceIdentity	resource
	)

Resets the taken activities for the specified resource.

Parameters

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. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No

Security

No restrictions apply.

void SaveActivity	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		JobActivityOutput	jobActivityOutput
	)

Saves the taken activity with the output variable values.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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. Name Type Comment Required OutputVariables Collection A collection of OutputVariable. No SetTime DateTime The time the activity is completed. No Cost Double Cost of the completed activity. No LoggingData string This is for internal use only. No

Security

No restrictions apply.

JobActivity TakeActivity	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity
	)

Takes an activity for completion.

Parameters

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.. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No

Returns

A JobActivity object that represents the activity that has been taken including any input and output variables. The input and output variables in the return parameter are displayed in the order defined and if no order is set, the order of the variables is displayed as configured.

Remarks

If the activity is no longer pending, or has already been taken by another resource an exception will be raised.
When an activity is taken it will not be available on anyone else's workqueue unless the activity has been configured for concurrent resource access. The activity will remain taken until it is completed or until a resources session is renewed, in which case the taken activity is reclaimed.
If auditing is enabled, a new audit entry will be created with details of the activity that has been taken.

Security

No restrictions apply.

JobActivity TakeActivityFromJob	(	string	sessionId,
		JobIdentity	jobIdentity
	)

Takes an activity from the work queue of the logged on user for a specified job.

Parameters

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. Name Type Comment Required Id String The id of the job to take activity from Yes

Returns

An object of type JobActivity which holds the details of the taken activity.

Security

No restrictions apply.

JobActivity TakeAnyActivity

(

string

sessionId

)

Takes any activity from the work queue of the logged on user.

Parameters

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.

Returns

An object of type JobActivity which holds the details of the taken activity.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required MaxActivitiesCount Int32 Can specify the maximum number of activities to return. No StartDueDate DateTime Can supply the earliest due date for an activity that will be returned. If StartDueDateTime is null, then the filter is not considered. No StartPendingTime DateTime Can supply the earliest pending time for an activity that will be returned. If StartPendingTime is null, then the filter is not considered. No ActivityTypeFilters Int32 You can supply one or more types of activity to return. See Remarks section of this API to get more information. No WorkQueueDefinition WorkQueueDefinitionIdentity If Id member is populated, then we will filter on the specified work type. No MetaDataFilter MetaDataFilter If supplied, get activities where work type fields have a particular value No UsePrioritySetting Int16 If set to true, then the API will use the supplied priority level. See Remarks section of this API to get more information. No Priority Int16 Priority level of activity. Highest Priority is 1. Lowest Priority is 10 No ActivityName String If set, only get activities with this name No UseJobSlaStatus Boolean If set to true, then uses the JobSlaStatus No JobSlaStatus Int16 Only gets activities which meet the jobs Service Level Agreements No JobState String If set, will only get activities from jobs that are in the specified state. States can be used to monitor the status or percentage complete of a particular job. No UseActivitySlaStatus Boolean If set to true, then uses the ActivitySlaStatus No ActivitySlaStatus Int16 Only gets activities which meet the activities Service Level Agreements No UseCombinedWorkQueue Boolean If set to true, then get activities for the resources and also activities for groups the resource is a member of No UseWorkAllocationRules Boolean If set to true, then use work allocation rules. See Remarks section for additional information No UserFilterData String json representation of the JobActivityFilter JobActivityFilter If set, this filter takes precedence No

Returns

An instance of type NextActivity object containing the next activity information.

Remarks

The TakeNextActivity2 API will override the UseWorkAllocationRules member of the filter parameter and ALWAYS set it to true.
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	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~*"

Security

No restrictions apply.

void UpdateActivityDueDate	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		DateTime	dueDate,
		bool	resetException
	)

Updates the due date of a specified activity.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
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.

Remarks

If there are service level agreement (SLA) thresholds and triggers defined for the activity they will be updated accordingly based on the new due date.

Security

No restrictions apply.

void UpdateActivityPriority	(	string	sessionId,
		JobActivityIdentity	jobActivityIdentity,
		short	activityPriority
	)

Updates the priority of a specified activity in a job.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
activityPriority	The new activity priority for the specified activity.

Remarks

If auditing is enabled, a new audit entry will be created with details of the activity that has been updated.

Security

No restrictions apply.

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.

Parameters

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. Name Type Comment Required NodeId Int16 The ID of the activity within a process. Yes EmbeddedProcessCount Int16 The map level on which the activity resides. A value of 0 indicates that the map is the parent map, if the value is 1 it is a child map and so on. Yes JobId String The job to which the activity belongs. Yes ActivityName String Name of the activity. NOT used by this API. No
resourceIdentityCollection	A ResourceIdentityCollection collection of resources to assign to the activity. ResourceIdentity members. Name Type Comment Required Id String The ID of the resource. Yes Name String Name of the resource. NOT used by this API. No ResourceType Int16 Type of the resource. NOT used by this API. No

Remarks

If advanced workflow rules are defined on the activity then the resources cannot be updated, an exception will be thrown.
If advanced workflow rules are not defined, then any existing resources will be removed and replaced with those in the resourceIdentityCollection parameter.

Security

No restrictions apply.