Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional stateChange fields if needed



newState

invalid

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

New state of the entity: 'inService', 'maintenance', 'outOfService'



OldState

invalid

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Previous state of the entity: 'inService', 'maintenance', 'outOfService'



stateChangeFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



stateInterface

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Card or port name of the entity that changed state



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information.

reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem.   Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event.

reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity   Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information.

UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event.

Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…).   For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received).

the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

schemaReference

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: true

·   valueRange:  no range constraint

·   support:
OPTIONAL

An uri of a standards-defined JSON object schema; used to valide the stndDefinedFields.data property contents



data

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

A native standards-defined JSON notification



stndDefinedFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the stndDefinedFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information.

reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem.   Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event.

reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity   Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information.

UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event.

Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…).   For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received).

the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received)



stndDefinedNamespaceString0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Standards organization defined event namespace; expected usage includes event routing by the event listener

timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...