...

{"header":"bootuptime_ClientConnectComplete_split","content":"ccsp-lm-lite","type":<event>","pollingFrequency":"0"}

T2 Report Profiles

                        A Telemetry 2.0 Report Profile is a configuration, authored in JSON, that can be sent to any RDK device which supports Telemetry 2.0. A Report Profile contains properties that are interpreted by the CPE in order to generate and upload a telemetry report. These properties define the details of a generated report, including:

• Scheduling (how often the report should be generated) 
• Parameters (what key/value pairs should be in the report)   
• Encoding (the format of the generated report)   
• Protocol (protocol to use to send generated report)

Profiles Set Properties

profiles

An array of profile objects that each defines a Telemetry 2.0 Report Profile.

profiles

• is required
• Type: an array of profile 

profiles Constraints

maximum number of items: the maximum number of items for this array is: 10

Profile

profile

• is optional
• Type: object

Profile Properties

name

Name of the Profile. This is value is accessible from within the Report Profile as dataModel parameter "Profile.Name".

name

• is optional
• Type: string

versionHash

Unique value that is expected to change when anything within the Report Profile is changed.

versionHash

• is optional
• Type: string

value

The JSON representing this Report Profile.

value

• is optional
• Type: object (JSON object which is a T2 Report Profile)

Description

Text describing the purpose of this Report Profile.

Description

• is optional
• Type: string

Version

Version of the profile. This value is opaque to the Telemetry 2 component, but can be used by server processing to indicate specifics about data available in the generated report.

Version

• is optional
• Type: string

Protocol

The protocol to be used for the upload of report generated by this profile.

Protocol

• is required
• Type: string

Protocol Constraints

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

EncodingType

The encoding type to be used in the report generated by this profile.

EncodingType

• is required
• Type: string

EncodingType Constraints

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

ReportingInterval

The interval, in seconds, at which this profile shall cause a report to be generated.

ReportingInterval

• is optional
• Type: integer

ActivationTimeOut

The amount of time, in seconds, that this profile shall remain active on the device. This is the amount of time from which the profile is received until the CPE will consider the profile to be disabled. After this time, no further reports will be generated for this report.

ActivationTimeOut

• is optional
• Type: integer

TimeReference

TBD. Must be value of "0001-01-01T00:00:00Z" for Telemetry 2.0.

TimeReference

• is optional
• Type: string

TimeReference Default Value

The default value is:

"0001-01-01T00:00:00Z"

GenerateNow

When true, indicates that the report for this Report Profile should be generated immediately upon receipt of the profile.

GenerateNow

• is optional
• Type: boolean

GenerateNow Default Value

The default value is:

false

Parameter

An array of objects which defines the data to be included in the generated report. Each object defines the type of data, the source of the data and an optional name to be used as the name (marker) for this data in the generated report.

Parameter

• is required
• Type: object[]

Parameter Type

object (Parameter Definition)

Parameter Constraints

maximum number of items: the maximum number of items for this array is: 800

HTTP

HTTP Protocol details that will be used when Protocol="HTTP".

HTTP

• is optional
• Type: object

HTTP Type

object 

JSONEncoding

JSON Encoding details that will be used when EncodingType="JSON".

JSONEncoding

• is optional
• Type: object

JSONEncoding Type

object