Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > :ADD_ATT

:ADD_ATT

Script statement: Adds recipients to a notificationAn Automation Engine object type used to send messages to users and user groups. [Formerly called "CallOperator."] at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start)..

Syntax

:ADD_ATT RECIPIENT, Recipient, [Calendar, Calendar Keyword]

Syntax

Description/Format

RECIPIENT

Name of the attribute that should be added.
Format: AE name, script literal or script variable
Allowed value: "RECIPIENT"

Recipient

Name of a userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management., user groupA group of users who have a common profile of rights. A particular object type in the Automation Engine. User groups are an organizing construct to help you better manage users because you can grant user groups access rights the same way that you grant various access rights to a single user. All users in the user group are automatically given those access rights. This makes managing users not only more efficient but also more secure because working with user groups gives you a better overview of what rights are assigned. or email address.
Format: scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.

Calendar

Name of a Calendar objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.
Format: script literal or script variable

Calendar Keyword

Calendar keyword within this calendarAn Automation Engine object type that defines a set of days based on calendar keywords..
Format: script literal or script variable

Comments

This script statement can only be used in the Process tab of a notification. It adds the specified user, user group or email address to the listShows entities in a grid view of recipients that should be notified. Calendars can also be specified. In this case, the recipient is only notified if a defined calendar keywordThe attribute of a Calendar object that defines which days included in the calendar. applies.

Recipients that have already been specified are overwritten because this script statement does not change the Notification object. The modified recipient list only applies for the particular execution.

Refer to the reportA report provides more detailed information about a task's execution or a component. to see the recipients that have been added by this script statement.

Note that the user must be indicated in the format User name/Department which complies with the name of the User object.

Example

The following example adds the user "BU/AE" to the list of responsible recipients in a notification. This user is only notified if a valid calendar day exists in the calendar "READINESS".

:ADD_ATT RECIPIENT, "BU/AE", "READINESS","WEEKDAYS"

The second example informs all members of the user group "ADMIN".

:ADD_ATT RECIPIENT, "ADMIN"

 

See also:

Script element Description

:REMOVE_ATT

Removes recipients s in a notification at runtime.
:PUT_ATT This is used to change the value of an attribute during generation.
:PUT_ATT_APPEND Extends the notification's message text at runtime.
GET_ATT This functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… returns the values of a taskAn executable object that is running. Tasks are also referred to as activities.'s attributes during generation.
GET_ATT_SUBSTR

Supplies part of the message text in a notification.

Script Elements - Read or Modify Objects

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH