Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

qmf.content field

Data Type

Description

_schema_package

STRING

Schema package name

_schema_id

SCHEMA_ID

Schema class identifier

_schema_class

SCHEMA_CLASS

Schema class definition

_object_id

OBJECT_ID

Managed object identifier

_data

QMF_DATA

Data, managed and/or described or free-form

_event

QMF_EVENT

Event

_query

QMF_QUERY

Query

Message Body Map Formats

SCHEMA_ID

No Format
  SCHEMA_ID := { _package_name: STRING,
                 _class_name:   STRING,
                 _type:         '_data' | '_event',
                 _hash_str:     STRING    UUID
               }

Field

Optional

Description

_package_name

no

Package name (namespace) for the described class

_class_name

no

Name of the described class

_type

no

Class type: data or event

_hash _str

yes

Hash string (uuid) to distinguish different versions of a class

...

No Format
  SCHEMA_CLASS := { _schema_id:        SCHEMA_ID,
                    _valuesdesc:        { EACH_ATTR_NAME: SCHEMA_PROPERTY | SCHEMA_METHOD }STRING,
                    _subtypes:  { EACH_ATTR_NAME: qmfProperty | qmfMethod }
default_severity: NUMBER,
                    _properties:       [SCHEMA_PROPERTY, ...],
                    }
_methods:          [SCHEMA_METHOD, ...]
                  }

Field

Optional

Description

_schema_id

Field

Optional

Description

_schema_id

no

Identifier for this schema class

_values desc

no yes

Map Description of schema attribute names and either their property or method descriptions. The subtype defines whether an attribute is a property or a method.

_subtypes

no

Map of subtype names ('qmfProperty' or 'qmfMethod') for each attribute

SCHEMA_PROPERTY

the schema class

_default_severity

yes

Default severity for an event class

_properties

no

List of SCHEMA_PROPERTY elements describing the properties of the class

_methods

no

List of SCHEMA_METHOD elements describing the methods of the class

SCHEMA_PROPERTY

No Format

  SCHEMA_PROPERTY :
No Format

  SCHEMA_PROPERTY := { _typename:       QMF_TYPESTRING,
                       _accesstype:     RO | RC | RW QMF_TYPE,
                       _unitindex:       STRINGBOOL,
                       _minaccess:     'RO' | 'RC' | NUMBER'RW',
                       _maxunit:        NUMBERSTRING,
                       _maxlenmin:        NUMBER,
                       _dirmax:        I | O | IONUMBER,
                       _descmaxlen:       STRINGNUMBER,
                       _references: SCHEMA_IDdir:        'I' | 'O' | 'IO',
                       _subtypedesc:       QMF_SUBTYPESTRING,
                     }
  _references: SCHEMA_ID,
                       _subtype:    QMF_SUBTYPE
                     }

Field

Field

Optional

Description

_type name

no

The QMF data type name of this the property

_type

no

The QMF data type of this property

_index

yes

True iff this property is an index of an object. Default is False.

_access

yes

The remote access rules for this property:
RO => Read Only (default if not specified)
RC => Read Create
RW => Read Write

_unit

yes

Annotation. Units of measure for numeric values

_min

yes

Minimum numeric value

_max

yes

Maximum numeric value

_maxlen

yes

Maximum length of a variable length value (in octets)

_dir

yes

Used only for method arguments. Direction of transfer:
I => Input (caller to callee)
O => Output (callee to caller)
IO => Both

_desc

yes

Annotation. Description of the property

_references

yes

If the type is a reference to another managed object, this field may be used to specify the required class for that object

_subtype

yes

May be used to further specify the meaning of the value of this field. For example, a number may actually be a timestamp or a duration. A string may be a reference to another object, or a URL.

QMF_TYPE

No Format
  QMF_TYPE := 'TYPE_VOID'   |
              'TYPE_BOOL'   |
              'TYPE_INT'    |
              'TYPE_FLOAT'  |
              'TYPE_STRING' |
              'TYPE_MAP'    |
              'TYPE_LIST'   |
              'TYPE_UUID'

QMF_SUBTYPE

No Format
  QMF_SUBTYPE := 'reference' |
                 'url'       |
                 'timestamp' |
                 'duration'

SCHEMA_METHOD

No Format
  SCHEMA_METHOD := { _descname:      STRING,
                     _argumentsdesc:    { EACH_ARG_NAME:   STRING,
                     _arguments: [SCHEMA_PROPERTY, }...]
                   }

Field

Optional

Description

_name

no

The name of the method

_desc

yes

Annotation. Description of this method

_arguments

no

Map List of argument names and SCHEMA_PROPERTY data to describe them elements that describe the method's arguments

QMF_METHOD_CALL

No Format
  QMF_METHOD_CALL := { _object_id:   OBJECT_ID,
                       _method_name: STRING,
                       _arguments:   { EACH_KEY: VALUE },
                       _subtypes:    { EACH_KEY: STRING }
                     }

...

No Format
  OBJECT_ID := { _agent_name:  STRING,
                 _objectagent_nameepoch: STRINGNUMBER,
                 _schemaobject_idname:   SCHEMA_IDSTRING
               }

Field

Optional

Description

_agent_name

yes

Name of the agent that is managing the referenced data

_objectagent_name epoch

no yes

Name Numeric epoch of the data that uniquely identifies the data within the context of the agent (or the context of the schema class, if provided)

_schema_id

yes

If the referenced data is "described", the identifier of the schema that describes it. This field serves to disambiguate the naming of objects in case objects of different types have the same _object_name.

...

agent process. This number is managed by the agent and is incremented each time the agent process starts. This field is only present for transient object IDs that must not be the same for a given object across an agent restart. Persistent object IDs must not include this field.

_object_name

no

Name of the data that uniquely identifies the data within the context of the agent.

QMF_QUERY

No Format

  QMF_QUERY := { _what:      QMF_QUERY_TARGET,
                 _where:     QMF_QUERY_PREDICATE,
                 _object_id: OBJECT_ID,
                 _schema_id: SCHEMA_ID
               }

Field

Optional

Description

_what

no

Identifies the kind of data being queried

_where

yes

Query predicate to limit the number of results of the query

_object_id

yes

Identifier of a single object being queried

_schema_id

yes

Identifier of a single schema being queried

QMF_QUERY_TARGET

No Format
  QMF_QUERY_TARGET := { _what:  QMF_CONTENT_TYPE,
 'SCHEMA_ID' |
                      'SCHEMA'    |
                      'OBJECT_where: QMF_QUERY_PREDICATEID' |
               }

...

Field

...

Optional

...

Description

...

_what

...

no

...

Identifies the kind of data being queried

       'OBJECT'

QMF_QUERY_PREDICATE

...

_where

...

yes

...

QMF_SUBSCRIBE

No Format
  QMF_SUBSCRIBE := { _query:     QMF_QUERY,
                     _duration:  NUMBER,
                     _interval:  NUMBER
                   }

...