xMatters uses constants in scripting in a manner similar to variables (i.e., the constant name is abstracted from the constant value). Constants can be Global, applying across all Companies in an xMatters multi-tenancy deployment, or Company-specific, applying only to the Company for which they are defined.
An xMatters administrator creates a constant named "BES_URL" with a value representing the current BlackBerry Enterprise Server URL. The constant is then used in several xMatters scripting packages (i.e., the constant is used rather than the actual BES URL). If the server's URL changes, the administrator can simply modify the value of the BES_URL constant. The change will then be propagated to all instances of the BES_URL constant in the scripting packages.
| Note: | When an existing constant is modified, it takes five minutes for the change to be reflected in the scripts. |
xMatters super administrators can define Global Constants that will be available in scripting for all Companies in the xMatters deployment.
| Note: | If a Global Constant and a Company Constant have the same name, the value of the Company Constant overrides the value of the Global Constant for that Company. |
If you are modifying or adding a Global Constant, you can define the following settings (Constant Name and Value are mandatory):
Company Administrators can define Company Constants that will be available in scripting for the Company that they administrate.
| Note: | If a Global Constant and a Company Constant have the same name, the value of the Company Constant overrides the value of the Global Constant for that Company. Additionally, Company Constants have independent values between Companies; multiple Companies can define a constant with the same name, but different values. |
If you are modifying or adding a Company Constant, you can define the following settings (Constant Name and Value are mandatory):
Company Administrators and Developers can create Event Domain Constants that will be available in scripting for all event objects associated with an Event Domain.
If you are modifying or adding an Event Domain Constant, you can define the following settings (Constant Name and Value are mandatory):
The following sections identify the constants within xMatters pre-configured to handle common SMS messages and the style of e-mail notifications.
Constants are used to define the messages that Users will receive as confirmation and first alert messages when they create or modify a text phone Device in xMatters. The following table identifies the constants that you can edit to define the confirmation and first alert messages, and the help text Users will see if they request more information.
Note that these constants can be defined as Global Constants, which apply to all Companies in the system, or as Company Constants, which apply only to those Companies for which they are defined. If a Global Constant and a Company Constant have the same name, xMatters will use the value of the Company Constant.
| Constant | Description |
|---|---|
|
SMSCONFIRMMSG |
Defines the confirmation message displayed to Users when they create, modify, or activate a text phone Device in xMatters. To meet the best practices requirements of the Mobile Marketing Association (MMA), this message should include the following information:
Example: Welcome to xMatters on demand; the number of alerts you will receive varies with usage. Send HELP for more info; send STOP to opt out. Message & data rates may apply.
|
|
SMSFIRSTMSG |
Defines the text of the sample message displayed to Users when they create or modify a text phone Device in xMatters. To meet the best practices requirements of the MMA, this message should include the same information as the confirmation message; for example: This is a sample message from xMatters on demand. Send HELP for more information, or send STOP to opt out. Message & data rates may apply.
|
|
SMSHELPMSG |
Defines the text of the message xMatters should send when a User responds to an xMatters notification with HELP. To meet the best practices requirements of the MMA, this message should include the following:
Example: xMatters on demand has been authorized to send notifications to this text phone. The number of messages you receive may vary, and prices are determined by your phone service provider. For more information, call 1-888-555-5555. To opt-out, reply to this message with STOP.
|
| SMSSTOPMSG |
Defines the text of the message xMatters should send when a User responds to an xMatters notification with STOP; for example: Your Device will no longer receive SMS messages from the xMatters notification service. |
The e-mail presentation constants can be defined as Global, Company, or Event Domain Constants. If a Global Constant and a Company Constant have the same name, the value of the Company Constant overrides the value of the Global Constant for that Company. If an Event Domain Constant has the same name as a Company Constant (or a Global Constant), then the value of the Event Domain Constant will override the value of the other Constants for messages sent for that Event Domain.
| Constant | Description |
|---|---|
|
EMAILLOGOURL |
Defines the URL at which the logo used at the top of the e-mail message is stored. If no URL is defined, xMatters uses the following default path: <XM_HOME>/webserver/static/images/logos/xmatters_email.gif If the value specified in the constant is not a fully qualified URL (i.e., it does not begin with http://), xMatters will prepend the location of the xMatters web server, as defined by the WEBSERVERURL Global Constant. |
|
EMAILCSS |
Defines the cascading style sheet (CSS) to use when formatting e-mail messages. If no CSS is defined, messages are formatted using the default xMatters layout and styles. |
|
EMAILFOOTER |
Defines the message contained in the footer added to the bottom of each e-mail message. If no message is defined, the default footer is "Powered by xMatters". |