Provides methods for creating jobs, updating the status of jobs and managing job properties. More...
Public Member Functions | |
| void | ActivateJob (string sessionId, JobIdentity jobIdentity) |
| Activates a job with the specified job id. More... | |
| void | ActivateJobs (string sessionId, JobIdentityCollection jobIdentityCollection) |
| Activates the jobs with the specified job id's. More... | |
| void | ActivateJobsWithSuspendReason (string sessionId, string suspendReason) |
| Takes a suspend reason and reactivates all jobs that it finds with a matching suspend reason. More... | |
| void | AddJobDocumentRule (string sessionId, JobIdentity jobIdentity, string name, bool restrictedDocument, string description, DocumentTypeIdentity documentTypeIdentity, DateTime?dateRequired, MilestoneIdentity milestoneIdentity, DocumentProcessBasicRule documentBasicRule, DocumentProcessBusinessRule documentBusinessRule, ProcessIdentity documentUploadProcess, bool allowDeletion, ProcessIdentity documentTypeDueProcess, int documentTypeDueExceptionDuration) |
| Adds an adhoc basic rule into a job document rule. More... | |
| void | AddJobNote (string sessionId, JobIdentity jobIdentity, NoteInfo noteInfo) |
| Adds a note that will be associated with a job. More... | |
| void | AddRoleMember (string sessionId, JobIdentity jobIdentity, RoleIdentity roleIdentity, ResourceIdentity resourceIdentity) |
| Adds a member to a specified role. More... | |
| void | AddToNumericVarValue (string sessionId, VariableIdentity2 variableIdentity, object variableValueToAdd) |
| Adds the value that has been passed to a specified variable. More... | |
| void | ArchiveJobs (string sessionId) |
| Archives the jobs when archive settings is off. Archiving operation cannot run when Archive settings is Yes in Server Settings. Archiving operation cannot run when archiving is already in progress. This is an asynchronous operation and executes via worker task. More... | |
| bool | ConfirmJobDocument (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentity documentTypeIdentity) |
| Use the ConfirmJobDocument method to evaluate particular rule of the document set, of the jobid, with the specific document type. The rule will only consider documents that are in an Accepted state. More... | |
| JobDocumentTypeRuleResultCollection | ConfirmJobDocuments (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentityCollection documentTypeIdentityCollection) |
| Use the ConfirmJobDocuments method to evaluate all the rules of the document set, of the jobid. The rule will only consider documents that are in an Accepted state. More... | |
| string | CreateCustomProcessForJob (string sessionId, string jobId, string categoryName, string newProcessName) |
| Creates a new version of the process map based on existing one on a live job and associates job id with the newly created map. More... | |
| JobIdentity | CreateJob (string sessionId, ProcessIdentity processIdentity, JobInitialization jobInitialization) |
| Creates a new instance (a job) for the specified process map. More... | |
| JobProgressOutput | CreateJobAndProgress (string sessionId, ProcessIdentity processIdentity, JobInitialization jobInitialization) |
| This API executes all automatic activities and returns the pending manual activity if available, job id, and job status. More... | |
| JobIdentity | CreateJobAndStartAt (string sessionId, ProcessIdentity processIdentity, JobInitialization jobInitialization, ProcessActivityIdentity processActivityIdentity) |
| Creates a job for a specified business process map and starts it at a specified activity. More... | |
| JobIdentity | CreateJobInCase (string sessionId, ProcessIdentity caseProcessIdentity, CaseIdentity caseJobIdentity, JobInitialization jobInitialization) |
| This API provides the funtionality of CreateJobInCase, CreateJobInCaseUsingMapName, CreateJobInCaseUsingRef and CreateJobInCaseUsingRefMapName. More... | |
| JobProgressOutput | CreateJobInCaseAndProgress (string sessionId, ProcessIdentity processIdentity, CaseIdentity caseIdentity, JobInitialization jobInitialization) |
| This API executes all automatic activities and returns the job id, job status and any pending manual activity of the case fragment job. More... | |
| JobIdentity | CreateJobInCaseWithDocuments (string sessionId, ProcessIdentity caseProcessIdentity, CaseIdentity caseJobIdentity, JobWithDocumentsInitialization jobWithDocsInitialization) |
| This API provides the funtionality of CreateJobInCase, CreateJobInCaseUsingMapName, CreateJobInCaseUsingRef and CreateJobInCaseUsingRefMapName and also accepts documents. More... | |
| JobWithDocumentsProgressOutput2 | CreateJobInCaseWithDocumentsAndProgress2 (string sessionId, ProcessIdentity processIdentity, CaseIdentity caseIdentity, JobWithDocumentsInitialization jobWithDocsInitialization, VariableIdentityCollection variablesToReturn) |
| Creates a new instance (a job) for the specified fragment with documents. In addition, if automatic activities are the first actviites of the job, they will be performed until the job is finished or only manual activities are pending. More... | |
| SyncJob | CreateJobSync (string sessionId, ProcessIdentity processIdentity, JobInitialization jobInitialization, VariableIdentityCollection variablesToReturn) |
| Creates a synchronous job for a specified process map. More... | |
| SyncJobWithDocument | CreateJobSyncWithDocument (string sessionId, ProcessIdentity processIdentity, JobWithDocumentInitialization jobWithDocInitialization, VariableIdentityCollection variablesToReturn) |
| Creates a new instance (a job) for the specified process map with document. This API is designed to enhance capture activities execution by creating document in memory and by accessing local transformation server instance (specify local port number in web.config under setting 'TSExternalServicePortForSyncProcessing', default is 9001). The document data will be committed to database only if user opts to save. In addition, the specified process map can have only automatic activities. Note: This API is supported in RTTS mode only. More... | |
| SyncJobWithDocuments | CreateJobSyncWithDocuments (string sessionId, ProcessIdentity processIdentity, JobWithDocumentsInitialization2 jobWithDocsInitialization, VariableIdentityCollection variablesToReturn) |
| Creates a new instance (a job) for the specified process map with multiple document. This API is designed to enhance capture activities execution by creating document in memory and by accessing local transformation server instance (specify local port number in web.config under setting 'TSExternalServicePortForSyncProcessing', default is 9001). The document data will be committed to the database only if user opts to save. In addition, the specified process map can have only automatic activities. Note: This API is supported in RTTS mode only. More... | |
| JobIdentity | CreateJobUsingProcessType (string sessionId, short processType, string caseReference, ProcessIdentity processIdentity, JobInitialization2 jobInitialization) |
| Creates a job using process type. So, if process type is business process, then create a job. If process type is case definition, then create a case. More... | |
| JobIdentity | CreateJobWithDocuments (string sessionId, ProcessIdentity processIdentity, JobWithDocumentsInitialization jobWithDocsInitialization) |
| Creates a new instance (a job) for the specified process map with documents. More... | |
| JobWithDocumentsProgressOutput2 | CreateJobWithDocumentsAndProgress2 (string sessionId, ProcessIdentity processIdentity, JobWithDocumentsInitialization jobWithDocsInitialization, VariableIdentityCollection variablesToReturn) |
| Creates a new instance (a job) for the specified process map with documents. In addition, if automatic activities are the first actviites of the job, they will be performed until the job is finished or only manual activities are pending. More... | |
| void | DeleteJobDocumentRule (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentity documentTypeIdentity) |
| Deletes the specified document rule if it is defined at runtime (i.e, adhoc) else throws error. More... | |
| void | DeleteJobNote (string sessionId, JobIdentity jobIdentity, DateTime dateNoteEntered) |
| Deletes a note associated with a job. More... | |
| void | DeleteRoleMember (string sessionId, JobIdentity jobIdentity, RoleIdentity roleIdentity, ResourceIdentity resourceIdentity) |
| Removes a resource from a specified role. More... | |
| int | EvaluateScore (string sessionId, JobIdentity job) |
| Evaluates and returns the score for the specified job. The predictive model needs to be turned on to the process map on which the job is created. More... | |
| void | ForceValidJobDocument (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentity documentTypeIdentity, string comment) |
| Forces the valid job document. More... | |
| JobExceptionSummaryCollection | GetExceptionMaps (string sessionId, JobExceptionFilter jobExceptionFilter) |
| Retrieve all the exceptions for the specified search criteria. Without any filter setting set, this API will get all exception maps from Live and Finished databases. More... | |
| JobRoleCollection | GetJobCaseRoles (string sessionId, JobIdentity jobIdentity) |
| Retrieves details on the case job roles. More... | |
| ComplexVariableValueRowCollection | GetJobComplexVariableForTable (string sessionId, JobIdentity jobIdentity, VariableIdentity variableIdentity) |
| Gets the value of specified static/dynamic complex variable in a job, as a collection that can be used to populate a form table control. More... | |
| ComplexVariableActionOutput | GetJobComplexVariableRows (string sessionId, UpdateComplexVariableAction updateComplexVariableAction) |
| Gets complex variable rows based on row index or search criteria. More... | |
| JobCount2Collection | GetJobCount2 (string sessionId, JobCountFilter jobCountFilter) |
| Retrieves the job count from the available jobs for the specified statuses. More... | |
| JobDocumentRuleCollection | GetJobDocumentRules (string sessionId, JobIdentity jobIdentity) |
| Get the documents type rules defined in a job. More... | |
| JobDocumentCollection | GetJobDocuments (string sessionId, JobIdentity jobIdentity) |
| Gets the documents received and corresponding document type rules in a job. More... | |
| JobDocumentIdentityCollection | GetJobDocumentsUsingType (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentity documentTypeIdentity) |
| Returns all Job Documents which are equal to a specified document type within a job. More... | |
| JobEventCollection | GetJobEvents (string sessionId, JobIdentity jobIdentity) |
| Retrieves the process events for the specified job. More... | |
| JobHistoryCollection | GetJobHistory2 (string sessionId, JobIdentity jobIdentity, JobHistoryFilter jobHistoryFilter) |
| Retrieves the job history for the specified job. More... | |
| JobInfo | GetJobInfo (string sessionId, JobIdentity jobIdentity, JobHistoryFilter filter) |
| Retrieves details for the specified job. More... | |
| string | GetJobLanguage (string sessionId, JobIdentity jobIdentity) |
| Retrieves the language associated with the job. More... | |
| JobMilestoneCollection | GetJobMilestones (string sessionId, JobIdentity jobIdentity) |
| Retrieves the milestones of the specified job. More... | |
| JobNoteCollection | GetJobNotes (string sessionId, JobIdentity jobIdentity, JobNoteFilter jobNoteFilter) |
| Retrieves the job notes from a specified process. These notes can be filtered depending on the Note Type and the resource(s) for which it should be returned to. More... | |
| ProcessIdentity | GetJobProcessIdentity2 (string sessionId, JobIdentity jobIdentity, short embeddedProcessCount) |
| Retrieves the details of a process that a job is based on. More... | |
| JobProperties2 | GetJobProperties2 (string sessionId, JobIdentity jobIdentity, JobHistoryFilter filter) |
| Returns all the job properties with additional details of languageinfo, supportinginfo and workqueue definition of a particular job. More... | |
| JobRole2 | GetJobRole2 (string sessionId, JobIdentity jobIdentity, RoleIdentity roleIdentity) |
| Retrieves fixed roles from a process. Floating roles from the job are also returned. More... | |
| RoleCollection | GetJobRoles (string sessionId, JobIdentity jobIdentity) |
| Retrieves a collection of job roles associated with a specified job. More... | |
| JobList | GetJobs4 (string sessionId, JobFilter4 jobFilter) |
| Retrieves jobs for the specified filter criteria. Different from GetJobs3 in that you have a filter setting for filtering with JobSla. Service Level Agreements are times defined relative to process due date that are indicators you are approaching the due date. More... | |
| int | GetJobsCountWithQuery (string sessionId, QueryIdentity queryIdentity, JobQueryFilter jobQueryFilter) |
| Retrieves jobs count based on the specified query. The query can be an existing saved query, or a custom query for which the settings are specified through the jobQueryFilter parameter. The queryFilter is set for unsaved queries and the queryIdentity would be null in such cases. More... | |
| string | GetJobSource (string sessionId, string jobId) |
| Retrieves the job source associated with the job. More... | |
| JobsSummaryCollection | GetJobsSummary (string sessionId, JobSummaryFilter jobSummaryFilter) |
| Gets a summary of jobs using specified Group By, Aggregates and Jobs Filter. More... | |
| JobsSummaryResults | GetJobsSummaryWithQuery (string sessionId, QueryIdentity queryIdentity, JobField groupByField) |
| Executes a supplied Job 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... | |
| JobQueryResult2 | GetJobsWithQuery2 (string sessionId, bool useDefaultQuery, QueryIdentity queryIdentity, JobQueryFilter jobQueryFilter) |
| Retrieves jobs based on the specified query. The query could be the default query specified for this resource, an existing saved query, or a custom query for which the settings are specified through the jobQueryFilter parameter. Also, we can optionally request the jobs count by setting the GetJobsCount property of the filter parameter to true. When select to return the jobs count the number returned will be the number of jobs and will not be restrained by the maximum number of jobs to return filter parameter. More... | |
| JobQueryResult2 | GetJobsWithQueryAndFilter (string sessionId, QueryIdentity queryIdentity, JobFieldValue jobFieldValue) |
| Retrieves jobs based on the specified query and a dynamic filter criteria defined in the JobFieldValue parameter. The JobFieldValue 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... | |
| JobVariableHistoryCollection | GetJobVariableHistory (string sessionId, JobNodeIdentity jobNodeIdentity, JobVariableHistoryFilter jobVariableHistoryFilter) |
| Retrieves the job variable history. More... | |
| JobVariableCollection | GetJobVariables (string sessionId, JobIdentity jobIdentity) |
| Gets the job variables. More... | |
| VariableValueCollection | GetJobVariablesValues (string sessionId, JobIdentity jobIdentity, VariableIdentityCollection variableIdentityCollection) |
| Retrieves a list of variable values for a specified job. More... | |
| VariableValue | GetJobVariableValue (string sessionId, JobIdentity jobIdentity, VariableIdentity variableIdentity) |
| Retrieves the variable value from the specified job. More... | |
| ProcessViewerData | GetJobViewerData (string sessionId, JobIdentity jobIdentity, bool associatedJobs) |
| Retrieves the job properties, the customize and restart access permissions and also maps the job details and runtime status in XML format (used primarily by the Job Viewer control). More... | |
| JobProperties | GetMinJobDetails (string sessionId, JobIdentity jobIdentity, JobHistoryFilter filter, short maxWQFieldCount) |
| Retrieves a minimum anount of information on the specified job. More... | |
| StateHistoryCollection | GetStateChangeHistory (string sessionId, JobIdentity jobIdentity) |
| Retrieves the state changes history for a specified job. More... | |
| SubJobProperties | GetSubJobProperties (string sessionId, SubJobIdentity subJobIdentity, short jobDatabase) |
| Retrieves the variables and history of a sub job. More... | |
| ProcessViewerData | GetSubJobViewerData2 (string sessionId, SubJobIdentity subJobIdentity, ProcessIdentity processIdentity, bool getSubJobProperties) |
| Retrieves the sub job properties, customize and restart access details, and also maps the details with runtime status in XML format. More... | |
| JobMilestoneCollection | GetUpdatedMilestones (string sessionId, DateTime lastUpdatedDateTime, short databaseConnectionType) |
| Retrieve the milestones that have been updated since the specified date. More... | |
| void | HoldJob2 (string sessionId, JobIdentity jobIdentity, OnHoldOptions2 onHoldOptions) |
| Holds a job with the specified job details. Note: The expected finish time and the expected duration of a job will be updated by the amount of time the job was on hold when the job is taken off hold. Also escalations will not fire while the job is on hold. Note: We should not call HoldJob from within the job itself(on.net node) either in a subjob or at parent level, as it leads to an infinite loop as the.Net node does not complete prior to the job being put on hold. The job is then activated on the same node and put on hold again. More... | |
| void | HoldJobs (string sessionId, JobIdentityCollection jobIdentityCollection, OnHoldOptions onHoldOptions) |
| Put the specified jobs On Hold. Note: The expected finish time and the expected duration of jobs will be updated by the amount of time the jobs were on hold when the jobs are taken off hold. Also escalations will not fire while the job is on hold More... | |
| bool | IsAccessPermitted (string sessionId, JobIdentity jobIdentity, short accessType) |
| Defines the access permitted by the current resource for a particular action for a specified job. It determines whether the resource can Create, Suspend or Terminate a job. More... | |
| bool | PerformChecking (string sessionId, JobIdentity jobIdentity, ResourceIdentity resourceIdentity) |
| Determines whether checking can be performed or not. More... | |
| bool | PerformSampling (string sessionId, JobIdentity jobIdentity) |
| Determines whether sampling can be performed or not. More... | |
| void | PurgeJobs (string sessionId, PurgeJobsOptions options) |
| Removes the jobs from the system based on the options provided. More... | |
| void | PurgeJobsByID (string sessionId, StringCollection jobIds) |
| The API takes the list of job Ids as input and purge the completed and terminated jobs in the list from live and finished job tables. More... | |
| void | RaiseAnonymousEvent (JobIdentity jobIdentity, string eventName, string eventSource, InputVariableCollection updatedVariables) |
| Raises an anonymous process event for the specified job using the system resource. More... | |
| void | RaiseEvent (string sessionId, JobIdentity jobIdentity, string eventName, string eventSource, InputVariableCollection updatedVariables) |
| Raises a process event for the specified job. More... | |
| void | ReceivedJobDocument (string sessionId, JobIdentity jobIdentity, DocumentIdentity documentIdentity, bool useSource, string source, bool useStatus, short status) |
| Documents Received will be added with the status of Received and if the document already exists it will be updated with the given status. More... | |
| void | ReceivedJobDocuments (string sessionId, JobIdentity jobIdentity, DocumentIdentityCollection documentIdentityCollection, FolderIdentity folderIdentity, bool useSource, string source, bool useStatus, short status) |
| Documents Received will be added with the status of Received and if the document already exists it will be updated with the given status. More... | |
| void | RecoverJob (string sessionId, JobIdentity jobIdentity) |
| Recovers a job if they have failed the evaluation stage. More... | |
| void | RecoverJobs (string sessionId, JobIdentityCollection jobIdentityCollection) |
| Recovers the jobs that are specified. More... | |
| void | ReevaluateJobDocumentRequiredDates (string sessionId, JobIdentity jobIdentity) |
| Re evaluate job document required dates. More... | |
| void | ReevaluatePrecondition (string sessionId, JobIdentity jobIdentity) |
| Reevaluates the precondition for a specified job. More... | |
| void | ReEvaluateSkin (string sessionId, JobIdentity jobIdentity, SkinEvaluationOptions skinOptions) |
| Reevaluates a skin on a job using existing job or a case variable. If a new skin is determined any overridden job and activity level properties for the skin are updated within the job. More... | |
| void | ReplaceJobRoleMembers (string sessionId, JobIdentity jobIdentity, RoleIdentity roleIdentity, ResourceIdentityCollection resources) |
| Replaces the members of a floating role in a job with new members. More... | |
| void | ResetJobVariables (string sessionId, JobActivityIdentity jobActivity, JobIdentity subJob, bool useLatestHistory, DateTime setTime) |
| Resets the variables for the specified job. More... | |
| void | RestartJob (string sessionId, JobActivityIdentity jobActivityIdentity, ProcessActivityIdentityCollection embeddedProcessList, short restartType, JobIdentity subJobIdentity) |
| Allows administrators to correct any runtime problems with the flow of maps by restarting the job at or after a particular node. More... | |
| void | SuspendJob (string sessionId, JobIdentity jobIdentity, JobNote jobNote) |
| Please note that this function is deprecated. Please use SuspendJob2 instead. Suspends the job with the specified job id. More... | |
| void | SuspendJob2 (string sessionId, SuspendJobInfo suspendJobInfo) |
| Suspends the job with the specified job id. More... | |
| void | SuspendJobs (string sessionId, JobIdentityCollection jobIdentityCollection, JobNote jobNote) |
| Please note that this function is deprecated. Please use SuspendJobs2 instead. Suspends the specified jobs. More... | |
| void | SuspendJobs2 (string sessionId, SuspendJobsInfo suspendJobsInfo) |
| Suspends the specified jobs. More... | |
| void | TerminateJob (string sessionId, JobIdentity jobIdentity) |
| Terminates a specified job. More... | |
| void | TerminateJobs (string sessionId, JobIdentityCollection jobIdentityCollection) |
| Terminates the specified jobs. More... | |
| void | UnHoldJob (string sessionId, JobIdentity jobIdentity) |
| Activates the specified job that is on hold. More... | |
| void | UnHoldJobs (string sessionId, JobIdentityCollection jobIdentityCollection) |
| Activates the specified jobs that are on hold. More... | |
| object | UpdateJobComplexVariable (string sessionId, UpdateComplexVariableAction updateComplexVariableAction) |
| Updates job complex variable data. More... | |
| void | UpdateJobComplexVariableFromTable (string sessionId, JobIdentity jobIdentity, VariableIdentity variableIdentity, ComplexVariableValueRowCollection complexVariableRows) |
| Updates the value of specified dynamic complex variable in a job, with the data passed from a form table control. More... | |
| void | UpdateJobCustomerData (string sessionId, JobIdentity jobIdentity, string customerData, OutputVariableCollection variables) |
| Updates the customer data against the job. The customer data will contain context information to enable users to progress activities. More... | |
| void | UpdateJobDocumentRequiredDate (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentity documentTypeIdentity, DateTime requiredDate) |
| Updates the job document rule date required. More... | |
| void | UpdateJobDocumentRule (string sessionId, JobIdentity jobIdentity, DocumentTypeIdentity documentTypeIdentity, DateTime dateRequired, string description, DocumentProcessBasicRule documentBasicRule) |
| updates the job document rule. More... | |
| void | UpdateJobDocumentType (string sessionId, JobIdentity jobIdentity, DocumentIdentity documentIdentity, DocumentTypeIdentity documentTypeIdentity) |
| Updates the type of the job document with the specified document type. More... | |
| void | UpdateJobExpectedFinishTime (string sessionId, JobIdentity jobIdentity, DateTime expectedFinishTime, bool resetException) |
| Updates the expected finish time of a live job. More... | |
| void | UpdateJobLanguage (string sessionId, JobIdentity jobIdentity, string languageName) |
| Updates the language for the specified job. More... | |
| void | UpdateJobMilestoneActualDate (string sessionId, JobIdentity jobIdentity, MilestoneIdentity milestoneIdentity, DateTime newActualDate) |
| Updates the actual date for a milestone actual in a specified job. More... | |
| void | UpdateJobMilestoneTargetDate (string sessionId, JobIdentity jobIdentity, MilestoneIdentity milestoneIdentity, DateTime newTargetDate) |
| Updates the target finish date for a milestone in a specified job. More... | |
| void | UpdateJobNote (string sessionId, JobIdentity jobIdentity, DateTime dateNoteEntered, NoteInfo noteInfo) |
| Updates a note associated with a job. More... | |
| void | UpdateJobOwner (string sessionId, JobIdentity jobIdentity, ResourceIdentity jobOwner) |
| Updates the job owner for the specified jobs. More... | |
| void | UpdateJobOwners (string sessionId, JobIdentityCollection jobIdentityCollection, ResourceIdentity resourceIdentity) |
| Updates the job owner for the specified jobs. More... | |
| void | UpdateJobOwnerUsingSearchCriteria (string sessionId, JobFilter jobFilter, ResourceIdentity jobOwner) |
| Updates the job owner of the jobs identified using the specified search criteria. More... | |
| void | UpdateJobPriority (string sessionId, JobIdentity jobIdentity, short jobPriority) |
| Updates the job priority for the specified job. More... | |
| void | UpdateJobSource (string sessionId, string jobId, string jobSource) |
| Updates the job source for a specified job. More... | |
| void | UpdateJobSpend (string sessionId, JobIdentity jobIdentity, double value) |
| Updates the current spend so far for a specified job. More... | |
| void | UpdateJobState (string sessionId, JobIdentity jobIdentity, string jobState) |
| Changes a job state and perform any action associated with the state. Will restart the job if required. More... | |
| void | UpdateJobVariables (string sessionId, JobIdentity jobIdentity, UpdatedVariableCollection updatedVariables) |
| Updates the variable values for a specified job. More... | |
| void | UpdateReceivedJobDocumentsStatus (string sessionId, JobIdentity jobIdentity, DocumentIdentityCollection documentIdentityCollection, FolderIdentity folderIdentity, DocumentTypeIdentity documentTypeIdentity, short status) |
| Updates the received job documents status. More... | |
| string | UpgradeJobs2 (string sessionId, UpgradeJobFilter upgradeJobFilter) |
| Upgrades the jobs using the specified upgrade criteria. More... | |
| void | UpgradeJobsAsync (string sessionId, UpgradeJobFilter upgradeJobFilter) |
| Upgrades the jobs asynchronously using the specified filter criteria More... | |
Provides methods for creating jobs, updating the status of jobs and managing job properties.
| void ActivateJob | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Activates a job with the specified job id.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job that needs to be activated.
|
| void ActivateJobs | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection | ||
| ) |
Activates the jobs with the specified job id's.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentityCollection | A JobIdentityCollection collection object that are to be activated. JobIdentity members.
|
| void ActivateJobsWithSuspendReason | ( | string | sessionId, |
| string | suspendReason | ||
| ) |
Takes a suspend reason and reactivates all jobs that it finds with a matching suspend reason.
| 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. |
| suspendReason | The suspend reason associated with job. |
| void AddJobDocumentRule | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| string | name, | ||
| bool | restrictedDocument, | ||
| string | description, | ||
| DocumentTypeIdentity | documentTypeIdentity, | ||
| DateTime? | dateRequired, | ||
| MilestoneIdentity | milestoneIdentity, | ||
| DocumentProcessBasicRule | documentBasicRule, | ||
| DocumentProcessBusinessRule | documentBusinessRule, | ||
| ProcessIdentity | documentUploadProcess, | ||
| bool | allowDeletion, | ||
| ProcessIdentity | documentTypeDueProcess, | ||
| int | documentTypeDueExceptionDuration | ||
| ) |
Adds an adhoc basic rule into a job document rule.
| 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 that is the job for which the role member needs to be added.
| ||||||||||||||||
| name | Name for the new job document rule. | ||||||||||||||||
| restrictedDocument | If set to true, the job document rule will be set to restricted. If set to false, the job document rule will be set to unrestricted. | ||||||||||||||||
| description | Text description for the job document rule. | ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type that needs to be added to the job document rule. Cannot be null.
| ||||||||||||||||
| dateRequired | If not null, the required date for job document rule. | ||||||||||||||||
| milestoneIdentity | A MilestoneIdentity identity object that is used to identify the milestone to be updated.
| ||||||||||||||||
| documentBasicRule | A Document Process Basic Rule object that is used to define the state of document and the number of required documents.
| ||||||||||||||||
| documentBusinessRule | A Document Process Business Rule object that is used to define the Business Rule Identity. | ||||||||||||||||
| documentUploadProcess | A ProcessIdentity identity object that is used to identify the document upload process to create a job on.
| ||||||||||||||||
| allowDeletion | If set to true, the job document rule can be deleted. | ||||||||||||||||
| documentTypeDueProcess | A ProcessIdentity identity object that is used to identify the document type due process to create a job on.
| ||||||||||||||||
| documentTypeDueExceptionDuration | The duration of the exception for the document type that is due. |
| void AddJobNote | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| NoteInfo | noteInfo | ||
| ) |
Adds a note that will be associated with a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job for which the note will be added to.
| ||||||||||||
| noteInfo | A NoteInfo object that contains the note text and type. If the type is left empty then a default note type is added.
|
| void AddRoleMember | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| RoleIdentity | roleIdentity, | ||
| ResourceIdentity | resourceIdentity | ||
| ) |
Adds a member to a specified role.
| 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 that is the job for which the role member needs to be added.
| ||||||||||||||||
| roleIdentity | A RoleIdentity object containing the information of the role that needs to be updated with a member. Cannot be null
| ||||||||||||||||
| resourceIdentity | A ResourceIdentity identity object containing the resource that needs to be added to the role. Cannot be null
|
| void AddToNumericVarValue | ( | string | sessionId, |
| VariableIdentity2 | variableIdentity, | ||
| object | variableValueToAdd | ||
| ) |
Adds the value that has been passed to a specified variable.
| 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. | ||||||||||||||||||||
| variableIdentity | A VariableIdentity2 object whose value needs to be updated. Cannot be null
| ||||||||||||||||||||
| variableValueToAdd | The numeric variable value to add. Note: An exception is triggered for non-numeric values. Cannot be null |
| void ArchiveJobs | ( | string | sessionId | ) |
Archives the jobs when archive settings is off. Archiving operation cannot run when Archive settings is Yes in Server Settings. Archiving operation cannot run when archiving is already in progress. This is an asynchronous operation and executes via worker task.
| 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. |
| bool ConfirmJobDocument | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity | ||
| ) |
Use the ConfirmJobDocument method to evaluate particular rule of the document set, of the jobid, with the specific document type. The rule will only consider documents that are in an Accepted state.
| 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 that is the job for which the document should be associated with.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type that needs to be added. Cannot be null.
|
| JobDocumentTypeRuleResultCollection ConfirmJobDocuments | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentityCollection | documentTypeIdentityCollection | ||
| ) |
Use the ConfirmJobDocuments method to evaluate all the rules of the document set, of the jobid. The rule will only consider documents that are in an Accepted state.
| 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 that is the job for which the document should be associated with.
| ||||||||||||||||
| documentTypeIdentityCollection | A DocumentTypeIdentityCollection collection of DocumentTypeIdentity that has the details of the Document Type Identities which are to be evaluated.
|
| Name | Type | Comment | Required |
|---|---|---|---|
| DocumentTypeID | String | The Id Of the document Type | Yes |
| Result | Boolean | Returns true or false. True if the document rule is validated else false. | Yes |
| string CreateCustomProcessForJob | ( | string | sessionId, |
| string | jobId, | ||
| string | categoryName, | ||
| string | newProcessName | ||
| ) |
Creates a new version of the process map based on existing one on a live job and associates job id with the newly created map.
| 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. |
| jobId | Job Id of base map. |
| categoryName | (Optional) Category name for new map. If empty, associates with the existing map category. |
| newProcessName | (Optional) Process name for new map. If empty, new map name is name of process used to create this job prefixed with the keyword Customisable. |
| JobIdentity CreateJob | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobInitialization | jobInitialization | ||
| ) |
Creates a new instance (a job) for the specified process map.
| 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 that is used to identify the process to create a job on.
| ||||||||||||||||
| jobInitialization | A JobInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
|
| JobProgressOutput CreateJobAndProgress | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobInitialization | jobInitialization | ||
| ) |
This API executes all automatic activities and returns the pending manual activity if available, job id, and job status.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| processIdentity | A ProcessIdentity identity object containing the processid and version of the process to create a job on.
| ||||||||||||||||
| jobInitialization | A JobInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
|
| JobIdentity CreateJobAndStartAt | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobInitialization | jobInitialization, | ||
| ProcessActivityIdentity | processActivityIdentity | ||
| ) |
Creates a job for a specified business process map and starts it at a specified activity.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| processIdentity | A ProcessIdentity identity object containing the processid and version of the process to create a job on.
| ||||||||||||||||
| jobInitialization | A JobInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
| ||||||||||||||||
| processActivityIdentity | A ProcessActivityIdentity identity object that contains the activity information at which the job needs to be started using node name.
|
| JobIdentity CreateJobInCase | ( | string | sessionId, |
| ProcessIdentity | caseProcessIdentity, | ||
| CaseIdentity | caseJobIdentity, | ||
| JobInitialization | jobInitialization | ||
| ) |
This API provides the funtionality of CreateJobInCase, CreateJobInCaseUsingMapName, CreateJobInCaseUsingRef and CreateJobInCaseUsingRefMapName.
| 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. | ||||||||||||||||
| caseProcessIdentity | A ProcessIdentity identity object that is used to identify the process to create a job on.
| ||||||||||||||||
| caseJobIdentity | A CaseIdentity identity object containing case job id of the case associated with the process.
| ||||||||||||||||
| jobInitialization | A JobInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
|
| JobProgressOutput CreateJobInCaseAndProgress | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| CaseIdentity | caseIdentity, | ||
| JobInitialization | jobInitialization | ||
| ) |
This API executes all automatic activities and returns the job id, job status and any pending manual activity of the case fragment job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| processIdentity | A ProcessIdentity identity object that is used to identify the case fragment process to create a job on.
| ||||||||||||||||
| caseIdentity | A CaseIdentity identity object with the job id of the case associated with the fragment.
| ||||||||||||||||
| jobInitialization | A JobInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
|
| JobIdentity CreateJobInCaseWithDocuments | ( | string | sessionId, |
| ProcessIdentity | caseProcessIdentity, | ||
| CaseIdentity | caseJobIdentity, | ||
| JobWithDocumentsInitialization | jobWithDocsInitialization | ||
| ) |
This API provides the funtionality of CreateJobInCase, CreateJobInCaseUsingMapName, CreateJobInCaseUsingRef and CreateJobInCaseUsingRefMapName and also accepts documents.
| 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. | ||||||||||||||||
| caseProcessIdentity | A ProcessIdentity identity object that is used to identify the process to create a job on.
| ||||||||||||||||
| caseJobIdentity | A CaseIdentity identity object containing case jobid of the case associated with the process.
| ||||||||||||||||
| jobWithDocsInitialization | A JobWithDocumentsInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values.
|
| JobWithDocumentsProgressOutput2 CreateJobInCaseWithDocumentsAndProgress2 | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| CaseIdentity | caseIdentity, | ||
| JobWithDocumentsInitialization | jobWithDocsInitialization, | ||
| VariableIdentityCollection | variablesToReturn | ||
| ) |
Creates a new instance (a job) for the specified fragment with documents. In addition, if automatic activities are the first actviites of the job, they will be performed until the job is finished or only manual activities are pending.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| processIdentity | A ProcessIdentity identity object that is used to identify the process to create a job on.
| ||||||||||||||||
| caseIdentity | A CaseIdentity identity object that is used to identify the case in which the fragment instance should be created.
|
| jobWithDocsInitialization | A JobWithDocumentsInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values.
| ||||||||||||||||
| variablesToReturn | A VariableIdentityCollection collection of variables whose values are to be returned. VariableIdentity members.
|
| SyncJob CreateJobSync | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobInitialization | jobInitialization, | ||
| VariableIdentityCollection | variablesToReturn | ||
| ) |
Creates a synchronous job for a specified process map.
| 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 that is used to identify the process to create a job on. Cannot be null
| ||||||||||||||||
| jobInitialization | A JobInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
| ||||||||||||||||
| variablesToReturn | A collection of VariableIdentity objects that identifies the variables that need to be returned. Can be null VariableIdentity members.
|
| SyncJobWithDocument CreateJobSyncWithDocument | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobWithDocumentInitialization | jobWithDocInitialization, | ||
| VariableIdentityCollection | variablesToReturn | ||
| ) |
Creates a new instance (a job) for the specified process map with document. This API is designed to enhance capture activities execution by creating document in memory and by accessing local transformation server instance (specify local port number in web.config under setting 'TSExternalServicePortForSyncProcessing', default is 9001). The document data will be committed to database only if user opts to save. In addition, the specified process map can have only automatic activities. Note: This API is supported in RTTS mode only.
| 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 that is used to identify the process to create a job on.
| ||||||||||||||||
| jobWithDocInitialization | A JobWithDocumentInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values.
| ||||||||||||||||
| variablesToReturn | A VariableIdentityCollection collection of variables whose values are to be returned.
|
| SyncJobWithDocuments CreateJobSyncWithDocuments | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobWithDocumentsInitialization2 | jobWithDocsInitialization, | ||
| VariableIdentityCollection | variablesToReturn | ||
| ) |
Creates a new instance (a job) for the specified process map with multiple document. This API is designed to enhance capture activities execution by creating document in memory and by accessing local transformation server instance (specify local port number in web.config under setting 'TSExternalServicePortForSyncProcessing', default is 9001). The document data will be committed to the database only if user opts to save. In addition, the specified process map can have only automatic activities. Note: This API is supported in RTTS mode only.
| 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 that is used to identify the process to create a job on.
| ||||||||||||||||
| jobWithDocsInitialization | A JobWithDocumentsInitialization2 object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values.
| ||||||||||||||||
| variablesToReturn | A VariableIdentityCollection collection of variables whose values are to be returned.
|
| JobIdentity CreateJobUsingProcessType | ( | string | sessionId, |
| short | processType, | ||
| string | caseReference, | ||
| ProcessIdentity | processIdentity, | ||
| JobInitialization2 | jobInitialization | ||
| ) |
Creates a job using process type. So, if process type is business process, then create a job. If process type is case definition, then create a case.
| 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. | ||||||||||||||||
| processType | Process type. The enumeration follows
| ||||||||||||||||
| caseReference | The case reference if creating a case or case fragment (job in case). If not provided, then the case id will be used as the case reference for case. | ||||||||||||||||
| processIdentity | A ProcessIdentity identity object containing the processid and version of the process to create a job on.
| ||||||||||||||||
| jobInitialization | A JobInitialization2 object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values. Can be null
|
| JobIdentity CreateJobWithDocuments | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobWithDocumentsInitialization | jobWithDocsInitialization | ||
| ) |
Creates a new instance (a job) for the specified process map with documents.
| 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 that is used to identify the process to create a job on.
| ||||||||||||||||
| jobWithDocsInitialization | A JobWithDocumentsInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values.
|
| JobWithDocumentsProgressOutput2 CreateJobWithDocumentsAndProgress2 | ( | string | sessionId, |
| ProcessIdentity | processIdentity, | ||
| JobWithDocumentsInitialization | jobWithDocsInitialization, | ||
| VariableIdentityCollection | variablesToReturn | ||
| ) |
Creates a new instance (a job) for the specified process map with documents. In addition, if automatic activities are the first actviites of the job, they will be performed until the job is finished or only manual activities are pending.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| processIdentity | A ProcessIdentity identity object that is used to identify the process to create a job on.
| ||||||||||||||||
| jobWithDocsInitialization | A JobWithDocumentsInitialization object that contains the initialization variables for the new job. The variables in the job will be updated with the corresponding values.
| ||||||||||||||||
| variablesToReturn | A VariableIdentityCollection collection of variables whose values are to be returned.
|
| void DeleteJobDocumentRule | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity | ||
| ) |
Deletes the specified document rule if it is defined at runtime (i.e, adhoc) else throws error.
| 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 that is the job for which the document will be removed from.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type that will be deleted. Cannot be null.
|
| void DeleteJobNote | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DateTime | dateNoteEntered | ||
| ) |
Deletes a note associated with a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is the job with the note to be deleted.
| ||||||||
| dateNoteEntered | The date and time when the note was entered for the job. |
| void DeleteRoleMember | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| RoleIdentity | roleIdentity, | ||
| ResourceIdentity | resourceIdentity | ||
| ) |
Removes a resource from a specified role.
| 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 that is the job for which the role member needs to be removed.
| ||||||||||||||||
| roleIdentity | A RoleIdentity object containing the role that needs to have a member removed. Cannot be null
| ||||||||||||||||
| resourceIdentity | A ResourceIdentity identity object containing the resource that needs to be removed from the role. Cannot be null
|
| int EvaluateScore | ( | string | sessionId, |
| JobIdentity | job | ||
| ) |
Evaluates and returns the score for the specified job. The predictive model needs to be turned on to the process map on which the job is created.
| 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. | ||||||||
| job | A JobIdentity identity object used to identify the job for which the score needs to be evaluated.
|
| void ForceValidJobDocument | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity, | ||
| string | comment | ||
| ) |
Forces the valid job document.
| 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 that is the job which contains the documents to be set to valid.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type that will be set to valid. Cannot be null.
| ||||||||||||||||
| comment | A user specified comment to explain why the document is set automatically to valid |
| JobExceptionSummaryCollection GetExceptionMaps | ( | string | sessionId, |
| JobExceptionFilter | jobExceptionFilter | ||
| ) |
Retrieve all the exceptions for the specified search criteria. Without any filter setting set, this API will get all exception maps from Live and Finished databases.
| 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. | ||||||||||||||||
| jobExceptionFilter | A JobExceptionFilter object that can be used to filter the exception maps. Can be null
|
| JobRoleCollection GetJobCaseRoles | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Retrieves details on the case job roles.
| 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 that is used to identify the job whose roles are to be retrieved.
|
| ComplexVariableValueRowCollection GetJobComplexVariableForTable | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| VariableIdentity | variableIdentity | ||
| ) |
Gets the value of specified static/dynamic complex variable in a job, as a collection that can be used to populate a form table control.
| 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 that is used to identify the job from which the variable value needs to be updated.
| ||||||||
| variableIdentity | A VariableIdentity identity object that is used to identify the variable whose value needs to be updated in the specified job.
|
| ComplexVariableActionOutput GetJobComplexVariableRows | ( | string | sessionId, |
| UpdateComplexVariableAction | updateComplexVariableAction | ||
| ) |
Gets complex variable rows based on row index or search criteria.
| sessionId | The session identifier. |
| updateComplexVariableAction | The updateComplexVariableAction. |
| JobCount2Collection GetJobCount2 | ( | string | sessionId, |
| JobCountFilter | jobCountFilter | ||
| ) |
Retrieves the job count from the available jobs for the specified statuses.
| 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. | ||||||||||||
| jobCountFilter | A JobCountFilter object containing the job status and job type information on which the jobs need to be filtered.
|
| Enumeration | Description |
|---|---|
| 0 | Active |
| 1 | All Live And Finished |
| 2 | All Finished |
| 3 | All Live |
| 4 | Completed |
| 5 | Ready For Evaluation |
| 6 | Pending Completion |
| 7 | Suspended |
| 8 | Terminated |
| 9 | On Hold |
| 10 | Awaiting Completion |
| 11 | Awaiting Case Completion |
| 12 | Terminated Awaiting Completion |
| 13 | Terminated Awaiting Case Completion |
| Enumeration | Description |
|---|---|
| 0 | Normal Job |
| 1 | Case Instance |
| 2 | Case Fragment |
| 3 | All |
| JobDocumentRuleCollection GetJobDocumentRules | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Get the documents type rules defined in a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identityobject that is used to identify the job whose documents type rules defined to retrieve.
|
| Name | Type | Comment |
|---|---|---|
| Name | String | The name of the Job Document Rule. |
| DocumentType | DocumentTypeIdentity | The id of the document type. |
| DateRequired | DateTime | If not null, the required date for job document rule. |
| Adhoc | Boolean | If true, the job document rule will be an adhoc rule. |
| Description | String | A user defined description for the Job Document Rule. |
| Status | JobDocumentRuleStatus | Sets the status of the Job Document Rule where 0 = NotRun, 1 = Passed, 2 = Failed. |
| Comment | String | A user defined comment for the job document rule. |
| RuleData | DocumentProcessRuleData | A DocumentProcessRuleData object which contains information on the document process basic rules and the document process business rules. |
| RestrictedDocument | Boolean | If true, the document will be set to restricted. If false, the documment will be unrestricted. |
| DocumentUploadProcess | ProcessIdentity | A ProcessIdentity identity object that is used to identify the document upload process. |
| DocumentDueProcess | ProcessIdentity | A ProcessIdentity identity object that is used to identify the document type due process. |
| DocumentDueProcessInterval | Duration | The duration of interval between when the document due process will be ran. |
| JobDocumentCollection GetJobDocuments | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Gets the documents received and corresponding document type rules in a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose documents received and corresponding document type to be retrieve.
|
| Name | Type | Comment |
|---|---|---|
| Name | String | The name of the Job Document Rule. |
| DocumentId | String | The Id of the document. |
| DocumentType | DocumentTypeIdentity | The id of the document type. |
| DateRequired | DateTime | If not null, the required date for job document rule. |
| DateRecieved | DateTime | If not null, the date in which the job document was recieved. |
| Source | String | The source message passed to the job documents. |
| Description | String | The description of the job document. |
| Status | JobDocumentStatus | Sets the status of the Job Document Rule where 0 = NotRun, 1 = Passed, 2 = Failed. |
| Comment | String | A user defined comment for the job document rule. |
| RuleData | DocumentProcessRuleData | A DocumentProcessRuleData object which contains information on the document process basic rules and the document process business rules. |
| RestrictedDocument | Boolean | If true, the document will be set to restricted. If false, the documment will be unrestricted. |
| JobDocumentIdentityCollection GetJobDocumentsUsingType | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity | ||
| ) |
Returns all Job Documents which are equal to a specified document type within a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object that is the job for which the documents are contained.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type that will be used for the search. Cannot be null.
|
| Name | Type | Comment |
|---|---|---|
| DocumentId | String | Unique identifier of document type |
| JobIdentity | JobIdentity | A JobIdentity identity object that is the job for which the document is contained. |
| JobEventCollection GetJobEvents | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Retrieves the process events for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose events are to be retrieved.
|
| JobHistoryCollection GetJobHistory2 | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| JobHistoryFilter | jobHistoryFilter | ||
| ) |
Retrieves the job history for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose job history we need to get.
| ||||||||||||||||
| jobHistoryFilter | A JobHistoryFilter object which will be used as the filter criteria for retrieving the job details. Can be null
|
| JobInfo GetJobInfo | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| JobHistoryFilter | filter | ||
| ) |
Retrieves details for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose details we require.
| ||||||||||||||||
| filter | A JobHistoryFilter object which will be used as the filter criteria for retrieving the job details
|
| string GetJobLanguage | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Retrieves the language associated with the job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job for which the language needs to be retrieved.
|
| JobMilestoneCollection GetJobMilestones | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Retrieves the milestones of the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose milestone information needs to be retrieved.
|
| JobNoteCollection GetJobNotes | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| JobNoteFilter | jobNoteFilter | ||
| ) |
Retrieves the job notes from a specified process. These notes can be filtered depending on the Note Type and the resource(s) for which it should be returned to.
| 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 that is used to identify the job whose notes need to be retrieved.
| ||||||||||||||||
| jobNoteFilter | A JobNoteFilter object used to filter the job notes. Can be null
|
| Enumeration | Description |
|---|---|
| 0 | All Resources |
| 1 | Include Resource |
| 2 | Exclude Resource |
| ProcessIdentity GetJobProcessIdentity2 | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| short | embeddedProcessCount | ||
| ) |
Retrieves the details of a process that a job is based on.
| 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 used to identify the job whose porocess identity we want to find out.
| ||||||||
| embeddedProcessCount | 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. |
| JobProperties2 GetJobProperties2 | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| JobHistoryFilter | filter | ||
| ) |
Returns all the job properties with additional details of languageinfo, supportinginfo and workqueue definition of a particular job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose properties are to be retrieved.
| ||||||||||||||||
| filter | A JobHistoryFilter object that can be used to filter the job history by activity type and whether to include associated jobs.
|
| Enumeration | Description |
|---|---|
| -1 | None |
| 0 | Script Activity |
| 1 | Com Activity |
| 2 | Ordinary Activity |
| 4 | Transactional Activity |
| 5 | Create New Job Activity |
| 6 | Straight Through Activity |
| 7 | DotNet Activity |
| 8 | Web Service Activity |
| 9 | Create Sub Job Activity |
| 10 | Xml Activity |
| 11 | CSharp Activity |
| 12 | VBNet Activity |
| 13 | Data Access Activity |
| 14 | Design Activity |
| 15 | Synchronization Activity |
| 16 | Sleep Activity |
| 17 | Job Owner Activity |
| 18 | Job Variable Info Activity |
| 19 | Resource Info Activity |
| 20 | Event Activity |
| 25 | Extraction Capture Activity |
| 26 | Separation Classification Capture Activity |
| 28 | PDF Generation Activity |
| 29 | Scan Capture Activity |
| 30 | Validation Capture Activity |
| 31 | Verification Capture Activity |
| 32 | Document Review Capture Activity |
| 108 | Image Processing Capture Activity |
| 109 | Composite Capture Activity |
| 122 | Export Capture Activity |
| 123 | Sign Documents Activity |
| 124 | CCM Compose And Sign Activity |
| 125 | CCM Distribute Activity |
| JobRole2 GetJobRole2 | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| RoleIdentity | roleIdentity | ||
| ) |
Retrieves fixed roles from a process. Floating roles from the job are also returned.
| 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 that is used to identify the job whose role information needs to be retrieved. Cannot be null
| ||||||||||||
| roleIdentity | A RoleIdentity objectwhose complete role information needs to be retrieved. Cannot be null
|
| Name | Type | Comment |
|---|---|---|
| DynamicRoleId | String | The dynamic Id of the role. |
| Identity | RoleIdentity | The Id of the role. |
| RoleType | RoleType | The type of the role. If 0 the role type is Fixed. If 1 the role type is Floating. |
| AssociatedResources | ResourceIdentityCollection | A collection of ResourceIdentity that are associated with the job role. |
| RoleCollection GetJobRoles | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Retrieves a collection of job roles associated with a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose job roles information needs to be retrieved.
|
| JobList GetJobs4 | ( | string | sessionId, |
| JobFilter4 | jobFilter | ||
| ) |
Retrieves jobs for the specified filter criteria. Different from GetJobs3 in that you have a filter setting for filtering with JobSla. Service Level Agreements are times defined relative to process due date that are indicators you are approaching the due date.
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| jobFilter | A JobFilter4 object used to filter the jobs. Cannot be null
|
| Enumeration | Description |
|---|---|
| 0 | SLA Status 1 |
| 1 | SLA Status 2 |
| 2 | SLA Status 3 |
| 3 | SLA Status 4 |
| 4 | SLA Status 5 |
| Enumeration | Description |
|---|---|
| 0 | Normal Job |
| 1 | Case Instance |
| 2 | Associated Job (Job in Case) |
| 4 | Business Rule Job |
| Enumeration | Description |
|---|---|
| 0 | Active |
| 1 | All Live And Finished |
| 2 | All Finished |
| 3 | All Live |
| 4 | Completed |
| 5 | Ready For Evaluation |
| 6 | Pending Completion |
| 7 | Suspended |
| 8 | Terminated |
| 9 | On Hold |
| 10 | Awaiting Completion |
| 11 | Awaiting Case Completion |
| 12 | Terminated Awaiting Completion |
| 13 | Terminated Awaiting Case Completion |
| ? | Matches any single character. For example, "Bl?ck" finds either "Black" or "Block" |
| * | Matches any one or more characters. For example, "North*" finds "North", "Northeast", and "Northwest". And "(*)" finds any content enclosed by parentheses |
| ~ | Used as an escape character to include a literal question mark, asterisk, or tilde. For example, to find "West*" use "West~*" |
The enumeration for Field type in SortOptions setting follows.
| Enumeration | Description |
|---|---|
| 1 | Status |
| 2 | Creation Time |
| 3 | Creator |
| 4 | Completion Time |
| 5 | JobId |
| 6 | Process Name |
| 7 | Process Version |
| 8 | Priority |
| 9 | State |
| 11 | Case Reference |
| 12 | Owner |
| 13 | Type |
| 14 | Score |
| 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 | Supporting Info |
| 18 | Expected Duration |
| 19 | State Percentage |
The enumeration for SortOrder in SortOptions setting follows.
| Enumeration | Description |
|---|---|
| 0 | Ascending |
| 1 | Descending |
| int GetJobsCountWithQuery | ( | string | sessionId, |
| QueryIdentity | queryIdentity, | ||
| JobQueryFilter | jobQueryFilter | ||
| ) |
Retrieves jobs count based on the specified query. The query can be an existing saved query, or a custom query for which the settings are specified through the jobQueryFilter parameter. The queryFilter is set for unsaved queries and the queryIdentity would be null in such cases.
| sessionId | A string that uniquely identifies the session for the logged on user. If the sessionId is invalid, an exception is raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| queryIdentity | The unique identity of the query. If set, jobQueryFilter is ignored.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| jobQueryFilter | Specifies the filter to retrieve jobs count. This parameter can be null if queryIdentity is set. This parameter cannot be null when queryIdentity is null or queryIdentity Id is blank.
|
| Operator | Description |
|---|---|
| ? | 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~*" |
| Enumeration | Description |
|---|---|
| -1 | None |
| 0 | Resource |
| 1 | Resource and Groups |
| 2 | Direct Subordinates |
| 3 | Resource and Direct Subordinates |
| 4 | Indirect Subordinates |
| 5 | Resource and Indirect Subordinates |
| Enumeration | Description |
|---|---|
| 0 | All |
| 1 | Since |
| 2 | Between |
| 3 | Today |
| 4 | ThisWeek |
| 5 | ThisMonth |
| 6 | ThisYear |
| Enumeration | Description |
|---|---|
| 0 | SlaStatus1 |
| 1 | SlaStatus2 |
| 2 | SlaStatus3 |
| 3 | SlaStatus4 |
| 4 | SlaStatus5 |
| Enumeration | Description |
|---|---|
| 0 | Normal Job |
| 1 | Case Instance |
| 2 | Associated Job (Job in Case) |
| 4 | Business Rule Job |
| Enumeration | Description |
|---|---|
| 0 | Job Criteria Active |
| 1 | Job Criteria All Live And Finished |
| 2 | Job Criteria All Finished |
| 3 | Job Criteria All Live |
| 4 | Job Criteria Completed |
| 5 | Job Criteria Ready For Evaluation |
| 6 | Job Criteria Pending Completion |
| 7 | Job Criteria Suspended |
| 8 | Job Criteria Terminated |
| 9 | Job Criteria On Hold |
| 10 | Job Criteria Awaiting Completion |
| 11 | Job Criteria Awaiting Case Completion |
| 12 | Job Criteria Terminated Awaiting Completion |
| 13 | Job Criteria Terminated Awaiting Case Completion |
| Enumeration | Description |
|---|---|
| 0 | JobList |
| 1 | WorkQueue |
| 2 | All |
| 3 | System |
| string GetJobSource | ( | string | sessionId, |
| string | jobId | ||
| ) |
Retrieves the job source associated with the job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
| jobId | A string that is used to identify the job for which the job source needs to be retrieved. |
| JobsSummaryCollection GetJobsSummary | ( | string | sessionId, |
| JobSummaryFilter | jobSummaryFilter | ||
| ) |
Gets a summary of jobs using specified Group By, Aggregates and Jobs Filter.
| 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. | ||||||||||||||||||||||||||||||||||||
| jobSummaryFilter | A JobSummaryFilter object that can be used to apply group by, additional group by, aggregates and jobs filter settings. Can be null
|
| Enumeration | Description |
|---|---|
| 0 | None |
| 1 | Job Status |
| 2 | Job Creation Time |
| 3 | Job Creator |
| 4 | Job Finish Time |
| 5 | Job Id |
| 6 | Job Process Name |
| 7 | Job Process Version |
| 8 | Job Priority |
| 9 | State |
| 10 | RAG |
| 11 | Case Ref |
| 12 | Job Owner |
| Enumeration | Description |
|---|---|
| 0 | None |
| 1 | Job Status |
| 2 | Job Creation Time |
| 3 | Job Creator |
| 4 | Job Finish Time |
| 5 | Job Id |
| 6 | Job Process Name |
| 7 | Job Process Version |
| 8 | Job Priority |
| 9 | State |
| 10 | RAG |
| 11 | Case Ref |
| 12 | Job Owner |
| Enumeration | Description |
|---|---|
| 0 | Count |
| 1 | Sum |
| 2 | Average |
| 3 | Minimum |
| 4 | Maximum |
| JobsSummaryResults GetJobsSummaryWithQuery | ( | string | sessionId, |
| QueryIdentity | queryIdentity, | ||
| JobField | groupByField | ||
| ) |
Executes a supplied Job Query and based on the groupByField passed in, returns a summary of the query results and an overall total count.
The query specifies filter criteria that are applied to the results. e.g. can filter on activity name, priority or Case Ref.
| sessionId | A string that uniquely identifies the session for the current logged on user. If the sessionId is invalid then an exception will be raised. | ||||||||||||||||
| queryIdentity | A QueryIdentity object that can be used to specify a Job Query.
| ||||||||||||||||
| groupByField | A JobField object used to specify the field to group the results by. See Remarks section of this API to get more information.
|
| Enumeration | Description |
|---|---|
| 1 | Job Status Field |
| 3 | Job Creator Field |
| 6 | Job Process Name Field |
| 7 | Job Process Version Field |
| 8 | Job Priority Field |
| 9 | State Field |
| 10 | Sla Field |
| 11 | Case Ref Field |
| 12 | The job owner field |
| 13 | Type Field |
| 14 | Score Field |
| 15 | The job WorkType |
| 16 | The job WorkType Field |
| JobQueryResult2 GetJobsWithQuery2 | ( | string | sessionId, |
| bool | useDefaultQuery, | ||
| QueryIdentity | queryIdentity, | ||
| JobQueryFilter | jobQueryFilter | ||
| ) |
Retrieves jobs based on the specified query. The query could be the default query specified for this resource, an existing saved query, or a custom query for which the settings are specified through the jobQueryFilter parameter. Also, we can optionally request the jobs count by setting the GetJobsCount property of the filter parameter to true. When select to return the jobs count the number returned will be the number of jobs and will not be restrained by the maximum number of jobs to return filter parameter.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| useDefaultQuery | A boolean value that specifies whether to use the default query. The query is used to retrieve jobs. If set to true, queryIdentity and jobQueryFilter are ignored. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| queryIdentity | The unique identity of the query. This parameter is only considered if useDefaultQuery is false. If set, jobQueryFilter is ignored.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| jobQueryFilter | Specifies the filter to retrieve jobs. This parameter can be null if either useDefaultQuery is true or queryIdentity is set. This parameter cannot be null when useDefaultQuery is false and queryIdentity is null or queryIdentity Id is blank.
|
| Operator | Description |
|---|---|
| ? | 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~*" |
| Enumeration | Description |
|---|---|
| -1 | None |
| 0 | Resource |
| 1 | Resource and Groups |
| 2 | Direct Subordinates |
| 3 | Resource and Direct Subordinates |
| 4 | Indirect Subordinates |
| 5 | Resource and Indirect Subordinates |
| Enumeration | Description |
|---|---|
| 0 | All |
| 1 | Since |
| 2 | Between |
| 3 | Today |
| 4 | ThisWeek |
| 5 | ThisMonth |
| 6 | ThisYear |
| Enumeration | Description |
|---|---|
| 0 | SlaStatus1 |
| 1 | SlaStatus2 |
| 2 | SlaStatus3 |
| 3 | SlaStatus4 |
| 4 | SlaStatus5 |
| Enumeration | Description |
|---|---|
| 0 | Normal Job |
| 1 | Case Instance |
| 2 | Associated Job (Job in Case) |
| 4 | Business Rule Job |
| Enumeration | Description |
|---|---|
| 0 | Job Criteria Active |
| 1 | Job Criteria All Live And Finished |
| 2 | Job Criteria All Finished |
| 3 | Job Criteria All Live |
| 4 | Job Criteria Completed |
| 5 | Job Criteria Ready For Evaluation |
| 6 | Job Criteria Pending Completion |
| 7 | Job Criteria Suspended |
| 8 | Job Criteria Terminated |
| 9 | Job Criteria On Hold |
| 10 | Job Criteria Awaiting Completion |
| 11 | Job Criteria Awaiting Case Completion |
| 12 | Job Criteria Terminated Awaiting Completion |
| 13 | Job Criteria Terminated Awaiting Case Completion |
| Enumeration | Description |
|---|---|
| 1 | Status |
| 2 | Creation Time |
| 3 | Creator |
| 4 | Completion Time |
| 5 | JobId |
| 6 | Process Name |
| 7 | Process Version |
| 8 | Priority |
| 9 | State |
| 11 | Case Reference |
| 12 | Owner |
| 13 | Type |
| 14 | Score |
| 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 | Supporting Info |
| 18 | Expected Duration |
| 19 | State Percentage |
The enumeration for SortOrder in SortOptions setting follows.
| Enumeration | Description |
|---|---|
| 0 | Ascending |
| 1 | Descending |
Enumeration for QueryType
| Enumeration | Description |
|---|---|
| 0 | JobList |
| 1 | WorkQueue |
| 2 | All |
| 3 | System |
| JobQueryResult2 GetJobsWithQueryAndFilter | ( | string | sessionId, |
| QueryIdentity | queryIdentity, | ||
| JobFieldValue | jobFieldValue | ||
| ) |
Retrieves jobs based on the specified query and a dynamic filter criteria defined in the JobFieldValue parameter. The JobFieldValue is used to update the filter parameters of the query with a dynamic value and allows the results to be further filtered based on this value.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| queryIdentity | The unique identity of the query. This will be used to get the filter of the query to which the dynamic field will be applied
| ||||||||||||||||
| jobFieldValue | Contains the filter field and value that will be used to dynamically update the query filter parameters and only have results returned that match the updated filter parameters. |
| Name | Type | Comment | Required |
|---|---|---|---|
| FieldType | short | The field type that the dynamic filter applies to. See table below for valid values | Yes |
| MetaDataFieldName | string | This field should be populated if the FieldType is a WorkType Field and should hold the Name of the work type field | Yes |
| FieldValue | object | The value of the field that should be used to update the filter | Yes |
| Enumeration | Description |
|---|---|
| 1 | JobStatusField |
| 3 | JobCreatorField |
| 5 | JobIDField |
| 6 | JobProcessNameField |
| 7 | JobProcessVersionField |
| 8 | JobPriorityField |
| 9 | StateField |
| 10 | SlaField |
| 11 | CaseRefField |
| 12 | JobOwnerField |
| 13 | Type |
| 14 | Score |
| 15 | WorkType |
| 16 | WorkTypeField |
| Enumeration | Description |
|---|---|
| 0 | JobList |
| 1 | WorkQueue |
| 2 | All |
| 3 | System |
| JobVariableHistoryCollection GetJobVariableHistory | ( | string | sessionId, |
| JobNodeIdentity | jobNodeIdentity, | ||
| JobVariableHistoryFilter | jobVariableHistoryFilter | ||
| ) |
Retrieves the job variable history.
| 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. | ||||||||||||||||||||
| jobNodeIdentity | A JobNodeIdentity object that contains details of which job and which node is involved. Cannot be null
| ||||||||||||||||||||
| jobVariableHistoryFilter | A JobVariableHistoryFilter object used as filter criteria for retrieving the variable history. Can be null
|
| Name | Type | Comment |
|---|---|---|
| VariableIdentity | VariableIdentity | The Id of the variable |
| VariableType | Short | The type of variable. Please see remarks section for more details. |
| VariableValueBefore | Object | The value of the variable before. |
| VariableValueAfter | Object | The value of the variable after. |
| SetTime | DateTime | Sets the time frame for history. |
| SetTimeSeconds | DateTime | Sets the seconds for returnedhistory. |
| JobIdentity | JobIdentity | The job containing the variable history to be returned. |
| NodeIdentity | NodeIdentity | The Id of the node where the variables are associated with. |
| EmbeddedProcessCount | Short | The number of embedded processes that are contained within the job. |
| Enumeration | Description |
|---|---|
| 0 | Empty |
| 1 | System |
| 2 | Short |
| 3 | Long |
| 4 | Float |
| 5 | Double |
| 6 | Currency |
| 7 | Date |
| 8 | String |
| 9 | Dispatch |
| 11 | Bool |
| 12 | Variant |
| 14 | Decimal |
| 17 | Byte |
| 2000 | Array |
| 8204 | Complex |
| 32759 | Folder |
| 32760 | Document |
| 32761 | Entity |
| 32762 | Nullable String |
| 32763 | Nullable Date |
| 32764 | Checklist |
| 32765 | Text |
| 32766 | Xml Expression |
| JobVariableCollection GetJobVariables | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Gets the job variables.
| 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 used to identify the job whose variable values are to be retrieved. Cannot be null
|
| VariableValueCollection GetJobVariablesValues | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| VariableIdentityCollection | variableIdentityCollection | ||
| ) |
Retrieves a list of variable values for a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identityobject used to identify the job whose variable values are to be retrieved. Cannot be null
| ||||||||||||
| variableIdentityCollection | A VariableIdentityCollection collection of variables whose values are to be returned. VariableIdentity members.
|
| VariableValue GetJobVariableValue | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| VariableIdentity | variableIdentity | ||
| ) |
Retrieves the variable value from the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose variable value is to be retrieved.
| ||||||||||||
| variableIdentity | A VariableIdentity identity object identifying the variable whose runtime value we want from the specified job.
|
| Name | Type | Comment |
|---|---|---|
| Value | Object | The value of the variable that is returned. |
| Found | Boolean | If true, the variable was found. If false, the variable was not found. |
| ProcessViewerData GetJobViewerData | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| bool | associatedJobs | ||
| ) |
Retrieves the job properties, the customize and restart access permissions and also maps the job details and runtime status in XML format (used primarily by the Job Viewer control).
| 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 that is used to identify the job for which the job viewer data to be retrieved.
| ||||||||
| associatedJobs | If set to true, then get details for associated jobs as well. NOT used by this API |
| JobProperties GetMinJobDetails | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| JobHistoryFilter | filter, | ||
| short | maxWQFieldCount | ||
| ) |
Retrieves a minimum anount of information on the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose details we require.
| ||||||||||||||||
| filter | A JobHistoryFilter object which will be used as the filter criteria for retrieving the job details
| ||||||||||||||||
| maxWQFieldCount | The maximum number of workqueue fields to be returned. |
| StateHistoryCollection GetStateChangeHistory | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Retrieves the state changes history for a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job.
|
| SubJobProperties GetSubJobProperties | ( | string | sessionId, |
| SubJobIdentity | subJobIdentity, | ||
| short | jobDatabase | ||
| ) |
Retrieves the variables and history of a sub job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| subJobIdentity | A SubJobIdentity object detailing the sub-job.
| ||||||||||||
| jobDatabase | Database to use for searching for the job.
|
| ProcessViewerData GetSubJobViewerData2 | ( | string | sessionId, |
| SubJobIdentity | subJobIdentity, | ||
| ProcessIdentity | processIdentity, | ||
| bool | getSubJobProperties | ||
| ) |
Retrieves the sub job properties, customize and restart access details, and also maps the details with runtime status in XML format.
| 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. | ||||||||||||||||
| subJobIdentity | A SubJobIdentity object detailing the sub-job.
| ||||||||||||||||
| processIdentity | A ProcessIdentity identity object containing the processid and version of the process to create a job on.
| ||||||||||||||||
| getSubJobProperties | if set to true the properties of the sub job will be returned. If false, nothing is returned. |
| JobMilestoneCollection GetUpdatedMilestones | ( | string | sessionId, |
| DateTime | lastUpdatedDateTime, | ||
| short | databaseConnectionType | ||
| ) |
Retrieve the milestones that have been updated since the specified date.
| 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. | ||||||||
| lastUpdatedDateTime | The last updated date time. Will only get milestones updated after this date time | ||||||||
| databaseConnectionType | Whether to return the milestones for live jobs, archived jobs or both.
|
| void HoldJob2 | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| OnHoldOptions2 | onHoldOptions | ||
| ) |
Holds a job with the specified job details. Note: The expected finish time and the expected duration of a job will be updated by the amount of time the job was on hold when the job is taken off hold. Also escalations will not fire while the job is on hold.
Note: We should not call HoldJob from within the job itself(on.net node) either in a subjob or at parent level, as it leads to an infinite loop as the.Net node does not complete prior to the job being put on hold. The job is then activated on the same node and put on hold again.
| 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 that is used to identify the job that needs to be put on hold.
| ||||||||||||||||||||||||||||||||
| onHoldOptions | A OnHoldOptions object that specify if the job needs to be put on hold based on ActivationDate or ActivationPeriod. It also contains the information related to Activation date and period and the reason for holding the job.
|
| Enumeration | Description |
|---|---|
| 0 | Activation Date |
| 1 | Activation Period |
| void HoldJobs | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection, | ||
| OnHoldOptions | onHoldOptions | ||
| ) |
Put the specified jobs On Hold. Note: The expected finish time and the expected duration of jobs will be updated by the amount of time the jobs were on hold when the jobs are taken off hold. Also escalations will not fire while the job is on hold
| 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. | ||||||||||||||||||||||||||||||||
| jobIdentityCollection | A JobIdentityCollection collection object that describes jobs that are to be put on hold. JobIdentity members.
| ||||||||||||||||||||||||||||||||
| onHoldOptions | A OnHoldOptions object that specify if the jobs need to be put on hold based on ActivationDate or ActivationPeriod. It also contains the information related to Activation date and period and the reason for holding the jobs.
|
| Enumeration | Description |
|---|---|
| 0 | Activation Date |
| 1 | Activation Period |
| bool IsAccessPermitted | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| short | accessType | ||
| ) |
Defines the access permitted by the current resource for a particular action for a specified job. It determines whether the resource can Create, Suspend or Terminate a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job on which the access needs to be checked.
| ||||||||||||||||||||||||||
| accessType | Type of access to the job you want verified
|
| bool PerformChecking | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| ResourceIdentity | resourceIdentity | ||
| ) |
Determines whether checking can be performed or not.
| 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 that is used to identify the job on which need to verify if checking is to be performed.
| ||||||||||||||||
| resourceIdentity | A ResourceIdentity identity object containing the resource that we are discovering if checking needs to be performed. Cannot be null
|
| bool PerformSampling | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Determines whether sampling can be performed or not.
| 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 that is used to identify the job on which need to verify if sampling is to be performed.
|
| void PurgeJobs | ( | string | sessionId, |
| PurgeJobsOptions | options | ||
| ) |
Removes the jobs from the system based on the options provided.
| 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. | ||||||||||||||||||||
| options | A PurgeJobsOptions object containing options based on which, the jobs will need to be deleted.
|
| void PurgeJobsByID | ( | string | sessionId, |
| StringCollection | jobIds | ||
| ) |
The API takes the list of job Ids as input and purge the completed and terminated jobs in the list from live and finished job tables.
| 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. |
| jobIds | The list of JobIds to be purged. |
| void RaiseAnonymousEvent | ( | JobIdentity | jobIdentity, |
| string | eventName, | ||
| string | eventSource, | ||
| InputVariableCollection | updatedVariables | ||
| ) |
Raises an anonymous process event for the specified job using the system resource.
| jobIdentity | A JobIdentity identity object indicating the job the event will be raised for.
| ||||||||||||
| eventName | The event name (maximum of 40 characters). Is required. | ||||||||||||
| eventSource | The event source (maximum of 40 characters). Is required. | ||||||||||||
| updatedVariables | A collection of 0 or more InputVariable that need to be updated. Can be null. InputVariable members.
|
| void RaiseEvent | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| string | eventName, | ||
| string | eventSource, | ||
| InputVariableCollection | updatedVariables | ||
| ) |
Raises a process event for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object indicating the job the event will be raised for.
| ||||||||||||
| eventName | The event name (maximum of 40 characters). Is required. | ||||||||||||
| eventSource | The event source (maximum of 40 characters). Is required. | ||||||||||||
| updatedVariables | A collection of 0 or more InputVariable that need to be updated. Can be null. InputVariable members.
|
| void ReceivedJobDocument | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentIdentity | documentIdentity, | ||
| bool | useSource, | ||
| string | source, | ||
| bool | useStatus, | ||
| short | status | ||
| ) |
Documents Received will be added with the status of Received and if the document already exists it will be updated with the given status.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object containing the job details.
| ||||||||||||
| documentIdentity | A DocumentIdentity object containing the document information that needs to be added/ updated
| ||||||||||||
| useSource | if set to true use the source. If false, the source is not used. | ||||||||||||
| source | The source message. | ||||||||||||
| useStatus | if set to true use the passed in status. If false, the status is not used. | ||||||||||||
| status | The status of the document that needs to be updated with. When we are adding a new document the status will by default be set as Received. When we are updating the existing the document, the possible status will be as below:
|
| void ReceivedJobDocuments | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentIdentityCollection | documentIdentityCollection, | ||
| FolderIdentity | folderIdentity, | ||
| bool | useSource, | ||
| string | source, | ||
| bool | useStatus, | ||
| short | status | ||
| ) |
Documents Received will be added with the status of Received and if the document already exists it will be updated with the given status.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object containing the job details.
| ||||||||||||
| documentIdentityCollection | A DocumentIdentityCollection object containing the collection of documents that needs to be added
| ||||||||||||
| folderIdentity | A FolderIdentity object containing the folder details.
| ||||||||||||
| useSource | if set to true use the source. If false, the source is not used. | ||||||||||||
| source | The source message. | ||||||||||||
| useStatus | if set to true use the passed in status. If false, the status is not used. | ||||||||||||
| status | The status of the document that needs to be updated with. When we are adding a new document the status will by default be set as Received. When we are updating the existing the document, the possible status will be as below:
|
| void RecoverJob | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Recovers a job if they have failed the evaluation stage.
| 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 that is used to identify the job that needs to be recovered.
|
| void RecoverJobs | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection | ||
| ) |
Recovers the jobs that are specified.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentityCollection | A JobIdentityCollection collection object that indicates jobs that need to be recovered.
|
| void ReevaluateJobDocumentRequiredDates | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Re evaluate job document required dates.
| 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 containing the job details.
|
| void ReevaluatePrecondition | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Reevaluates the precondition for a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object used to identify the job whose precondition needs to be re-evaluated.
|
| void ReEvaluateSkin | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| SkinEvaluationOptions | skinOptions | ||
| ) |
Reevaluates a skin on a job using existing job or a case variable. If a new skin is determined any overridden job and activity level properties for the skin are updated within the job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job on which to evaluate the skin.
| ||||||||||||
| skinOptions | A SkinEvaluationOptions object that is used to indicate the skin evaluation options.
|
| void ReplaceJobRoleMembers | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| RoleIdentity | roleIdentity, | ||
| ResourceIdentityCollection | resources | ||
| ) |
Replaces the members of a floating role in a job with new members.
| 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 that is used to identify the job to update.
| ||||||||||||
| roleIdentity | A RoleIdentity identity object that is used to identify the role to update. The role Id or role Name can be used.
| ||||||||||||
| resources | A ResourceIdentityCollection collection object that contains the resources to set as the role members. |
| void ResetJobVariables | ( | string | sessionId, |
| JobActivityIdentity | jobActivity, | ||
| JobIdentity | subJob, | ||
| bool | useLatestHistory, | ||
| DateTime | setTime | ||
| ) |
Resets the variables for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
| jobActivity | A JobActivityIdentity identity object containing the job activity information. Cannot be null
| ||||||||||||||||||||
| subJob | A JobIdentity identity object containing the sub job details. Cannot be null
| ||||||||||||||||||||
| useLatestHistory | Determines if latest variable history needs to be used. | ||||||||||||||||||||
| setTime | Time at which the activity was performed. |
| void RestartJob | ( | string | sessionId, |
| JobActivityIdentity | jobActivityIdentity, | ||
| ProcessActivityIdentityCollection | embeddedProcessList, | ||
| short | restartType, | ||
| JobIdentity | subJobIdentity | ||
| ) |
Allows administrators to correct any runtime problems with the flow of maps by restarting the job at or after a particular node.
| 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 contains the node information to restart at or after.
| ||||||||||||||||||||
| embeddedProcessList | A collection of ProcessActivityIdentity that contains the embedded process list which describes the path into the map to reach the node Id specified. Passing in null or with count of zero means the node id refers to a node in the parent map. ProcessActivityIdentity members.
| ||||||||||||||||||||
| restartType | Where we want to restart. See Remarks section for enumeration | ||||||||||||||||||||
| subJobIdentity | A JobIdentity object that indicates the sub job whose node we want to restart at or after. Can be null i.e. if we are restarting in the main job
|
| Enumeration | Description |
|---|---|
| 0 | Restart At – Applies only to Activities |
| 1 | Restart After |
| void SuspendJob | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| JobNote | jobNote | ||
| ) |
Please note that this function is deprecated. Please use SuspendJob2 instead.
Suspends the job with the specified job id.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job that needs to be suspended.
| ||||||||||||||||||||||||
| jobNote | A JobNote object that contains the note text and type.
|
| void SuspendJob2 | ( | string | sessionId, |
| SuspendJobInfo | suspendJobInfo | ||
| ) |
Suspends the job with the specified job id.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| suspendJobInfo | A SuspendJobInfo object that is used to identify the job that needs to be suspended with optional suspension reason and note. SuspendJobInfo members.
|
| void SuspendJobs | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection, | ||
| JobNote | jobNote | ||
| ) |
Please note that this function is deprecated. Please use SuspendJobs2 instead.
Suspends the specified jobs.
| 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. | ||||||||||||||||||||||||
| jobIdentityCollection | A JobIdentityCollection collection object that identifies jobs that are to be suspended. JobIdentity members.
| ||||||||||||||||||||||||
| jobNote | A JobNote object that contains the job note to be added to highlight the suspend operation.
|
| void SuspendJobs2 | ( | string | sessionId, |
| SuspendJobsInfo | suspendJobsInfo | ||
| ) |
Suspends the specified jobs.
| 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. | ||||||||||||||||
| suspendJobsInfo | A SuspendJobsInfo object that is used to identify the list of jobs that needs to be suspended with optional suspension reason and note. SuspendJobsInfo members.
|
| void TerminateJob | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Terminates a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job that needs to be terminated.
|
| void TerminateJobs | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection | ||
| ) |
Terminates the specified jobs.
| 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. | ||||||||
| jobIdentityCollection | A JobIdentityCollection collection object that identifies jobs that are to be terminated. JobIdentity members.
|
| void UnHoldJob | ( | string | sessionId, |
| JobIdentity | jobIdentity | ||
| ) |
Activates the specified job that is on hold.
| 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 used to identify the job that needs to be activated.
|
| void UnHoldJobs | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection | ||
| ) |
Activates the specified jobs that are on hold.
| 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. | ||||||||
| jobIdentityCollection | A JobIdentityCollection collection object that describes jobs that are to be activated. JobIdentity members.
|
| object UpdateJobComplexVariable | ( | string | sessionId, |
| UpdateComplexVariableAction | updateComplexVariableAction | ||
| ) |
Updates job complex variable data.
| sessionId | The session identifier. |
| updateComplexVariableAction | The updateComplexVariableAction. |
| void UpdateJobComplexVariableFromTable | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| VariableIdentity | variableIdentity, | ||
| ComplexVariableValueRowCollection | complexVariableRows | ||
| ) |
Updates the value of specified dynamic complex variable in a job, with the data passed from a form table control.
| 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 that is used to identify the job from which the variable value needs to be retrieved.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| variableIdentity | A VariableIdentity identity object that is used to identify the variable whose value needs to be retrieved from the specified job.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| complexVariableRows | An ComplexVariableValueRowCollection collection object of row data of a complex variable whose values need to be updated. ComplexVariableValueRow members.
|
| void UpdateJobCustomerData | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| string | customerData, | ||
| OutputVariableCollection | variables | ||
| ) |
Updates the customer data against the job. The customer data will contain context information to enable users to progress activities.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job which needs to be updated with the customer data.
| ||||||||||||
| customerData | The context information to enable users to progress activities. | ||||||||||||
| variables | A collection of 0 or more OutputVariable that need to be updated. Cannot be null
|
| void UpdateJobDocumentRequiredDate | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity, | ||
| DateTime | requiredDate | ||
| ) |
Updates the job document rule date required.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object containing the job details.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document details.
| ||||||||||||||||
| requiredDate | The date required that is to be used for updating the job document. |
| void UpdateJobDocumentRule | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity, | ||
| DateTime | dateRequired, | ||
| string | description, | ||
| DocumentProcessBasicRule | documentBasicRule | ||
| ) |
updates the job document rule.
| 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 containing the job details.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type. Cannot be null.
| ||||||||||||||||
| dateRequired | The required date for the job. | ||||||||||||||||
| description | The description of the job. | ||||||||||||||||
| documentBasicRule | A Document Process Basic Rule object that is used to define the state of document and the number of required documents.
|
| void UpdateJobDocumentType | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentIdentity | documentIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity | ||
| ) |
Updates the type of the job document with the specified document type.
| 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 containing the job details.
| ||||||||||||||||
| documentIdentity | A DocumentIdentity identity object containing the document details.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type.
|
| void UpdateJobExpectedFinishTime | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DateTime | expectedFinishTime, | ||
| bool | resetException | ||
| ) |
Updates the expected finish time of a live job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job to update.
| ||||||||
| expectedFinishTime | The new expected finish time. | ||||||||
| resetException | If set to true the Job Duration Overrun exception will be reset so it can be raised again for this job. |
| void UpdateJobLanguage | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| string | languageName | ||
| ) |
Updates the language for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job for which the language needs to be modified.
| ||||||||
| languageName | The language that needs to be set for the job. This should be a culture name installed on the server by windows OS. Refer National Language Support (NLS) API Reference for list of languages and culture names. Few examples :- FR, EN, EN-GB etc.(these are the culture names for French, English, English(United Kingdom)) |
| void UpdateJobMilestoneActualDate | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| MilestoneIdentity | milestoneIdentity, | ||
| DateTime | newActualDate | ||
| ) |
Updates the actual date for a milestone actual in a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job.
| ||||||||
| milestoneIdentity | A MilestoneIdentity identity object that is used to identify the milestone to be updated.
| ||||||||
| newActualDate | The new actual datetime for the milestone |
| void UpdateJobMilestoneTargetDate | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| MilestoneIdentity | milestoneIdentity, | ||
| DateTime | newTargetDate | ||
| ) |
Updates the target finish date for a milestone in a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job.
| ||||||||
| milestoneIdentity | A MilestoneIdentity identity object that is used to identify the milestone to be updated.
| ||||||||
| newTargetDate | The new target finish datetime for the milestone |
| void UpdateJobNote | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DateTime | dateNoteEntered, | ||
| NoteInfo | noteInfo | ||
| ) |
Updates a note associated with a job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job the note is associated with.
| ||||||||||||
| dateNoteEntered | Date that the note was entered. This is required. | ||||||||||||
| noteInfo | A NoteInfo object that specifies the note text and type.
|
| void UpdateJobOwner | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| ResourceIdentity | jobOwner | ||
| ) |
Updates the job owner for the specified jobs.
| 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 indicating the job to be updated with a new job owner.
| ||||||||||||||||
| jobOwner | A ResourceIdentity identity object that will be set as the job owner for the job.
|
| void UpdateJobOwners | ( | string | sessionId, |
| JobIdentityCollection | jobIdentityCollection, | ||
| ResourceIdentity | resourceIdentity | ||
| ) |
Updates the job owner for the specified jobs.
| 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. | ||||||||||||||||
| jobIdentityCollection | A JobIdentity object which contains a collection of 0 or more jobs to be updated with a new job owner. JobIdentity members.
| ||||||||||||||||
| resourceIdentity | A ResourceIdentity identity object that will be set as the job owner for the jobs.
|
| void UpdateJobOwnerUsingSearchCriteria | ( | string | sessionId, |
| JobFilter | jobFilter, | ||
| ResourceIdentity | jobOwner | ||
| ) |
Updates the job owner of the jobs identified using the specified search criteria.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| jobFilter | A JobFilter object used to filter the jobs. Cannot be null
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| jobOwner | A ResourceIdentity identity object that needs to assigned as job owner of the jobs. Cannot be null
|
| Enumeration | Description |
|---|---|
| 0 | Active |
| 1 | Completed |
| 2 | Terminated |
| 3 | Suspended |
| 4 | Pending Completion |
| 5 | Locked |
| 6 | Ready For Evaluation |
| 7 | On Hold |
| 8 | Awaiting Completion |
| 9 | Awaiting Case Completion |
| 10 | Awaiting Completion Terminated |
| 11 | Awaiting Case Completion Terminated |
| Enumeration | Description |
|---|---|
| 0 | Normal Job |
| 1 | Case Instance |
| 2 | Associated Job (Job in Case) |
| 4 | Business Rule Job |
| Enumeration | Description |
|---|---|
| 0 | Active |
| 1 | All Live And Finished |
| 2 | All Finished |
| 3 | All Live |
| 4 | Completed |
| 5 | Ready For Evaluation |
| 6 | Pending Completion |
| 7 | Suspended |
| 8 | Terminated |
| 9 | On Hold |
| 10 | Awaiting Completion |
| 11 | Awaiting Case Completion |
| 12 | Terminated Awaiting Completion |
| 13 | Terminated Awaiting Case Completion |
| void UpdateJobPriority | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| short | jobPriority | ||
| ) |
Updates the job priority for the specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose priority needs to be updated.
| ||||||||
| jobPriority | The new job priority. This is required and must be between 1 and 100 inclusive. 1 is the highest priority, 100 is the lowest. |
| void UpdateJobSource | ( | string | sessionId, |
| string | jobId, | ||
| string | jobSource | ||
| ) |
Updates the job source for a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
| jobId | A string that is used to identify the job for which the job source needs to be changed. |
| jobSource | Job source that needs to be set for the job. |
| void UpdateJobSpend | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| double | value | ||
| ) |
Updates the current spend so far for a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job whose spend value needs to be updated.
| ||||||||
| value | Adds this value to the current spend so far for the job. |
| void UpdateJobState | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| string | jobState | ||
| ) |
Changes a job state and perform any action associated with the state. Will restart the job if required.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
| jobIdentity | A JobIdentity identity object that is used to identify the job for which the state needs to be updated.
| ||||||||
| jobState | The new job state for the job. Is required |
| void UpdateJobVariables | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| UpdatedVariableCollection | updatedVariables | ||
| ) |
Updates the variable values for a specified job.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object used to identify the job whose variables needs to be updated.
| ||||||||||||||||
| updatedVariables | An UpdatedVariableCollection collection object of variables whose values need to be updated. UpdatedVariable members.
|
| Enumeration | Description |
|---|---|
| 0 | Empty |
| 1 | System |
| 2 | Short |
| 3 | Long |
| 4 | Float |
| 5 | Double |
| 6 | Currency |
| 7 | Date |
| 8 | String |
| 9 | Dispatch |
| 11 | Bool |
| 12 | Variant |
| 14 | Decimal |
| 17 | Byte |
| 2000 | Array |
| 8204 | Complex |
| 32759 | Folder |
| 32760 | Document |
| 32761 | Entity |
| 32762 | Nullable String |
| 32763 | Nullable Date |
| 32764 | Checklist |
| 32765 | Text |
| 32766 | Xml Expression |
| void UpdateReceivedJobDocumentsStatus | ( | string | sessionId, |
| JobIdentity | jobIdentity, | ||
| DocumentIdentityCollection | documentIdentityCollection, | ||
| FolderIdentity | folderIdentity, | ||
| DocumentTypeIdentity | documentTypeIdentity, | ||
| short | status | ||
| ) |
Updates the received job documents status.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
| jobIdentity | A JobIdentity identity object containing the job details.
| ||||||||||||||||
| documentIdentityCollection | A DocumentIdentityCollection object containing the collection of documents that needs to be added
| ||||||||||||||||
| folderIdentity | A FolderIdentity object containing the folder details.
| ||||||||||||||||
| documentTypeIdentity | A DocumentTypeIdentity identity object containing the document type.
| ||||||||||||||||
| status | The status of the document that needs to be updated with. When we are adding a new document the status will by default be set as Received. When we are updating the existing the document, the possible status will be as below:
|
| string UpgradeJobs2 | ( | string | sessionId, |
| UpgradeJobFilter | upgradeJobFilter | ||
| ) |
Upgrades the jobs using the specified upgrade criteria.
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
| upgradeJobFilter | A UpgradeJobFilter object that can be used to determine which jobs get upgraded. Cannot be null
|
| void UpgradeJobsAsync | ( | string | sessionId, |
| UpgradeJobFilter | upgradeJobFilter | ||
| ) |
Upgrades the jobs asynchronously using the specified filter criteria
| sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
| upgradeJobFilter | A UpgradeJobFilter object that can be used to determine which jobs get upgraded. Cannot be null
|
