pp108 : DeliverMessage

DeliverMessage

  

This Web service operation is deprecated. Instead, you can use HumanInteraction Web service for sending tasks and SendNotification Web service for sending notifications HumanInteraction.

This method is used to send a notification to a user. DeliverMessage is part of the Notification Methodset in the Cordys Notification application package.

SOAP Request

<DeliverMessage xmlns="http://schemas.cordys.com/1.0/notification">
    <SOURCE>Process Platform Process-Engine</SOURCE>
    <TARGET>CPCINBOX</TARGET>
    <IS_EMAIL_MANDATORY>true</IS_EMAIL_MANDATORY>
    <SENDER>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</SENDER>
    <SENDER_ADDRESS>
        <MAIL_ID>[email protected]</MAIL_ID>
        <DISPLAY_NAME>John Doe</DISPLAY_NAME>
    </SENDER_ADDRESS>
    <SUBJECT>Orders</SUBJECT>
    <PRIORITY>LOW</PRIORITY>
    <IS_PRIORITY_FIXED>false</IS_PRIORITY_FIXED>
    <DUE_DATE>2006-08-20T18:04:46.0</DUE_DATE>
    <MESSAGE_TYPE>TASK</MESSAGE_TYPE>
    <MAIL_SUBJECT>Employee Detail</MAIL_SUBJECT>
    <DEPENDENT>TRUE</DEPENDENT>
    <EMAIL_MODEL_ID>{2E6BEDAD-5F0C-49E8-90B0-54217521ADF6}</EMAIL_MODEL_ID>
    <INBOX_MODEL_ID>{D5EBDC7B-3954-44BF-90ED-FAF0E037E7B4}</INBOX_MODEL_ID>
    <LANGUAGE>fr_FR</LANGUAGE>
    <DISPATCH_LOGIC>LeastWorkDispatch</DISPATCH_LOGIC>
    <MESSAGE_DATA>
        <Application>
            <id>Cordys</id>
            <description>Description required here</description>
            <caption>Delivered_Message</caption>
            <page>main</page>
            <data>
                <message_data>
                    <Person>
                        <Id>1293812938</Id>
                        <Name>
                            <First-Name>John</First-Name>
                            <Last-Name>Doe</Last-Name>
                        </Name>
                        <Designation>Software Engineer</Designation>
                    </Person>
                </message_data>
                <message_metadata>[actual message data xml]</message_metadata>
            </data>
            <url>/cordys/myTask.htm</url>
        </Application>
    </MESSAGE_DATA>
    <MANDATORY>FALSE</MANDATORY>
    <MAIL_ATTACHMENTS>
        <attachment encoded="false" name="">PARAMETER</attachment>
    </MAIL_ATTACHMENTS>
    <RECEIVERS>
        <USER_ID>John_accounts_JA12</USER_ID>
        <PARTICIPANT_DN>cn=Jsmith,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</PARTICIPANT_DN>
        <MAILING_LIST>
            <to>
                <address>
                    <displayName>Jack</displayName>
                    <emailAddress>[email protected]</emailAddress>
                </address>
                <address>
                    <displayName>Michael</displayName>
                    <emailAddress>[email protected]</emailAddress>
                </address>
            </to>
            <cc>
                <address>
                    <displayName>Dick</displayName>
                    <emailAddress>[email protected]</emailAddress>
                </address>
            </cc>
            <bcc>
                <address>
                    <displayName>Laura</displayName>
                    <emailAddress>[email protected]</emailAddress>
                </address>
            </bcc>
        </MAILING_LIST>
    </RECEIVERS>
    <URL>/cordys/myTask.htm</URL>
</DeliverMessage>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

SOURCE

Contains the source that triggered the event or notification

String

  

TARGET

Target to which the notification is to be sent

String

The target can either be an Inbox or an external mail address.

  • To send the notification to an Inbox, set the value of TARGET to CPCINBOX.
  • To send the notification to an external mail address, set the value of TARGET toMAIL.
    You can include multipleTARGETelements to simultaneously send messages to both the Inbox and email address.

IS_EMAIL_MANDATORY

Contains True/False value.

  

Set the value to true if the notification should be sent to the email id of the user mandatorily.

SENDER

Contains the DN of the sender

String (DN)

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

SENDER_ADDRESS

Contains the email address and display name of the sender

String (email)

If this element is left blank, the details provided in the CUSP Preferences are used.

SUBJECT

Contains the subject of the notification

    

PRIORITY

Indicates the priority level of a message

String

The priority of the message can be any of the following:

  • LOW
  • NORMAL
  • HIGH

IS_PRIORITY_FIXED

Priority of a particular message while forwarding it to other recipients

Boolean

Set the value of this element to
FALSE to allow the user to change the priority of a particular message while forwarding it to other recipients. Set the value to
TRUE to restrict the user from changing the priority while forwarding the message.

DUE_DATE

Indicates the task completion time

Date

The date should be in the following format:<YYYY-MM-DD> T<HH:MM:SS:MS>

MESSAGE_TYPE

Contains the type of the notification

  

 

  • To send a Task notification, set the value of this element toTASK.
  • To send an Information notification, set the value of this element toINFO.

MAIL_SUBJECT

Contains the subject of the notification. This element is applicable only if you are sending notifications through email.

String

  

DEPENDENT

Contains True/False value.Use this element to send Task notifications.

  

To send a dependent task notification, set the value ofDEPENDENTto
TRUE.

EMAIL_MODEL_ID

Contains the id of the email model

String

  

INBOX_MODEL_ID

Contains the id of the inbox model

String

  

LANGUAGE

Contains the locale of the email model

String

The locale is of the following format : fr_FR_WIN representing the french language in France and the OS as Windows.If the locale specified in the message does not exist in the XML Store, then the Process Platform default locale setting is taken. The Process Platform default locale is set while installing Process Platform and is found as a property in the wcp.properties file.

DISPATCH_LOGIC

Contains the name of the dispatch logic used to send the notification

    

MESSAGE_DATA

Contains the message for the notification

  

The content of the message can be simple XML data or an application data structure.

MANDATORY

Contains True/False value. This tag is applicable for Task notifications

Boolean

Set the value of this element toTRUEto prevent a task notification from being deleted if it is not yet complete.

MAIL_ATTACHMENTS

Contains attachments, if any, that are being sent with the message;

  

Contains theattachmenttag.

attachment

Contains the actual attachment file being sent with the mail.

  

This tag takes two attributes:

  • name- The name of the file being sent as attachment.
  • encoded- A boolean value that specifies whether the attachment is encoded or not. If 'true', the contents of the attachment are Base64 encoded. If 'false', the attachment is sent as a plain ASCII text file.

address

Contains the actual address that the mail has to be sent to.

  

This has two tags:

  • displayName- The name to be displayed in the address.
  • emailAddress- The actual email address that the mail has to be sent to.

    Note: To send the message to multiple recipients, use as many address tags.

RECEIVERS

Contains the details of the recipients of the message

String (email)

 

  • SpecifyPARTICIPANT_DN, if the recipient is a Cordys user or a role. You can also specify multiplePARTICIPANT_DNs.
  • SpecifyUSER_ID, if the recipient is a non-Cordys user. You can also specify multipleUSER_IDs.
  • SpecifyMAILING_LIST (internal & external users), when you want to send the message to the email address of the users. Contains the following tags:
    • to - Message is sent to all the recipients in this tag. Contains the address tag.
    • cc - A copy of the message is sent to that recipient, and the recipient's name is visible to other recipients of the message. Contains the address tag.
    • bcc - A copy of the message is sent to that recipient, and the recipient's name is not visible to other recipients of the message. Contains the address tag.

URL

Contains the URL of the application that is used by the email. This tag applies whenTARGETis set to
MAIL.

String

  

 

SOAP Response

<DeliverMessageResponse xmlns="http://schemas.cordys.com/1.0/notification">
    <result>
        <tuple>
            <MESSAGE_RESPONSE>
                <PARTICIPANT_DN>cn=Jdoe,cn=organizational users,o=cpc,cn=cordys,o=vanenburg.com</PARTICIPANT_DN>
                <MESSAGE_ID>117353426302015</MESSAGE_ID>
            </MESSAGE_RESPONSE>
        </tuple>
    </result>
</DeliverMessageResponse>

Response Parameters

Parameter

Description

PARTICIPANT_DN

Indicates the DN of the user or role to whom the message is to be forwarded.

MESSAGE_ID

ID of the message.