Set up Text-To-Speech

Text-to-speech can be used in Workflow commands to read out text to a user. This can either use the default sound device on the system, or a specific one. In this example, we are setting up a Workflow which announces information about urgent alarms, such as a door being forced open. This brings immediate awareness to the Runtime operator for what is happening, and where, increasing response time.

Configure the Workflow Trigger

The trigger must first be configured to execute the Workflow when a door asset has a status change.

  1. Create a new Workflow.
  2. Configure the trigger.
    1. Double-click the Start block.
    2. Click Add.
    3. Navigate to the integrated system for the doors, expand, and select Assets.
    4. In the Events pane, click Status Changed.
    5. Click OK, then OK again.

Set up the Logic

The Workflow must be configured so we only announce that there has been a door forced open at the correct time, rather than on just any status change.

  1. Add a Logic block to the Workflow.
  2. Configure the Logic block.
    1. Double-click the Logic block.
    2. Expand Triggering Item and select Initial.
    3. In the Properties pane, double-click Current Status Name.
    4. In the Operations pane, click =.
    5. In the Constants pane, click String.
    6. In the Expression pane, type "Forced Open" into the text box.
    7. Click OK.
  3. Add an Action block to the Workflow.
  4. Connect the False exit path for the Logic block to the Stop block, and the True exit path to the Action block.
  5. Connect the Action block exit path to the Stop block.

Set up the Text-To-Speech Announcement

We now need to configure the actual announcement to tell the operator a door has been forced open.

  1. Double-click the Action block.
  2. Click Sound Service.
  3. In the Commands pane, select one of the text-to-speech commands:
    Command Parameters Description
    Play Text-To-Speech

    Text — The text to be read.

    Voice — The narrator voice to use. If left blank, this will use the default voice. See below this table for restrictions.

    Converts text to audio and plays it.
    Loop Text-To-Speech

    Text — The text to be read.

    Number of repeats — The number of times the audio is played. If this is set to zero, it will play indefinitely.

    Sound Device Name — The name of the device to play the audio on.

    Voice — The narrator voice to use. If left blank, this will use the default voice. See below this table for restrictions.

    Converts text to audio and plays it a specified number of times on the specified device.
    Loop Text-To-Speech

    Text — The text to be read.

    Number of repeats — The number of times the audio is played. If this is set to zero, it will play indefinitely.

    Voice — The narrator voice to use. If left blank, this will use the default voice. See below this table for restrictions.

    Converts text to audio and plays it a specified number of times.
    Loop Text-To-Speech

    Text — The text to be read.

    Number of repeats — The number of times the audio is played. If this is set to zero, it will play indefinitely.

    Sound Device Name — The name of the device to play the audio on.

    Voice — The narrator voice to use. If left blank, this will use the default voice. See below this table for restrictions.

    Converts text to audio and plays it a specified number of times on the specified device.
  4. In the Expression pane, click Text, then Advanced.
  5. Configure the expression:
    1. Expand Triggering Item and select initial.
    2. In the Properties pane, double-click Caption.
    3. In the Operations pane, click +.
    4. In the Constants pane, click String.
    5. In the Expression pane, type "has been forced open".
    6. Click OK.
  6. If the command you selected requires a Sound Device Name, click Sound Device Name in the Expression pane and enter the name of the sound device you wish for the audio to play on. If you do not know the name, you will need to find it first.
  7. If the command you selected requires the Number of repeats, click Number of repeats in the Expression pane and enter how many times you want the audio to play.
  8. If you wish to have the text narrated in a voice other than the default one on your system, click Voice and select the desired one from the list.
  9. Click OK.
When the Workflow is triggered, it will announce the door caption and that it has been forced open. So, for example, if a door named "Shipping and Receiving Entrance" has been opened by force, the Workstation will announce "Shipping and Receiving Entrance has been forced open" to the operator.