CentraSite Documentation : CentraSite Developer's Guide : Built-In Design/Change-Time Actions Reference : Built-In Actions for Design/Change-Time Policies : Send Email Notification
Send Email Notification
Sends an email message to specified users and/or groups.
Note:  
*To use this action, CentraSite must have a connection to an SMTP email server. For instructions on how to configure the email server, see the CentraSite Administrator’s Guide.
*During an iteration of the policy, if the connection to a SMTP email server fails, this policy action returns a failure code. CentraSite writes the failure message to the policy log; however performs the next action in the policy (if one exists).
Event Scope
Pre-Create
Post-Create
Pre-Update
Post-Update
Pre-Delete
Post-Delete
Pre-State Change
Post-State Change
OnConsumerRegistration
OnTrigger
Object Scope
This action can be enforced on any object type that the policy engine supports.
Input Parameters
Users
Array of Users. Users who are to receive the email.
Note:  
You can specify the recipients of the email using the Users parameter, the Groups parameter, or both.
Groups
Array of Groups. Groups whose users are to receive the email.
Note:  
CentraSite will only send the email to those users in the group whose CentraSite user account includes an email address.
Subject
String. The text that you want to appear in the email's subject line. This text can include substitution tokens to insert run-time data into the subject line.
Use Email Template
Email Template. Specifies the template that is to be used to generate the body of the email message.
Note:  
*You can use the predefined template, ChangeNotification.html, as your email template if you do not want to create an email template of your own.
*If you use an email template to generate the body of the message, you cannot specify the body of the message using the Custom Message parameter. (In other words, you specify the body of the message using either the Use Email Template  or the Custom Message parameter.)
Custom Message
TextArea. The text of the email message. This text can include substitution tokens to insert run-time data into the message.
Note:  
If you use the Custom Message parameter to specify the body of the email message, you cannot generate the body of the message using an email template. (In other words, you specify the body of the message using either the Custom Message or the Use Email Template parameter.)
Format
String. Specifies whether the custom mail message is formatted as HTML or plain text.
Include owner in notification
Boolean. When enabled, this parameter sends the email notification to the owner of the object on which the policy is acting in addition to the users specified by the Users and Groups parameters.
Substitution Tokens
The following list describes substitution tokens that you can use to incorporate data from the run-time instance of a policy into the email. For example, you can use tokens to return information about the object on which the policy is acting, identify the user who triggered the policy, and/or indicate what type of event caused the policy to fire.
Be aware that some tokens are only meaningful for certain types of objects. User objects, for example, do not have a Description attribute, so the ${entity.description} token has no meaning for a User object. If you use a substitution token that is not supported by the policy's target object, CentraSite simply replaces the substitution token with a space at enforcement time.
If the target object includes the requested attribute, but the attribute itself has no value, CentraSite also replaces the substitution token with a space in the email message. If the requested attribute contains an array of values, CentraSite inserts the values into the email as a comma-separated list.
This token...
Inserts the following information into the parameter value at execution time...
${api.usage}
This token will be replaced with the value specified in the API Usage attribute of API.
${entity.approver}
The name of the user who approved or rejected the approval request.
Note:  
This token is only meaningful in email messages that are issued by the Initiate Approval or Initiate Group-dependent Approval actions. If it is used in a context where there is no approver or approval request, the token is simply replaced with a space.
${entity.approvercomments}
The comment provided by the approver when he or she approved or rejected the approval request.
Note:  
This token is only meaningful in email messages that are issued by the Initiate Approval or Initiate Group-dependent Approval actions. If it is used in a context where there is no approval request, the token is simply replaced with a space.
${entity.attribute.attributeName}
The value of the attribute specified in attributeName. You can use this token with all attribute types (including computed types) except Classification, File, and Relationship types.
Important:  
You must specify the attribute's schema name in attributeName, not its display name. For information about an attribute's schema name, see the CentraSite Administrator’s Guide.
${entity.BUIAssetURL}
A link to the URL of the asset details page in CentraSite Business UI.
${entity.BUIBaseURL}
A link to the URL of the CentraSite Business UI.
${entity.description}
The object's description.
Note:  
Users do not have a Description attribute.
${user.displayname}
The display name of the user who triggered the policy.
${entity.key}
The object's key (that is, the UUID that uniquely identifies the object within the registry).
${entity.name}
The object's name (in the user's locale).
${entity.owner}
The name of the user who owns the object against which the policy is acting.
${entity.type}
The type of object against which the policy acting.
${entity.state}
The state of the object against which the policy is acting.
If the object is an Asset, Policy, or Lifecycle Model, this action inserts the object's current lifecycle state. For all other object types, this token is ignored.
${entity.URL}
The URL for the object on which the policy is acting. (This is the URL that opens the object in CentraSite Control.)
${entity.version}
The object's user-assigned version identifier.
${event.type}
The type of event that triggered the policy.
${from.state}
The state from which the object is being switched (if the policy is executing on a Pre-State Change or Post-State Change event).
${target.state}
The state to which the object is being switched (if the policy is executing on a Pre-State Change or Post-State Change event).
${user.locale}
The locale of the user who triggered the policy.
${user.name}
The name of the user who triggered the policy.
${user.organization}
The name of the organization to which the user who triggered the policy belongs.
Example
User ${entity.owner} has added the following asset to the catalog:
Name: ${entity.name} Description: ${entity.description}
Copyright © 2005-2015 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback