VxPro: Create event pop-up banner in VxOpsCenter from Vx ASCII translator trigger

Issue

  • How to create an alarm with an event banner popup in VideoXpert from an ASCII trigger.

Product Line

Pelco Video Management

Environment

  • VideoXpert
  • VideoXpert Professional
    • VxPro v2.5.0.112 or greater
    • VxOpsCenter (OCC)
  • ASCIIVxTranslatorService v2.2.2.0 or greater

Cause

ASCII alarms sent from Access Control system.

Resolution

 

  1. Configure the ASCII Translator Service using the following article: VideoXpert: ASCII / PLC Setup  
    Make sure to fully read through and follow the setup article.

     
  2. The following .XML files will need to be renamed for use, recommend making a copy and then renaming the copy.

    Rename the following for use:
    defaultAlarmConfiguration.xml >to> AlarmConfiguration.xml
    defaultCustomSituations.xml >to> CustomSituations.xml

     
  3. Anytime you make changes to data in the .XML files, you will need to close and then re-launch the ASCIIVxTranslatorService.exe console for testing.

    Open Windows Explorer and navigate to 'C:\Program Files (x86)\PelcoASCIIVxTranslatorService" > double click on ASCIIVxTranslatorService.exe to open the console.

         Note: Console will not run if the ASCII Vx Translator Service is running.  It is either one or the other, use the console for testing but the service is started and used for a production system.
     
  4. Configure the Alarms using the AlarmConfiguration.XML

    Recommend using a utility like Notepad++ to edit the XML files.

    Default AlarmConfiguration.XML file, only Alarm 1 is preconfigured with default information:




    *Friendly name for the alarm


    *Number associated to the alarm, this number will be referenced in the ASCII string to trigger.  Each additional alarm would need to sequence the number...e.g. 2,3,4,5...etc.


    *Id of the device associated to the alarm, it is recommended to leave at the default "USE_INTEGRATION_ID".  Will use the integration ID which is auto assigned by the Core/Pro Server.  This is not how to associate a data source.


    *AlarmState is either 1 or 0 for ON/OFF respectively, '1' = Alarm_active
    *Type: Is the Situation Type.  References the matching Situation in the CustomSituations.xml file.  You can have multiple alarm entries reference the same Situation or create individual Situations per alarm.  Think of the Situation as the Event Type which gets injected into the Events tab (VxToolbox / Admin Portal).



    *Properties are Key/Value pairs - Property keys for pre-defined Situation types are pre-defined and must not be changed. External situations allow for adding any user-defined properties that are desired.

    This specific 'Property' is an example and does not need to be configured, because this is an example you can edit this 'Property' to add a data source id (link a camera / video).

    To associate a data source to the alarm (Camera/Video)
    - Key = data_source_id
    - Value = uuid:xxxxxxxxxxxxx:video
    (the data source uuid listed for the camera in OpsCenter)

    Example:



    Optional - Add another Property to include the data_source_name.
    - Key = data_source_name
    - Value = FrontOffice
    (the data source name associated to the camera)





    *Edit the 'Value' to the friendly name of the alarm.



    *Used to execute an associated script.  These elements can be removed if there are no scripts to execute.



    *The inactive (OFF) alarm state and associated situation type.



    Example with 3 Alarms configured in the AlarmConfiguration.XML





    NOTE:  Notice that the Situation Type has an added number, this is so we can create multiple and reference the Situations in the CustomSituations.xml file.


    Example of 3 custom Situations in the CustomSituation.xml called by the alarms in the AlarmConfiguration.xml





    Note: Log, Notify, DisplayBanner, Audible and AckNeeded are all Boolean (0 or 1).  Severity is an integer from 1 -10 (Configured for 1 in this file = 10 in VxToolbox, 3 = 7...ect).
    AutoAcknowledge is an integer of seconds.  Make sure the AutoAcknowledge is not set to '0', this will result in no alarm pop-up even if DisplayBanner =1.

     
  5. Run the ASCIIVxTranslatorServer.exe console to inject the 'Situations' into VideoXpert.
     
  6. In VxToolbox, navigate to the Events tab and then filter by the Category: External.  Verify the custom situations have been injected.



     
  7. Right-click on the Events and select Event Notification Settings. The Pop-up is already enabled but in order to function you must assign a user role.




    *If you would like to change configuration options which are defined in the CustomSituations.xml file like Severity, DisplayBanner, Audible...ect, you will need to change them in the xml file or they will be overwritten the next time the ASCIIVxTranslator service is restarted.

     
  8. Using the console, manually trigger the alarm to test. 

    Type cmd and then the alarm ASCII string

    To trigger Alarm1 (using default commands)  type in cmd 1Ea , Alarm2 would be cmd 2Ea ..etc.



     
  9. Verify the Event Banner pop-up is displayed in VxOpsCenter.







    With a data_source_id linked you should be able to double-click the banner to start video playback.

     
  10. Close the console and then start the ASCII Vx Translator Service.  Verify alarms are triggering properly using the production equipment and configuration.