Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

TABLE OF CONTENTS

Notification Activity

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 01, 2024
  • 5 minute read

Activity description:

The Notification Activity is incorporated in the workflow process design to send notifications to actors, in the form of email and SMS. The messages can be customized for each actor by appending the resource properties to the message.

Activity Properties:

The Notification activity has to be configured by specifying appropriate values for the different properties in the Activity Properties area. The Activity Properties can be accessed by clicking on the Activity Properties tool in the Tool Bar or by selecting the appropriate option from the right click menu for the Notification activity. The Activity Properties are organized under the following groups of related properties. The properties under each group are described in this topic.

Name & Description

The properties in the Name & Description group have been described below. You can use these properties to specify the name and description for the activity.

Name - This property can be used to specify a name for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Description - This property specifies a brief description to be displayed for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Configuration

The properties in the Configuration group have been described below. You can use these properties to configure the functionality of the activity.

Notification Type - The Notification type can be selected from the drop down list provided for this property. Notifications can be sent in the form of email or SMS to cell phones. The 'All' option is provided to send messages through all media.

Property Type: Mandatory (This property must be set if the action is to be assigned to any resource(s).)

Actors

The property in the Actors group has been described below. You can use this property to specify the content of the notification.

ToResource- This property specifies the resource(s) to which the notification is to be sent.

Property Type: Mandatory (This property must be set if the action is to be assigned to any resource(s).)

Steps to set the To property

  1. To specify the actors to receive the Notification message, click the button for the 'To' property to open the property window.

  2. In this window, build an expression to select the actors using the actors properties. Select an attribute from the first drop down list, then select the operator, type of value (Value, Variable, Content, XMLVariables), and the corresponding value for the property from the corresponding drop downs. Select "End" from the last drop- down to complete the expression. If you are building a compound expression, you can select one of the logical operators to connect the different conditions that form the expression.

  3. Add the condition to the expression by clicking Add. This will display the expression to the text area.

  4. You can remove a condition already added to the expression by clicking Undo.

  5. You can also clear an existing expression if necessary by clicking Clear. This is useful if you want to clear large expressions in the text area in order to build a new expression.

  6. After building the expression, click Update to save it.

See Notification - ToResource for a detailed description of the To property window.

See the Using XML Variables section in the About XML Variables topic for details on how to use the XMLVariables to build the expression.

Notification Contents

The properties in the Notification Contents group have been described below. You can use these properties to specify the content of the notification.

From Email Address - This property specifies the email address from which the email notifications will be sent. If the Notification type is of the form 'All' or 'Email' then this property must be set. If it is not set, then the email notifications will not be sent.

Property Type: Optional (This property needs to be set only if the notification type selected in the corresponding property is either 'All' or 'Email'.)

Message - This is the actual content of the notification sent to the resource(s). The notification can be customized for each resource.

Property Type: Optional (This property needs to be set only if required.)

Steps to set the Message property

  1. To specify the Notification message, click the button for the 'Message' property to open the property window.

  2. In this window, enter the message text directly in the text editor.

  3. If you want to personalize the message you can do so using the Field controls to add resource property values. For example, to add a message that includes the name of the actor submitting the approval request, you can do as follows: First type in the text "Hello". Next select "Variable" and "Variable.SubmittedBy.name" from the two drop downs for Field and click Append. This will add the placeholder for the variable after the text entered in the text editor. At run-time this placeholder will be replaced by the corresponding value, i.e. the name, resulting in a personalized salutation. Type in a message in the next line to complete the message body.

  4. You can manipulate the text using the appropriate tools from the tool bar. You can cut, copy and paste text, undo and redo changes, repeat the last command, zoom in and zoom out the view as well as print the text.

  5. You can format the text, if necessary, using the formatting tools. You can make text bold or italic or change the font or size, set text color or background color.

  6. After adding the message, click Update to save it.

  7. Click the Close button to close the window without saving the message.

    See Notification: ToResource for a detailed description of the Message property window.

    Activity outputs:

    The Notification Activity does not return any value.

    Example for Notification Activity

    In an organization, whenever Approver1 rejects a Notification send to Manager, if manager approves it will go for next Approver, as shown in below workflow.

    Whenever a workflow triggers a Request, it will send to Approval1.  If Approval1 rejects, a Notification will send to Assign actor.

    Settings For Notification Activity:

    Notifications can be sent in the form of Email or SMS to cell phones.

    Step 1: Select Notification Type as Email type from the drop down to send notification.

    Step 2: Click ToResource property to specify the resource(s) to which the notification has to be sent.


    Step 3: Select specified Actor and click Update to save the changes.

    Exception Behavior

    Each activity has the Raise Error on Unhandled Linked Output property on click of which, it shows all the default configured mapped error outputs in red with their check boxes selected.

    See Mapped Error Output for more details.

    In This Topic
    TitleResults for “How to create a CRG?”Also Available in