Configuring the Default Notification Templates

The default email HTML templates are common to all organizations handled by the Codar instance. Codar automatically looks for these templates in the csa.war\WEB-INF\classes\notifications directory to send out the notification emails.

The HTML email notification templates can be configured for the following types of notifications:

  • Deploy action
  • Approval action
  • Custom action
  • Package promote
  • ALM test action

For each of these notifications, based on the result, either a success or a failure notification will be sent to the subscriber.

The CODAR_NOTIFICATION.htm file is used to send these notifications, stored in the csa.war\WEB-INF\classes\notifications directory.

See HTML Template Configuration/Troubleshooting Notes for configuration requirements and troubleshooting HTML email notification errors.

Using the Notification Templates

If Codar has to send out HTML email notifications, the email templates must be designed using pre-defined notification tokens. These tokens are described in Notification Tokens. It is not possible to add custom tokens as these custom tokens will not be recognized by Codar.

For token configuration requirements, and troubleshooting emails that do not display correctly (such as the token itself displays rather than the actual value, or the email displays as plain text instead of HTML output), see HTML Template Configuration/Troubleshooting Notes

When the templates are configured, Codar first looks for templates under the csa.war\WEB-INF\classes\notifications\ORGANIZATION_ID folder where ORGANIZATION_ID is the Org Id of the Organization defined in Codar. The Organization Identifier can be retrieved from the General Information tab on the Consumer or Provider page of the Organizations page in the Codar Management Console.

Notification Tokens

The following table lists the common tokens and their descriptions, which can be used in all the notification templates.

Token Description
Organization Tokens
org.name The name of the organization, defined as the Display Name of the Organization.
org.portalTitle The title of the portal, defined as the title of the organization's Marketplace Portal.
org.csaUrl The Codar host name, protocol, and port, usually as "https://CSAHOST:CSAPORT".
org.csaHost The Codar host name and protocol, as "https://CSAHOST".
org.legalNotice The link that points to the Organization's privacy agreement.
org.termsOfUse The link that points to the Organization's terms of use.
org.welcomeMessage The welcome message defined for the Marketplace Portal in the Organization.
org.footerMessage The copyright statement defined for the Marketplace Portal in the Organization.
org.content The result of the action; for example, success or failure.

Unsupported HTML Notification Functionality

The following HTML notification functionality is not supported:

  • It is not possible to create email templates specific for each version of a service design. For example, if a service design called "Simple vCenter Compute" has two or more versions, only a single email template can be created to be used by all the versions of this service design.

  • Subject lines cannot be customized.

  • Mails that are triggered by Notification API calls will be sent as legacy text notifications.

  • Operations Orchestration flows that send notifications will not be sent in HTML format.

  • For schedules (promote and clean-up schedules), only text notifications will be sent.

Send Help Center feedback