Scripting Objects
The following links identify and explain the various scripting objects
available in the xMatters platform scripting environment. The purpose
of each object is described, along with the scripting components with
which it is used, a list of its reserved script object variables, the
methods it provides, and other details. Most object methods have examples
of their use included with the description.
Naming Objects
This documentation uses a consistent naming scheme for all of the methods
and objects presented here. In practice, most object names are variables,
and can be named according to whatever business practices apply. For example,
the @notification script object referred to within this document could
be referenced within your scripts as @alert.
The following object names are provided by the system, and cannot be
modified (as identified in the System Tokens
section):
- @event:
Reserved to be used within business scripts to represent the inbound event.
- @exception:
Reserved to be used within scripts to access the exception handling blocks.
- @main:
Reserved to be used with business scripts to share information between
processes.
- @phone:
Reserved to be used within callout and callin scripts to process phone
commands.
- @response:
Reserved to be used within handler scripts to specify response
information, and in callout and callin scripts to initiate interaction
with a user.
Object reference names, variable names, and method names
are all case-sensitive.
Object scope
Unless otherwise indicated, all objects have one of the following scopes:
- Event lifecycle:
represents the period from when the event is created to when the event
terminates. Variables added to objects with a scope of “event lifecycle”
persist for the life of the event, and can be accessed as long as the
event exists.
- Script lifecycle:
represents the period from when a script is first executed to when the
script completes execution. Variables added to objects with a scope of
“script lifecycle” can be accessed while the script is being executed.
When a script object method returns a NULL, the returned
script object will no longer exist.
Script Objects
Script
Object (default)
Advanced
Message Object
Advanced
Message Report Object
Company
Object
Content
Object
Device
Object
Event
Object
Exception
Object
ExternalServiceMessage
Object
ExternalServiceRequest2
Object
ExternalServiceRequest
Object
ExternalServiceResponse
Object
Group
Object
Interaction
Object
Notification
Details Report Object
Notification
Object
Person
Object
Phone
Object
Recipient
Object
Response Object
Subscription
Object
URL
Alias Object
User
Session Object