Email message variables and properties

Create a customized email messages file by using a combination of variables and properties. The following tables contain the variables and properties that you can use.

Message variables

Table 1. Dynamic variables available for email messages
Variable Description
$(ram.asset.name) The name of the asset. To more accurately identify assets, use this variable with the version number.
$(ram.asset.version) The version number of the asset
$(ram.asset.id) The GUID (unique ID) for the asset
$(ram.asset.url) The URL to the General Details page for the asset
$(ram.asset.owner.name) The name of the owner of the asset
$(ram.asset.owner.email) The email address for the owner of the asset
$(ram.asset.owner.id) The user name of the owner of the asset
$(ram.asset.owner.url) The URL to the profile page for the owner of the asset
$(ram.asset.community.name) The community that the asset belongs to
$(ram.asset.community.id) The unique ID number of the community that the asset belongs to
$(ram.asset.type.name) The asset type of the asset
$(ram.asset.categories) The categories of the asset
$(ram.asset.shortdescription) The short description of the asset
$(ram.asset.description) The description of the asset
Note: Descriptions often contain HTML content.
$(ram.asset.state) The current lifecycle state of the asset, such as Draft or Approved
$(ram.user.name) The name of the user that is receiving the email
$(ram.user.email) The email address of the user who is receiving the email
$(ram.user.id) The user name of the user who is receiving the email
$(ram.user.url) The URL to the profile page for the user who is receiving the email

Message properties

Table 2. Properties available for email messages
Property Description Example
email_test_subject The subject of the email sent when you test whether emails are working on the Tools page of the Administration menu IBM® Rational® Asset Manager Test Email
email_test_message The body of the email that is sent when you test whether emails are working on the Tools page of the Administration menu This email is a test from IBM Rational Asset Manager.
email_subscription_subject_aggregate The subject of the email that is sent when a user subscribes to an asset and sets the frequency for receiving notifications to a daily, weekly, or monthly range [Subscription]: IBM Rational Asset Manager Updates
email_subscription_subject The subject of the email that is sent when a user subscribes to an asset and specifies to be notified of asset updates as soon as the updates occur.

Use {0} for the name of the asset and for the event of the subscription.

Example in the .properties file: [Subscription] {0}

Example in the generated email: [Subscription] My Presentation: Discussion topic created

where My Presentation is a link to the asset.

email_subscription_subscription_name The name of the subscription that event belongs to. The subscription is entered by users when they subscribe to an asset.

Use {0} for the name of the subscription.

Example in the .properties file: You have subscribed to {0}.

Example in the generated email: You have subscribed to My Presentation Subscription.

email_subscription_asset_version The asset name and version are displayed as a link to the asset.

Use {0} for the name of the asset and {1} for the version of the asset.

Example in the .properties file: {0} [{1}]

Example in the generated email: My Presentation [1.0]

where My Presentation [1.0] is a link to the asset that you subscribed to.

email_subscription_user_time The user who edited the asset and the time that the change was made.

Use {0} for the user and {1} for the time of the change.

Example in the .properties file: {0} updated this asset on {1}.

Example in the generated email: User updated this asset on May 15 10:52am.

email_subscription_permission_denied The body of the email that notifies users when they do not have permissions to view an asset You no longer have permission to view the asset referenced in this subscription.
email_subscription_edit_subscription A link to the Subscriptions page on My Dashboard, where you can edit your subscription settings Edit your subscriptions
email_subscription_deleted_asset The body of the email that notifies users when an asset that they subscribe to is deleted The asset you subscribed to was deleted. Your subscription is removed.
email_subscription_deleted_forum The body of the email that notifies users when a forum that they subscribe to is deleted The forum you subscribed to was deleted. Your subscription is removed.
email_subscription_deleted_topic The body of the email that notifies users when a forum topic that they subscribe to is deleted The topic you subscribed to was deleted. Your subscription is removed.
email_subscription_deleted_search The body of the email that notifies users when a subscription to a search query is no longer valid The search query that you subscribed to is not valid. Your subscription will be removed.
email_asset_subject The default subject of emails about sharing an asset. This email is sent when a user clicks Email on the General Details page of an asset.

Use {0} for the asset name.

Example in the .properties file: Message concerning the asset {0}

Example in the generated email: Message concerning the asset My Presentation

email_asset_no_message The default body of emails about sharing an asset if the user does not type a message

Use {0} for the user name and {1} for the asset name.

The asset name is a link to the asset.
Example in the .properties file: {0} thought you would be interested in the asset {1}.

Example in the generated email: User thought you would be interested in the asset My Presentation.

where My Presentation is a link to the asset.

email_asset_message The body of emails about sharing an asset if the user types a message.

Use {0} for the user, {1} for the asset, and {2} for the message from the user. The asset name is a link to the asset and the message content is contained by an HTML paragraph tag.

Example in the .properties file: {0} wrote you a message about the asset {1}: {2}

Example in the generated email: User wrote you a message about the asset My Presentation: There is a typo in the document heading.

email_subject_lifecycle_accepted The subject of the email that is sent when a user approves an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the asset version.

Example in the .properties file: [Lifecycle] {0} approved {1} [{2}]

Example in the generated email: [Lifecycle] User approved My Presentation [1.0]

email_subject_lifecycle_commented The subject of the email that is sent when a user enters a comment on the Review page of an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the asset version.

Example in the .properties file:[Lifecycle] {0} commented on the asset {1} [{2}]

Example in the generated email: [Lifecycle] User commented on the asset My Presentation [1.0]

where My Presentation [1.0] is a link to the asset.

email_subject_lifecycle_rejected The subject of the email that is sent when a user rejects an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the asset version.

Example in the .properties file:[Lifecycle] {0} rejected asset: {1} [{2}]

Example in the generated email: [Lifecycle] User rejected asset: My Presentation [1.0]

email_subject_lifecycle_preretired The subject of the email that is sent when an asset moves to the Pre-Retired state of the Retire lifecycle.

Use {0} for the asset name and {1} for the asset version.

Example in the .properties file: [Lifecycle] {0} [{1}] has been moved to the Pre-Retired state

Example in the generated email: [Lifecycle] My Presentation [1.0] has been moved to the Pre-Retired state

email_subject_lifecycle_retired The subject of the email that is sent when an asset moves to the Retired state of the Retire lifecycle.

Use {0} for the asset name and {1} for the asset version.

Example in the .properties file: [Lifecycle] {0} [{1}] has been moved to the Retired state

Example in the generated email: [Lifecycle] My Presentation [1.0] has been moved to the Retired state

email_subject_asset_state_change The subject of the email that is sent when an asset changes states in a lifecycle.

Use {0} for the asset name, {1} for the asset version, and {2} for the asset state.

Example in the .properties file: [Lifecycle] The asset {0} has been moved to the {2} state

Example in the generated email: [Lifecycle] The asset My Presentation has been moved to the published state

email_body_lifecycle_collaborator_accepted The body of the email that is sent when a user approves an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the user comment.

Example in the .properties file: {0} approved the asset {1} in the state: $(ram.asset.state)

Comments: {2}

Example in the generated email: User approved My Presentation in the state: draft

Comments: I think this asset is ready to be published.

email_body_lifecycle_collaborator_commented The body of the email that is sent when a user enters a comment on the Review page of an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the user comment.

Example in the .properties file: {0} commented on the asset {1}: {2}

Example in the generated email: User commented on the asset My Presentation: Can you explain section two in more detail?

email_body_lifecycle_collaborator_rejected The body of the email that is sent when a user rejects an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the user comment.

Example in the .properties file: {0} rejected the asset {1}: {2}.

Example in the generated email: User rejected the asset My Presentation: This asset is missing key pieces of information.

email_body_lifecycle_preretired The body of the email that is sent when a user rejects an asset.

Use {0} for the user name, {1} for the asset name, and {2} for the user comment.

Example in the .properties file: {0} moved {1} to the Pre-Retired state. In the Pre-Retired state, the asset is available to everyone who previously had access to the asset. Once the asset is Retired, it will no longer be accessible.

Example in the generated email: User moved My Presentation to the Pre-Retired state. In the Pre-Retired state, the asset is available to everyone who previously had access to the asset. Once the asset is Retired, it will no longer be accessible.

email_body_lifecycle_retired The body of the email that is sent when an asset moves to the Retired state of the Retire lifecycle.

Use {0} for the asset name and {1} for the state name.

Example in the .properties file: {0} moved {1} to the Retired state. In the Retired state the asset is only accessible to administrators and asset owners.

Example in the generated email: User moved My Presentation to the Retired state. In the Retired state the asset is only accessible to administrators and asset owners.

email_body_lifecycle_initial_state The body of the email that is sent when an asset enters the first state of a lifecycle.

Use {0} for the asset name and {1} for the state name.

Example in the .properties file: {0} has been submitted to and has entered the {1} state.

Example in the generated email: My Presentation has been submitted to and has entered the published state.

email_body_lifecycle_state_change The body of the email that is sent when an asset moves from one state to another.

Use {0} for the asset name, {1} for the initial state name, and {2} for the state the asset has been changed to.

Example in the .properties file: The asset {0} has been moved from the {1} state to the {2} state.

Example in the generated email: The asset My Presentation has been moved from the draft state to the published state.

email.subject.error The subject of the email that is sent to the administrator when a problem occurs IBM Rational Asset Manager - Error Occurred
email.body.stack.trace The body of the email that is sent to the administrator when a problem occurs.

Use {0} for the error and include HTML tags around the error to preserve the spacing for each error.

Example in the .properties file:<p> <pre width="150">{0}</pre></p>
email.body.completed.task The body of the email that is sent when the repository completes a scheduled task.

Use {0} for the asset name.

Example in the .properties file: The task for <div class="completedTask">{0}</div> is completed.

Example in the generated email: The task for My Presentation is completed.

lifecycleCollaboratorEmail.subject The subject of the email that is sent when a user is added as a reviewer for an asset.

Use {0} for the asset name.

Example in the .properties file: [Lifecycle] The asset {0} has been moved to the $(ram.asset.state) state.

Example in the generated email: [Lifecycle] The asset My Presentation has been moved to the draft state.

lifecycleCollaboratorEmail.body The body of the email that is sent when a user is added as a reviewer for an asset.

Use {1} for the asset name and {2} for the asset version.

Example in the .properties file: The asset {1} [{2}] has been moved to the $(ram.asset.state) state.

Example in the generated email: The asset My Presentation [1.0] has been moved to the published state.

where My Presentation [1.0] is a link to the asset.

lifecycleReviewBoardMemberEmail.subject The subject of the email that is sent when a user is added as a lifecycle manager for an asset.

Use {0} for the asset name and {1} for the asset version.

Example in the .properties file: [Lifecycle] You have been added as a lifecycle manager for the asset {0} [{1}] in state $(ram.asset.state.

Example in the generated email: [Lifecycle] You have been added as a lifecycle manager for the asset My Presentation [1.0] in state draft.

lifecycleReviewBoardMemberEmail.body The body of the email that is sent when a user is added as a lifecycle manager for an asset.

Use {1} for the asset name and {2} for the asset version.

Example in the .properties file: You have been added as a lifecycle manager for the asset {1} [{2}] in state $(ram.asset.state).

Example in the generated email: You have been added as a lifecycle manager for the My Presentation [1.0] in state draft.

where My Presentation [1.0] is a link to the asset.


Feedback