3 TMF 642 Alarm Events and Definitions
This chapter provides information on TMF 642 alarm events.
The Process TMF 642 alarm events provide an event-driven architecture for creating, updating, and deleting alarm and threshold crossing alarms on devices maintained by ATA.
The TMF 642 alarms events are listed here and are available as Kafka message in the ora-alarm-topology topic.
TMF 642 Alarm
This section provides the list of TMF 642 Alarm events.
AlarmCreateEvent
The following table provides the AlarmCreateEvent event details and the corresponding values:
Table 3-1 AlarmCreateEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 AlarmCreateEvent message |
| Message Header (with Examples) | eventType: “AlarmCreateEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "AlarmCreateEvent",
"event": {
"alarm": {
"@type": "OracleAlarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
{
"@type": "ServiceRef",
"id": "OT_EQUIPMENT"
}
],
"alarmChangedTime": "2024-06-19T09:45:26.495Z",
"alarmDetails": "Details in string format",
"alarmedObject": {
"@referredType": "",
"@type": "AlarmedObjectRef",
"id": "ARLN02TXAW.P01:MS_BG-40_81/51118",
"name": ""
},
"alarmedObjectType": "",
"alarmEscalation": true,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-06-19T05:41:02.000Z",
"alarmType": "processingErrorAlarm",
"comment": [
{
"@type": "Comment",
"comment": "Manual: Event List Edit (API)"
}
],
"customAttributes": [
{
"name": "Category",
"type": "",
"value": "category"
},
{
"name": "TestEventField",
"type": "",
"value": "End-to-end-UA-UIM Test Field Value"
},
{
"name": "SubCategory",
"type": "",
"value": "sub-category"
}
],
"externalAlarmId": "3743573",
"id": "3456",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "major",
"place": [
{
"@type": "RelatedPlace",
"name": ""
}
],
"probableCause": "ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "",
"state": "raised"
}
},
"eventId": "3456",
"eventTime": "2024-07-16T08:53:43.608Z",
"eventType": "AlarmCreateEvent"
}
AlarmAttributeValueChangeEvent
The following table provides the AlarmAttributeValueChangeEvent event details and the corresponding values:
Table 3-2 AlarmAttributeValueChangeEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 AlarmAttributeValueChangeEventmessage |
| Message Header (with Examples) | eventType: “AlarmAttributeValueChangeEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "AlarmAttributeValueChangeEvent",
"event": {
"alarm": {
"@type": "OracleAlarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
{
"@type": "ServiceRef",
"id": "OT_EQUIPMENT"
}
],
"alarmChangedTime": "2024-06-19T09:45:26.495Z",
"alarmDetails": Alarm detials",
"alarmedObject": {
"@referredType": "",
"@type": "AlarmedObjectRef",
"id": "ARLN02TXAW.P01:MS_BG-40_81/51118",
"name": ""
},
"alarmedObjectType": "",
"alarmEscalation": true,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-06-19T05:41:02.000Z",
"alarmType": "processingErrorAlarm",
"comment": [
{
"@type": "Comment",
"comment": "Manual: Event List Edit (API)"
}
],
"customAttributes": [
{
"name": "TestEventField",
"type": "",
"value": "End-to-end-UA-UIM Test Field Value"
}
],
"externalAlarmId": "3743573",
"id": "1234",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "critical",
"place": [
{
"@type": "RelatedPlace",
"name": ""
}
],
"probableCause": "ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "",
"state": "updated"
}
},
"eventId": "1234",
"eventTime": "2024-07-16T09:12:31.544Z",
"eventType": "AlarmAttributeValueChangeEvent"
}
ClearAlarmCreateEvent
The following table provides the ClearAlarmCreateEvent event details and the corresponding values:
Table 3-3 ClearAlarmCreateEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 ClearAlarmCreateEvent message |
| Message Header (with Examples) | eventType: “ClearAlarmCreateEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "ClearAlarmCreateEvent",
"event": {
"clearAlarm": {
"@type": "ClearAlarm",
"alarmClearedTime": "2024-08-08T10:09:25.000Z",
"alarmPattern": [
{
"@type": "AlarmRef",
"id": "421044"
}
],
"clearedAlarm": [
{
"@type": "OracleAlarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
],
"alarmChangedTime": "2024-08-08T10:10:06.648Z",
"alarmDetails": Alarm detials",
"alarmedObject": {
"@referredType": "OT_PHYSICAL_TERMINATION_POINT",
"@type": "AlarmedObjectRef",
"id": "ARLN02TXAW.P01:MS_BG-40_81/51118",
"name": ""
},
"alarmedObjectType": "OT_PHYSICAL_TERMINATION_POINT",
"alarmEscalation": false,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-08-08T10:08:35.000Z",
"alarmType": "processingErrorAlarm",
"comment": [
{
"@type": "Comment",
"comment": "SQL Tool: Clear"
}
],
"externalAlarmId": "3745195",
"id": "1234",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "cleared",
"place": [
],
"probableCause": "ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "ECI_ALARM_UC01 Communication-Fail",
"state": "cleared"
}
],
"clearSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"clearUserId": "admin",
"state": "done"
}
},
"eventId": "1234",
"eventTime": "2024-08-08T10:10:06.673Z",
"eventType": "ClearAlarmCreateEvent"
}
AlarmDeleteEvent
The following table provides the AlarmDeleteEvent event details and the corresponding values:
Table 3-4 AlarmDeleteEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 AlarmDeleteEventmessage |
| Message Header (with Examples) | eventType: “AlarmDeleteEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "AlarmDeleteEvent",
"event": {
"alarm": {
"@type": "Alarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
{
"@type": "ServiceRef",
"id": "OT_EQUIPMENT"
}
],
"alarmChangedTime": "2024-06-19T09:45:26.495Z",
"alarmDetails": “Alarm details”
"alarmedObject": {
"@referredType": "",
"@type": "AlarmedObjectRef",
"id": "ARLN02TXAW.P01:MS_BG-40_81/51118",
"name": ""
},
"alarmedObjectType": "",
"alarmEscalation": true,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-06-19T05:41:02.000Z",
"alarmType": "processingErrorAlarm",
"comment": [
{
"@type": "Comment",
"comment": "DeleteExpired"
}
],
"externalAlarmId": "3743573",
"id": "1234",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "major",
"place": [
{
"@type": "RelatedPlace",
"name": ""
}
],
"probableCause": "ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "",
"state": "updated"
}
},
"eventId": "1234",
"eventTime": "2024-07-16T12:14:22.845Z",
"eventType": "AlarmDeleteEvent"
}
TMF 642 ThresholdCrossing Alarm
This section provides the list of TMF 642 ThresholdCrossing Alarm events.
AlarmCreateEvent
The following table provides the AlarmCreateEvent event details and the corresponding values:
Table 3-5 AlarmCreateEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 AlarmCreateEvent message |
| Message Header (with Examples) | eventType: “AlarmCreateEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "AlarmCreateEvent",
"event": {
"alarm": {
"@type": "OracleAlarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
],
"alarmChangedTime": "2024-08-07T08:29:59.000Z",
"alarmDetails": Alarm details",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"id": "ARLN02TXAW.P01",
"name": ""
},
"alarmedObjectType": "OT_AID",
"alarmEscalation": false,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmType": "qualityOfServiceAlarm",
"comment": [
],
"crossedThresholdInformation": {
"direction": "up",
"granularity": "15min",
"indicatorName": " ECI_TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"indicatorUnit": "",
"observedValue": "-32768.0"
},
"externalAlarmId": "3731539",
"id": "1111",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "minor",
"place": [
],
"probableCause": "ECI_TCA_UC05 LSNEXT_PKTS_ERROR",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "TWM_HIGH",
"state": "raised"
}
},
"eventId": "1111",
"eventTime": "2024-08-07T08:29:59.407Z",
"eventType": "AlarmCreateEvent"
}
AlarmAttributeValueChangeEvent
The following table provides the AlarmAttributeValueChangeEvent event details and the corresponding values:
Table 3-6 AlarmAttributeValueChangeEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 AlarmAttributeValueChangeEventmessage |
| Message Header (with Examples) | eventType: “AlarmAttributeValueChangeEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "AlarmAttributeValueChangeEvent",
"event": {
"alarm": {
"@type": "OracleAlarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
],
"alarmChangedTime": "2024-08-07T08:30:25.000Z",
"alarmDetails": Alarm detials",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"id": "LSN/EMS_XDM_33/9489:73:12295",
"name": ""
},
"alarmedObjectType": "OT_AID",
"alarmEscalation": false,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmType": "qualityOfServiceAlarm",
"comment": [
],
"crossedThresholdInformation": {
"direction": "up",
"granularity": "15min",
"indicatorName": " ECI_TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"indicatorUnit": "",
"observedValue": "-32768.0"
},
"externalAlarmId": "3731539",
"id": "1111",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "major",
"place": [
],
"probableCause": "ECI_TCA_UC05 LSNEXT_PKTS_ERROR",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "TWM_HIGH",
"state": "updated"
}
},
"eventId": "1111",
"eventTime": "2024-08-07T08:30:25.347Z",
"eventType": "AlarmAttributeValueChangeEvent"
}
ClearAlarmCreateEvent
The following table provides the ClearAlarmCreateEvent event details and the corresponding values:
Table 3-7 ClearAlarmCreateEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 ClearAlarmCreateEvent message |
| Message Header (with Examples) | eventType: “ClearAlarmCreateEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "ClearAlarmCreateEvent",
"event": {
"clearAlarm": {
"@type": "ClearAlarm",
"alarmClearedTime": "2024-08-07T08:30:25.000Z",
"alarmPattern": [
{
"@type": "AlarmRef",
"id": "33"
}
],
"clearedAlarm": [
{
"@type": "OracleAlarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
],
"alarmChangedTime": "2024-08-07T08:31:04.742Z",
"alarmDetails": “Alarm Details”,
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"id": "LSN/EMS_XDM_33/9489:73:12295",
"name": ""
},
"alarmedObjectType": "OT_AID",
"alarmEscalation": false,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmType": "qualityOfServiceAlarm",
"comment": [
{
"@type": "Comment",
"comment": "SQL Tool: Clear"
}
],
"crossedThresholdInformation": {
"direction": "up",
"granularity": "15min",
"indicatorName": " ECI_TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"indicatorUnit": "",
"observedValue": "-32768.0"
},
"externalAlarmId": "3731539",
"id": "1111",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "cleared",
"place": [
],
"probableCause": "ECI_TCA_UC05 LSNEXT_PKTS_ERROR",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "TWM_HIGH",
"state": "cleared"
}
],
"clearSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"clearUserId": "admin",
"state": "done"
}
},
"eventId": "1111",
"eventTime": "2024-08-07T08:31:04.767Z",
"eventType": "ClearAlarmCreateEvent"
}
AlarmDeleteEvent
The following table provides the AlarmDeleteEvent event details and the corresponding values:
Table 3-8 AlarmDeleteEvent
| Event Details | Value |
|---|---|
| Summary | TMF 642 AlarmDeleteEventmessage |
| Message Header (with Examples) | eventType: “AlarmDeleteEvent” |
| Topic | ora-alarm-topology |
| Producer | Any Assurance System or Alarm Management System |
| Consumer | ATA |
| URL | Provided during Deployment |
| Schemas | TMF-642 Version 5.0 |
Example Payload:
{
"@type": "AlarmDeleteEvent",
"event": {
"alarm": {
"@type": "Alarm",
"ackState": "unacknowledged",
"ackSystemId": "",
"ackUserId": "",
"affectedService": [
],
"alarmChangedTime": "2024-08-07T08:33:01.567Z",
"alarmDetails": “Alarm detials",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"id": "LSN/EMS_XDM_33/9489:73:12295",
"name": ""
},
"alarmedObjectType": "OT_AID",
"alarmEscalation": false,
"alarmRaisedTime": "",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmType": "qualityOfServiceAlarm",
"comment": [
{
"@type": "Comment",
"comment": "DeleteExpired"
}
],
"crossedThresholdInformation": {
"direction": "up",
"granularity": "15min",
"indicatorName": " ECI_TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"indicatorUnit": "",
"observedValue": "-32768.0"
},
"externalAlarmId": "3731539",
"id": "1111",
"isRootCause": false,
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"perceivedSeverity": "cleared",
"place": [
],
"probableCause": "ECI_ALARM_UC05 Ext-Alm2(Battery Discharge)",
"reportingSystemId": "pg-naparchu1.ua6.gbucdsint02phx.oraclevcn.com",
"serviceAffecting": false,
"specificProblem": "TWM_HIGH",
"state": "updated"
}
},
"eventId": "1111",
"eventTime": "2024-08-07T08:33:01.613Z",
"eventType": "AlarmDeleteEvent"
}