[X-Sign Broadcast] How to send Multimedia interrupts with Raptor API

Index:

1. X-Sign Broadcast Setup

2. X-sign Broadcast Raptor Settings

3. Creating Raptor Configuration
4. Creating All Clear Configuration (Resolved)
5. Testing your Raptor Configurations

[Instructions]

X-Sign Broadcast Setup

1. Confirm that your X-Sign Broadcast Settings app is updated to the latest version.
2. Create a Tag Group within Broadcast that will be the desired endpoint for your Broadcast.
   
   
   
   
3. To assign device(s)to a Tag, select the Tag Group and click Edit tag. Select all the devices that you want to assign to the group and click Confirm.
   
   
   
   
   
   Those devices should now show up under the Tag.
   
   
   
   

X-sign Broadcast Informacast Settings

1. Navigate back to All device > Device Control
   
   
2. Under Emergency Settings
   
   
   
   
   
   1. Provider > Raptor.
   2. Interrupt > ON.
   3. Push Type > API connectors.
   4. Set Text Style Settings.
      
      
      
      
      
      
      
      
      
   5. Picture > Settings > Add. To ensure best quality image that fills the display, use a 3840x2160 resolution image file. Once uploaded, copy the MD5 value to a text file as you'll need this later on. Click OK when done.
      
      
      
      
      
   6. Repeat the process for Audio as above.
      
      
      
      
   7. Endpoint Settings > Add > Select required Tag Group. Copy the Endpoint URL to the same text file as the others as you'll need it later on as well.
      
      
   8. Adjust Play Time and Toggle Important Message (user cannot close broadcast at the board side) as needed.
   9. Scroll down to the bottom and click Apply.
      
      

Creating Raptor Configuration

1. Login to https://admin.icmobile.singlewire.com/.
2. Admin > Configurations and click Add Configuration.
   
   
   
   
   
   
3. Create a Configuration.
   Set Configuration Type > Emergency and Name your Event (this will be your event initiator e.g Test-Scenario-Initiate).
   
   
   
   
   
   
4. Select
   1. Buildings(s) to receive this event.
   2. Emergency Type
   3. Optional Status > Initiated
   4. Payload > 
      
      {
          "background":"45a56aaf1fb61ca520b480e314ca297e",
          "audio":"558f24acbea97ea9b1c368fb9f1da8ee",
          "text":"Emergency Alert from Raptor + BenQ"
      }
      
      Example payload above. The background and audio fields must be filled with the MD5 values of the pictures and audio configured in the Broadcast Emergency settings.
      
      
      
      
      
   5. Click Save.

Creating All Clear Configuration (Resolved)

1. Repeat the steps above to Create a Configuration, but name this one differently to differentiate it from the initiating event configuration. (e.g. Test-Scenario-Resolved). 

2. In the Payload of the Event Configuration, you'll send the parameters for "allClear":"false" instead of the content settings (background/audio/text). Make sure to use the same Endpoint URL as your scenario for the Webhook URL.
   
   
   
   

3. Click Save.

Testing your Raptor Configurations

1. Test Emergency Initiated
   1. Select your Building.
      
      
   2. Confirm your events are Active, then click EMERGENCY.
      
      
      
      
   3. Select your Emergency Type and click Initiate.
      Since we set our Event to Secure (see Creating Raptor Configuration), we want to choose Secure. If your Emergency Type was another option, choose THAT option. 
      
      
      
      
      
   4. Emergency Event should be displayed under Incidents.
      
      
2. Test Emergency Resolved
   1. Click End to end your initiated Emergency Event.
      
      
   2. Confirm ending the Emergency Event.
      
      

If you have any questions or issues with the setup, please reach out to your BenQ representative/contact and they'll be able to assist.