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

:REMOVE_ATT

Script statement: Removes recipients in 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

:REMOVE_ATT RECIPIENT, Recipient

Syntax

Description/Format

RECIPIENT

Name of the attribute that should be removed.
Format:AE name, script literal or script literal
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, script variableA placeholder for a value within a script. or number

User and UserGroup objects: The wildcard charactersThese are placeholders for characters when you specify filters. ? stands for exactly one character, * for any number of characters. "*" and "?" can be used. "*" refers to any number of characters, "?" refers to exactly one character.

Comments

This script statement can only be used in the Process tab of notifications. It removes the specified users, user groups or email addresses from the listShows entities in a grid view of responsible recipients.

The specified recipients are not permanently deleted as this script statement does not change the Notification objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task. The modification only applies for a particular execution.

Ensure that you do not remove all responsible recipients when you use wildcard characters.  Otherwise, script processing aborts and an error message is generated.

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

Note that users must be specified in the format User name/Department. It must comply with the name of the User object. The script aborts if the user cannot be found.

Examples

The following example removes the user "BU/AE" from the list of responsible recipients of a notifications.

:REMOVE_ATT RECIPIENT,"BU/AE"

The second example removes all users of the departmentDepartment name to which the Automation Engine user belongs. "AE".

:REMOVE_ATT RECIPIENT,"*/AE"

The user group "ADMIN" is removed in the third example.

:REMOVE_ATT RECIPIENT,"ADMIN"

 

See also:

Script element Description

:ADD_ATT

Adds users and user groups to 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