A set of optional properties that modify or adjust the reporting for a profile.  If GenerateNow is present, ReportingAdjustments shall be ignored.


Example:

"ReportingAdjustments": {
        "ReportOnUpdate":true,
        "FirstReportingInterval":1000,
        "MaxUploadLatency":400
    }



ReportingAdjustments Properties

PropertyTypeRequired
ReportOnUpdatebooleanOptional
FirstReportingIntervalintegerOptional
MaxUploadLatencyintegerOptional

ReportOnUpdate


Indicates if a report should be generated and sent before a new version of this profile is activated.  A new version of a profile is indicated by a profile with the same name but different hashVersion.  When this occurs, T2 shall check ReportOnUpdate for the profile being replaced and, if true, shall generate and send the report immediately for the profile that is being replaced..

ReportOnUpdate

  • is optional
  • Type: boolean

FirstReportingInterval


The number of seconds to wait after profile activation before generating a report once.  After this time elapses and a report is generated and sent, all other reports for this profile must respect the reportingInterval or other reporting requirements of the profile.  If a ReportingInterval is present for this profile, the ReportingInterval schedule must be started after the FirstReportingInterval has expired.

FirstReportingInterval

  • is optional
  • Type: unsigned integer

MaxUploadLatency


This value is only valid when TimeReference is different from the default of “0001-01-01T00:00:00Z".  If present, this value is used to randomize the upload time of a generated report.  It represents the maximum number of milliseconds over which the upload of a report should be randomized.  The T2 component shall calculate this random latency period once when the profile is activated and shall use that value each time the report is uploaded.  In case of failure of the upload connection, existing caching and retry logic shall apply, based on the Protocol of the profile.

MaxUploadLatency

  • is optional
  • Type: unsigned integer
  • No labels