Package Thor.API.Operations

Interface tcProvisioningOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcProvisioningOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method	Description
long	addProcessTaskInstance(long plTaskKey, long plOrcKey)	Provides the ability to add/execute a task where the task's manual insert property is enabled.
void	cancelProvisioningTasks(String processTask, String processDefn)	This method cancels the pending provisioning tasks for a given process task of a process definition
Thor.API.tcResultSet	findAllOpenProvisioningTasks(Map attributeList, String[] statuses)	This method return a list of all the provisioning tasks (and their details) assigned to any user.
Thor.API.tcResultSet	findObjects(String actionType, String[] targetKeys, String type, String[] statusesIn, String[] statusesNotIn, Map searchCriteria)	This method returns all Resource Objects based on the parameters.
Thor.API.tcResultSet	findObjects(String actionType, String[] targetKeys, String type, String[] statusesIn, String[] statusesNotIn, Map searchCriteria, boolean allowModifyOnProvisioningStatus)	This method returns all Resource Objects based on the parameters.
Thor.API.tcResultSet	findObjects(String actionType, String[] targetKeys, String type, Map searchCriteria)	This method returns all Resource Objects based on the parameters.
Thor.API.tcResultSet	getAssignedOpenProvisioningTasks(long userKey, Map attributeList, String[] statuses)	This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to.
Thor.API.tcResultSet	getAssignedOpenProvisioningTasksPaged(long userKey, Map attributeList, String[] statuses, int startRow, int pageSize, String[] order, boolean ascendingOrder, boolean getTotalRowCount)	This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to.
Thor.API.tcResultSet	getAssignedProvisioningTasks(long userKey, Map attributeList, String[] statuses)	This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to.
int	getNumberOfOpenProvisioningTasksAssignedToUser(long userKey)	This method returns the number of provisioning tasks are assigned to a given user based on the given statuses.
int	getNumberOfProvisioningTasksAssignedToUser(long userKey, String[] statuses)	This method returns the number of provisioning tasks are assigned to a given user based on the given statuses.
Thor.API.tcResultSet	getObjectDetail(long plProcessInstanceKey)	Returns detailed object information about the process specified.
Thor.API.tcResultSet	getOpenProvisioningTasksAssignedToManagedUsers(long userKey, Map attributeList, String[] statuses)	This method returns a list of all the provisioning tasks (and their details) that are assigned to the users for whom the specified user is a manager of.
Thor.API.tcResultSet	getOpenProvisioningTasksAssignedToManagedUsersPaged(long userKey, Map attributeList, String[] statuses, int startRow, int pageSize, String[] order, boolean ascendingOrder, boolean getTotalRowCount)	This method return a list of all the provisioning tasks (and their details) that are assigned to the users managed by a given user or to the groups to which the user belongs to.
Thor.API.tcResultSet	getOpenProvisioningTasksAssignedToSubgroups(long userKey, Map attributeList, String[] statuses, boolean hierarchyOrder)	This method returns a list of all the assigned provisioning tasks that are visible to the specified user based on his indirect group membership.
Thor.API.tcResultSet	getOpenProvisioningTasksAssignedToSubgroupsPaged(long userKey, Map attributeList, String[] statuses, boolean hierarchyOrder, int startRow, int pageSize, String[] order, boolean ascendingOrder, boolean getTotalRowCount)	This method returns a list of all the assigned provisioning tasks that are visible to the specified user based on his indirect group membership.
Thor.API.tcResultSet	getOrganizationProvisioningProcessInformation(long plObjectInstanceForOrganizationKey)	Returns information about the provisioning process associated with an object instance for an organization in the system.
Thor.API.tcResultSet	getProcessDetail(long plProcessInstanceKey)	Returns detailed task information about the process specified.
Thor.API.tcResultSet	getProcessInstanceData(List<String> processInstances)	This method returns all the orc_tos_instance_keys corresponding to each process instance key.
Date	getProvisioingProcessOfflinedDate(long processInstanceKey)	Deprecated.
Thor.API.tcResultSet	getProvisioningTaskDetails(long taskInstanceKey)	Returns information about the provisioning process task instance.
Thor.API.tcResultSet	getProvisioningTasksAssignedToManagedUsers(long userKey, Map attributeList, String[] statuses)	This method returns a list of all the provisioning tasks (and their details) that are assigned to the users for whom the specified user is a manager of.
Thor.API.tcResultSet	getProvisioningTasksAssignedToSubgroups(long userKey, Map attributeList, String[] statuses, boolean hierarchyOrder)	This method returns a list of all the assigned provisioning tasks that are visible to the specified user based on his indirect group membership.
Thor.API.tcResultSet	getResponsesForInstanceTask(long instanceKey)	This method returns all the responses for a given a task instance.
Thor.API.tcResultSet	getTaskHistory(long taskKey)	Returns a history of the assignment of the indicated task.
long	getTasksArchived(String reqKey)	Deprecated.
Thor.API.tcResultSet	getTasksAvailableForUpdate(long taskInstanceKey)	Returns task status and bucket against task instance key which are available for update.
Thor.API.tcResultSet	getUserOrgResourceDetailsForProvisioningProcess(long processInstance)
Thor.API.tcResultSet	getUserProvisioningProcessInformation(long plObjectInstanceForUserKey)	Returns information about the provisioning process associated with an object instance for a user in the system.
boolean	isTaskNoteEncrypted(long plTaskInstanceKey)	Deprecated.
boolean	isTaskUpdatable(long plTaskInstanceKey, long plUserKey)	Verifies if the user has the permission to updates the details of a specified task instance.
void	reassignTasksToGroup(long[] taskInstanceKeys, byte[][] taskInstanceRowvers, long groupKey)	This method re-assigns the selected tasks to the specified group.
void	reassignTasksToGroup(long[] taskInstanceKeys, long groupKey)	This method re-assigns the selected provisioning tasks to the specified group.
void	reassignTasksToUser(long[] taskInstanceKeys, byte[][] taskInstanceRowvers, long userKey)	This method re-assigns the selected tasks to the specified user.
void	reassignTasksToUser(long[] taskInstanceKeys, long userKey)	This method re-assigns the selected tasks to the specified user.
String	retryTask(long plTaskInstanceKey)	Provides the ability to re-execute a task if any of its prior executions have failed.
Map	retryTasks(long[] taskInstanceKeys)	This method provides the ability to re-execute the list of specified tasks if any of their prior executions have failed.
void	revokeDisconnectedAccount(long usrKey, long oiuKey)	Performs revocation of disconnected account provisioned to a user.
void	setTasksCompletedManually(long[] taskInstanceKeys)	This method provides the ability to set the task instance as manually completed given a list of specified tasks.
void	updateProcessDefinitionName(long msProcessDefnKey, Map attributes)	Updates the specified Process Definition name instance.
void	updateTask(long taskInstanceKey, byte[] taskInstanceRowVer, Map phAttributeList)	Updates the details of a specified task instance.
void	updateTask(long plTaskInstanceKey, Map phAttributeList)	Deprecated.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Details

getUserProvisioningProcessInformation

Thor.API.tcResultSet getUserProvisioningProcessInformation(long plObjectInstanceForUserKey)
                                                    throws tcAPIException,
tcNotProvisionedException,
tcAPIException

Returns information about the provisioning process associated with an object instance for a user in the system. It locates the provisioning process, and returns a result set giving information about the provisioning process. If the provisioning process is a meta-process, it returns within the result set information about all the sub-processes involved in provisioning. The information provided is enough to recreate the process tree.

Parameters:

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

Returns:

A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information. The following information is included in the resultset returned by this API:

• Process Instance.Key
• Process.Process Definition.Process Key
• Orders.Key
• Process Definition.Key
• Process Instance.Supplementary Code
• Organizations.Key
• Process Integration.Key
• Users.Key
• Process Instance.Assigned To
• Process Instance.Status
• Process Instance.Note
• Process Instance.Updated By
• Process Instance.Update Date
• Process Instance.Descriptive Data
• Process Instance.Package Instance Key
• Process Instance.Subprocess Key
• Process Instance.Reference Key
• Process Instance.Depends
• ORC_LAST_UPDATE
• ORC_LAST_UPDATEBY
• Process Instance.Suborder
• Process Instance.Service Order
• Process Instance.Parent Key
• Process Instance.Required Complete
• Process Instance.Target
• Process Instance.System Level
• Process Instance.Order By Policy
• Process Instance.Create
• Process Instance.Created By

Throws:

tcAPIException

tcNotProvisionedException

getOrganizationProvisioningProcessInformation

Thor.API.tcResultSet getOrganizationProvisioningProcessInformation(long plObjectInstanceForOrganizationKey)
                                                            throws tcAPIException,
tcNotProvisionedException,
tcAPIException

Returns information about the provisioning process associated with an object instance for an organization in the system. It locates the provisioning process, and returns a result set giving information about the provisioning process. If the provisioning process is a meta-process, it returns within the result set information about all the sub-processes involved in provisioning. The information provided is enough to recreate the process tree.

Parameters:

plObjectInstanceForOrganizationKey - The key of the object instance for an organization in the system.

Returns:

A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information. The following information is included in the resultset returned by the API:

• Process Instance.Key
• Process.Process Definition.Process Key
• Orders.Key
• Process Definition.Key
• Process Instance.Supplementary Code
• Organizations.Key
• Process Integration.Key
• Users.Key
• Process Instance.Assigned To
• Process Instance.Status
• Process Instance.Note
• Process Instance.Updated By
• Process Instance.Update Date
• Process Instance.Descriptive Data
• Process Instance.Package Instance Key
• Process Instance.Subprocess Key
• Process Instance.Reference Key
• Process Instance.Depends
• ORC_LAST_UPDATE
• ORC_LAST_UPDATEBY
• Process Instance.Suborder
• Process Instance.Service Order
• Process Instance.Parent Key
• Process Instance.Required Complete
• Process Instance.Target
• Process Instance.System Level
• Process Instance.Order By Policy
• Process Instance.Create
• Process Instance.Created By

Throws:

tcAPIException

tcNotProvisionedException

getProcessDetail

Thor.API.tcResultSet getProcessDetail(long plProcessInstanceKey)
                               throws tcAPIException,
tcNotAtomicProcessException,
tcAPIException

Returns detailed task information about the process specified. This detail covers all the tasks involved in the process, their current statuses and other such detailed information. It should only be used with atomic processes.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

Returns:

A tcResultSet containing one to many rows, each row holding information about a task in the process. The following information is returned in the resultset:

• Process Instance.Task Details.Key
• Process Instance.Task Details.Type
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Details.Status
• Process Instance.Task Details.Data
• Process Instance.Task Details.Projected Start
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Actual End Date
• Process Instance.Task Details.Reason
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Action
• Process Instance.Task Details.System level
• Process Instance.Task Details.Creation Date
• Process Instance.Task Details.Created By
• Process Instance.Task Details.Note
• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Process Definition.Tasks.Task Description
• Process Definition.Tasks.Days
• Process Definition.Tasks.Hours
• Process Definition.Tasks.Minutes
• Process Definition.Tasks.Milestone Datalabel
• Process Definition.Tasks.Disable Manual Insert
• Status.Category
• Process Definition.Tasks.Responses.Description
• Process Instance.Task Information.Updated By User Key
• Process Instance.Task Information.Updated By User ID
• Process Instance.Task Information.Updated By First Name
• Process Instance.Task Information.Updated By Last Name
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Process Definition.Tasks.Responses.Key
• TLG_KEY
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assign Type
• RETRYALLOWED

Throws:

tcAPIException

tcNotAtomicProcessException

getObjectDetail

Thor.API.tcResultSet getObjectDetail(long plProcessInstanceKey)
                              throws tcAPIException,
com.thortech.xl.orb.dataaccess.tcDataAccessException,
tcAPIException

Returns detailed object information about the process specified. This detail covers object's current statuses and other such detailed information. It should only be used with atomic processes.

Parameters:

plProcessInstanceKey - The key of the process instance in the system.

Returns:

A tcResultSet containing information about a object in the process. tcResultSet contains

• Users.Key
• Users.User ID
• Objects.Key
• Objects.Name
• Process Definition.Key
• Process Definition.Name
• Objects.Object Status.Status

Throws:

tcAPIException

com.thortech.xl.orb.dataaccess.tcDataAccessException

Since:

11.1.1.4

addProcessTaskInstance

long addProcessTaskInstance(long plTaskKey,
 long plOrcKey)
                     throws tcTaskNotFoundException,
tcAPIException,
tcAPIException

Provides the ability to add/execute a task where the task's manual insert property is enabled. If an instance of this task already exists, the task must have 'Allow Multiple Instances' property set to true in order to be executed.

Parameters:

plTaskKey - The key of the process task defined in process definition

plOrcKey - The key of the process order instance

Throws:

tcTaskNotFoundException - thrown when the task key passed is invalid

tcAPIException - thrown if any errors occur while adding the task instance

retryTask

String retryTask(long plTaskInstanceKey)
          throws tcTaskNotFoundException,
tcAPIException,
tcAPIException

Provides the ability to re-execute a task if any of its prior executions have failed.

Parameters:

plTaskInstanceKey - The key of the task instance to be re-executed

Returns:

Status of the task instance after it's been re-executed

Throws:

tcTaskNotFoundException

tcAPIException

updateTask

void updateTask(long plTaskInstanceKey,
 Map phAttributeList)
         throws tcTaskNotFoundException,
tcAPIException,
tcAwaitingObjectDataCompletionException,
tcAwaitingApprovalDataCompletionException,
tcAPIException

Deprecated.

Updates the details of a specified task instance.

Parameters:

plTaskInstanceKey - The key of the task instance to be updated

phAttributeList - A Map of name-value pairs. The Map key should contain the following metadata codes:

• Process Instance.Task Details.Note
• Process Instance.Task Details.Status
• Process Instance.Task Information.Assigned To User Key

The Map value should contain the respective update data.

Throws:

tcTaskNotFoundException

tcAPIException

tcAwaitingObjectDataCompletionException

tcAwaitingApprovalDataCompletionException

isTaskUpdatable

boolean isTaskUpdatable(long plTaskInstanceKey,
 long plUserKey)
                 throws tcTaskNotFoundException,
tcAPIException,
tcAPIException

Verifies if the user has the permission to updates the details of a specified task instance.

Parameters:

plTaskInstanceKey - The key of the task instance to be updated

plUserKey - The key of user whose permissions need to be checked.

Returns:

boolean If the task is assigned to the user a true value is returned.

Throws:

tcTaskNotFoundException

tcAPIException

getProvisioningTaskDetails

Thor.API.tcResultSet getProvisioningTaskDetails(long taskInstanceKey)
                                         throws tcAPIException,
tcAPIException

Returns information about the provisioning process task instance.

Parameters:

taskInstanceKey - The key of the task instance in a provisioning process.

Returns:

A tcResultSet containing one to many rows, each row holding information about a process instance, its parent process instance and other key information. The following details about the task instance are returned in the resultset:

• Process Instance.Task Details.Key
• Process Instance.Task Details.Type
• Process Instance.Task Details.Status
• Process Instance.Task Details.Data
• Process Instance.Task Details.Reason
• Users.Key
• Process Instance.Task Information.Assign Type
• Organizations.Key
• Process Instance.Key
• Process Definition.Name
• Process Instance.Descriptive Data
• Process Instance.Task Details.Projected Start
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Actual End Date
• SCH_REASON
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Action
• Process Instance.Task Details.System level
• Process Instance.Task Details.Creation Date
• Process Instance.Task Details.Created By
• Process Instance.Task Details.Note
• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Process Definition.Tasks.Task Description
• Process Definition.Tasks.Days
• Process Definition.Tasks.Hours
• Process Definition.Tasks.Minutes
• Process Definition.Tasks.Milestone Datalabel
• Process Definition.Tasks.Disable Manual Insert
• Status.Category
• Process Definition.Tasks.Responses.Description
• Process Instance.Task Information.Updated By User Key
• Process Instance.Task Information.Updated By User ID
• Process Instance.Task Information.Updated By First Name
• Process Instance.Task Information.Updated By Last Name
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Process Definition.Tasks.Responses.Key
• TLG_KEY
• Groups.Key
• Groups.Group Name

Throws:

tcAPIException

tcNotProvisionedException

getAssignedProvisioningTasks

Thor.API.tcResultSet getAssignedProvisioningTasks(long userKey,
 Map attributeList,
 String[] statuses)
                                           throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to. For displaying the open pending and rejected tasks, the statuses argument filter can be used.

Parameters:

userKey - User to get the assigned provisioning tasks.

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

Returns:

A resultset with each row having detailed information of each task. The returned result set also contains a column mentioning whether the specified user can see the task because he/she is a proxy for some other user. Also, it should returned a new column called "Date Assigned" which will have the date when the task was assigned to the user/group. The returning resultset columns are described below:

• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Organizations.Organization Name
• Status.Status
• Status.Category
• Process Instance.Task Details.Data
• Objects.Key
• Objects.Name
• Objects.Type
• Process Instance.Key
• Process Instance.Task Details.Key
• Process Instance.Task Details.Status
• Process Instance.Task Details.Type
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Action
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Actual End Date
• Process Instance.Task Details.Creation Date
• Process Instance.Task Details.Created By
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Projected Start
• Process Instance.Task Information.Assigned To
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Information.Assigned To User Key
• Process Instance.Task Information.Creation Date
• Process Instance.Task Information.Created By
• Process Instance.Task Information.Retry Task
• Process Instance.Task Information.Update Date
• Process Instance.Task Information.Updated By
• Process Instance.Task Information.Assigned To Group Key
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Target User
• Process Instance.Descriptive Data
• Requests.Key
• Process.Process Definition.Process Form Key
• Process Instance.Task Information.Assign Type

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

8.0

getProvisioningTasksAssignedToManagedUsers

Thor.API.tcResultSet getProvisioningTasksAssignedToManagedUsers(long userKey,
 Map attributeList,
 String[] statuses)
                                                         throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method returns a list of all the provisioning tasks (and their details) that are assigned to the users for whom the specified user is a manager of. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object is a result set with each row having detail information of each task. The result set also contain a column mentioning whether the specified user is a proxy for the user. Also, this method returnes a new column called "Date Assigned" which will have the date when the task was assigned to the user/group. The method also includes a Map as an argument that will contain name-value pairs so that the result set can be filtered over multiple columns. The attribute list should support the date search feature so that the tasks can be searched with start and end date ranges. This API has been modified in the following way: If the XL.AllowProxyVisibilityForAssignedTasks system property has been set then this API will return tasks that are assigned to Managed users of any user for whom the current user is a proxy. If the above system property is not set, then the API will return only the tasks assigned to managed users of the current user.

Parameters:

userKey - User to get the assigned provisioning tasks.

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

Returns:

a result set with provisiong task information

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

8.0

reassignTasksToUser

void reassignTasksToUser(long[] taskInstanceKeys,
 long userKey)
                  throws tcAPIException,
tcUserNotFoundException,
tcTaskNotFoundException,
tcBulkException,
tcAPIException

This method re-assigns the selected tasks to the specified user.

Parameters:

taskInstanceKeys - array of task instances that need to be re-assigned

userKey - the user key that all the task instance will re-assign to

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

tcUserNotFoundException - raise if the user is not a valid user.

tcTaskNotFoundException - raise if one or more task are not valid.

tcBulkException - raise if a problem occurred on any of the re-assigments of the task instance.

Since:

8.0

reassignTasksToGroup

void reassignTasksToGroup(long[] taskInstanceKeys,
 long groupKey)
                   throws tcAPIException,
tcGroupNotFoundException,
tcTaskNotFoundException,
tcBulkException,
tcAPIException

This method re-assigns the selected provisioning tasks to the specified group.

Parameters:

taskInstanceKeys - array of task instances that need to be re-assigned

groupKey - the group key that all the task instance will re-assign to

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

tcGroupNotFoundException - raise if the group is not a valid group.

tcTaskNotFoundException - raise if one or more task are not valid.

tcBulkException - raise if a problem occurred on any of the re-assigments of the task instance.

Since:

8.0

retryTasks

Map retryTasks(long[] taskInstanceKeys)
        throws tcTaskNotFoundException,
tcBulkException,
tcAPIException,
tcAPIException

This method provides the ability to re-execute the list of specified tasks if any of their prior executions have failed.

Parameters:

taskInstanceKeys - array of task instances to retry

Returns:

a Map of keys and status of the retry of each of the instances.

Throws:

tcTaskNotFoundException - raised if one or more task instances are not valid. isMessage will contain the list of invalid task instance keys separated by commas.

tcBulkException - raised if one or many task instance had errors retrying. getReturnValue() from this exception returns a Map of successfully retried tasks and isKeys is an array of task which retry caused problems.

tcAPIException - raise if a problem occurred when retrying the task.

Since:

8.0

getNumberOfProvisioningTasksAssignedToUser

int getNumberOfProvisioningTasksAssignedToUser(long userKey,
 String[] statuses)
                                        throws tcUserNotFoundException,
tcAPIException,
tcAPIException

This method returns the number of provisioning tasks are assigned to a given user based on the given statuses.

Parameters:

userKey - The User Key of the user for whom to get the number of approval tasks.

statuses - An array of statuses to filter the tasks by. If multiple statuses are specified, they are evaluated using the OR operator. If no status is specified then it looks for all tasks irrespective of status.

Returns:

the number of tasks assigned to the given user based on the given statuses

Throws:

tcUserNotFoundException - raise if the user is not a valid user in the system.

tcAPIException - raise if there is a problem during the execution of the API.

Since:

8.0

setTasksCompletedManually

void setTasksCompletedManually(long[] taskInstanceKeys)
                        throws tcTaskNotFoundException,
tcBulkException,
tcAPIException,
tcAPIException

This method provides the ability to set the task instance as manually completed given a list of specified tasks.

Parameters:

taskInstanceKeys - array of task instances to retry

Throws:

tcTaskNotFoundException - raised if one or more task instances are not valid. isMessage will contain the list of invalid task instance keys separated by commas.

tcBulkException - raised if one or many task instance had errors retrying.

tcAPIException - raise if a problem occurred when retrying the task.

Since:

8.0

getResponsesForInstanceTask

Thor.API.tcResultSet getResponsesForInstanceTask(long instanceKey)
                                          throws tcAPIException,
tcTaskNotFoundException,
tcAPIException

This method returns all the responses for a given a task instance.

Parameters:

instanceKey - the task instance

Returns:

a result set with all the responses given a task instance. The resultset contains the following columns:

• Process Definition.Tasks.Responses.Key
• Process Definition.Tasks.Key
• Status.Key
• Event Handler Manager.Key
• Process Definition.Tasks.Responses.Response
• Process Definition.Tasks.Responses.Description
• Process Definition.Tasks.Responses.Update Date
• RSC_UPDATEBY
• Process Definition.Tasks.Responses.System Level
• Process Definition.Tasks.Responses.Creation Date
• Process Definition.Tasks.Responses.Created By

Throws:

tcAPIException - raise if a problem is found.

tcTaskNotFoundException - raise if the task instance is not valid.

Since:

8.0

getProvisioingProcessOfflinedDate

@Deprecated
Date getProvisioingProcessOfflinedDate(long processInstanceKey)
                                throws tcAPIException,
tcAPIException

Deprecated.

API to find out if a given provisioned instance for a user is in off-lined stage or not

Parameters:

processInstanceKey - , Process Instance Key value

Returns:

a date indicating when the message is submitted for off-lining if the value returned is null, process is not in off-lined stage

Throws:

tcAPIException

tcAPIException

reassignTasksToUser

void reassignTasksToUser(long[] taskInstanceKeys,
 byte[][] taskInstanceRowvers,
 long userKey)
                  throws tcAPIException,
tcUserNotFoundException,
tcTaskNotFoundException,
tcStaleDataUpdateException,
tcBulkException,
tcAPIException

This method re-assigns the selected tasks to the specified user. This version of API is introduced to have optimistic locking. When multiple users try to reassign the task at the same time, only the first one will succeed and other ones will fail

Parameters:

taskInstanceKeys - Task instance keys (Process Instance.Task Details.Key) of the tasks that need to be updated

taskInstanceRowvers - Task instance row versions (Process Instance.Task Details.Row Version) of the tasks that need to be updated

userKey - the user key that all the task instance will be re-assigned to

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

tcUserNotFoundException - raise if the user is not a valid user.

tcTaskNotFoundException - raise if one or more task are not valid.

tcStaleDataUpdateException - If the data that passed is stale. If data that is paased to the API contains multiple task instances, API attempts to reassign all the instances and reports at the end about the failed ones because of the stale data by throwing this exception.

tcBulkException - raise if a problem occurred on any of the re-assigments of the task instance.

Since:

8.5.3.3

reassignTasksToGroup

void reassignTasksToGroup(long[] taskInstanceKeys,
 byte[][] taskInstanceRowvers,
 long groupKey)
                   throws tcAPIException,
tcGroupNotFoundException,
tcTaskNotFoundException,
tcStaleDataUpdateException,
tcBulkException,
tcAPIException

This method re-assigns the selected tasks to the specified group. This version of API is introduced to have optimistic locking. When multiple users try to reassign the task at the same time, only the first one will succeed and other ones will fail

Parameters:

taskInstanceKeys - Task instance keys (Process Instance.Task Details.Key) of the tasks that need to be re-assigned

taskInstanceRowvers - Task instance row versions (Process Instance.Task Details.Row Version) of the tasks that need to be re-assigned

groupKey - the group key that all the task instance will be re-assigned to

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

tcGroupNotFoundException - raise if the group is not a valid group.

tcTaskNotFoundException - raise if one or more task are not valid.

tcStaleDataUpdateException - If the Task instance row versions that passed is stale. If data that is paased to the API contains multiple task instances, API attempts to reassign all the instances and reports at the end about the failed ones because of the stale data by throwing this exception.

tcBulkException - raise if a problem occurred on any of the re-assignments of the task instance.

Since:

8.5.3.3

updateTask

void updateTask(long taskInstanceKey,
 byte[] taskInstanceRowVer,
 Map phAttributeList)
         throws tcTaskNotFoundException,
tcAPIException,
tcAwaitingObjectDataCompletionException,
tcAwaitingApprovalDataCompletionException,
tcStaleDataUpdateException,
tcAPIException

Updates the details of a specified task instance. This version of API is introduced to have optimistic locking. When multiple users try to update the task at the same time, only the first one will succeed and other ones will fail

Parameters:

taskInstanceKey - Task instance key (Process Instance.Task Details.Key) of the task that needs to be updated

taskInstanceRowVer - Task instance row version (Process Instance.Task Details.Row Version) of the task that needs to be updated

phAttributeList - A Map of name-value pairs. The Map key should contain the following metadata codes:

• Process Instance.Task Details.Note
• Process Instance.Task Details.Status
• Process Instance.Task Information.Assigned To User Key

The Map value should contain the respective update data.

Throws:

tcTaskNotFoundException

tcAPIException

tcAwaitingObjectDataCompletionException

tcAwaitingApprovalDataCompletionException

tcStaleDataUpdateException - If Task instance row version that is passed to the API is stale

Since:

8.5.3.3

getProvisioningTasksAssignedToSubgroups

Thor.API.tcResultSet getProvisioningTasksAssignedToSubgroups(long userKey,
 Map attributeList,
 String[] statuses,
 boolean hierarchyOrder)
                                                      throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method returns a list of all the assigned provisioning tasks that are visible to the specified user based on his indirect group membership. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set.

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of provisioning tasks

hierarchyOrder - a boolean that specifies the order of group hierarchy. If this is true, then we get all the parent groups and their member users. If this is false then we get all the subgroups and their member users.

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Organizations.Organization Name
• Status.Status
• Status.Category
• Process Instance.Task Details.Data
• Objects.Key
• Objects.Name
• Objects.Type
• Process Instance.Key
• Process Instance.Task Details.Key
• Process Instance.Task Details.Status
• Process Instance.Task Details.Type
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Action
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Actual End Date
• Process Instance.Task Details.Creation Date
• Process Instance.Task Details.Created By
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Projected Start
• Process Instance.Task Information.Assigned To
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Process Instance.Task Information.Assigned To User Key
• Process Instance.Task Information.Creation Date
• Process Instance.Task Information.Created By
• Process Instance.Task Information.Retry Task
• Process Instance.Task Information.Update Date
• Process Instance.Task Information.Updated By
• Process Instance.Task Information.Assigned To Group Key
• Process Instance.Task Information.Assign Type
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Target User
• Requests.Key

Throws:

tcUserNotFoundException - raised if the user is not a valid user.

tcAPIException - raised if a problem occurred when retrieving the information.

tcAttributeNotFoundException - raised if an attribute is not valid.

Since:

9.0.1.1.2

getTaskHistory

Thor.API.tcResultSet getTaskHistory(long taskKey)
                             throws tcAPIException,
tcAPIException

Returns a history of the assignment of the indicated task.

Parameters:

taskKey - The sch_key of the task.

Returns:

A resultset containing the entire task assignment history of the indicated task. The following columns are returned in the result set: Status.Status Process Instance.Task History.Action Process Instance.Task History.Assign Type Process Instance.Task History.Assigned To User Process Instance.Task History.Assigned To Group Process Instance.Task History.Assigned By User Process Instance.Task History.Assign Date Process Instance.Task Information.Assignee User Key Process Instance.Task Information.Assignee User ID Process Instance.Task Information.Assignee First Name Process Instance.Task Information.Assignee Last Name Groups.Group Name ASSIGNER_USER_LOGIN ASSIGNER_USER_KEY ASSIGNER_FIRST_NAME ASSIGNER_LAST_NAME Users.Manager Key Users.Manager Login Users.Manager First Name Users.Manager Last Name

Throws:

tcAPIException

tcAPIException

Since:

9.0.1.1.2

getTasksAvailableForUpdate

Thor.API.tcResultSet getTasksAvailableForUpdate(long taskInstanceKey)
                                         throws tcAPIException,
tcAPIException

Returns task status and bucket against task instance key which are available for update. It is based on CURRENT status of task.

Parameters:

taskInstanceKey - The key of the task instance in the system.

Returns:

A tcResultSet containing one to many rows, each row holding information about a task status and bucket against task instance key.

Throws:

tcAPIException

Since:

9.0.1.1.2

findAllOpenProvisioningTasks

Thor.API.tcResultSet findAllOpenProvisioningTasks(Map attributeList,
 String[] statuses)
                                           throws tcAPIException,
tcAPIException

This method return a list of all the provisioning tasks (and their details) assigned to any user. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object will be a result set with each row having detail information of each task. The returned result set also contains a column mentioning whether the specified user can see the task because he/she is a proxy for some other user. Also, it should returned a new column called "Date Assigned" which will have the date when the task was assigned to the user/group.This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

Returns:

Throws:

tcAPIException - raise if a problem occurred in the API

Since:

9.1.0.2

getAssignedOpenProvisioningTasks

Thor.API.tcResultSet getAssignedOpenProvisioningTasks(long userKey,
 Map attributeList,
 String[] statuses)
                                               throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object will be a result set with each row having detail information of each task. The returned result set also contains a column mentioning whether the specified user can see the task because he/she is a proxy for some other user. Also, it should returned a new column called "Date Assigned" which will have the date when the task was assigned to the user/group.This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - User to get the assigned provisioning tasks.

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

Returns:

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

9.1

getAssignedOpenProvisioningTasksPaged

Thor.API.tcResultSet getAssignedOpenProvisioningTasksPaged(long userKey,
 Map attributeList,
 String[] statuses,
 int startRow,
 int pageSize,
 String[] order,
 boolean ascendingOrder,
 boolean getTotalRowCount)
                                                    throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method return a list of all the provisioning tasks (and their details) that are assigned to the given user or to the groups to which the user belongs to. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object will be a result set with each row having detail information of each task. The returned result set also contains a column mentioning whether the specified user can see the task because he/she is a proxy for some other user. Also, it should returned a new column called "Date Assigned" which will have the date when the task was assigned to the user/group.This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - User to get the assigned provisioning tasks.

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

startRow - The starting row of the result

pageSize - The page size (how many rows to return)

order - The sort order. The sorting is done only on data from the database.

ascendingOrder - - a boolean value if the sorting is to be ascending or descending

getTotalRowCount - - a boolean value which specifies whether to get total number of rows along with paged results

Returns:

tcResultSet with the information matching the filter criteria. The following are the columns returned:

• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Organizations.Organization Name
• Process Instance.Task Details.Status
• Status.Category
• Process Instance.Task Details.Data
• Objects.Key
• Objects.Name
• Objects.Type
• Process Instance.Key
• Process Instance.Task Details.Key
• Process Instance.Task Details.Row Version
• Process Instance.Task Details.Status
• Process Instance.Task Details.Type
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Action
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Projected Start
• Process Instance.Task Information.Assigned To
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Information.Assigned To User Key
• Process Instance.Task Information.Creation Date
• Process Instance.Task Information.Update Date
• Process Instance.Task Information.Updated By
• Process Instance.Task Information.Assigned To Group Key
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Target User
• Process Instance.Task Information.Target User First Name
• Process Instance.Task Information.Target User Last Name
• Process Instance.Descriptive Data
• Requests.Key
• Process.Process Definition.Process Form Key
• Process Instance.Task Information.Assign Type

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

9.1.0.1

getOpenProvisioningTasksAssignedToManagedUsers

Thor.API.tcResultSet getOpenProvisioningTasksAssignedToManagedUsers(long userKey,
 Map attributeList,
 String[] statuses)
                                                             throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method returns a list of all the provisioning tasks (and their details) that are assigned to the users for whom the specified user is a manager of. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object is a result set with each row having detail information of each task. The result set also contain a column mentioning whether the specified user is a proxy for the user. Also, this method returnes a new column called "Date Assigned" which will have the date when the task was assigned to the user/group. The method also includes a Map as an argument that will contain name-value pairs so that the result set can be filtered over multiple columns. The attribute list should support the date search feature so that the tasks can be searched with start and end date ranges. This API has been modified in the following way: If the XL.AllowProxyVisibilityForAssignedTasks system property has been set then this API will return tasks that are assigned to Managed users of any user for whom the current user is a proxy. If the above system property is not set, then the API will return only the tasks assigned to managed users of the current user. This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - User to get the assigned provisioning tasks.

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

Returns:

a result set with provisiong task information

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

9.1

getOpenProvisioningTasksAssignedToManagedUsersPaged

Thor.API.tcResultSet getOpenProvisioningTasksAssignedToManagedUsersPaged(long userKey,
 Map attributeList,
 String[] statuses,
 int startRow,
 int pageSize,
 String[] order,
 boolean ascendingOrder,
 boolean getTotalRowCount)
                                                                  throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method return a list of all the provisioning tasks (and their details) that are assigned to the users managed by a given user or to the groups to which the user belongs to. For displaying the open pending and rejected tasks, the statuses argument filter can be used. The returned object will be a result set with each row having detail information of each task. The returned result set also contains a column mentioning whether the specified user can see the task because he/she is a proxy for some other user. Also, it should returned a new column called "Date Assigned" which will have the date when the task was assigned to the user/group.This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - User to get the assigned provisioning tasks.

attributeList - List of attributes to filter the requested information.

statuses - an array of status strings to filter the result set

startRow - The starting row of the result

pageSize - The page size (how many rows to return)

order - The sort order. The sorting is done only on data from the database.

ascendingOrder - - a boolean value if the sorting is to be ascending or descending

getTotalRowCount - - a boolean value which specifies whether to get total number of rows along with paged results

Returns:

tcResultSet with the information matching the filter criteria. The following are the columns returned:

• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Organizations.Organization Name
• Process Instance.Task Details.Status
• Status.Category
• Process Instance.Task Details.Data
• Objects.Key
• Objects.Name
• Objects.Type
• Process Instance.Key
• Process Instance.Task Details.Key
• Process Instance.Task Details.Row Version
• Process Instance.Task Details.Status
• Process Instance.Task Details.Type
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Action
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Projected Start
• Process Instance.Task Information.Assigned To
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Information.Assigned To User Key
• Process Instance.Task Information.Creation Date
• Process Instance.Task Information.Update Date
• Process Instance.Task Information.Updated By
• Process Instance.Task Information.Assigned To Group Key
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Target User
• Process Instance.Task Information.Target User First Name
• Process Instance.Task Information.Target User Last Name
• Process Instance.Descriptive Data
• Requests.Key
• Process.Process Definition.Process Form Key
• Process Instance.Task Information.Assign Type

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

9.1.0.1

getNumberOfOpenProvisioningTasksAssignedToUser

int getNumberOfOpenProvisioningTasksAssignedToUser(long userKey)
                                            throws tcUserNotFoundException,
tcAPIException,
tcAPIException

This method returns the number of provisioning tasks are assigned to a given user based on the given statuses. This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - The User Key of the user for whom to get the number of approval tasks.

Returns:

the number of tasks assigned to the given user based on the given statuses

Throws:

tcUserNotFoundException - raise if the user is not a valid user in the system.

tcAPIException - raise if there is a problem during the execution of the API.

Since:

9.1

getOpenProvisioningTasksAssignedToSubgroups

Thor.API.tcResultSet getOpenProvisioningTasksAssignedToSubgroups(long userKey,
 Map attributeList,
 String[] statuses,
 boolean hierarchyOrder)
                                                          throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method returns a list of all the assigned provisioning tasks that are visible to the specified user based on his indirect group membership. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set. This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of provisioning tasks

hierarchyOrder - a boolean that specifies the order of group hierarchy. If this is true, then we get all the parent groups and their member users. If this is false then we get all the subgroups and their member users.

statuses - an array of status strings to filter the result set

Returns:

A result set with the information matching the filter criteria. The following are the columns returned:

• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Organizations.Organization Name
• Status.Status
• Status.Category
• Process Instance.Task Details.Data
• Objects.Key
• Objects.Name
• Objects.Type
• Process Instance.Key
• Process Instance.Task Details.Key
• Process Instance.Task Details.Status
• Process Instance.Task Details.Type
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Action
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Actual End Date
• Process Instance.Task Details.Creation Date
• Process Instance.Task Details.Created By
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Projected Start
• Process Instance.Task Information.Assigned To
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Process Instance.Task Information.Assigned To User Key
• Process Instance.Task Information.Creation Date
• Process Instance.Task Information.Created By
• Process Instance.Task Information.Retry Task
• Process Instance.Task Information.Update Date
• Process Instance.Task Information.Updated By
• Process Instance.Task Information.Assigned To Group Key
• Process Instance.Task Information.Assign Type
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Target User
• Requests.Key

Throws:

tcUserNotFoundException - raised if the user is not a valid user.

tcAPIException - raised if a problem occurred when retrieving the information.

tcAttributeNotFoundException - raised if an attribute is not valid.

Since:

9.1

getTasksArchived

@Deprecated
long getTasksArchived(String reqKey)
               throws tcUserNotFoundException,
tcAPIException,
tcAPIException

Deprecated.

This method would derive if the tasks for a particular process instance are archived or not

Parameters:

reqKey - The request Key

Returns:

A number indicating the number of tasks archived, or zero if there are no tasks archived.

Throws:

tcAPIException - raise if there is a problem during the execution of the API.

tcUserNotFoundException

Since:

9.1

getOpenProvisioningTasksAssignedToSubgroupsPaged

Thor.API.tcResultSet getOpenProvisioningTasksAssignedToSubgroupsPaged(long userKey,
 Map attributeList,
 String[] statuses,
 boolean hierarchyOrder,
 int startRow,
 int pageSize,
 String[] order,
 boolean ascendingOrder,
 boolean getTotalRowCount)
                                                               throws tcAPIException,
tcUserNotFoundException,
tcAttributeNotFoundException,
tcAPIException

This method returns a list of all the assigned provisioning tasks that are visible to the specified user based on his indirect group membership. The attributeList parameter contains the name-value pairs used to filter the results returned by the result set. This uses OTI table which has a subset of data present in OSI/SCH table

Parameters:

userKey - the user key to find the approval tasks

attributeList - the list of attributes that filter the search of provisioning tasks

hierarchyOrder - a boolean that specifies the order of group hierarchy. If this is true, then we get all the parent groups and their member users. If this is false then we get all the subgroups and their member users.

statuses - an array of status strings to filter the result set

statuses - an array of status strings to filter the result set

startRow - The starting row of the result

pageSize - The page size (how many rows to return)

order - The sort order. The sorting is done only on data from the database.

ascendingOrder - - a boolean value if the sorting is to be ascending or descending

getTotalRowCount - - a boolean value which specifies whether to get total number of rows along with paged results

Returns:

tcResultSet with the information matching the filter criteria. The following are the columns returned:

• Process Definition.Tasks.Key
• Process Definition.Tasks.Task Name
• Organizations.Organization Name
• Process Instance.Task Details.Status
• Status.Category
• Process Instance.Task Details.Data
• Objects.Key
• Objects.Name
• Objects.Type
• Process Instance.Key
• Process Instance.Task Details.Key
• Process Instance.Task Details.Row Version
• Process Instance.Task Details.Status
• Process Instance.Task Details.Type
• Process Instance.Task Details.Update Date
• Process Instance.Task Details.Updated By
• Process Instance.Task Details.Action
• Process Instance.Task Details.Actual Start Date
• Process Instance.Task Details.Projected End
• Process Instance.Task Details.Projected Start
• Process Instance.Task Information.Assigned To
• Process Instance.Task Details.Task Offlined
• Process Instance.Task Information.Assigned To User Key
• Process Instance.Task Information.Creation Date
• Process Instance.Task Information.Update Date
• Process Instance.Task Information.Updated By
• Process Instance.Task Information.Assigned To Group Key
• Process Instance.Task Information.Assigned Date
• Process Instance.Task Information.Assignee User Key
• Process Instance.Task Information.Assignee User ID
• Process Instance.Task Information.Assignee First Name
• Process Instance.Task Information.Assignee Last Name
• Groups.Key
• Groups.Group Name
• Process Instance.Task Information.Target User
• Process Instance.Task Information.Target User First Name
• Process Instance.Task Information.Target User Last Name
• Process Instance.Descriptive Data
• Requests.Key
• Process.Process Definition.Process Form Key
• Process Instance.Task Information.Assign Type

Throws:

tcAPIException - raise if a problem occurred in the API

tcUserNotFoundException - raise if the user is not valid

tcAttributeNotFoundException - raise if an attribute is not valid

Since:

9.1.0.1

isTaskNoteEncrypted

@Deprecated
boolean isTaskNoteEncrypted(long plTaskInstanceKey)
                     throws tcTaskNotFoundException,
tcAPIException

Deprecated.

Verifies if the the Process Instance.Task Details.Note of task instance contains a encrypted data or non encrpted data.

Parameters:

plTaskInstanceKey - The key of the task instance

Returns:

boolean return true if Process Instance.Task Details.Note contains encryted data or Process Instance.Task Details.Note contains non encrypted data

Throws:

tcTaskNotFoundException

tcAPIException

Since:

9.1.0.2

findObjects

Thor.API.tcResultSet findObjects(String actionType,
 String[] targetKeys,
 String type,
 String[] statusesIn,
 String[] statusesNotIn,
 Map searchCriteria,
 boolean allowModifyOnProvisioningStatus)
                          throws tcAPIException,
tcAPIException

This method returns all Resource Objects based on the parameters.

Parameters:

actionType - Enable/Disable/Revoke/Modify. Used to search the valid statuses from Lookup.Object.Status.Filter

targetKeys - string array to hold either user keys or organization keys

type - U is user type, O is organization type.

statusesIn - A string array that specifies the statuses of the objects to be returned

statusesNotIn - A string array that specifies the statuses that the objects should not be in.

searchCriteria - . Object name and value pair need to be passed in.

allowModifyOnProvisioningStatus - boolean that specifies if resources in Provisioning status should be included for 'Modify' operation. If this is true and actionType is Modify, resources in 'Provisioning' status will be included in the result.

Returns:

tcResultSet

• Objects.Name
• Objects.Key
• Users-Object Instance For User.Key/ Organization-Object Instance-Process Instance.Key
• Object Instance.Key
• Process Instance.Descriptive Data
• Process Instance.Key

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

Since:

11.1.1.4.0

findObjects

Thor.API.tcResultSet findObjects(String actionType,
 String[] targetKeys,
 String type,
 String[] statusesIn,
 String[] statusesNotIn,
 Map searchCriteria)
                          throws tcAPIException,
tcAPIException

This method returns all Resource Objects based on the parameters.

Parameters:

actionType - Enable/Disable/Revoke/Modify. Used to search the valid statuses from Lookup.Object.Status.Filter

targetKeys - string array to hold either user keys or organization keys

type - U is user type, O is organization type.

statusesIn - A string array that specifies the statuses of the objects to be returned

statusesNotIn - A string array that specifies the statuses that the objects should not be in.

searchCriteria - . Object name and value pair need to be passed in.

Returns:

tcResultSet

• Objects.Name
• Objects.Key
• Users-Object Instance For User.Key/ Organization-Object Instance-Process Instance.Key
• Object Instance.Key
• Process Instance.Descriptive Data
• Process Instance.Key

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

Since:

11.1.1.3.0

findObjects

Thor.API.tcResultSet findObjects(String actionType,
 String[] targetKeys,
 String type,
 Map searchCriteria)
                          throws tcAPIException,
tcAPIException

This method returns all Resource Objects based on the parameters.

Parameters:

actionType - Enable/Disable/Revoke/Modify. Used to search the valid statuses from Lookup.Object.Status.Filter

targetKeys - string array to hold either user keys or organization keys

type - U is user type, O is organization type.

searchCriteria - . Object name and value pair need to be passed in.

Returns:

tcResultSet

• Objects.Name
• Objects.Key
• Users-Object Instance For User.Key/ Organization-Object Instance-Process Instance.Key
• Object Instance.Key
• Process Instance.Descriptive Data
• Process Instance.Key

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

Since:

11.1.1.3.0

getProcessInstanceData

Thor.API.tcResultSet getProcessInstanceData(List<String> processInstances)
                                     throws tcAPIException

This method returns all the orc_tos_instance_keys corresponding to each process instance key.

Parameters:

processInstances - list that contains all the process instances for which orc_tos_instance_key is to be gotten

Returns:

null if processInstances is null or empty
else tcResultSet

• Process Instance.Key
• Process Instance.Descriptive Data

Throws:

tcAPIException - raise if a problem occurred when retrieving the information.

updateProcessDefinitionName

void updateProcessDefinitionName(long msProcessDefnKey,
 Map attributes)
                          throws tcAPIException,
tcInvalidAttributeException,
tcProcessNotFoundException,
tcAPIException

Updates the specified Process Definition name instance.

Parameters:

msProcessDefnKey - The key of the Process Definition instance

attributes - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this Process Definition. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.

• Process Definition.Name

Throws:

tcAPIException - Thrown if an error occurs while retrieving the data about unassigned groups from the database

tcInvalidAttributeException - If one or more of the attributes in the map are invalid attributes of the specified Process Definition instance

tcProcessNotFoundException

Since:

11.1.1.4.0

cancelProvisioningTasks

void cancelProvisioningTasks(String processTask,
 String processDefn)
                      throws tcAPIException,
tcAPIException

This method cancels the pending provisioning tasks for a given process task of a process definition

Parameters:

processTask - the process task name.

processDefn - the process definition name

Throws:

tcAPIException - thrown if data set errors occur

Since:

11.1.1.4.0

revokeDisconnectedAccount

void revokeDisconnectedAccount(long usrKey,
 long oiuKey)
                        throws tcAPIException,
tcObjectNotFoundException,
tcRevocationNotAllowedException,
tcUserNotFoundException

Performs revocation of disconnected account provisioned to a user.

Parameters:

usrKey - The key of the user.

oiuKey - The key of the object instance for a user in the system.

Throws:

tcAPIException

tcObjectNotFoundException

tcRevocationNotAllowedException

tcUserNotFoundException

Since:

11.1.2.0.0

getUserOrgResourceDetailsForProvisioningProcess

Thor.API.tcResultSet getUserOrgResourceDetailsForProvisioningProcess(long processInstance)
                                                              throws tcAPIException,
tcNotProvisionedException

Parameters:

processInstance -

Returns:

Throws:

tcAPIException

tcNotProvisionedException