Software development kit (SDK) example

The Software Development Kit (SDK) example below provides you with both sample code that subscribes to a system alarm PubSub topic and a new Application Programming Interface (API) which, once called, generates the alarm after the system updates it.

The third-party application can subscribe to either a single or a |*| PubSub topic.

Single PubSub Topic

<system name>.realtime.systemalarm.notification.<topic>

Where:

• <system name> is the name of the current system that generated the system alarm.

• <topic> is configured by the Administrator.

|*| PubSub Topic

<system name>.realtime.systemalarm.notification.|*|

Where:

• <system name> is the name of the current system that generated the system alarm.

• Optional: |*| indicates that the third-party application will subscribe all configured system alarm PubSub topics that have a configured key topic.

  Note: The system will not publish the default <system name>.realtime.systemalarm.notification topic with the wildcard subscription if <topic> is left blank.

AlarmMessageInfo

The buffer received from the PubSub callback contains the AlarmMessageInfo data. With this information, the third-party application can update the data and then call the new UpdateSystemAlarm API to generate the updated alarm.