How Recordings are Propagated

There is no need to propagate your recordings across xMatters nodes manually. If you create or modify recordings in one of the Recordings subfolders, xMatters automatically propagates the recordings to all nodes. The following section describes the propagation process in detail.

Propagation Details

Voice recordings can be found in two areas on each node that has Phone/SIP installed: a staging area and a runtime area. The primary purpose of the staging areas is to populate the database after an install. The runtime area is used at runtime to play voice recordings during notifications.

The staging area is located at:

<xMatters>\node\assets\resources\runtime\common\recordings
 

The runtime area is located at:

<xMatters>\node\phone-engine\datastore\domains\common\recordings
 

When a node starts, the staging area is scanned for voice recordings that are not represented in the database. If a recording is missing from the database, it is added together with its descriptive recording phrase (if an associated properties file is present; a recordings properties file has the same name as the recording, except that its postfix extension is “properties” instead of “vox”). Phrase descriptions are located in the english\phrases subdirectory.

At regular time intervals, the database is scanned to ensure that all recordings defined are distributed to the runtime area. Similarly, the runtime area is scanned for recordings not represented in the database. If new recordings or newer versions of recordings are detected, the recording is added and the version is updated in the database. The version is represented by an incremental number in the database and by a suffix appended to the name represented by a dash followed by the number (for example, the recording “severity” version 3 is represented in the runtime area by “severity-3.vox”).

The voice recordings are also regularly scanned for resources that can expire. These represent recorded voice messages associated with a given event, such as a recorded comment. By default, these recordings expire after 24 hours, after which they are removed from the database and all runtime areas.

The Resource Broker on each node is responsible for synchronizing voice recording resources between the database and its local runtime area. To do so, it implements the regular (i.e., time-based) polling functionality described above; and, it uses a subscription mechanism to ensure resource changes are communicated to all nodes in a timely fashion. Each node in a multi-node deployment subscribes to resource changes and is informed when the change event occurs, allowing the node to update its resources. As a result, when communication problems occur or a node is temporarily offline, the time-based synchronization verification acts as a backup to ensure propagation.

Example

Assume that the xMatters web user interface has been used to create a new recording. The recording script is run on the node creating the recording. After recording is complete, a message is sent to the Resource Broker, which then updates the database with the change. In turn, Resource Brokers that maintain other nodes are informed and subsequently update their local resources.

Upgrades (Copying Recordings)

During an upgrade (and for other situations that require copying voice recordings), copying voice recordings to the runtime area of one of the Phone/SIP installed nodes adds the recordings to the database and distributes them to all other nodes. However, phrase descriptions manually entered in the runtime area are not added to the database and are therefore not available to display in the web user interface (note that you can add phrase descriptions manually through the web user interface).

Alternatively, you can add the recordings to the staging area of one of the nodes and then restart that node. The benefit of this approach is that if the associated properties files are included, the phrase descriptions are added to the database and made available for display in the web user interface.