Campaign Manager Trigger Controller

About Campaign Manager Trigger Controller

The Campaign Manager Trigger Controller is a part of the Ryarc Software used for triggering a campaign using a code that is related to that specific campaign. It can be triggered manually at any time, and it will interrupt other campaigns that are already playing, by selecting an option in the ‘Settings’ of the campaign.



Setting up the Campaign Manager Trigger Controller

Create a campaign, and add the media that you want to be displayed on the player once the trigger code is fired. Set up the wanted settings in the ‘What’, ‘When’ and ‘Where’ section and then go to the ‘Settings’ section.

Here, verify the ‘Campaign Details’ part:



Select the ‘Use trigger’ checkbox. Enter the wanted code (ex: ‘123’) that you will later use in the Trigger Controller, and also select the ‘Interrupt other campaigns immediately:’ checkbox.



Save, and publish the campaign. Go to ‘Channels’ create the Player Configuration File and open it.

Go to ‘General Settings’ – ‘Network Settings’ and verify the ‘Connection Settings’ part.



Here, select the ‘Enable external trigger events’ check box and verify the ‘Trigger port:’ field. This port will later be used in the Trigger Controller.

Run the diagnostics, and once they are passed you can start the player. The player plays the Ryarc Logo (Idle File) even though the campaign is published, because it is waiting for the trigger to be fired.



Verify the UI of the Trigger Controller:

Under ‘File’ there are the ‘New’, ‘Open’, ‘Save’, Save As’ and ‘Exit’ options. They can be used to save the data to a .rtl file, also open a previously created .rtl file. Below, the ‘CM Protocol6’ is chosen by default. In the ‘Choose a device’ section under the ‘Input a port number’ field you should enter the port number from the Player Configuration File as previously stated. Next, you should enter the IP address of the player (it can be found in the ‘Devices’ entity of the CM Service) and click on ‘Add’.



After clicking ‘Add’ the IP address will be added to the ‘Target Hosts’ list. If you want to delete it, you can do so by selecting the IP address and clicking on ‘Remove’.

Verify the ‘Choose an action’ section. Here are the ‘Manage Trigger’ and ‘XML Format’ tabs. Under ‘Manage Trigger’ is the field used to enter the code we previously mentioned in the ‘Settings’ of the campaign. By clicking on ‘Add’ the code will be added to the ’Target Trigger Codes’ list below. Same as for the hosts, by selecting the code, and clicking on ‘Remove’ it will be removed from the list.



Select the ‘XML Format’ tab and verify it. Firstly, before adding the codes, this tab will be empty.



After successfully adding a code, and selecting it, the ‘XML Format’ tab will display the XML code.



Note that this XML format is for each individual trigger code. Also, here are the ‘Export XML’ button which can be used to export this code to a XML file, and the ‘Refresh’ button.

Triggering the code

After successfully adding the proper host and code, in order to fire a trigger to the player, you need to select the host and the code and then click on the ‘Trigger’ button.



Once the trigger is fired, verify the 'Status' section, in which you can see the details about the trigger: time, description



Now, notice that the media from the campaign plays on the player. Once it finishes, the player continues playing other non-trigger campaigns, or the Ryarc logo (Idle file) if it is the only published campaign. The user can fire triggers at any desired time, and the player will play that media.

There are also other ways to use the Trigger Controller such as using the Dappler to play audio files, trigger the campaigns using a Barcode Scanner or Ryarc Mobile. Note that all of these options need to be properly set up.