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

:REMOVE_ATT

Script statement: Removes recipients in a notification at runtime.

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 user, user group or email address.
Format: script literal, script variable or number

User and UserGroup objects: The wildcard 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 list of responsible recipients.

The specified recipients are not permanently deleted as this script statement does not change the Notification object. 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 report 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 function returns the values of a task'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