Actions

Overview

Actions can be viewed as outputs and can be executed either via events or panels.

Base Parameters

Each action has the following base parameters:

Parameter	Description
Name	Name to identify this model
Action Type	Type to decide which parameters are needed
Enabled	Indicates if the model is enabled
Category	The associated category
Description	Additional description
Execute as Primary Only	If enabled, this Action will only be executed when the NodeState of this node is Primary
Initial Status	Status which is used after initialization
Logging	If enabled, this item will create log entries
Last Execution	The date and time when this Action was last executed
Last Successful Execution	The date and time when this Action was last successfully executed
Occurrences	Number of times this item has occurred
Retry Count	Amount of retries in case of an error when executing this Action
Retry If Failed	If enabled, this Action will be executed again in case of an error
Retry Interval	Interval between retries in case of an error when executing this Action In seconds
Sequence Number	The unique sequence ID of this item. Used for the Ember+ provider OID.
Status Code	The current status code
Status Message	The current status message
Status	The current status
Substitution Table	The associated Substitution Table

Output

After an action has been executed, the result can be viewed in the History section of the action detail.
The table provides a brief overview of whether the action was executed successfully or not.

Timestamp	Log Value	Details

Detail Output

More detailed information about the execution can be obtained by clicking on the detail icon.
This will show the following sections as JSON.

Info

The Info section contains static information about the action, that do not change with each execution.
These values will be collected when the action is initialized.

Execution

The Execution section contains information about the execution result.
For example, the action result, the response from a request or the output from a script.

Parameters

The Parameters section contains the parameter values that are used to execute the action.
If a parameter value contains a placeholder, then here the replaced value will be available.

info

If a placeholder could not be replaced, then the delimiters will be removed and the raw placeholder remains.

Original Parameters

The OriginalParameters section contains the parameter values that are configured on the action.
If a parameter value contains a placeholder, then here the original, non-replaced value will be available.

Execution Source

The ExecutionSource section contains the information from where the action was executed.

Action Runner

The ActionRunner section contains the information which runner was used to execute the action.
For example, this could be the local runner, when the action was executed on the local core or the agent runner, when the action was executed on an agent.

Audio Recording

Records audio from an audio input.

Parameter	Description
Audio Input
Command

info

Requires the Audio add-on.

The following Commands are currently supported:

• Start
• Stop

Bionic Studio GPIO

Change a GPI on a Bionic Studio server.

Parameter	Description
Device	Associated Bionic Studio Server Generic Device
Destination Port	UDP Destination Port Must match the Bionic Studio configuration
Source Port	UDP Source Port Must match the Bionic Studio configuration
GPI Number
GPI Value	If Follow Event Status is selected, the event status (on / off) will be used as value

The following GPI Values are currently supported:

• True
• False
• Follow Event Status

Codec Control

Allows to control a wide range of audio codecs using the DCM modules from DSA Volgmann.

Parameter	Description	Supports Placeholders
Command
Codec	Codec Device
Number	SIP URI / phone number Required if command Connect is selected	✔️
Profile	Mode Number Required if command Connect is selected	✔️

The following Commands are currently supported:

• Connect
• Disconnect
• Answer

DHD Logic State

Allow to set the state of DHD logic elements via the ECP protocol.

Parameter	Description	Supports Placeholders
Device	DHD Mixing Console Device
Logic ID	ID of the DHD logic element (can be found in DHD ToolBox)	✔️
Logic State	The logic state to set true/false	✔️

DMS

Allows to send commands to Lawo Radio Consoles using the DMS / VisTool protocol.

Parameter	Description	Supports Placeholders
Device	Lawo Radio Console Device
Type	Screen Button / Screen Button RGB, depending on your OnAir Designer configuration
Slot	Screen Button Slot	✔️
Key	Screen Button Key	✔️
Value	1 = press, 0 = release	✔️

The following Types are currently supported:

• Screen Button
• Screen Button RGB
• Surface Button

DMX Scene

Allows to load DMX scenes using IP-based DMX controllers (Sunlite / ProLED / Nicolaudie devices).

Parameter	Description	Supports Placeholders
Device	DMX Controller Generic Device
Device Edition
Scene Index	Zero-based scene number within the DMX configuration	✔️
Page Index	Subpage within the scene Zero-based. Required if device edition SIUDI7 is selected	✔️
Command	Command to send
Value	Command value (0 - 1000) or hexadecimal RGB value for scene color set (e.g. #FF0000 for red)	✔️

The following Device Editions are currently supported:

• SIUDI7
• SIUDI11A

The following Commands are currently supported:

• Scene Color Set
• Scene Dimmer Set
• Scene On
• Scene Speed Set

DStar

Allows the control (pan / tilt / zoom / focus) of BR Remote uL camera heads.

Parameter	Description	Supports Placeholders
Device	Generic Device
Camera ID
Command
Pan	Value 0 - 126 = left, 128 - 255 = right. The bigger the offset from the middle (127), the higher the speed. 127 means no change. Moves left or right. Required if command Normal Move is selected.	✔️
Tilt	Value 0 - 126 = up, 128 - 255 = down. The bigger the offset from the middle (127), the higher the speed. 127 means no change. Moves up or down. Required if command Normal Move is selected.	✔️
Zoom	Sub Index Required if command Normal Move is selected	✔️
Focus / Preset Number	Sub Index Value	✔️

The following Commands are currently supported:

• Load Preset
• Normal Move
• Store Preset

E-Mail

Sends notifications to one or more recipients via SMTP.
It uses the global SMTP server settings.

Parameter	Description	Supports Placeholders
Recipients	Recipient of the e-mail You can add multiple addresses comma-separated	✔️
Subject	Subject of the message	✔️
Body	Body of the message	✔️
Use HTML	If enabled, HTML can be used in the Body.
Priority	Message priority

info

Before you can use this action, you need to configure an SMTP Server in the E-Mail settings.

The following Priorities are currently supported:

• low
• normal
• high

Ember+ Function

Parameter	Description	Supports Placeholders
Device	Generic Ember+ Device
Ember Path
Arguments	As JSON	✔️
Parameter OID	Object Identifier (OID) of parameter. Will be populated automatically if field is left empty.

Ember+ GPIO

Sets an Ember+ GPI of the given provider. The value will be set to the current status of the event.

Parameter	Description
Device	Generic Ember+ Device
GPIO Node Name	Name of the Ember+ GPIO element as shown in TinyEmber or Lawo configuration
GPI Number
Pulse
Parameter OID	Object Identifier (OID) of parameter. Will be populated automatically if field is left empty.

Ember+ Matrix

Sets crosspoints in an Ember+ matrix

Parameter	Description	Supports Placeholders
Device	Generic Ember+ Device
Ember Path	Path of the Ember+ matrix node
Source ID		✔️
Destination ID		✔️
Channel Count	Channel/crosspoint count
Parameter OID	Object Identifier (OID) of parameter. Will be populated automatically if field is left empty.

tip

The channel count can be used to set multiple crosspoints at once (e.g. for stereo connects). The source and destination ID will automatically increase by one.

Example:

Source ID: 10
Destination ID: 50
Channel Count: 2
Resulting Crosspoints: 10 -> 50 and 11 -> 51

Ember+ Value

Sets any value in a Ember+ device.

Parameter	Description	Supports Placeholders
Device	Generic Ember+ Device
Ember Path
Value		✔️
Use Event Status	If enabled, the event status (on / off) will be used as GPIO value
Parameter OID	Object Identifier (OID) of parameter. Will be populated automatically if field is left empty.

Ember+ Values

Sets multiple values in a Ember+ device.

Parameter	Description
Device	Generic Ember+ Device
Ember+ Values	As JSON
Delay Between Commands	Pause duration between each Ember+ value In milliseconds

tip

You can use the Ember+Viewer to copy the values

File

Creates text-based files. If the file does already exist, it will be replaced.

Parameter	Description	Supports Placeholders
Path	Absolute storage path for the generated file Without filename	✔️
Filename	Filename including extension (e.g. file.txt)	✔️
Encoding
Content		✔️
Append to File	If disabled, the content of the file is replaced every time

UNC paths are supported, but without authentication

If the destination path requires authentication, the Broadcast Suite Core service needs be run as domain user with appropriate rights.

The following Encodings are currently supported:

• ASCII (7-bit character set)
• EBU
• UTF-16 (Big Endian Byte Order)
• UTF-16 (Little Endian Byte Order)
• UTF-32 (Big Endian Byte Order)
• UTF-32 (Little Endian Byte Order)
• UTF-8

Agent Action

The file action can be executed on an agent.

G&D KVM Crosspoint

Allows to control Guntermann & Drunck KVM matrices.

Parameter	Description	Supports Placeholders
Device	The associated KVM device Generic Device
Console Name	Console unit name	✔️
CPU Name	CPU unit name	✔️

HTTP Request

Sends an HTTP Request which can be used to send content to external systems or web services

Parameter	Description	Supports Placeholders
Device	API Device
Request Method
Request URI		✔️
Content Type	The content type used in the HTTP header
Request Body		✔️
Check for successful response	If enabled, the action only receives the status Execution successful when it has received a successful response code (2XX).

info

Depending on your network architecture, you might need to configure a proxy server before you can use this action.

The following Request Methods are currently supported:

• GET
• POST
• PUT
• PATCH
• DELETE

The following Content Types are currently supported:

• application/json
• application/vnd.api+json
• application/xml
• application/x-www-form-urlencoded
• text/html
• text/plain
• text/xml

IHSE Crosspoint

Sends one or multiple crosspoints to IHSE KVM matrices (draco series).

Parameter	Description	Supports Placeholders
Device	IHSE KVM matrix IHSE KVM Matrix Device
Crosspoints	Source (left) and destination (right), including prefix (CON_ / CPU_). Example: CON_1003:CPU_3003 One crosspoint per line	✔️

IHSE Macro

Allows to set IHSE KVM macros.

Parameter	Description	Supports Placeholders
Device	IHSE KVM Matrix Device
Macro Key		✔️
Console ID	Prefix CON_ is optional	✔️
User ID	0 = Disable User ID (Use Matrix Macros)	✔️

KPF Crosspoint

Allows to set KPF crosspoints in Lawo Radio OnAir products.

Parameter	Description	Supports Placeholders
Device	KPF matrix Generic Device
Source ID	Use 0 to mute/disconnect KPF Source ID	✔️
Destination ID	KPF Destination ID	✔️
Channel Count	Channel Count (1 - 8) If this value is higher than 1, multiple crosspoints with incremental source / destination IDs are set.	✔️

Livewire GPIO

Sets a GPO of an Axia xNode to the status of the associated event.

Parameter	Description
Device	GPIO device Generic Device (with authentication) Device
GPO Port Number
GPO Pin Number

Load Preset

Allows to load a Preset.
Will execute all actions in the preset for the matching area.

Parameter	Description	Supports Placeholders
Preset	The preset with the actions to execute Select a preset or use a preset ID. Supports Placeholders.	✔️
Area	The area to use for the preset Select an area or use an area ID. Supports Placeholders.	✔️

Load Snapshot

Loads a Select-a-Line Snapshot.

Parameter	Description
Snapshot
Override Existing Return Line

info

Requires the Select-a-Line add-on.

Log

Add custom log entries to the Core log.
Can be used to find certain triggers and events more efficiently

Parameter	Description	Supports Placeholders
Log Message		✔️
Log Level

The following Log Levels are currently supported:

• Trace
• Debug
• Info
• Warn
• Error
• Fatal
• Off

Agent Action

The log action can be executed on an agent.

Marshall Switcher

Allows to control Marshall VMV-402-SH MultiViewers.

Parameter	Description	Supports Placeholders
Device	Generic Device
Command
Value	Byte value	✔️

The following Commands are currently supported:

• Show Quad View
• Switch Input

Modbus TCP

Allows to write coils and registers using ModbusTCP.

Parameter	Description	Supports Placeholders
Device	Modbus Device
Function Code
Address	Starts at 1
Value		✔️

The following Function Codes are currently supported:

• Write Single Coil
• Write Single Register

MQTT

Allows sending of MQTT messages.

Parameter	Description	Supports Placeholders
Device	MQTT Device
Topic	Topic for the MQTT message	✔️
Value	Value to send	✔️
Retain	Asks the broker to store the last message for the given topic

Node State

Allows you to set the node state on the current core.

Parameter	Description
Node State	Node state to set on the Broadcast Suite Core

The following Node States are currently supported:

• Primary
• Secondary

License

The Node State action does not count towards the license limit.

OSC

Allows sending of OSC messages via UDP.

Parameter	Description	Supports Placeholders
Device	Target device Generic Device
OSC Path		✔️
Value	Value to send	✔️
Local Port	OSC source port
Data Type	Type of the value to send

The following Data Types are currently supported:

• Boolean
• Float
• Integer
• String

Placeholder Updater

Updates the ReplacementValue of the specified Placeholder.

Parameter	Description	Supports Placeholders
Placeholder	Placeholder to update Dynamic Placeholder
Replacement Value	Value which should be set on the Placeholder	✔️

RDS

Allows to send a command to an RDS Encoder.

Parameter	Description	Supports Placeholders
Device	RDS Encoder Device
Command	Command to use
Value	Value to send	✔️

The following Commands are currently supported:

• Programme Type (PTY)
• Radio Text (RT)
• Traffic Announcement (TA)

Remote Trigger

Allows you to set the status and current value of a trigger from type Remote Trigger on an external Broadcast Suite instance.

Parameter	Description	Supports Placeholders
Remote Broadcast Suite	Device, which represents the remote Broadcast Suite Broadcast Suite Device
Remote Trigger ID	The ID which is specified as Remote Trigger ID parameter on the Remote Trigger on the external Broadcast Suite instance.
Remote Trigger Status	Status, which should be set on the Remote Trigger
Remote Trigger Value	Value, which should be set on the Remote Trigger	✔️

The following Remote Trigger Status are currently supported:

• No State
• Off
• On
• Failed
• Initialized
• Not Initialized
• Initialization failed
• Disabled
• Paused
• Locked
• Connecting
• Connected
• Connection failed
• Timeout
• Disconnecting
• Disconnected
• Not executed
• Execution successful
• Execution failed
• Partially executed

License

The Remote Trigger action does not count towards the license limit.

RS-232

Sends a series of commands to a COM port.

Parameter	Description	Supports Placeholders
COM Port	Name of the serial port, e.g. COM1
Baud Rate	Serial baud rate
Data Bits	Amount of data bits
Stop Bits	Number of stop bits per byte
Parity	Parity configuration
Commands	After each command, a line break (\r\n) is being sent to the serial port. One command per line	✔️
Interval	Waiting time before sending the next command In milliseconds

The following Baud Rates are currently supported:

• 2400
• 4800
• 9600
• 19200

The following Stop Bits are currently supported:

• 1
• 1.5
• 2

The following Paritys are currently supported:

• None
• Even
• Odd

Script

Allows to execute different scripts.

Parameter	Description	Supports Placeholders
Script Type
Script Content		✔️

IMPORTANT

Please note that these scripts are being executed as the same user as Broadcast Suite Core. On Windows systems, this is usually Local System.
For Linux installations, you can configure the Shell Path in the Core settings.

The following Script Types are currently supported:

• Batch Script (.bat)
• PowerShell (.ps1)
• Shell (.sh)
• VB-Script (.vbs)

Agent Action

The script action can be executed on an agent.

Skaarhoj Panel

Allows to send a command to a Skaarhoj panel.

Parameter	Description	Supports Placeholders
Device	Skaarhoj Panel Device
Command	Command to send	✔️

SMS

Sends SMS messages to one or more recipients using Twilio.

Parameter	Description	Supports Placeholders
Recipients	List of message recipient numbers The number must start with +. You can add multiple recipients comma-separated (e.g. +41 76 123 45 67, +41761112233).	✔️
Message	Message to send	✔️

info

Before you can use this action, you need to set the
Twilio API Key SID in the API Keys settings,
Twilio API Key SID Secret in the API Keys settings,
Twilio Account SID in the API Keys settings and
Twilio Messaging Service SID in the API Keys settings.

SNMP

Allows to send SNMP TRAP and SNMP SET requests with various data types to a specified endpoint.

Parameter	Description	Supports Placeholders
Command	SNMP Command Type
Data Type	SNMP Data Type
Destination Address		✔️
Destination Port
OID	Object Identifier You may also use 1.3.6.1.4.1.38083.111 and children of this OID	✔️
Value	Value to send	✔️
Community String	SNMP community string	✔️

The following Commands are currently supported:

• SNMP SET
• SNMP TRAP

The following Data Types are currently supported:

• Counter32
• Counter64
• Gauge32
• Int32
• Octet String
• Time Ticks

Sound4 Preset

Allows to control the OnAir presets of Sound4 BigVoice voice processors.

Parameter	Description	Supports Placeholders
Device	Sound4 Device
Channel Number	Usually 1 or 2	✔️
Preset Reference Mode
Preset	Preset name or ID, depending on the preset reference mode.	✔️

The following Preset Reference Modes are currently supported:

• ID
• Name

TCP

Allows to connect to the configured destination over TCP and send messages.
Optionally, the response can be verified.

Parameter	Description	Supports Placeholders
Destination Address	Destination Endpoint
Destination Port	TCP Destination Port
Payload	Content to send	✔️
Payload Type	Payload and response encoding
Verify Response	If enabled, the action waits for a response after sending the TCP message
Expected Response	If no response has been received or if the response does not match, the action will have the status Execution failed. Required if Verify Response is enabled	✔️
Expected Response Operand	Required if Verify Response is enabled. If regex is selected, the Expected Response will not be replaced with placeholders.
Response Timeout	Time to wait for response, if Verify Response is enabled In milliseconds

The following Payload Types are currently supported:

• ASCII
• Byte Array
• UTF-8

The following Response Operands are currently supported:

• equals (=)
• not equal (!=)
• lesser than (<)
• lesser than (<) absolute
• lesser than or equal (<=)
• greater than (>)
• greater than (>) absolute
• greater than or equal (>=)
• contains
• does not contain
• starts with
• ends with
• regex
• empty
• empty or whitespace
• any

Telegram Notification

Sends notifications to one or more recipients using a Telegram bot.
Further information on bots can be found on https://core.telegram.org/bots/api

Parameter	Description	Supports Placeholders
Recipients	List of message recipient user- or group IDs You can add multiple recipients comma-separated (e.g. 1234, 5678). Find your Telegram ID under https://t.me/my_id_bot.	✔️
Message	Message to send	✔️

info

Before you can use this action, you need to set the Telegram API Key in the API Keys settings.

Telnet

Allows to send commands to a telnet device.

Parameter	Description	Supports Placeholders
Device	Generic Device, Telnet Device or Sound4 Device
Commands	Commands to send One command per line	✔️
Interval	After each command, the action pauses for the configured amount of time Pause between each command. In milliseconds.
Expected Response	The expected response for the Commands. If the response contains this value, the action has the status "Execution successful". Leave empty if no response is expected

UDP

Allows to send UDP telegrams.

Parameter	Description	Supports Placeholders
Device	Destination Endpoint Generic Device
Destination Port	UDP Destination Port If no port is specified here, the port of the device is used
Source Port	UDP Source Port
Payload	The content to send	✔️
Payload Type	Payload encoding

The following Payload Types are currently supported:

• ASCII
• Byte Array
• UTF-8

Videohub Crosspoint

Parameter	Description	Supports Placeholders
Device	Blackmagic Design Videohub Device
Crosspoints	One crosspoint per line. Format: Source:Destination	✔️

vMix

Parameter	Description	Supports Placeholders
Device	API Device
Function	As described in the vMix API documentation
Value	Depends on the function, please refer to the vMix API documentation	✔️
Input	Input as number (starting from 1), name or GUID	✔️
Selected Name	Only required for title or XAML inputs	✔️

The following Functions are currently supported:

• Active Input
• Add Input
• Layer On
• Layer Off
• Layer On/Off
• List Add
• Next Item
• Open Preset
• Overlay 1 In
• Overlay 1 Out
• Overlay 1 Off
• Overlay 2 In
• Overlay 2 Out
• Overlay 2 Off
• Overlay 3 In
• Overlay 3 Out
• Overlay 3 Off
• Overlay 4 In
• Overlay 4 Out
• Overlay 4 Off
• Play
• Previous Item
• Script Start
• Script Stop
• Pause
• Set Countdown
• Set Image
• Set Layer
• Set Text
• Start Countdown
• Start MultiCorder
• Start Recording
• Start Streaming
• Stop Countdown
• Stop MultiCorder
• Stop Recording
• Stop Streaming

WebSocket

Sends a WebSocket message.

Parameter	Description	Supports Placeholders
Device	WebSocket Device
Socket Address	If the address does not start with ws, the hostname and port from the device is used WebSocket URI (e.g. ws://127.0.0.1/socket)
Message	Text message to be sent	✔️

WhatsApp

Send WhatsApp messages via the WhatsApp Business Cloud API.

Parameter	Description	Supports Placeholders
WhatsApp Device	WhatsApp Device
Recipients	Recipient of the WhatsApp message the E.164 format without + (e.g. 41441234567) You can add multiple recipients comma-separated	✔️
Message	Supports Markdown format	✔️

info

This requires an activated WhatsApp Business account.