For more information, including FAQs and resources, please visit the link below:
RDKM-SSO
Property | Type | Required |
---|---|---|
Description | string | Optional |
Version | string | Optional |
Protocol | string | Required |
EncodingType | string | Required |
ReportingInterval | integer | Optional |
ActivationTimeOut | integer | Optional |
TimeReference | string | Optional |
GenerateNow | boolean | Optional |
Parameter | array | Required |
TriggerCondition | array | Optional |
HTTP | object | Optional |
JSONEncoding | object | Optional |
Text describing the purpose of this Report Profile.
Description
string
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
string
The protocol to be used for the upload of report generated by this profile.
Protocol
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"HTTP" | When Protocol is equal to HTTP, an HTTP element is expected to occur within the Profile. |
The encoding type to be used in the report generated by this profile.
EncodingType
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"JSON" | When EncodingType is equal to JSON, a JSONEncoding element is expected to occur within the Profile. |
The interval, in seconds, at which this profile shall cause a report to be generated.
ReportingInterval
integer
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
integer
TBD. Must be value of "0001-01-01T00:00:00Z" for Telemetry 2.0.
TimeReference
string
The default value is:
"0001-01-01T00:00:00Z"
When true, indicates that the report for this Report Profile should be generated immediately upon receipt of the profile.
GenerateNow
boolean
The default value is:
false
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
object[]
object
(Parameter Definition)
maximum number of items: the maximum number of items for this array is: 800
An array of condition definition objects which defines the conditions upon which a report should be generated. If any one condition evaluates to TRUE, the report is generated. Each condition definition object in the array defines the type of data, the source of the data, the operator and value to evaluate.
TriggerCondition
array[]
array
(TriggerCondition Definition)
maximum number of items: the maximum number of items for this array is: 50
HTTP Protocol details that will be used when Protocol="HTTP".
HTTP
object
object
(HTTP Protocol Definition)
JSON Encoding details that will be used when EncodingType="JSON".
JSONEncoding
object
object
(JSON Encoding Definition)
This is an example of a complete Report Profile. The "Parameter" property defines the data to be gathered and reported. Notice that there are three types of data supported: dataModel, event, and grep. The other properties define scheduling, protocols and encoding of the generated report.
|