# Class CIM_FormattedIndicationSubscription
extends CIM_IndicationSubscription

A subclass of IndicationSubscription that defines the text formatting of Indication information. The TextFormatOwningEntity, TextFormatID, TextFormat, and TextFormatParameters properties are used to describe a human-readable representation of the Indication as defined by the referenced CIM_IndicationFilter. This representation MAY be used by the CIM_ListenerDestination when the intended consumer of the Indication is human. For example, this format could be used when writing the Indication to a system log or sending an e-mail notification to a system administrator.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_AbstractIndicationSubscription
|
+--CIM_IndicationSubscription
|
+--CIM_FormattedIndicationSubscription

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Association | boolean | true

Description

string

A subclass of IndicationSubscription that defines the text formatting of Indication information. The TextFormatOwningEntity, TextFormatID, TextFormat, and TextFormatParameters properties are used to describe a human-readable representation of the Indication as defined by the referenced CIM_IndicationFilter. This representation MAY be used by the CIM_ListenerDestination when the intended consumer of the Indication is human. For example, this format could be used when writing the Indication to a system log or sending an e-mail notification to a system administrator.

UMLPackagePath | string | CIM::Event
Version | string | 2.10.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
TextFormat | string |

Description

string

A string describing the human-readable format for representing the Indications described by this Subscription. The actual text is constructed by applying the dynamic content, defined in the Indication, to the string specified in this property. /n /n The dynamic content is specified by embedding the following syntax in the appropriate places in the format string: "{" <index>["["[<index>]"]"],<type>"}" - the first occurrence of <index> defines the element of TextFormatParameters that contains the name of the Indication property to be used to populate the text message. - if the Indication property defined by the first <index> is an array property, then the first index MUST be followed by either empty brackets (i.e., []) or an index value enclosed in brackets (e.g., [1]). If empty brackets are specified (e.g., {4[], string}), then the dynamic content of the text message is populated with a list of the array elements. If an index is specified (e.g., {4[1], string}, then only the specified array element is used to populate the message. If the value of the dynamic content is not defined in the Indication, then the string "UNKNOWN" is used to populate the text message. - <type> defines the type of the dynamic content. Valid values for <type> are: 'boolean', 'string', 'char16', 'uint8', 'sint8', 'uint16', 'sint16', 'uint32', 'sint32', 'uint64', 'sint64', 'datetime', 'real32', 'real64' or 'ref'. The string encoding for the dynamic content MUST conform to the MOF Syntax Grammar described in the CIM Infrastructure Specification. The string encoding for a list of array elements MUST conform to the definition of the arrayInitializer element. As an example, a format string for a UPS AlertIndication could be defined as follows: "A {4,string} UPS Alert of type {5,uint16} was detected on the device {6,string} on the system {2,string} at {1,datetime}. The following actions have been recommended to resolve the alert: {3[],string}".

TextFormatID | string |
Description | string | An opaque string that uniquely identifies, within the scope of the TextFormatOwningEntity, a human-readable format for representing the Indications described by this Subscription.
ModelCorrespondence | string | CIM_FormattedIndicationSubscription.TextFormatOwningEntity, CIM_FormattedIndicationSubscription.TextFormat, CIM_FormattedIndicationSubscription.TextFormatParameters
TextFormatOwningEntity | string |
Description | string | The TextFormatOwningEntity is a string that uniquely identifies the entity that owns the definition of the human-readable format described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format.
ModelCorrespondence | string | CIM_FormattedIndicationSubscription.TextFormatID, CIM_FormattedIndicationSubscription.TextFormat, CIM_FormattedIndicationSubscription.TextFormatParameters
TextFormatParameters | string[] |
ArrayType | string | Indexed
Description | string | An indexed array containing the names of properties defined in the select clause of the associated CIM_IndicationFilter Query. The values of these Indication properties are used to populate the dynamic content of the text message.
ModelCorrespondence | string | CIM_FormattedIndicationSubscription.TextFormatOwningEntity, CIM_FormattedIndicationSubscription.TextFormatID, CIM_FormattedIndicationSubscription.TextFormat

### Association References

Name | Class Origin | Reference Class
--- | --- | ---

### Propagated Association References

Name | Class Origin | Reference Class
--- | --- | ---

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
FailureTriggerTimeInterval | uint64 | CIM_AbstractIndicationSubscription
OnFatalErrorPolicy | uint16 | CIM_AbstractIndicationSubscription
OtherOnFatalErrorPolicy | string | CIM_AbstractIndicationSubscription
OtherRepeatNotificationPolicy | string | CIM_AbstractIndicationSubscription
OtherSubscriptionState | string | CIM_AbstractIndicationSubscription
RepeatNotificationCount | uint16 | CIM_AbstractIndicationSubscription
RepeatNotificationGap | uint64 | CIM_AbstractIndicationSubscription
RepeatNotificationInterval | uint64 | CIM_AbstractIndicationSubscription
RepeatNotificationPolicy | uint16 | CIM_AbstractIndicationSubscription
SubscriptionDuration | uint64 | CIM_AbstractIndicationSubscription
SubscriptionInfo | string | CIM_AbstractIndicationSubscription
SubscriptionStartTime | datetime | CIM_AbstractIndicationSubscription
SubscriptionState | uint16 | CIM_AbstractIndicationSubscription
SubscriptionTimeRemaining | uint64 | CIM_AbstractIndicationSubscription
TimeOfLastStateChange | datetime | CIM_AbstractIndicationSubscription

## Class Methods