Working with Script Packages

Script Packages are used to store a group of related scripts for a particular task or function within xMatters. There are three types of Script Packages:

Business

Used to store scripts that will process inbound events and deal with the generation and handling of responses and interactions with notifications. Business Script Packages are linked to an event domain. All events that are inbound on a specific event domain will be processed by the corresponding Script Package.

Callin

Used to store scripts that deal with users calling into xMatters. The scripts in this package deal with the authentication of users and delegation to other Script Packages.

Callout

Used to store scripts that deal with notification of users over the phone. These packages are not domain-specific, and will be used to route users to Business Script Packages that are domain-specific.

Checking out a Script Package

You can open a Script Package from the database to edit its details, or to modify the scripts within the Script Package.

To check out a Script Package:
  1. Click Database > Check Out.
  2. In the Check Out dialog box, select the Script Package you want to check out, and then click Check Out.
  3. When the check out is complete, click Close.

Checking in a Script Package

After modifying a Script Package, whether by adding or removing scripts or editing the Script Package details, it must be checked in to the database. Once it has been checked in, you can alter its status by promoting it within the Check Out dialog box.

You must save and validate your Script Package before you can check it in.

To check in a Script Package:
  1. Click Database > Check In.
  1. In the Check In Report dialog box, review the changes to the Script Packages.
  2. Click OK to apply your changes.

Deleting Archive and Development Script Packages

Using the xMatters Developer IDE, you can remove Archive and Development Script Packages from the database. You cannot remove Production-version Script Packages.

To delete unused Script Packages:
  1. Click Database > Check Out.
  2. In the Check Out dialog box, expand the Script Package containing the versions you want to delete.
  3. Do one of the following:

Getting started With the xMatters Developer IDE

Configuring the database connection

Creating and modifying Script Packages

Creating a script