"dataModel" Parameter Properties

A dataModel parameter defines data that will come from the CPE data model, e.g., TR-181

Example

{ 
    "type": "dataModel",
    "name": "T2_DeviceInfo_MemStatus_Used",
    "reference": "Device.DeviceInfo.MemoryStatus.Used"
}

On this Page :                             

Available Properties

Property

Type

Required

typestringRequired
namestringOptional
referencestringRequired
reportEmptybooleanOptional
methodstringOptional
usestringOptional
reportTimestampstringOptional

type

Defines a data model parameter, e.g., TR-181 data.

type

  • is required
  • Type: string

type Constraints

constant: the value of this property must be equal to:

"dataModel"


name

Optional: The key name to be used for this data in the generated report.

name

  • is optional
  • Type: string


reference

The data model object or property name whose value is to be in the generated report, e.g., "Device.DeviceInfo.HardwareVersion"

reference

  • is required
  • Type: string


reportEmpty

Should this marker name be included in the generated report even if the search string was not found in the log file?

reportEmpty

  • is optional
  • Type: boolean

reportEmpty Default Value

The default value is:

"false"

method

The method that the Telemetry component should use to retrieve this value.

method

  • is optional
  • Type: string

Method Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"get"When method is "get", the Telemetry component will use the bus GET API to get the parameter value for the dataModel reference.  This is the default behavior
"subscribe"When method is "subscribe", the Telemetry component will use RBUS APIs to register interest in any value change for the dataModel name specified in the reference property of the dataModel element.

method Default Value

The default value is:

"get"

use

This property indicates how the data for this parameter should be gathered and reported.

•  "count": Indicates that the value to report for this parameter is the number of times it has occurred during the reporting interval.  This is only relevant when method="subscribe".
•  "absolute": Indicates that the value to report for this parameter is the last actual value received, in the case of method="subscribe"
•  "csv": Indicates that the value to report for this parameter is a comma separated list of all the actual values received, in the case of method="subscribe".  NOTE: "csv" is not currently supported in Telemetry 2.0.

use

  • is optional
  • Type: string

use Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"count"Indicates that the value to report for this parameter is the number of times it has occurred during the reporting interval.
"absolute"Indicates that the value to report for this parameter is the last actual value received, in the case of events, or found in the log file, in the case of greps.
"csv"Indicates that the value to report for this parameter is a comma separated list of all the actual values received, in the case of events, or found in the log file, in the case of greps. NOTE: "csv" is not currently supported in Telemetry 2.0.
"accumulate"

Indicates that the value to report for this parameter is an array of all values received over the course of the reporting period. 

Example 1: Marker name is "my_marker_name" and first instance of the event was "Data from event 1":  
{ "my_marker_name": [

                "Data from event 1",

                "Data from event 2",

                "Data from event 3"

                ]

}

use Default Value

The default value is:

"absolute"

reportTimestamp

Specifies if a timestamp should be captured and reported to indicate the time at which this event was received by the Telemetry Framework.  If specified, this timestamp will appear in the generated report as the eventName with suffix of "_CT".  If "use" is "accumulate", the timestamp will be reported as an array where each element corresponds to the same element index for the event data.  For dataModel parameters, this is only useful for "method":"subscribe" parameters.

reportTimestamp

  • is optional
  • Type: string

reportTimestamp Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"Unix-Epoch"Indicates that the timestamp value must be captured and reported as a Unix Epoch timestamp
"None"Indicates that no timestamp should be captured or reported for this dataModel subscribe event

reportTimestamp Default Value

The default value is:

"None"
  • No labels

DISCLAIMER: Please note that the use of the RDK Wiki is subject to its Privacy Policy & Terms of Use. In addition, this Wiki may be accessed by all RDK licensees and their contractors.