
{"id":9530,"date":"2022-06-21T09:11:27","date_gmt":"2022-06-21T09:11:27","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/device_management\/telemetry_2\/telemetry_2-0_report_profiles\/triggercondition\/"},"modified":"2025-03-25T05:18:32","modified_gmt":"2025-03-25T05:18:32","slug":"triggercondition","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/","title":{"rendered":"TriggerCondition"},"content":{"rendered":"<!DOCTYPE html PUBLIC \"-\/\/W3C\/\/DTD HTML 4.0 Transitional\/\/EN\" \"http:\/\/www.w3.org\/TR\/REC-html40\/loose.dtd\">\n <html><body><h2 class=\"wp-main-header wp-block-heading\">TriggerCondition for Telemetry 2 Report Profiles<\/h2><p>The TriggerCondition property is an array of objects that define the condition(s) under which the T2 report should be generated.&nbsp; Similar to Parameters, each object specifies the type of data for the condition.<\/p><p>Each object defines a condition upon which the report should be generated. If any one condition evaluates to TRUE, the report is generated <em>immediately<\/em>.&nbsp; This behaves like all conditions are OR&#8217;d. The first evaluation to TRUE will cause further evaluations to cease, and the report will be generated.<\/p><p>TriggerCondition is OR&#8217;d with ReportingInterval, such that report generation occurs when the reporting interval is reached OR when a condition evaluates to TRUE. If TriggerCondition is present, ReportingInterval is optional.&nbsp; If GenerateNow is used, TriggerCondition may not be present.<\/p><p><span>The Telemetry 2 component uses rbus to subscribe for changes and conditions to the dataModel property specified in each TriggerCondition object.<\/span><\/p><p>NOTE: Only &#8220;dataModel&#8221; data is supported for TriggerCondition objects in the RDK releases.<\/p><h3 id=\"TriggerCondition-Example\">Example<\/h3><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><code class=\"language-json\">{\n    \"type\": \"dataModel\",\n    \"reference\":\"Device.WiFi.Radio.1.Stats.X_COMCAST-COM_NoiseFloor\", <br>    \"operator\":\"gt\",\"threshold\":\"-65\", \"minThresholdDuration\":120\n}\n<\/code><\/pre><h3 class=\"wp-sub-header\">Available Properties<\/h3><div class=\"table-wrap\"> <table class=\"wrapped relative-table confluenceTable\"><colgroup><col style=\"width: 30.2026%;\"><col style=\"width: 14.9171%;\"><col style=\"width: 54.8803%;\"><\/colgroup><thead><tr><th class=\"confluenceTh\">Property<\/th><th class=\"confluenceTh\">Type<\/th><th class=\"confluenceTh\">Required<\/th><\/tr><\/thead><tbody><tr><td class=\"confluenceTd\"><a href=\"#TriggerCondition-type\" class=\"rdk-inside-table\">type<\/a><\/td><td class=\"confluenceTd\"><code>string<\/code><\/td><td class=\"confluenceTd\">Required<\/td><\/tr><tr><td class=\"confluenceTd\"><a href=\"#TriggerCondition-operator\" class=\"rdk-inside-table\">operator<\/a><\/td><td class=\"confluenceTd\"><code>string<\/code><\/td><td class=\"confluenceTd\">Required<\/td><\/tr><tr><td class=\"confluenceTd\"><a href=\"#TriggerCondition-threshold\" class=\"rdk-inside-table\">threshold<\/a><\/td><td class=\"confluenceTd\"><code>integer<\/code><\/td><td class=\"confluenceTd\">Optional<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\"><a href=\"#TriggerCondition-minThresholdDuration\" class=\"rdk-inside-table\">minThresholdDuration<\/a><\/td><td colspan=\"1\" class=\"confluenceTd\"><code>integer<\/code><\/td><td colspan=\"1\" class=\"confluenceTd\">Optional<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\"><a href=\"#TriggerCondition-reference\" class=\"rdk-inside-table\">reference<\/a><\/td><td colspan=\"1\" class=\"confluenceTd\"><code>string<\/code><\/td><td colspan=\"1\" class=\"confluenceTd\">Required (for type=&#8221;dataModel&#8221;)<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\"><a href=\"#TriggerCondition-eventName\" class=\"rdk-inside-table\">eventName<\/a><\/td><td colspan=\"1\" class=\"confluenceTd\"><code>string<\/code><\/td><td colspan=\"1\" class=\"confluenceTd\">Required (for type=&#8221;event&#8221;)<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\"><a href=\"#TriggerCondition-component\" class=\"rdk-inside-table\">component<\/a><\/td><td colspan=\"1\" class=\"confluenceTd\"><code>string<\/code><\/td><td colspan=\"1\" class=\"confluenceTd\">Required (for type=&#8221;event&#8221;)<\/td><\/tr><\/tbody><\/table> <\/div><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-type\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><p><br><\/p><h3 class=\"wp-sub-header\">type<\/h3><p>Defines the type of data to be used for the condition.<\/p><p><code><br>type<\/code><\/p><ul><li>is required<\/li><li>Type: <code>string<\/code><\/li><\/ul><h3 id=\"TriggerCondition-typeConstraints\">type Constraints<\/h3><div class=\"table-wrap\"> <table class=\"wrapped confluenceTable\"><colgroup><col><col><\/colgroup><thead><tr><th class=\"confluenceTh\">Value<\/th><th class=\"confluenceTh\">Description<\/th><\/tr><\/thead><tbody><tr><td class=\"confluenceTd\"><code>dataModel<\/code><\/td><td class=\"confluenceTd\">Data that comes from the data model, e.g., TR-181 data.<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\">event<\/td><td colspan=\"1\" class=\"confluenceTd\"><p><span>Data that comes from a component event<\/span><\/p><p><em><strong>NOTE<\/strong>: Event conditions are not yet supported in RDK builds.<\/em><\/p><\/td><\/tr><\/tbody><\/table> <\/div><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-operator\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><p><br><\/p><h3 class=\"wp-sub-header\">operator<\/h3><p>Indicates the filter type used in conjunction with a trigger condition. If the data type of the dataModel parameter is string or date\/time, then only the &ldquo;any&rdquo; filter type applies.<\/p><p><code>name<\/code><\/p><ul><li>is required<\/li><li>Type: <code>string<\/code><\/li><\/ul><h4 id=\"TriggerCondition-operatorConstraints\">operator Constraints<\/h4><p><strong>enum<\/strong>: the value of this property must be equal to one of the following values:<\/p><div class=\"table-wrap\"> <table class=\"wrapped confluenceTable\"><colgroup><col><col><\/colgroup><thead><tr><th class=\"confluenceTh\">Value<\/th><th class=\"confluenceTh\">Explanation<\/th><\/tr><\/thead><tbody><tr><td class=\"confluenceTd\"><code>\"any\"<\/code><\/td><td class=\"confluenceTd\">This condition is TRUE when any change to the indicated parameter occurs.<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\">&#8220;lt&#8221;<\/td><td colspan=\"1\" class=\"confluenceTd\">This condition is TRUE when the value of the parameter is less than the threshold value.<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\">&#8220;gt&#8221;<\/td><td colspan=\"1\" class=\"confluenceTd\">This condition is TRUE when&nbsp;the value of the parameter is greater than the threshold value.<\/td><\/tr><tr><td colspan=\"1\" class=\"confluenceTd\">&#8220;eq&#8221;<\/td><td colspan=\"1\" class=\"confluenceTd\">This condition is TRUE when&nbsp;the value of the parameter is equal to the threshold value.<\/td><\/tr><\/tbody><\/table> <\/div><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-threshold\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><p><br><\/p><h3 class=\"wp-sub-header\">threshold<\/h3><p>The operand value to use during evaluation of the condition if the operator is not &#8220;any&#8221;.&nbsp; If operator is &#8220;any&#8221;, then threshold is ignored.&nbsp;&nbsp;<span>For boolean data types, TRUE and FALSE are represented by &#8220;1&#8221; and &#8220;0&#8221;, respectively.<\/span><\/p><p><code>threshold<\/code><\/p><ul><li>is optional<\/li><li>Type: <code>integer<\/code><\/li><\/ul><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-minThresholdDuration\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><br><\/pre><h3 class=\"wp-sub-header\">minThresholdDuration<\/h3><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><br><\/pre><p>Minimum time, in seconds, between report generation if condition reoccurs or persists. This will help prevent device from bogging down generating the same report over and over. If not specified, a new report will be generated every time this Trigger Condition is satisfied.<\/p><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><br><\/pre><p><code>threshold<\/code><\/p><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><br><\/pre><ul><li>is optional<\/li><li>Type: <code>integer<\/code><\/li><\/ul><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-reference\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><p><br><\/p><h3 class=\"wp-sub-header\">reference<\/h3><p>When type=&#8221;dataModel&#8221;, reference indicates the data model object or property name whose value is to be in the generated report, e.g., &#8220;Device.DeviceInfo.HardwareVersion&#8221;<\/p><p><code>reference<\/code><\/p><ul><li>is required for type=&#8221;dataModel&#8221;<\/li><li>Type: <code>string<\/code><\/li><\/ul><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-eventName\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><p><br><\/p><h3 class=\"wp-sub-header\">eventName<\/h3><p>When type=&#8221;event&#8221;, eventName indicates the <span>event name by which the component will report this data to Telemetry 2.<\/span><\/p><p><code>reference<\/code><\/p><ul><li>is required for type=&#8221;eventName&#8221;<\/li><li>Type: <code>string<\/code><\/li><\/ul><h3 class=\"wp-sub-header\"><span class=\"confluence-anchor-link conf-macro output-inline\" id=\"TriggerCondition-component\" data-hasbody=\"false\" data-macro-name=\"anchor\"> <\/span><\/h3><p><br><\/p><h3 class=\"wp-sub-header\">component<\/h3><p>When type=&#8221;event&#8221;, component indicates the component name f<span>rom which this data should be expected.&nbsp;<\/span><\/p><p><code>reference<\/code><\/p><ul><li>is required for type=&#8221;eventName&#8221;<\/li><li>Type: <code>string<\/code><\/li><\/ul><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><code class=\"language-json\"><br><\/code><\/pre><\/body><\/html>\n","protected":false},"excerpt":{"rendered":"<p>TriggerCondition for Telemetry 2 Report Profiles The TriggerCondition property is an array of objects that [&hellip;]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":9510,"menu_order":5,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-9530","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>TriggerCondition - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"TriggerCondition - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"TriggerCondition for Telemetry 2 Report Profiles The TriggerCondition property is an array of objects that [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:32+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/\",\"name\":\"TriggerCondition - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:11:27+00:00\",\"dateModified\":\"2025-03-25T05:18:32+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Device Management\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Xconf\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Telemetry 2.0\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Telemetry 2.0: Report Profiles\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"TriggerCondition\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"TriggerCondition - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/","og_locale":"en_US","og_type":"article","og_title":"TriggerCondition - RDK Documentation Portal | Documentation","og_description":"TriggerCondition for Telemetry 2 Report Profiles The TriggerCondition property is an array of objects that [&hellip;]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:32+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/","name":"TriggerCondition - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:11:27+00:00","dateModified":"2025-03-25T05:18:32+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/triggercondition\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"Device Management","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/"},{"@type":"ListItem","position":4,"name":"Xconf","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/"},{"@type":"ListItem","position":5,"name":"Telemetry 2.0","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/"},{"@type":"ListItem","position":6,"name":"Telemetry 2.0: Report Profiles","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/"},{"@type":"ListItem","position":7,"name":"TriggerCondition"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9530","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=9530"}],"version-history":[{"count":1,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9530\/revisions"}],"predecessor-version":[{"id":9531,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9530\/revisions\/9531"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9510"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=9530"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}