8.2.5 Retrieving Alarm Data

The GCAMS database contains the following information:

• A list, by call control library, of all the boards that are currently open
• Information about each opened board, including the board name, the call control library ID, all open time slots on the board, alarm source objects associated with the device, and the alarm callback procedure
• A list of registered alarm source objects and their attributes. (Alarm source objects are registered automatically when the gc_Start( ) function is called.)
• Default alarm source object data (provided by GCAMS)

8.2.5.1 Alarm Numbers and Names

Alarm events are identified in the database by name and number. The following functions are used to retrieve the names, numbers and IDs and to convert them from one to the other:

gc_AlarmName( )

converts the alarm name to English, for a given event. Alarm names are assigned by the developer for use in report generation.

gc_AlarmNumber( )

retrieves the alarm number, for a given event. Alarm numbers (values) are predefined for a given ASO. See the Global Call API Library Reference for ASOs that are common to multiple call control libraries.

gc_AlarmNumberToName( )

converts the alarm number to the English name

8.2.5.2 Alarm Source Object IDs and Names

Alarm source objects (ASOs) are identified in the GCAMS database by the ASO ID and by the ASO name. ASOs that are not part of a call control library have predefined names, as provided in the Global Call API Library Reference. The names of ASOs that are part of a call control library are provided in the appropriate Global Call Technology User's Guide.

The following functions are used to retrieve ASO names and IDs and to convert them from one to the other:

gc_AlarmSourceObjectID( )

retrieves the alarm source object ID, for a given event

gc_AlarmSourceObjectIDToName( )

converts an alarm source object ID

gc_AlarmSourceObjectName( )

retrieves the alarm source object name, for a given event

gc_AlarmSourceObjectNameToID( )

converts the alarm source object name to the alarm source object ID

Note: GCAMS uses predefined IDs for the ASOs it has implemented, however it is recommended that applications use the gc_AlarmSourceObjectNameToID( ) function to associate the ASO name with an ID rather than using the ID directly. This allows for more flexible applications if ASOs that reside in call control libraries and have dynamically assigned IDs are added to the application.

In addition, the following functions are used to obtain additional information about the ASOs:

gc_GetAlarmSourceObjectList( )

gets all ASOs associated with a line device

gc_GetAlarmSourceObjectNetworkID( )

gets the network ID associated with a line device.

For more information on these functions, see the individual function descriptions in the Global Call API Library Reference.

Click here to contact Telecom Support Resources