HTML Template Configuration/Troubleshooting Notes

  • Be sure the HTML template file names are correct. The names must be the same as the default HTML template file names, with the exception of the design-specific email templates, which also follow a specific naming convention. Only the contents of the HTML files can be changed.
  • The name of the directory under csa.war/WEB-INF/classes/notifications must be the same as the Organization Identifier, and not the Organization Display Name.

  • Two or more versions of a service design will use the same template if a design-specific template is defined. If the components differ widely across these versions, it is not possible to create different design-specific templates for each version.
  • The notification tokens are case-sensitive. For example:${INFRASTRUCTURE_SERVICE-SERVER_GROUP.serverCount} is not the same as ${infrastructure_service-Server_group.serverCount}.
  • If tokens are seen as-is in email notifications, check to see if the tokens are entered correctly. Verify that the components containing these properties, and the properties, are visible. Properties with encrypted data cannot be accessed.

  • Only visible components and visible properties will be available.

    • The parent component need not be visible. So if the parent component is hidden, but the child component is visible, then all placeholder tokens corresponding to their visible properties of the child component will be resolved.

    • However, if the parent component is visible, but the child component is hidden, then the property values of the child component cannot be accessed using placeholder tokens.

  • The tokens must be entered exactly as shown in the HTML Template Configuration/Troubleshooting Notes section. If the token is entered incorrectly, the email notification will show the token name rather than the name that the token represents. For example, if you use Subscriber.name instead of subscriber.name, the email content will show Subscriber.name instead of the person's name.
  • Be sure that the following characters are not used in the names of custom components:

    $ { [ ( . ) ] } and whitespace

    If CSA finds these characters in the name of the components, then they will be removed. For example, if a component name is SERVER{TEST COMPONENT.NAME}, then CSA will use the name SERVERTESTCOMPONENTNAME.

  • To debug any possible issues in collecting data required for HTML notifications, enable debug logging for the following in log4j2.xml. This file can be found under csa.war/WEB-INF/classes:

    com.hp.csa.service.notification.NotificationMailServiceImpl

    com.hp.csa.service.notification.templates

    Debug log entries will be seen in the csa.log file.

Note For Clustered CSA nodes, email templates, csa.properties and log4j2.xml must be identical across all nodes so that the behavior is consistent in a cluster. The HTML templates and any modifications to the templates must be applied to each CSA node in the cluster.

Legacy text notifications will be sent under these conditions:

  • If there is an error while creating emails in HTML. Look up csa.log and correct any parsing issues.
  • If notifications are sent for Service Instance Upgrade and Transfer Subscription.