Constants

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.

Example

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.

Global Constants

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.
To configure Global Constants:
  1. On the Admin tab, in the Configuration menu, click Global Constants.
  2. Do one of the following:

Defining Global Constant Details

If you are modifying or adding a Global Constant, you can define the following settings (Constant Name and Value are mandatory):

SMS Confirmation and First Alert Messages

Global 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 Global 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.

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:

  • A clear identification of xMatters (or the company) as the message sender.
  • Contact details, such as how to get more information.
  • Details on how to opt out of the service. xMatters accepts the following stop codes: STOP, END, QUIT, CANCEL, UNSUBSCRIBE, STOP ALL, and DISABLE.

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:

  • A clear identification of xMatters (or the company) as the message sender.
  • Contact details for the User to get more information about xMatters; for example, a web address or a phone number.
  • A short description of the service provided, including pricing terms.
  • Opt-out information.

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.
 

Company Constants

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.
To configure Company Constants:
  1. On the Admin tab, in the Configuration menu, click Company Constants.
  1. Do one of the following:

Defining Company Constant Details

If you are modifying or adding a Company Constant, you can define the following settings (Constant Name and Value are mandatory):

Event Domain Constants

Company Administrators and Developers can create Event Domain Constants that will be available in scripting for all event objects associated with an Event Domain.

To configure Event Domain Constants:
  1. On the Developer tab, in the Domains menu, click Event Domain Constants.
  2.  In the Event Domain drop-down list, select the Event Domain for which you want to create or modify the constants, and then click Continue.
  1. Do one of the following:

Defining Event Domain Constant Details

If you are modifying or adding an Event Domain Constant, you can define the following settings (Constant Name and Value are mandatory):