Skip to main content

Programs

Allows chaining of multiple automation actions/cues into one automation program

R
Written by René Rojas
Updated over a year ago

For example, you may want to adjust the volume of an auditorium depending on the number of seats sold.

Programs are made up of one or more steps. Each program can be triggered by trigger macro (more triggers are under development) or specified as part of Automation Settings.

Smart Programs - examples of how to configure various sets of automation with new triggers and conditions

Legacy Programs - legacy ways to use automation programs

RB has a limitation that programs triggered by activity offsets are not being scheduled if there are no activities in following days. This will not affect cinemas in normal operation, as generally there are more days booked in advance.

Syncing With Estate

Like Macros, Programs can be created at an estate level and Synced with individual TMS instances.

Changes to Programs at a TMS level will cause the Program to unsync with the estate version and no longer receive changes.

Programs can be resynced with the estate version discarding any local changes.

More information on Estate Programs

Main Settings

Name

Value

Default

Description

Name

String

Empty

A name of the program

Trigger Type

String

None

A type of trigger to trigger the program execution

Each type of trigger type contains its own list of properties to be set.

Enable and disable

Each program can be enabled and disabled for every screen on the site separately. A program which is disabled for a specific screen will not be fired for that screen. This means that TMS will not try to check any triggers or conditions and will not execute automation on that screen.

By default, new programs will have all auditoriums disabled.

Older programs when updating to the 5.10 RB version will be migrated to be enabled to follow the previous behaviour where enabling and disabling programs for screens were not an option.

Viewing Programs in the Schedule screen.

As of 5.11.00 version there has been an addition of being able to view Offset Activity Triggers that are scheduled to activate on the Schedule screen. These triggers are now displayed as a blue bar on the schedule and will appear depending on the configuration of the program. Additionally, hovering over the blue bar will provide the user with the name of the program that is set to activate before the show. See examples below:

Triggers

Different triggers available on RosettaBridge can help to start the execution of automation programs based on different needs. Part of the triggers are actually being scheduled behind the scene by TMS, but another part of the triggers depend on unscheduled events.

Macro trigger

Macro trigger allows adding macro to the playlist which will trigger the program execution.

Option

Description

Macros

The name of the macro, which will be triggering the program. Please keep in mind that the macro should be of type Trigger.

Macro setup:

There are two ways how macro can trigger a program:

Option 1 (Suggested): The trigger macro has to be executed on TMS. This can be achieved by checking the “Execute on TMS” checkbox.

Option 2: The trigger macro has to be correctly mapped to the player and actually be executed, so the player would report successful execution back to the TMS to trigger a program.

Fixed time trigger

Fixed time trigger will trigger a program every day at a set time.

By default, these triggers are scheduled one day in advance, but they can be adjusted with the feature.programs.trigger.fixed.range = 0 0 0 1 property. This should not affect the program execution, and should only be adjusted if schedule visibility is required more in advance.

Offset activity trigger

Offset activity trigger can be set to be an offset before or after the activity, also different sets of activities can be selected to be considered when scheduling the trigger. This trigger resembles daily automation that was available before this functionality introduction. The goal is to set automation before or after scheduled activities.

Option

Description

Mode

Auditorium

  • The gap to detect should consider activities only on the auditorium in question

  • the program will be triggered only on the triggered screen

Site

  • The gap to detect should consider activities on all enabled auditoriums on the site

  • The program will be triggered for every enabled auditorium on the site

Gap to detect

The minimal gap between activities where TMS should look for the offset (defines day start and day end, the program will not be triggered if gap between activities A and B is smaller than set)

Offset mode

Offset before or after activities

Offset value

Offset from the activity when the program should be triggered

Activity

Defines what activities are considered (Any, Shows, Firmware updates)

Ingest finished trigger

Requires POWER license

Ingest finished is one of the not scheduled triggers and will start executing the program when the transfer to the screen will either complete, fail or gets cancelled. Transfers to some extent are scheduled, but the ingest process cannot be perfectly predictable, therefore these triggers are activated at the end of the process.

Option

Description

Bulk transfers

If enabled, program will be triggered after all ingests that are happening withing the set gap to detect

if disabled, program will be triggered after every ingest.

Ignore non-starter transfer

If enabled, program will not consider transfers that cannot start.

Gap to detect (Only available for bulk transfer detection)

Defines a gap to detect from one transfer to the next one. If there are multiple transfers with smaller then defined gap between them, program will only be triggered when the last one completes.

Steps

Steps are groups of actions. An automation program can have one or many steps, which can contain none or more actions. When the program is triggered by a trigger macro in the playlist, all steps will be executed in sequence. If a step is interrupted for some reason, like the condition being false, the program will jump to the next step.

Name

Value

Default

Description

Name

String (Optional)

Empty

A name to help identify a given step.

DEPRECATED Triggered

Boolean

False

DEPRECATED functionality which should not be used unless you're still on legacy programs.

Actions

0 or more actions

Empty

The actions to be performed by this step.

Actions

An action is a single activity within TMS. Multiple actions can belong to a single step.

The following actions are currently available in TMS as of 5.08.00.

Name

Description

Macro

Allows a particular macro to be invoked.

Volume

Changes the volume on the Sound Device associated with the auditorium. The units can be Level or Db.

Delay

Allows a pause, in seconds, that can delay the execution of the particular step for a period of time.

Conditions

Allows programs to contain logic that determines the flow of the program.

If a condition is not satisfied then the remaining actions in the step will be skipped.

Conditions

Conditions are particular actions that change the flow of a given step depending on whether or not their criteria are met. When the condition is not met within the program step, the next actions on the step will be skipped and the program will continue on to the next step or complete the execution if no more steps are set.

Seats sold Condition

This condition checks the number of admissions and compares it to the maximum number of available seats in the triggered auditorium during the program execution. Condition is defined in percentage form. If on the program execution, the auditorium seats sold for the currently loaded show fall within the defined range, the condition will be resolved to true and step execution will continue, otherwise, it will skip all following actions in the step.

If the seats sold and the seat total isn’t available, for example, this was a manually booked show, or there is no current show, then this is considered false.

Seats sold condition values are inclusive, so if they are set from 0 to 25 percent, then even if no seats were sold, the condition will be true.

Name

Description

Seats Sold Condition

Inclusive Percentage From and Percentage To values needs to be set to compare range with a loaded show.

Primary device power status condition

This condition checks the defined primary device power status and returns true if the device power status match, otherwise, it will skip all following actions in the step.

Name

Description

Device Status

Offline - will result to true if the device is offline or in eco power mode

Online - will result to true if the device is online

Device Type

Value defines which primary device on the auditorium condition should check

Transfer is expected condition

Requires POWER license

This condition checks if there are expected transfers to the auditorium.

Name

Description

Is expected

Enabled - condition will result to true if there are expected transfers

Disabled - condition will result to true if no transfers are expected

Ignore non-starter transfer

If enabled, program will not consider transfers that cannot start.

Transfer gap

The amount of time from when the program execution have started to consider transfers.

E.g. scheduled transfers

No shows in condition

This condition checks if there are no shows scheduled in the auditorium at the defined time. If the program will encounter at least one show, it will result to false and the step will be skipped.

No shows in

Amount of time from when the program execution have started to look for the next show.

Mode

Auditorium

The gap to detect should consider activities only on the auditorium in question

Site

The gap to detect should consider activities on all enabled auditoriums on the site

Gap between activities condition

Similarly to an activity offset trigger option, this condition is checking if the program is running in the set time gap between the shows. If the program is not running in the defined time gap, it will result to false and the step will be skipped.

Gap to detect

The minimal gap between activities where TMS should look for the offset. The program will not be triggered if the gap between activities A and B is smaller than defined value.

Mode

Auditorium

The gap to detect should consider activities only on the auditorium in question

Site

The gap to detect should consider activities on all enabled auditoriums on the site

Activity

Defines what activities are considered (Any, Shows, Firmware updates)

Content is missing condition

Requires POWER license

This condition checks if there are shows in an auditorium with missing content.

Is missing?

If checked, condition will return true when at least one show on the auditorium is reporting missing content.

If not checked, the condition will return true if no shows on the auditorium are reporting missing content

Did this answer your question?