27.2 Tokens

Some of the contents of the message and task files are tokenized, allowing the system to run macros that fetch elements to include in the body or subject of the message.

  • $$INCLUDE:<filename.msg>$$: This is the name of a file you want to invoke and display in a message. It could include such things as predefined tables. The macro infers that the message file is found in the current folder. This allow a part of a message (such as a details table that might be included in multiple messages) to be defined only once and then referenced where needed. This minimizes challenges when you change the included message.

    You can change the name or the look and feel (including the contents) of the default tables or you can customize your own table, based on one of these:

    • businessServiceDetailsTable.msg

    • businessServiceWithWorkloadsDetailsTable.msg

    • changeRequestDetailsTable.msg

    • changeRequestWithWorkloadsChangesDetailsTable.msg

    • changeRequestWithWorkloadsDetailsTable.msg

  • $$STYLE:<filename.style>$$: This is the name of a style file you want to invoke and display in a message. It could include such things as headers. The macro infers that the style file is found in the /styles folder.

  • $$PRODUCT_NAME$$: This is the formal name of the Cloud Manager system, renamed as you want it to appear in your rebranded version of the product. The value for this macro is found in the theming configuration file (/etc/cloudmanager-themes.cfg). For more information, see Section 24.3, The Theming Configuration File.

  • $$PRODUCT_SHORT_NAME$$: This is the informal or “short” name of the Cloud Manager system, renamed as you want it to appear in your rebranded version of the product. The value for this macro is found in the theming configuration file (/etc/cloudmanager-themes.cfg). For more information, see Section 24.3, The Theming Configuration File.

  • $$PRODUCT_URL$$: This is the URL link to Cloud Manager system you have installed and configured for use in your organization. Because it is used in all messages, this macro is included in the main_skin.msg file.

  • $$CONTENT$: This token is found only in the main_skin.msg template. It is the insertion point for the editable .msg file content you control (that is, the various messages, subjects, and task messages found in the theming infrastructure).

  • $$EMBED_IMAGE:<image_name>$$: This token references a file in the /themes directory. It directs Cloud Manager to calculate a Base-64 encoded string, and then embeds that string in the message.

  • $$ATTACH_IMAGE:<image_name>$$: This token references a file in the /themes directory. It directs Cloud Manager to attach an image to the email. It also adds a content inside the email message that references the attachment.

The following list of macros is available for use only in core messages. The purpose of each is self-explanatory. Use the form ${MACRO_NAME} when you tokenize a message.

  • ATTACH_IMAGE

  • BS_ID

  • BS_NAME

  • BS_ID_NAME

  • BS_DESCRIPTION

  • BS_STATUS

  • BS_SUBMISSION_DATE

  • BS_START_DATE

  • BS_EXPIRE_DATE

  • BS_REQUESTER

  • BS_REQUESTER_ID

  • BS_DECOMMISSIONED_DAT

  • BS_BUSINESS_GROUP_NAME

  • BS_ORG_NAME

  • BS_STATUS_ADDL_INFO

  • CURRENT_TIME_STAMP

  • ZONE_ID

  • ZONE_NAME

  • ZONE_DESCRIPTION

  • ZONE_CONNECTION_INFO

  • WL_NAME

  • WL_OSTYPE

  • WL_OSFAMILY

  • WL_BASECOST

  • WL_NUMBER_OF_CPUS

  • WL_AMOUNT_OF_MEMORY

  • WL_VM_NAME

  • WL_REPOSITORY_ID

  • WL_TEMPLATE_NAME

  • WL_SERVICE_LEVEL_NAME

  • WL_ZONE_NAME

  • WL_RESOURCE_GROUP_NAME

  • WL_IMPORTED

  • WL_DISKS_SUMMARY

  • WL_NIC_CONFIGS_SUMMARY

  • WL_AOS_SUMMARY

The following list of macros is available for use only for messages in the /tasks subfolder. The purpose of each is self-explanatory. Use the form ${MACRO_NAME} when you tokenize a message.

  • ATTACH_IMAGE

  • BS_ID

  • BS_NAME

  • BS_ID_NAME

  • BS_DESCRIPTION

  • BS_STATUS

  • BS_SUBMISSION_DATE

  • BS_START_DATE

  • BS_EXPIRE_DATE

  • BS_REQUESTER

  • BS_REQUESTER_ID

  • BS_DECOMMISSIONED_DATE

  • BS_BUSINESS_GROUP_NAME

  • BS_ORG_NAME

  • CR_ORIGBS_ID

  • CURRENT_TIME_STAMP

  • TASK_ID

  • TASK_SUBJECT

  • TASK_ID_SUBJECT

  • TASK_MESSAGE

  • TASK_STATUS

  • TASK_CALLOUT_GUID

  • TASK_DATE_CREATED

  • TASK_DATE_COMPLETED

  • TASK_COMPLETE_BY_DATE

  • TASK_DELEGATED_BY

  • TASK_DELEGATED_BY_ID

  • TASK_ASSIGNED_USER

  • TASK_ASSIGNED_USER_ID

  • TASK_ASSIGNED_PERMISSION