{"id":1561,"date":"2019-09-23T13:07:55","date_gmt":"2019-09-23T20:07:55","guid":{"rendered":"https:\/\/portal.staylinked.com\/sl\/kb\/?post_type=ht_kb&#038;p=1561"},"modified":"2021-03-26T13:41:45","modified_gmt":"2021-03-26T20:41:45","slug":"managing-the-usage-tracking-data","status":"publish","type":"ht_kb","link":"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/","title":{"rendered":"Managing the Usage Tracking Data"},"content":{"rendered":"\n<p>The StayLinked Server is a Java Server application and uses a Java Database to record and contain the Usage Tracking data. The Usage Tracking database is embedded in the server and is fully encrypted and secured.<\/p>\n\n\n\n<h2>Usage Tracking Database Details<\/h2>\n\n\n\n<p>The Java Database that is used to record the Usage Tracking data is contained in the \u2018..\/stay-linked\/usage\u2019 folder that resides on the StayLinked Server. The \u2018usage\u2019 folder and its contents are the database and the objects in this folder will be allocated while the StayLinked Server process is running. The \u2018usage\u2019 folder and its contents will not be able to be copied, modified, moved or deleted while the StayLinked Server process is running. In order to backup the Usage Tracking database, you must make a copy of the \u2018usage\u2019 folder and its contents while the StayLinked Server process is not running.<\/p>\n\n\n\n<h2>Usage Tracking Database Size and Growth<\/h2>\n\n\n\n<p>The contents of the Usage Tracking database are\nstored in the \u2018..\/stay-linked\/usage\u2019 folder that resides on the StayLinked\nServer. The size and growth of the \u2018usage\u2019 folder will depend upon a number of\nvariables:<\/p>\n\n\n\n<ul><li>The configuration of the Usage Tracking feature. The more options that are enabled for recording different information, the larger the database can grow.<\/li><li>The number of unique devices that connect to the StayLinked Server. If usage tracking is enabled, then at minimum there will be one single usage tracking record created for each unique device that connects to the server.<\/li><li>The number of sessions that are started and ended. If the usage tracking is configured to enable Session Tracking, then the database will increase in size as more sessions are started and ended.<\/li><li>The amount of Activity Tracking recorded. If the usage tracking is configured to enable Activity Tracking, then the frequency of activity being recorded will affect the size of the database.<\/li><li>The frequency of the Statistics Interval. If the usage tracking is configured to record Statistics to the database, then the database will grow faster if the Statistics Interval is shorter.<\/li><li>The amount of UserID Tracking recorded. If the usage tracking is configured to enable UserID Tracking, then the frequency of UserIDs being recorded will affect the size of the database.<\/li><li>The configuration of the Database Cleanup routine. The <a href=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\" data-type=\"ht_kb\" data-id=\"1495\">Activity Tracking Data Age before Export\/Cleanup<\/a> configuration and the \u2018Cleanup Interval\u2019 configuration will affect the size of the database.<\/li><\/ul>\n\n\n\n<h2>The Usage Tracking Database Cleanup Routine<\/h2>\n\n\n\n<p>In order to manage the growth of the Usage\nTracking database, the Database Cleanup routine can be configured to purge\nrecords from the database according to the Usage Tracking Configuration. The\nDatabase Cleanup routine will run according to the \u2018Cleanup Interval\u2019 that can\nbe configured. Each time the Database Cleanup routine runs, the following steps\nwill be performed.<\/p>\n\n\n\n<ul><li>The Usage Tracking Database Cleanup routine will wake up according to the configured \u2018Cleanup Interval\u2019 value, but the cleanup processing will only occur if Usage Tracking is enabled.<\/li><li>Session Tracking records will be collected based upon the \u2018<a href=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\" data-type=\"URL\" data-id=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\">Session Tracking Data Age before Export\/Cleanup<\/a>\u2019 setting. If configured for export, these old Session Tracking records will be written to an export file. Then, the collected records will be deleted from the Usage Tracking database.<\/li><li>Activity Tracking records will be collected based upon the \u2018<a href=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\" data-type=\"URL\" data-id=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\">Activity Tracking Data Age before Export\/Cleanup<\/a>\u2019 setting. If configured for export, these old Activity Tracking records will be written to an export file. Then, the collected records will be deleted from the Usage Tracking database.<\/li><li>UserID Tracking records will be collected based upon the \u2018<a href=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\" data-type=\"URL\" data-id=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\">UserID Tracking Data Age before Export\/Cleanup<\/a>\u2019 setting. If configured for export, these old UserID Tracking records will be written to an export file. Then, the collected records will be deleted from the Usage Tracking database.<\/li><li>The remaining tracking records will be counted and reported into the usage tracking log file.<\/li><\/ul>\n\n\n\n<p>After the process is completed, the Cleanup\nroutine will sleep according to the \u2018Cleanup Interval\u2019 value.<\/p>\n\n\n\n<p>The same cleanup procedure will be processed for the Statistics Tracking records, but the \u2018Statistics Interval\u2019 will control the frequency of the cleanup of statistics tracking records.<\/p>\n\n\n\n<h2>Resetting the Usage Tracking Database to Default<\/h2>\n\n\n\n<p>The Usage Tracking database can be reset to\ndefault. Resetting the database may be desirable if the \u2018usage\u2019 database folder\ngrows to a size that is larger than desired. The \u2018usage\u2019 folder that contains\nthe usage tracking database will grow dynamically as more tracking data is\nadded. The Database Cleanup routine will delete data from the database, but the\nnewly freed storage space will not be reclaimed by the file system. Any unused\nstorage that is freed by the Database Cleanup routine will be reused for any\nnew tracking data that is added. If you want to restore the \u2018usage\u2019 database\nfolder to the original default size and recover all of the unused storage\nspace, you will need to reset the usage tracking database. If you reset the\nusage tracking database, you will lose any data that had not already been\ncleaned-up by the Database Cleanup routine.<\/p>\n\n\n\n<p>The process to reset the usage tracking\ndatabase to default follows:<\/p>\n\n\n\n<ol><li>End the StayLinked Server process.<\/li><li>Delete, rename or move the \u2018usage\u2019 subfolder from under the parent \u2018stay-linked\u2019 folder.<\/li><li>Verify that the \u2018usage\u2019 folder no longer exists as a subfolder under the parent \u2018stay-linked\u2019 folder.<\/li><li>Restart the StayLinked Server process.<\/li><li>During startup, the StayLinked Server will build a fresh \u2018usage\u2019 folder if it does not already exist.<\/li><\/ol>\n","protected":false},"excerpt":{"rendered":"<p>The StayLinked Server is a Java Server application and uses a Java Database to record and contain the Usage Tracking data. The Usage Tracking database is embedded in the server and is fully encrypted and secured. Usage Tracking Database Details The Java Database that is used to record the Usage&#8230;<\/p>\n","protected":false},"author":7,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[47],"ht-kb-tag":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v16.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Managing the Usage Tracking Data &ndash; StayLinked<\/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:\/\/www.staylinked.com\/knowledge-base\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Managing the Usage Tracking Data &ndash; StayLinked\" \/>\n<meta property=\"og:description\" content=\"The StayLinked Server is a Java Server application and uses a Java Database to record and contain the Usage Tracking data. The Usage Tracking database is embedded in the server and is fully encrypted and secured. Usage Tracking Database Details The Java Database that is used to record the Usage...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/\" \/>\n<meta property=\"og:site_name\" content=\"StayLinked\" \/>\n<meta property=\"article:modified_time\" content=\"2021-03-26T20:41:45+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=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/#website\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/\",\"name\":\"StayLinked Knowledge Base\",\"description\":\"Partner Portal Resources and Support\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/portal.staylinked.com\/sl\/kb\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/#webpage\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/\",\"name\":\"Managing the Usage Tracking Data &ndash; StayLinked\",\"isPartOf\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/#website\"},\"datePublished\":\"2019-09-23T20:07:55+00:00\",\"dateModified\":\"2021-03-26T20:41:45+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/managing-the-usage-tracking-data\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/portal.staylinked.com\/sl\/kb\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Articles\",\"item\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Managing the Usage Tracking Data\"}]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","_links":{"self":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1561"}],"collection":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/comments?post=1561"}],"version-history":[{"count":0,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1561\/revisions"}],"wp:attachment":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/media?parent=1561"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=1561"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=1561"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}