API Message Reference

EN - Enumerate Notifications

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose Request to Enumerate Notifications.
Example EN\TXABC001\TDtenant1\FA\SE4
Explanation The control application is requesting that notifications for all Warnings and Errors be sent to it.
Notes

CallGem responds to this message by issuing Notify Event [NE] messages each time an event occurs which is of the severity specified in the SE parameter. CallGem maintains a cache of notifications for the last running hour.

For an overview of the query process, see Resource Enumeration API

From V10.6.263 there is a change to Enumeration behaviour when using the PersistToken (PS) parameter - see Resource Enumeration API.

Last Changed V9.2.0.40
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CS RateControl string false 1 1000000 From V10.6.660 - The number of event messages per second that the subscriber can handle during rollforward after re-subscribing. Defaults to 100 (per PersistToken). See Resource Enumeration API.
FA Facility string true 1 80 The application to which the message applies e.g. AlertMon, Scheduler, Scripter
PS PersistToken string false 1 80 Persist token. This tells CallGem to persist this transaction even if the socket connection from the originator fails. The transaction will buffer events in anticipation of reconnect and re-issue of the transaction.
SE Severity int true 1 4 The Severity of the event:
1Notification
2Warning
3Error
4Fatal Error
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter
TS TimeStamp string false 1 50 This parameter follows the Windows OLE Automation date format. When sent in the EN message it indicates the earliest time for which the application wants to register for events. The value should be in local time, not UTC. CallGem keeps a history of call cycle events in memory for one hour to facilitate failover recovery.
TX TransactionIdentifier string true 1 87 Transaction Identifier parameter

 

Copyright © 2004 - 2019  Sytel Limited