Skip to main content

Placeholders

Broadcast Suite supports several placeholders, which will be replaced during the execution of a trigger or an action.
This allows using, for example, the name of the active event in the Subject of an E-Mail Action.

Example​

The following example demonstrates the usage of placeholders:

E-Mail Action Subject (Input):
The `event` "{Event.Name}" is currently active, last on time: {Event.LastTimeStatusOn}
E-Mai Subject (Output):
The `event` "Studio OFF" is currently active, last on time: 15.06.2024 21:15:07
In this example, item placeholders were used.

Placeholder Types​

System Placeholders​

System placeholders are functions that support additional configuration.
A more detailed explanation and examples can be found here: System Placeholders

PlaceholderResult
{CurrentDate}15.06.2024
{CurrentTime}21:15:07
{Calc(35+7)}42
{MD5(Broadcast Suite)}f7f4c00025d600f9e51113f3b12ca8ed
{ProductNameWithCompany}SLG Broadcast Suite
{ProductNameWithVersion}SLG Broadcast Suite 2024.3

Item Placeholders​

Item placeholders grant access to item data.
See a full list of all item placeholders here: Item Placeholders

Static Placeholders​

Static placeholders can be created by yourself.
For example, to use as Recipients in the E-Mail Action.
These placeholders are loaded by the core at startup and then remain static until the configuration is reloaded.

Dynamic Placeholders​

Dynamic placeholders can be created by yourself.
In contrast to static placeholders, the value for these placeholders can be updated with the Placeholder Updater Action.

Placeholder Generator​

It is possible to access any value of an action, device, event or trigger.
Create a new placeholder and use the Generate button to create the value to the item.
As default CurrentValue is used, but you can change this to any property of an item.

Item Value​

Supported Item Types: Device, Trigger, Action, Event

Syntax:
{PhGenerator.ItemType.ItemId.PropertyName}
Example:
{PhGenerator.Device.0cfb80f5-1449-4ea6-af03-11b330c0e7b3.Name}

Values for Placeholder​

Supported Item Types: Trigger

Syntax:
{PhGenerator.ItemType.ItemId.ValuesForPlaceholder.ValueName}
Example:
{PhGenerator.Trigger.c95184ec-7163-458e-a0e4-a5947f073763.ValuesForPlaceholder.CurrentValue}

Parameter Values​

Supported Item Types: Trigger

Syntax:
{PhGenerator.ItemType.Parameter.ParameterId.Value}
Example:
{PhGenerator.Trigger.Parameter.fbb21a9d-3243-42a7-96b0-326c06e3d0ad.Value}

Forbidden Characters​

The following characters are not allowed inside a placeholder:

  • "
  • '
  • :
  • =
  • {
  • }