pp108 : TransferTask

TransferTask

This method can be used to transfer a task to a different target from what it is currently present.

SOAP Request

Only a Work list manager can execute this request.

The following is the sample request for transferring a task to a team or a work list.

<TransferTask xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <TaskId>5C260A6F-020E-11E1-FAC9-704120BF9710</TaskId>
    <Target type="worklist">
        <Assignee>5C260A6F-020E-11E1-ED02-915843545B5D</Assignee>
    </Target>
    <Memo>Transferring the task to the correct work group</Memo>
    <DueDate/>
</TransferTask>

The following is the sample request for transferring a task to a user or a role.

<TransferTask xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <TaskId>5C260A6F-020E-11E1-FAC9-704120BF9710</TaskId>
    <Target type="role">
        <Assignee>cn=finance,cn=organizational roles,o=system,
cn=cordys,cn=build22,o=vanenburg.com</Assignee>
        <Assignee>cn=admin,cn=organizational roles,o=system,
cn=cordys,cn=build22,o=vanenburg.com</Assignee>
    </Target>
    <Memo>Transferring to the finance and admin departments to do the followup</Memo>
    <DueDate/>
</TransferTask>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

TaskId

Unique Identifier of the task

This ID can be retrieved using the GetTasks API.

Target

Indicates the target that needs to be considered. Users can specify the target type by specifying one of the following values for the attribute 'type':

  • user
  • role
  • worklist
  • team
  • user - Provide the DN of the user to whom the task needs to be transferred. Multiple user DNs can be provided, with each in a separate Assignee element.
  • role - Provide the DN of the role to which the task needs to be transferred. Multiple role DNs can be provided, with each in a separate Assignee element.
  • worklist - Provide the ID of the worklist to which the task needs to be transferred. Only one Assignee element is allowed.
  • team - Provide the ID of the team to which the task needs to be transferred. Only one Assignee element is allowed.

Memo

Contents in the memo

This field is mandatory

DueDate

Date by which the task should be completed

 This must be in the YYYY-MM-DDTHH:mm:SS.ms format. For example: 2008-01-24T16:46:33.219.
This is an optional field.

SOAP Response

<TransferTaskResponse xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <Task>
        <ProcessInstanceId/>
        <ProcessName/>
        <TaskId>5C260A6F-020E-11E1-FB79-F2A29B709739</TaskId>
        <ParentTaskId>5C260A6F-020E-11E1-FB79-F2A29B709739</ParentTaskId>
        <State>CREATED</State>
        <Activity>TransferTaskToRole</Activity>
        <Sender displayName="JDoe" email="" phone1="" phone2="">cn=JDoe,cn=organizational users,
                 o=system,cn=cordys,cn=build22,o=vanenburg.com</Sender>
        <Assignee/>
        <BusinessAttributes/>
        <CompletedByUser/>
        <DelegatedToUser/>
        <TaskData>
            <ApplicationData/>
        </TaskData>
        <DeliveryDate>2012-08-01T11:54:01.0</DeliveryDate>
        <StartDate>2012-08-01T11:54:01.0</StartDate>
        <DueDate isExpired="false"/>
        <StartedOn/>
        <CompletionDate/>
        <IsPriorityFixed>0</IsPriorityFixed>
        <Priority>3</Priority>
        <ParentQueue>cn=clerk,cn=organizational roles,o=system,
cn=cordys,cn=build22,o=vanenburg.com</ParentQueue>
        <UITaskId islegacy="false">cordys_notif_autodelegatetask</UITaskId>
        <Targets>
            <Target type="role">cn=finance,cn=organizational roles,o=system,
cn=cordys,cn=build22,o=vanenburg.com</Target>
        </Targets>
        <url>/cordys/com/cordys/notification/workflow/autodelegationtaskpage.caf</url>
        <PossibleActions>
            <CLAIM/>
            <ASSIGN/>
            <SKIP/>
            <TRANSFER/>
            <SUSPEND/>
            <EXECUTE/>
            <VIEW/>
        </PossibleActions>
    </Task>
</TransferTaskResponse>

Response Parameters

Parameter

Required

Description

TaskId

Contains the unique identifier of the task

ParentTaskId

This ID is used to group all the tasks, which are assigned to the same role with "All linked users should execute task" option enabled in the
Activity Properties

Targets

Type of target where the task is sent

ProcessInstanceId

Contains the unique identifier of the source, which created this task

State

Contains the current state of the task

ProcessName

Contains the name of the source, which created this task

Activity

Contains the subject of the task

Sender

Contains the DN of the sender of the task
Attributes:

  • displayName - Display name of the user as mentioned in the user manager or as it is in the LDAP
  • phone1 - Phone number as mentioned in the contact details while creating a user
  • phone2 - Phone number as mentioned in the contact details while creating a user
  • email - E-mail ID as mentioned in the contact details while creating a user

Assignee

Contains the DN of the assignee, who claims the task or to whom the task is assigned by the manager.
Attributes:

  • displayName - Display name of the user as mentioned in the user manager or as it is in the LDAP
  • phone1 - Phone number as mentioned in the contact details while creating a user
  • phone2 - Phone number as mentioned in the contact details while creating a user
  • email - E-mail ID as mentioned in the contact details while creating a user

BusinessAttributes

Contains the business attributes XML of the task

CompletedByUser

Contains the DN of the user who completes the task

DelegatedToUser

Contains the DN of the user to whom the task is delegated

Priority

Contains the priority set on the task. It is set between 0 and

5. 0 denotes lowest priority while 5 denotes highest priority.

TaskData

Contains application data and custom data

ApplicationData

Contains the data the task has to perform, in XML format

StartDate

Contains the date on which the task must be started

StartedOn

Contains the date on which the task has actually started

DueDate isExpired

Contains the date on which the task is due. When isExpired is true, the due date is already past.

DeliveryDate

Contains the date on which the task is created

CompletionDate

Contains the date on which the task is actually completed

IsPriorityFixed

Contains the state of priority. If 1, the priority cannot be changed.

ParentQueue

Contains the Work List ID of the parent work list.While transferring the tasks to a different work list, the work list from which the task is transferred is referred as the parent queue.

UITaskId

Contains the unique identifier of the application

url

Contains the URL of the application or the user interface that needs to be opened

PossibleActions

Possible actions that the user can perform on this task


Note:

  • If the target is not 'user', then the task will be marked as 'new' in its new target. If the target is 'user', then the task will be in assigned state after its transfer.
  • The target to which the task is being transferred must always be different than the current target in which it already exists.