{"id":48105,"date":"2021-03-02T11:17:55","date_gmt":"2021-03-02T18:17:55","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?post_type=docs&p=48105"},"modified":"2021-03-02T11:17:55","modified_gmt":"2021-03-02T18:17:55","slug":"dcma-telemetry-properties","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/","title":{"rendered":"dcma-telemetry.properties"},"content":{"rendered":"

Applies to: <\/strong>Ephesoft Transact 2020.1.04 and above<\/p>\n

This document describes the properties in the dcma-telemetry.properties<\/strong> file in Ephesoft Transact. This information is intended for Transact administrators running Transact with a consumption-based license.<\/p>\n

Note: <\/strong>You should not make any changes to this property file unless directed by Ephesoft Support, or to enable or disable automatic reporting.<\/p>\n

<\/a>Overview<\/h2>\n

The dcma-telemetry.properties <\/strong>file configures settings for the automatic reporting of consumption data to Ephesoft. For more information on your consumption data, refer to the License Consumption Report<\/a>.<\/p>\n

<\/a>Configurable Properties<\/h2>\n

This section describes the configurable properties available in the dcma-telemetry.properties <\/strong>file, located at [Ephesoft_Directory]<\/em>\\Application\\WEB-INF\\classes\\META-INF\\dcma-telemetry.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Property<\/strong><\/span><\/td>\nDescription<\/strong><\/span><\/td>\n<\/tr>\n
dcma.telemetry.auto.upload<\/td>\nThis property enables or disables the automatic reporting of consumption data to Ephesoft.<\/p>\n

Note:<\/strong> If this is set to OFF<\/strong>, you will need to manually submit your consumption data each month. For steps, refer to Manual Reporting<\/a>.<\/td>\n<\/tr>\n

dcma.telemetry.consumption.upload.url<\/td>\nThis property specifies the URL where the license consumption snapshots are automatically uploaded.<\/p>\n

Important: <\/strong>Do not change this URL unless requested by Ephesoft.<\/td>\n<\/tr>\n

license.consumption.cronjob.expression<\/td>\nThis cron job controls when the license consumption data is captured, also referred to as a snapshot. In a multi-server environment, this cron job should be staggered for each server.<\/p>\n

By default, this is set to 9:00 PM daily.<\/td>\n<\/tr>\n

license.consumption.upload.cronjob.expression<\/td>\nThis cron job controls when the license consumption snapshot is automatically sent to Ephesoft. In a multi-server environment, this cron job should be staggered for each server.<\/p>\n

By default, this is set to 5:00 AM daily.<\/td>\n<\/tr>\n

number.of.past.months.to.show.for.download<\/td>\nThis property controls how many previous months of consumption data will be visible from the Monthly consumption report <\/strong>dropdown in the License Consumption Report<\/a>.<\/p>\n

By default, this is set to 11 months.<\/td>\n<\/tr>\n

dcma.telemetry.reporting.email.to.address<\/td>\nThis property specifies the email address your consumption report will be sent to when the Email <\/strong>button is clicked on the License Consumption Report <\/strong>page.<\/td>\n<\/tr>\n
license.consumption.snapshot.throttle1<\/sup><\/td>\nThis property specifies the minimum interval in minutes between two cycles to capture consumption snapshots.<\/p>\n

By default, this is set to 360 minutes (6 hours).<\/td>\n<\/tr>\n

license.consumption.upload.throttle1<\/sup><\/td>\nThis property specifies the minimum interval in minutes between two attempts to automatically upload consumption snapshots.<\/p>\n

By default, this is set to 5 minutes.<\/td>\n<\/tr>\n

license.consumption.upload.api.connect.timeout<\/td>\nThis property specifies how long Transact will wait (in minutes) for a server connection to be established when uploading the consumption report before timing out.<\/p>\n

By default, this is set to 1 minute.<\/td>\n<\/tr>\n

license.consumption.upload.api.read.timeout<\/td>\nThis property specifies how long Transact will wait (in minutes) for the servers to complete the request and provide a response before timing out.<\/p>\n

By default, this is set to 3 minutes.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

1. Throttling is a countermeasure in the event the CRON job schedules for snapshot creation and upload are accidentally configured to run too frequently.<\/em><\/sup><\/p>\n

<\/a>Conclusion<\/h2>\n

This completes an overview of the dcma-telemetry.properties<\/strong> file.<\/p>\n","protected":false},"featured_media":0,"parent":15612,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"yoast_head":"\ndcma-telemetry.properties | Ephesoft Docs<\/title>\n<meta name=\"robots\" content=\"noindex, follow\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"dcma-telemetry.properties\" \/>\n<meta property=\"og:description\" content=\"Applies to: Ephesoft Transact 2020.1.04 and above This document describes the properties in the dcma-telemetry.properties file in Ephesoft Transact. This […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\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=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/\",\"name\":\"dcma-telemetry.properties | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2021-03-02T18:17:55+00:00\",\"dateModified\":\"2021-03-02T18:17:55+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/ephesoft.com\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transact\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"System Configuration\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Ephesoft Transact Property Files Reference Guide\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"dcma-telemetry.properties\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\",\"url\":\"https:\/\/ephesoft.com\/docs\/\",\"name\":\"Ephesoft Docs\",\"description\":\"Intelligent Document Processing Made Easy\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/ephesoft.com\/docs\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"dcma-telemetry.properties | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"dcma-telemetry.properties","og_description":"Applies to: Ephesoft Transact 2020.1.04 and above This document describes the properties in the dcma-telemetry.properties file in Ephesoft Transact. This […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/","og_site_name":"Ephesoft Docs","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/","name":"dcma-telemetry.properties | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2021-03-02T18:17:55+00:00","dateModified":"2021-03-02T18:17:55+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/dcma-telemetry-properties\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/ephesoft.com\/docs\/"},{"@type":"ListItem","position":2,"name":"Transact","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/"},{"@type":"ListItem","position":3,"name":"System Configuration","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/"},{"@type":"ListItem","position":4,"name":"Ephesoft Transact Property Files Reference Guide","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/"},{"@type":"ListItem","position":5,"name":"dcma-telemetry.properties"}]},{"@type":"WebSite","@id":"https:\/\/ephesoft.com\/docs\/#website","url":"https:\/\/ephesoft.com\/docs\/","name":"Ephesoft Docs","description":"Intelligent Document Processing Made Easy","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ephesoft.com\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"comment_count":0,"_links":{"self":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/48105"}],"collection":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/comments?post=48105"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/48105\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/15612"}],"next":[{"title":"Ephesoft Logo URL redirection","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/ephesoft-logo-url-redirection\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/6718"}],"prev":[{"title":"Transact Temporary Folder Automatic Cleanup","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/transact-property-file-reference-guide\/ephesoft-temporary-folders-auto-cleanup\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/4609"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=48105"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=48105"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}