pp108 : SendNotification

SendNotification
 

This method is used to send a notification to the user.

SOAP Request

<SendNotification xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <NotificationId>{55EC8465-77D7-4DA6-A53C-F7A6FD5CD58D}</NotificationId>
    <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>3</Priority>
    <CallBackInfo component="" />
    <Sender>cn=JDoe,cn=organizational users,o=system,cn=cordys,cn=1205,o=vanenburg.com</Sender>
    <SenderInfo>
        <DisplayName>John Doe</DisplayName>
        <EmailId>[email protected]</EmailId>
    </SenderInfo>
    <isSendEmailAtomicOp>true</isSendEmailAtomicOp>
    <NotificationData>
        <ApplicationData />
        <CustomData />
        <Links>
            <link url="http://cordys.com" name="Visit us for more information" />
        </Links>
        <Annotation>This is a sales order approval notification</Annotation>
    </NotificationData>
    <SendTo>
        <Target type="worklist">
            <Assignee identifierType="id">{35B67844-8181-4B25-A8A2-C01E20831A6B}</Assignee>
        </Target>
        <MailingList>
            <To>[email protected];[email protected]</To>
            <Cc>[email protected]</Cc>
            <Bcc>[email protected]</Bcc>
        </MailingList>
    </SendTo>
</SendNotification>

Request Parameters

Parameter

Description

Data Type

Required

Accepted Input Values

NotificationId

Unique identifier of the notification.

String

 

This value is optional. If the Id is not provided, then notification service will generate a unique Id.For example: {55EC8465-77D7-4DA6-A53C-F7A6FD5CD58D}

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 notification

 

 

 

Sender

DN of the sender. This is optional.

 

 

 

Priority

Priority of the notification between 1 to 5.

Integer

 

The default priority is 3

Application Data

Contains the data or content of the notification in XML format.

 

 

 

CustomData

Contains additional information about the notification in XML format.

 

 

It is used to provide additional information.

Links

Contains the link of the application to be opened.

 

 

 

Annotation Text

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

 

 

 

Target

Contains the type of target where the notifications should be sent.

 

 

type - This is an optional tag

  • role - Provide the DN of the role in the Assignee tag.
  • worklist - Provide the ID of the worklist in the Assignee identifierType tag.
  • Team - Provide the ID of the team in the Assignee identifierType tag.
  • User - Provide the DN of the user in the Assignee tag.

    Note:
    User - If no type is specified, the current user is taken as default.

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 worklist 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 theExclusionListtag.

TaskData

Contains Application data and Custom data.

 

 

 

Sender

Contains the DN of the sender

 

 

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 CUSP Preferences are used.By Default, the information provided inSenderInfo will over-ride the information provided in the CUSP Preferences.

isSendEmailAtomicOp

Contains a boolean value, true or false.

 

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

NotificationData

Contains Application data,Custom data,Links and Annotation.

 

 

 

CallBackInfo

Information about the Caller (BPM/Case)

 

Internal

 

SendTo

Type of target where the notification should be sent. It contains the target and Mail List

 

 

In target the id of the target type has to be filled and in the mail list the mail id has to be filled.

SOAP Response

<SendNotificationResponse xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <Notification>
        <NotificationId>{152CCC20-6028-479B-B252-03E3EF943FFB}</NotificationId>
        <UserDN>cn=Jack,cn=organizational users,o=system,
cn=cordys,cn=D1205,o=vanenburg.com</UserDN>
    </Notification>
    <Notification>
        <NotificationId>{5905D4A8-1FAB-4EDE-92C0-9783AE67833E}</NotificationId>
        <UserDN>cn=Mike,cn=organizational users,o=system,
cn=cordys,cn=D1205,o=vanenburg.com</UserDN>
    </Notification>
</SendNotificationResponse>

Response Parameters

Parameter

Description

NotificationId

Contains the unique identifier of the notification.

UserDN

Contains the DN of the user to whom the notification is sent.