Overview

WebConfig is used as the production delivery mechanism for T2 report profiles.  

T2 report profiles are created in XConf, then are referenced via T2 Rules.  When a WebConfig Supplementary Services request for Telemetry occurs, XConf resolves the rules in order to identify all T2 report profiles that apply.  Then XConf packages up the T2 report profiles into a full set and returns the JSON to WebConfig.

Unlike what is done for the T1/Legacy/DCM telemetry configuration, T2 does not reach out to XConf directly for T2 report profiles.

If you are using T2 profiles for development, you may be setting profiles manually on the device by setting Device.X_RDKCENTRAL-COM_T2.ReportProfiles.  This will work, but if WebConfig is enabled, the profiles you set will be replaced by WebConfig supplementary services on reboot and during the maintenance window.  This is by design because the T2 component always expects a full set of T2 profiles, so any profiles that are not present in the set received will be removed.  See Report Profiles Set for more information.

To configure a T2 profile for delivery by WebConfig, please continue reading.

If instead of using WebConfig, you'd like to disable the WebConfig Supplementary Services request altogether, please see Disabling WebConfig Supplementary Services.

Creating Profiles and Rules in XConf

Use the XConf Admin UI and follow the instructions in this section.  See Feature Validation : Xconf Server for information about the RDK-M XConf instance.

For more details on T2 profiles, please see the following links: 

• Telemetry 2.0: Report Profiles - Documentation of available properties in T2 Report Profiles
• LINK TBD - Suggestions on properties that can be included in your T2 Report Profiles

Creating a T2 Report Profile in XConf

Please watch the demo video below for a quick lesson in creating a T2 Report Profile in XConf. 

A few things to note: 

• XConf will validate the T2 report profile JSON that you enter and will give an error if the JSON is not valid.
• XConf has an approval process. Any creation, change or deletion to a profile must be approved before it will go live.  This is demonstrated in the video and is only possible to do yourself while in XConf CI. Otherwise, the Release Management team owns permissions to approve all XConf profile changes.
• The name you give your T2 profile will be the name that is reported for Profile.Name if you include that in your T2 profile (which is highly recommended!).

Creating a T2 Rule in XConf

Please watch the demo video below for a quick lesson in creating a T2 Rule in XConf. 

A few things to note: 

• Rules can specify specific information, like mac addresses, or more general information, like device models.  A single rule can specify multiple mac addresses with OR so that you could add all test device Macs to a single rule if they should all get the same profiles.
• The simplest thing to do when trying to test for a specific device is to create a Mac-based rule.  Please note that XConf uses WAN Mac for RDK-B devices and eSTB Mac for RDK-V devices.
• T2 Rules allow for multiple T2 Report Profiles to be specified in a single rule.   

Using WebConfig Supplementary Services

Configure WebConfig Supplementary Services for Telemetry on a device by setting Device.X_RDK_WebConfig.SupplementaryServiceUrls.Telemetry to http://<yourWebConfigInstance>/api/v1/device/<mac>/config, where <mac> is the MAC address of the device, all lowercase without colons.  You can do so via WebPA in the cloud or dmcli or rbuscli directly on the device.  For instance, in the RDK-M environment, you would use http://webconfig.rdkcentral.com:9007/api/v1/device/<mac>/config

For example,

dmcli eRT setv Device.X_RDK_WebConfig.SupplementaryServiceUrls.Telemetry string http://webconfig.rdkcentral.com:9007/api/v1/device/aabbccddeeff/config

Disabling WebConfig Supplementary Services

If instead of using WebConfig, you'd like to disable the request for WebConfig Supplementary Services for Telemetry altogether, you can do so by setting the data model property to "NULL".  You can do so via WebPA in the cloud or dmcli or rbuscli directly on the device. 

For example,

dmcli eRT setv Device.X_RDK_WebConfig.SupplementaryServiceUrls.Telemetry string NULL

Make WebConfig Fetch T2 Profiles

There are two ways to make a device get the latest T2 profiles:

1. Reboot.  A reboot will cause WebConfig Client to reach out to the cloud for updated Supplementary Services
2. Do a "poke".  A "poke" is a way to tell the device that it should reach out now to get updated Supplementary Services.  Poke a device by setting Device.X_RDK_WebConfig.ForceSync to "telemetry".  You can do this in one of two ways:
   1. Use WebPA or Tardis to set the property 
   2. Use the following command on the device: dmcli eRT setv Device.X_RDK_WebConfig.ForceSync string "telemetry"

Validating That T2 Profile is on Device

When T2 profiles are received via WebConfig, they are persisted in msgPack format in /nvram/.t2reportprofiles/profiles.msgpack

To check that the device received the profiles on the device, you can get a human-readable version of the profiles.msgpack file by doing the following on the device:

webcfg_decoder -m /nvram/.t2reportprofiles/profiles.msgpack

v