OpenText Cordys 10.6 documentation : HumanInteraction

HumanInteraction
 

This method is used to send a task to the Inbox.

SOAP Request

<HumanInteraction xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <TaskId>\{8043CBD8-8F0F-41E5-A0EC-08B61730F977\}</TaskId>
    <HumanTaskModelId>\{A3661DAF-47AD-4FD8-B022-BE5585ACB05F\}</HumanTaskModelId>
    <InboxModelId>\{N366T564-47AD-4FD8-J897-JH5585ACB0I7\}</InboxModelId>
    <EmailModelId>\{K3661DAF-47AD-4FD8-B022-LK5585ACB09K\}</EmailModelId>
    <Subject>Sales Order Approval</Subject>
    <Priority>5</Priority>
    <DueDate>2008-01-24T16:46:33.219</DueDate>
    <Reminder>
        <Duration>150000</Duration>
        <Message>The is due in two days</Message>
    </Reminder>
    <StartDate>2008-01-20T16:46:33.219</StartDate>
    <Memos>
        <Memo>TestMemo</Memo>
    </Memos>
    <Dependent>true</Dependent>
    <Links>
        <link url="http://cordys.com" name="Visit us for more information" />
    </Links>
    <Annotation>This is a sales order approval task</Annotation>
    <Attachments>
        <Attachment name="sales.doc">http://cin0718/tae/sales.doc</Attachment>
    </Attachments>
    <CustomDispatchAlgorithm>MyDispatchAlgorithm</CustomDispatchAlgorithm>
    <TaskData>
        <ApplicationData xmlns="http://schemas.cordys.com/notification/workflow/1.0">
            <SalesOrderApprovalInputBO xmlns="http://schemas.cordys.com/1.0/cas/xforms">
                <SalesOrderApprovalInputDataBO>
                    <FreeFormData>
                        <Customername>Judy</Customername>
                        <ProductName>[http://www.cordys.com/productName]</ProductName>
                        <Quantity>102</Quantity>
                        <Price>90</Price>
                    </FreeFormData>
                </SalesOrderApprovalInputDataBO>
            </SalesOrderApprovalInputBO>
        </ApplicationData>
        <CustomData>\[Any additional data for the task to complete\]</CustomData>
    </TaskData>
    <CallBackInfo component="" />
    <Sender>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</Sender>
    <SenderInfo>
        <DisplayName>John Doe</DisplayName>
        <EmailId>Jdoe@cordys.com</EmailId>
    </SenderInfo>
    <isSendEmailAtomicOp></isSendEmailAtomicOp>
    <SendTo>
        <Target type="worklist">
            <Assignee identifierType="id">\{35B67844-8181-4B25-A8A2-C01E20831A6B\}</Assignee>
        </Target>
        <ExclusionList>
            <UserDN>cn=Jack,cn=organizational users,o=system,cn=cordys,cn=Jdoe,o=vanenburg.com</UserDN>
        </ExclusionList>
    </SendTo>
</HumanInteraction>

Request Parameters

Parameter

Description

Data Type

Required

Accepted Input Values

TaskId

Unique identifier of the task.

String

 

This value is optional. If the Id is not provided, then notification service will generate a unique Id.For example: {8043CBD8-8F0F-41E5-A0EC-08B61730F977}

HumanTaskModelId

Unique identifier of the Human Task

String

 

InboxModelId

Unique identifier of the Inbox model

String

 

 

EmailModelId

Unique identifier of the Email model

String

 

 

Subject

Subject of the task.

 

 

 

Priority

Priority of the task between 1 to 5.

Integer

 

The default priority is 3

DueDate

Date by which the task should be completed.

 

 

This should be in the YYYY-MM-DDTHH:mm:SS.ms format. For Example: 2008-01-24T16:46:33.219

Reminder

Reminder when the task is due.

 

 
  • Duration - specifies the time in milli-seconds, before the task is due.
  • Message - specifies the message that would be sent with the reminder.

StartDate

Date on which the task can be started.

 

 

This should be in the YYYY-MM-DDTHH:mm:SS.ms format. For Example: 2008-01-24T16:46:33.219

Memo

Memo that has to be sent

 

 

The actual content in the memo.

Dependent

Contains boolean value. Indicates if the task is dependent on some users to complete it.

 

 
  • False- Indicates that multiple users can perform a task independently. Example: Let us assume that a task Sign Attendance Register is assigned to multiple users. This can be performed by all of them and each user can perform the task independently. In such situations, you have to provide the parameter as False.
  • True- Indicates that multiple users cannot perform a task independently. This implies, a task can be performed by only one user at a time and other users cannot work on it. Example: Let us assume that a task Confirm Shipment is assigned to multiple users. Only one user can claim and perform it, while others cannot re-do it, as it is a one-time activity. In such situations, you have to provide the parameter as True.

Links

Contains the link of the application to be opened.

 

 

 

Annotation Text

Contains the additional information provided for an activity in the business process

 

 

 

Attachment name

Name of the attachment. Provide the key, based on which the object from the XML Store has to be retrieved, as a parameter.

 

 

It should be the path from the collection folder to the location of object in XML Store.For example: /cordys/notification/attachments/{Task_ID}/{Attachment_Name}

Note:
To add multiple attachments add the required number of Attachment tags in the Attachments tag.

Send To

Type of target where the task should be sent. It contains the target and exclusion tags.

 

 

If the target type is set to:

  • user - provide the DN of the user
  • role - provide the DN of the role
  • worklist - provide the ID of the work list
  • team - provide the ID of the team

identifierType

The identifier type of the assignee, either an ID or a Qname of the work list or team.

 

 

When the target type is set either to worklist or team, the Assignee identifierType accepts the following as parameters:

  • ID - provide the ID of the work list or team as the parameter. For example: {35B67844-8181-4B25-A8A2-C01E20831A6B}
  • QName - provide the qualified name of the work list or team as the parameter. For example: /SalesOrg/SalesRepWL.

ExclusionList

DN of the user who should be excluded from receiving the task

 

 

UserDN – To exclude multiple users, provide the required number of UserDN tags in the ExclusionList tag.

TaskData

Contains Application data and Custom data.

 

 

 

Application Data

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

 

 

 

CustomData

Contains additional information about the task in XML format.

 

 

It is not used to perform the task, but provides additional information.

Sender

Contains the DN of the sender. This is optional.

 

 

You can obtain the DN from the properties of that organizational user.

SenderInfo

Contains the email id and display name of the sender

 

 

If this information is not provided, the details given in the CUSP Preferences are used. By Default, the information provided in SenderInfo will over-ride the information provided in the CUSP Preferences.

isSendEmailAtomicOp

Contains a boolean value, true or false.

 

 
  • When isSendEmailAtomicOp is set to true and sending the email results in a failure, a SOAP fault is displayed.
  • When isSendEmailAtomicOp is set to false and sending the email results in a failure, the notification is not sent to the process.

CallBackInfo

Information about the caller (BPM/Case)

 

Internal

 

CustomeDispatchAlgorithm

Contains the Qname of the custom dispatch algorithm.

 

 

 

SOAP Response

<HumanInteractionResponse xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <TaskId>{8043CBD8-8F0F-41E5-A0EC-08B61730F977}</TaskId>
    <SentTo>           <Target type="worklist">
            <Assignee identifierType="id">\{35B67844-8181-4B25-A8A2-C01E20831A6B\}</Assignee>
      </Target>
      <ExclusionList>
            <UserDN>cn=Jack,cn=organizational users,o=system,cn=cordys,cn=Jdoe,o=vanenburg.com</UserDN>
      </ExclusionList>
    </SentTo>
</HumanInteractionResponse>

Response Parameters

Parameter

Description

TaskId

Returns the ID of the task

SentTo

Type of target where the task was sent. It contains the target and exclusion tags.