All Classes Namespaces Functions Properties Pages
Public Member Functions | Properties | List of all members
JobActivityQueryFilter Class Reference

Contains the search filter criteria for GetWorkQueueWithQuery and GetActivitiesWithQuery More...

Public Member Functions

 JobActivityQueryFilter ()
 Initializes a new instance of the JobActivityQueryFilter class. More...
 

Properties

short ActivityDesignType [get, set]
 Gets or sets the Activity Type filter.
The enumeration for ActivityDesignType setting follows.

EnumerationDescription
0None
1Ordinary Activity node
2Decision node
3Embedded Process node
4Library node
5Start Point node
6End Point node
7Script Activity node
8COM Activity node
9Transactional Activity node
10DotNet Activity node
11Web Service Activity node
12Xml Activity node
13CSharp Activity node
14VBNet Activity node
15Create New Job Activity node
16Create Sub Job Activity node
17Data Access Activity node
18Design Activity node
19Event Activity node
20Resource Info Activity node
21Job Owner Activity node
22Job Variable Info Activity node
23Sleep Activity node
24Synchronization Activity node
25Extraction Capture Activity node
26Separation Classification Capture Activity node
27Scan Capture Activity node
28Validation Capture Activity node
29Verification Capture Activity node
30Document Review Capture Activity node
32Loop Activity node. Skipped value 31 deliberately
33Expression Activity node
34SharePoint Create Site node
35SharePoint Create Folder node
36SharePoint Add Item node
37SharePoint DeleteItem node
38SharePoint UpLoader node
39SharePoint Move Item node
40SharePoint Get Document node
41PDF Generation Activity node
99Custom node
101Business Rule node
102Email Activity node
103Customer Data node
104RESTful Service node
105Document Generation Activity node
106Dynamics CRM node
107Ready For Review node
108Image Processing node
109Composite node
110CMIS Get Document node
111Trim Create Folder node
112Trim Add Document node
113CMIS Add Document node
114CMIS Update Document node
115Trim Get Document node
116CMIS Create Folder node
117CMIS Check In Document node
118CMIS Cancel Checkout Document node
119CMIS Find Document node
120Exchange Server Get Attachments node
121Capture Delete node
122Capture Export node
123Dynamics AX node
124Dynamics AX Search node
125Kapow node
126Transfer Activity node
127Document State node
128Document Received node
129Evaluate Document Set node
130Add DocumentType node
131Softpro Sign Documents node
132CCM Compose node
133CCM Distribute node
134Perceptive Add Document node
135Perceptive Get Document node
136Perceptive Update Document node
137Perceptive Delete Document node
138Perceptive Find Document node
139Perceptive Create Folder node
140Perceptive Check In Document node
141Perceptive Cancel Check-out Document node
More...
 
string ActivityName [get, set]
 Gets or sets the name of the activity. More...
 
short ActivitySlaStatus [get, set]
 Gets or sets the status of the activity using sla notation. More...
 
int ActivityTypeFilters [get, set]
 Gets or sets the type of activity. More...
 
short AssignedResourceFilter [get, set]
 Gets or sets the assigned resource filter.
The enumeration for AssignedResourceFilter setting follows.

EnumerationDescription
-1None
0The resource
1The resource and its groups
2The direct subordinates of the resource
3The resource and its direct subordinates
4The indirect subordinates of the resource
5The resource and its indirect subordinates
6The core worker service
7The transformation server service
8The export service
9The system. Includes core worker, transformation server and export services
10A worker or a group resource
11Any role, resource or group
More...
 
CaseIdentity Case [get, set]
 Gets or sets the the activities for a specified case. More...
 
bool CaseActivitiesOnly [get, set]
 Gets or sets a value indicating whether to retrieve activities based on the case. More...
 
CategoryIdentity Category [get, set]
 Gets or sets the category. More...
 
short CompletedDateFilterType [get, set]
 Gets or sets the type of the completed date filter. /n This is used to filter on the activity completed date. It will only apply if CompletedWork is set to true

EnumerationDescription
0All
1Due date since
2Due date between
3Due date of today
4Due date of this week
5Due date of this month
6Due date of this year
More...
 
short CompletedResourceFilter [get, set]
 Gets or sets the completed resource filter.
This is used to filter on the resource that completed the activity. It will only apply if CompletedWork is set to true

EnumerationDescription
-1None
0The resource
1The resource and its groups
2The direct subordinates of the resource
3The resource and its direct subordinates
4The indirect subordinates of the resource
5The resource and its indirect subordinates
6The core worker service
7The transformation server service
8The export service
9The system. Includes core worker, transformation server and export services
10A worker or a group resource
11Any role, resource or group
More...
 
bool CompletedWork [get, set]
 Gets or sets a value indicating whether [completed work].
Determines whether the query will look for live activities or completed activities. Default value is false. More...
 
short DueDateFilterType [get, set]
 Gets or sets the type of the due date.
The enumeration for DueDateFilterType setting follows.

EnumerationDescription
0All
1Due date since
2Due date between
3Due date of today
4Due date of this week
5Due date of this month
6Due date of this year
More...
 
short DueDateType [get, set]
 Gets or sets the type of the due date. Valid values are 0 (ACtivity) and 1 (Job). More...
 
DateTime EndDueDateTime [get, set]
 Gets or sets the end due date time. More...
 
bool GetQueryResultCount [get, set]
 Gets or sets a value indicating whether to get actvities count. More...
 
JobIdentityCollection JobIdsFilter [get, set]
 Gets or sets the job ids filter. More...
 
short JobSlaStatus [get, set]
 Gets or sets the status of the job using sla notation. More...
 
string JobState [get, set]
 Gets or sets the state of the job. States can be used to monitor the status or percentage complete of a particular job. More...
 
ResourceIdentity LoanResource [get, set]
 Gets or sets the loan resource. More...
 
int MaxActivitiesCount [get, set]
 Gets or sets maximum number of activities. More...
 
MetaDataFilter MetaDataFilter [get, set]
 Gets or sets the meta data filter configuration. More...
 
short MFPFilterCriteria [get, set]
 Gets or sets the value for retrieving the activities based on MFP Ready settings. Valid values are 0 (Retries MFPFriendly and non MFP activities) and 1 (Retries MFPFriendly and MFPOnly activities). More...
 
short NodeId [get, set]
 Gets or sets the node id. More...
 
short PageDirection [get, set]
 Gets or sets the page direction of the next page. More...
 
short PendingTimeFilter [get, set]
 Gets or sets the pending time filter.
The enumeration for PendingTimeFilter setting follows.

EnumerationDescription
0All i.e. do not use the pending time filter
1Activity has been pending for less than five minutes
2Activity has been pending for more than five minutes
3Activity has been pending for less than fifteen minutes
4Activity has been pending for more than fifteen minutes
5Activity has been pending for less than thirty minutes
6Activity has been pending for more than thirty minutes
7Activity has been pending for less than sixty minutes
8Activity has been pending for more than sixty minutes
9Activity has been pending for less than one day
10Activity has been pending for more than one day
11Activity has been pending for less than one week
12Activity has been pending for more than one week
13Activity has been pending for less than one month
14Activity has been pending for more than one month
More...
 
short Priority [get, set]
 Gets or sets the priority of activity. More...
 
short PriorityType [get, set]
 Gets or sets the type of the priority. Valid values are 0 (ACtivity) and 1 (Job). More...
 
ProcessIdentity Process [get, set]
 Gets or sets the process to retrieve the activities. More...
 
ResourceIdentity Resource [get, set]
 Gets or sets the details of the resource id. More...
 
bool ReturnJobIds [get, set]
 Gets or sets a value indicating whether to set return jobids. More...
 
ScoreFilter ScoreFilter [get, set]
 Gets or sets the score filter. More...
 
ActivitySortOptionsCollection SortOptions [get, set]
 Gets or sets the sort options which holds the sorting details of the workqueue/ System Queries. When ServerSettings property “Enable Workqueue Custom Sorting” is turned on, based on this SortOptions info sorting will be performed. If SortOptions is null, sorting will be performed as per default sort order. More...
 
DateTime StartDueDateTime [get, set]
 Gets or sets the start due date time. More...
 
DateTime StartPendingTime [get, set]
 Gets or sets the start pending time. More...
 
short StatusFilter [get, set]
 Gets or sets the activity status filter to search on. More...
 
string SuspendReason [get, set]
 Gets or sets the suspend reason. More...
 
bool UseActivityDesignType [get, set]
 Gets or sets a value indicating whether the ActivityDesignType Filter is used. More...
 
bool UseActivitySlaStatus [get, set]
 Gets or sets a value indicating whether to use activity sla status. More...
 
bool UseCombinedWorkQueue [get, set]
 Gets or sets a value indicating whether to use a combined workqueue. More...
 
bool UseJobSlaStatus [get, set]
 Gets or sets a value indicating whether to use job sla status. More...
 
short UsePrioritySetting [get, set]
 Gets or sets the whether to use priority in search criteria. More...
 
WorkQueueDefinitionIdentity WorkQueueDefinition [get, set]
 Gets or sets the workqueue definition to include in search criteria. More...
 

Description

Contains the search filter criteria for GetWorkQueueWithQuery and GetActivitiesWithQuery

Constructor & Destructor Documentation

Initializes a new instance of the JobActivityQueryFilter class.

Property Documentation

short ActivityDesignType
getset

Gets or sets the Activity Type filter.
The enumeration for ActivityDesignType setting follows.

EnumerationDescription
0None
1Ordinary Activity node
2Decision node
3Embedded Process node
4Library node
5Start Point node
6End Point node
7Script Activity node
8COM Activity node
9Transactional Activity node
10DotNet Activity node
11Web Service Activity node
12Xml Activity node
13CSharp Activity node
14VBNet Activity node
15Create New Job Activity node
16Create Sub Job Activity node
17Data Access Activity node
18Design Activity node
19Event Activity node
20Resource Info Activity node
21Job Owner Activity node
22Job Variable Info Activity node
23Sleep Activity node
24Synchronization Activity node
25Extraction Capture Activity node
26Separation Classification Capture Activity node
27Scan Capture Activity node
28Validation Capture Activity node
29Verification Capture Activity node
30Document Review Capture Activity node
32Loop Activity node. Skipped value 31 deliberately
33Expression Activity node
34SharePoint Create Site node
35SharePoint Create Folder node
36SharePoint Add Item node
37SharePoint DeleteItem node
38SharePoint UpLoader node
39SharePoint Move Item node
40SharePoint Get Document node
41PDF Generation Activity node
99Custom node
101Business Rule node
102Email Activity node
103Customer Data node
104RESTful Service node
105Document Generation Activity node
106Dynamics CRM node
107Ready For Review node
108Image Processing node
109Composite node
110CMIS Get Document node
111Trim Create Folder node
112Trim Add Document node
113CMIS Add Document node
114CMIS Update Document node
115Trim Get Document node
116CMIS Create Folder node
117CMIS Check In Document node
118CMIS Cancel Checkout Document node
119CMIS Find Document node
120Exchange Server Get Attachments node
121Capture Delete node
122Capture Export node
123Dynamics AX node
124Dynamics AX Search node
125Kapow node
126Transfer Activity node
127Document State node
128Document Received node
129Evaluate Document Set node
130Add DocumentType node
131Softpro Sign Documents node
132CCM Compose node
133CCM Distribute node
134Perceptive Add Document node
135Perceptive Get Document node
136Perceptive Update Document node
137Perceptive Delete Document node
138Perceptive Find Document node
139Perceptive Create Folder node
140Perceptive Check In Document node
141Perceptive Cancel Check-out Document node

string ActivityName
getsetinherited

Gets or sets the name of the activity.

short ActivitySlaStatus
getsetinherited

Gets or sets the status of the activity using sla notation.

int ActivityTypeFilters
getsetinherited

Gets or sets the type of activity.

Remarks
EnumerationDescription
1Manual Ordinary
4Manual Script
8Manual Create New Job
32Auto Script
64Auto Transactional
128Auto Create New Job
256Manual Adhoc
512Manual Mobile
1024Alert Task
short AssignedResourceFilter
getset

Gets or sets the assigned resource filter.
The enumeration for AssignedResourceFilter setting follows.

EnumerationDescription
-1None
0The resource
1The resource and its groups
2The direct subordinates of the resource
3The resource and its direct subordinates
4The indirect subordinates of the resource
5The resource and its indirect subordinates
6The core worker service
7The transformation server service
8The export service
9The system. Includes core worker, transformation server and export services
10A worker or a group resource
11Any role, resource or group

CaseIdentity Case
getsetinherited

Gets or sets the the activities for a specified case.

bool CaseActivitiesOnly
getsetinherited

Gets or sets a value indicating whether to retrieve activities based on the case.

CategoryIdentity Category
getsetinherited

Gets or sets the category.

short CompletedDateFilterType
getset

Gets or sets the type of the completed date filter. /n This is used to filter on the activity completed date. It will only apply if CompletedWork is set to true

EnumerationDescription
0All
1Due date since
2Due date between
3Due date of today
4Due date of this week
5Due date of this month
6Due date of this year

The type of the completed date filter.

short CompletedResourceFilter
getset

Gets or sets the completed resource filter.
This is used to filter on the resource that completed the activity. It will only apply if CompletedWork is set to true

EnumerationDescription
-1None
0The resource
1The resource and its groups
2The direct subordinates of the resource
3The resource and its direct subordinates
4The indirect subordinates of the resource
5The resource and its indirect subordinates
6The core worker service
7The transformation server service
8The export service
9The system. Includes core worker, transformation server and export services
10A worker or a group resource
11Any role, resource or group

The completed resource filter.

bool CompletedWork
getset

Gets or sets a value indicating whether [completed work].
Determines whether the query will look for live activities or completed activities. Default value is false.

true if [completed work]; otherwise, false.

short DueDateFilterType
getset

Gets or sets the type of the due date.
The enumeration for DueDateFilterType setting follows.

EnumerationDescription
0All
1Due date since
2Due date between
3Due date of today
4Due date of this week
5Due date of this month
6Due date of this year

short DueDateType
getsetinherited

Gets or sets the type of the due date. Valid values are 0 (ACtivity) and 1 (Job).

The type of the due date.

DateTime EndDueDateTime
getsetinherited

Gets or sets the end due date time.

bool GetQueryResultCount
getset

Gets or sets a value indicating whether to get actvities count.

JobIdentityCollection JobIdsFilter
getsetinherited

Gets or sets the job ids filter.

Remarks
The details of the job ids to be retrieved should be included in the collection.
short JobSlaStatus
getsetinherited

Gets or sets the status of the job using sla notation.

string JobState
getsetinherited

Gets or sets the state of the job. States can be used to monitor the status or percentage complete of a particular job.

Remarks
If JobState is null or empty, this filter criteria is not considered.
ResourceIdentity LoanResource
getsetinherited

Gets or sets the loan resource.

int MaxActivitiesCount
getsetinherited

Gets or sets maximum number of activities.

MetaDataFilter MetaDataFilter
getsetinherited

Gets or sets the meta data filter configuration.

short MFPFilterCriteria
getsetinherited

Gets or sets the value for retrieving the activities based on MFP Ready settings. Valid values are 0 (Retries MFPFriendly and non MFP activities) and 1 (Retries MFPFriendly and MFPOnly activities).

short NodeId
getsetinherited

Gets or sets the node id.

short PageDirection
getsetinherited

Gets or sets the page direction of the next page.

Remarks
0 - retrieve next page 1 - retrieve previous page
short PendingTimeFilter
getset

Gets or sets the pending time filter.
The enumeration for PendingTimeFilter setting follows.

EnumerationDescription
0All i.e. do not use the pending time filter
1Activity has been pending for less than five minutes
2Activity has been pending for more than five minutes
3Activity has been pending for less than fifteen minutes
4Activity has been pending for more than fifteen minutes
5Activity has been pending for less than thirty minutes
6Activity has been pending for more than thirty minutes
7Activity has been pending for less than sixty minutes
8Activity has been pending for more than sixty minutes
9Activity has been pending for less than one day
10Activity has been pending for more than one day
11Activity has been pending for less than one week
12Activity has been pending for more than one week
13Activity has been pending for less than one month
14Activity has been pending for more than one month

short Priority
getsetinherited

Gets or sets the priority of activity.

short PriorityType
getsetinherited

Gets or sets the type of the priority. Valid values are 0 (ACtivity) and 1 (Job).

The type of the priority.

ProcessIdentity Process
getsetinherited

Gets or sets the process to retrieve the activities.

ResourceIdentity Resource
getsetinherited

Gets or sets the details of the resource id.

Remarks
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.
bool ReturnJobIds
getsetinherited

Gets or sets a value indicating whether to set return jobids.

ScoreFilter ScoreFilter
getsetinherited

Gets or sets the score filter.

ActivitySortOptionsCollection SortOptions
getsetinherited

Gets or sets the sort options which holds the sorting details of the workqueue/ System Queries. When ServerSettings property “Enable Workqueue Custom Sorting” is turned on, based on this SortOptions info sorting will be performed. If SortOptions is null, sorting will be performed as per default sort order.

DateTime StartDueDateTime
getsetinherited

Gets or sets the start due date time.

Remarks
If StartDueDateTime is null, then the filter is not considered.
DateTime StartPendingTime
getsetinherited

Gets or sets the start pending time.

Remarks
If StartPendingTime is null, then the filter is not considered.
short StatusFilter
getsetinherited

Gets or sets the activity status filter to search on.

EnumerationDescription
0Pending Activity
1Active Activity
2Offered Activity
3Suspended Activity
4Activity Locked
5Active Activity No Evaluation
128All Live Activities
string SuspendReason
getsetinherited

Gets or sets the suspend reason.

The suspend reason.

bool UseActivityDesignType
getset

Gets or sets a value indicating whether the ActivityDesignType Filter is used.

bool UseActivitySlaStatus
getsetinherited

Gets or sets a value indicating whether to use activity sla status.

bool UseCombinedWorkQueue
getsetinherited

Gets or sets a value indicating whether to use a combined workqueue.

bool UseJobSlaStatus
getsetinherited

Gets or sets a value indicating whether to use job sla status.

short UsePrioritySetting
getsetinherited

Gets or sets the whether to use priority in search criteria.

Remarks
EnumerationDescription
0Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead.
1Using Priority - The work queue will be returned in order of priority.
2Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the PrioritiesToRetrieve parameter.
3Using Specific Priority - The work queue will only return activities of the specific priority provided in the PrioritiesToRetrieve parameter.

Gets or sets the workqueue definition to include in search criteria.