Services Integration Framework Guide

10.5

Back Next

GetTaskLineage

The

GetTaskLineage

API retrieves the following information, depending on the request parameter settings:

The closed tasks for a specified user.

The closed tasks for a specified user that are part of an active workflow process.

The closed tasks for a specified user that are part of an completed workflow process.

The open tasks that have a task in their lineage that is owned by the specified user.

The lineage for a specific task.

TaskData

The

TaskData

object contains information about a task.

The following table lists the TaskData fields that you can configure:

Field	Description
TaskRecord	A link to a data record associated with a task.
Comment	An optional task comment.
TaskType	The task type.
SubjectAreaUID	The UID of the task subject area.
Title	The task title.
TaskID	The ROWID of the task. Cannot be set by user.
DueDate	The date when the task is due.
Priority	The priority of the task. 1 : High priority. 0 : Normal priority. The default is 0 . -1 : Low priority.
StatusEnum	The workflow status. The default is TaskStatusEnum.OPEN .
OwnerUID	The user or role ID to whom the task is assigned.
InteractionID	The Interaction ID.
WorkflowProcessID	The ID of the workflow process that contains the task. Cannot be set by user.
CreateDate	The date when the task was created. Cannot be set by user.
Creator	The name of the user who created the task. Cannot be set by user.
LastUpdateDate	The date when the task was updated. Cannot be set by user.
LastUpdatedBy	The name of the user who updated the task. Cannot be set by user.
PreviousOwner	The name of the user or role to whom the task was previously assigned. The value is Null if the task is new or has not been assigned. Cannot be set by user.

TaskRecord

The

TaskRecord

object contains information about a record.

The following table describes the TaskRecord fields:

Field	Description
SiperianObjectUID	An identifier for an object in Informatica MDM Hub.
RecordKey	An identifier for a record in Informatica MDM Hub.
MatchRuleUID	An identifier for a match rule in Informatica MDM Hub. Only merge tasks require a MatchRuleUID.

Required Request Parameters

The

GetTaskLineage

request does not have required parameters.

Optional Request Parameters

The information that the

GetTaskLineage

response returns is based on the values in the optional request parameters. The following table describes the optional request parameters:

Parameter	Value
TaskID	The TaskID parameter identifies the task.
OwnerUID	The ID of the user to whom the task belongs.
WorkflowStatus	The status of the workflow process.
TaskPosition	If TaskPosition= USER , the response returns the task assigned to the specified user. If TaskPosition= WORKFLOW , the response returns the task that is currently active in the workflow process.

The following table describes the parameter values necessary to get the tasks completed by a specified user:

Parameter	Value
TaskID	NULL
OwnerUID	The user ID.
WorkflowStatus	ANY
TaskPosition	USER

The following table describes the parameter values necessary to get the tasks completed by a specified user that are part of an active workflow process:

Parameter	Value
TaskID	NULL
OwnerUID	The user ID.
WorkflowStatus	OPEN
TaskPosition	USER

The following table describes the parameter values necessary to get the tasks completed by a specified user that are part of a completed workflow process:

Parameter	Value
TaskID	NULL
OwnerUID	The user ID.
WorkflowStatus	CLOSED
TaskPosition	USER

The following table describes the parameter values necessary to get the open tasks that have a task in their lineage that is owned by the specified user:

Parameter	Value
TaskID	NULL
OwnerUID	The user ID.
WorkflowStatus	OPEN
TaskPosition	WORKFLOW

The following table describes the parameter values necessary to get the lineage for a specified task:

Parameter	Value
TaskID	The task ID.
OwnerUID	The OwnerUID value is ignored.
WorkflowStatus	The WorkflowStatus value is ignored.
TaskPosition	The TaskPosition value is ignored.

Response Fields

The following table describes the fields returned in the

GetTaskLineage

response:

Field	Description
Title	Contains the task title.
TaskType	Contains the task type.
Status	Contains the task status.

GetTaskLineage Request Usage Example

The code in the following example retrieves a list of tasks belonging to the user named '

siftester

' and are overdue.

GetTaskLineageRequest request = new GetTaskLineageRequest();
request.setOwner("siftester");
GetTaskLineageResponse response = (GetTaskLineageResponse) sipClient.process(request);

GetTaskLineage Response Usage Example

The code in the following example prints out the task information that the

GetTaskLineage

response returns:

GetTaskLineageResponse response = (GetTaskLineageResponse) sipClient.process(request);
int i=0; 
for(Iterator iter=response.getTaskList().iterator(); iter.hasNext();)
{ //iterate through response records 
  System.out.println("Printing task " + i);
  TaskMetaData task = (TaskMetaData) iter.next(); 
  System.out.println(task.getTitle()+", "+task.getTaskType()+", "+task.getStatus()); 
}

Rename Saved Search

Table of Contents

Services Integration Framework Guide

Services Integration Framework Guide

GetTaskLineage

GetTaskLineage

TaskData

TaskRecord

Required Request Parameters

Optional Request Parameters

Response Fields

GetTaskLineage Request Usage Example

GetTaskLineage Response Usage Example