{"id":1495,"date":"2019-09-23T09:18:19","date_gmt":"2019-09-23T16:18:19","guid":{"rendered":"https:\/\/portal.staylinked.com\/sl\/kb\/?post_type=ht_kb&p=1495"},"modified":"2022-05-26T17:15:36","modified_gmt":"2022-05-27T00:15:36","slug":"configuring-usage-tracking","status":"publish","type":"ht_kb","link":"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/","title":{"rendered":"Configuring Usage Tracking"},"content":{"rendered":"\n

When you select the \u2018Usage Tracking – Change Settings\u2019 option from the server tree or the Manage menu, a list of Settings will appear in the main display panel. The various settings can be configured to control the options available for the Usage Tracking features. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

The contents of this settings list are dynamic. Depending upon which settings options are enabled, other settings options may or may not be displayed in the list. Only the appropriate settings options will be displayed based upon the currently selected options. You must double-click on one of the settings in the list in order to make changes to that setting.<\/p>\n\n\n\n

Usage Tracking Feature<\/h3>\n\n\n\n

If you double-click on this option, you can enable or disable the entire usage tracking feature set.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

If you wish to have the basic usage tracking features be enabled, click \u2018Yes\u2019. If you wish to disable all of the usage tracking features, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

Activity Tracking Feature<\/h3>\n\n\n\n

If you double-click on this option, you can enable or disable the recording of activity information for each tracked device.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

If you wish to have activity information recorded for all tracked devices, click \u2018Yes\u2019. If you wish to disable activity tracking, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

Activity Tracking Data Age before Export\/Cleanup<\/h3>\n\n\n\n

If you double-click on this option, you can specify how long to keep the recorded activity records for each device. This setting will be compared to the \u2018Activity Recorded\u2019 date\/time stamp on Activity Tracking records in the database. The Usage Tracking Database Export\/Cleanup routine will remove Activity Tracking records where the \u2018Activity Recorded\u2019 date\/time stamp is older than this value. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Enter the number of days, hours and minutes of activity tracking data that you want to keep in the database. Use the appropriate data entry format. Valid values are 0 minutes to 30 days and the default value is 3 days. Click the OK button to make the change. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

Session Tracking Feature<\/h3>\n\n\n\n

If you double-click on this option, you can enable or disable the recording of session information history for each tracked device.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

If you wish to have session information history recorded for all tracked devices, click \u2018Yes\u2019. If you wish to disable session tracking, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

Session Tracking Data Age before Export\/Cleanup<\/h3>\n\n\n\n

If you double-click on this option, you can specify how long to keep the recorded session information history records for each device. This setting will be compared to the \u2018Session Ended\u2019 date\/time stamp on Session Tracking records in the database. The Usage Tracking Database Export\/Cleanup routine will remove Session Tracking records where the \u2018Session Ended\u2019 date\/time stamp is older than this value. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Enter the number of days, hours and minutes of session tracking data that you want to keep in the database. Use the appropriate data entry format. Valid values are 0 minutes to 30 days and the default value is 3 days. Click the OK button to make the change. To retain the current setting, click \u2018Cancel\u2019. <\/p>\n\n\n\n

UserID Tracking Feature<\/h3>\n\n\n\n

If you double-click on this option, you can enable or disable the recording of user ID history for each tracked device.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

If you wish to have user ID history recorded for all tracked devices, click \u2018Yes\u2019. If you wish to disable user ID tracking, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

UserID Tracking Data Age before Export\/Cleanup<\/h3>\n\n\n\n

If you double-click on this option, you can specify how long to keep the recorded user ID records for each device. This setting will be compared to the \u2018Recorded\u2019 date\/time stamp on User ID Tracking records in the database. The Usage Tracking Database Export\/Cleanup routine will remove User ID Tracking records where the \u2018Recorded\u2019 date\/time stamp is older than this value.<\/p>\n\n\n\n

Usage Tracking Database Export\/Cleanup Interval<\/h3>\n\n\n\n

If you double-click on this option, you can specify the number of hours between each processing of the database export\/cleanup routine.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Enter\nthe number of days, hours and minutes to use for the database export\/cleanup interval.\nUse the appropriate data entry format. Valid values are 15 minutes to 3 days.\nClick the OK button to make the change. To retain the current setting, click\n\u2018Cancel\u2019.<\/p>\n\n\n\n

Usage Tracking Database Cleanup Batch Size<\/h3>\n\n\n\n

If you double-click on this option, you can specify the number of records that are deleted in each batch by the database cleanup routine. This value may need to be tuned if the database is storing a very high volume of Activity or Statistics records.

NOTE: <\/strong>This value should only be changed as directed by StayLinked Technical Support.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Enter the number of records that the database cleanup routine should delete per batch. Valid values are 1000 to 10000 records. The recommended value is 2000 records. Click the OK button to make the change. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

Export Usage Tracking Records before Cleanup<\/h3>\n\n\n\n

If you double-click on this option, you can\nenable or disable the export of usage tracking data before it is purged. With\nthis option enabled, any Session, Activity, Statistics or UserID tracking\nrecords that are about to be purged will be exported into a time-stamped CSV\nfile in the server\u2019s \u2018logs\u2019 folder. One file will be created for each tracking\ntype and for each purging interval. In order to prevent excessive storage space\nusage on the server, the \u2018logs\u2019 folder should be monitored for export files and\nthey should be deleted or moved to alternate storage as needed. The exported\nfiles will follow this naming convention:<\/p>\n\n\n\n

  • StayLinkedExportActivity.20140903101748.csv<\/li>
  • StayLinkedExportSession.20140903101748.csv<\/li>
  • StayLinkedExportStatistics.20140903101748.csv<\/li>
  • StayLinkedExportUserID.20140903101748.csv <\/li><\/ul>\n\n\n\n
    \"\"<\/figure>\n\n\n\n

    If you wish to export purged data to CSV files,\nclick \u2018Yes\u2019. If you wish to disable the export of purged data, click \u2018No\u2019. To\nretain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

    Usage Tracking Verbose Logging<\/h3>\n\n\n\n

    The usage tracking log file will contain entries that describe the activities affecting the usage tracking database which is used to store all of the information recorded about the tracked devices. Normally, only basic information is logged into the usage tracking log file. If you double-click on this option, you can enable or disable the verbose logging of usage tracking database activity. <\/p>\n\n\n\n

    \"\"<\/figure>\n\n\n\n

    If you wish to have the verbose logging be enabled, click \u2018Yes\u2019. If you wish to have the usage tracking log file contain only basic activity, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

    Statistics Tracking Feature<\/h3>\n\n\n\n

    The appearance of the dialog and the options available for configuration of Statistics Tracking will depend upon whether Usage Tracking is enabled or not.Usage Tracking <\/strong>
    IS NOT Enabled: <\/strong>

    In the case where Usage Tracking is not enabled, you will have the option of recording statistics to a log file only. <\/p>\n\n\n\n

    \"\"<\/figure>\n\n\n\n

    If you wish to have statistics recorded into a log file, click \u2018Yes\u2019. If you wish to disable all statistics logging, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019.Usage Tracking IS Enabled: <\/strong>

    In the case where Usage Tracking is enabled, you will have three choices for recording statistics for each tracked device. <\/p>\n\n\n\n

    \"\"<\/figure>\n\n\n\n

    Answer\neach question, depending upon how you want to record statistics for your\ntracked devices.<\/p>\n\n\n\n

    • Click the \u2018Yes\u2019 button to configure statistics tracking as described by the current question.<\/li>
    • Click the \u2018No\u2019 button to move to the next pending question. <\/li>
    • Click the \u2018Cancel\u2019 button to retain the current setting. <\/li><\/ul>\n\n\n\n

      Statistics Reporting Interval<\/h3>\n\n\n\n

      If you double-click on this option, you can specify the number of minutes between each reporting of Statistics into the log and\/or database. This setting also controls the database export\/cleanup interval for statistics.<\/p>\n\n\n\n

      \"\"<\/figure>\n\n\n\n

      Enter the number of minutes to use for the\nStatistics reporting interval. Valid values are 1 to 120 minutes. Click the OK\nbutton to make the change. To retain the current setting, click \u2018Cancel\u2019.<\/p>\n\n\n\n

      Statistics Log File Maximum Size<\/h3>\n\n\n\n

      If you double-click on this option, you can specify the maximum size of the Statistics log file. When the statistics log file reaches this size, it will be erased, and a new log file will be started.<\/p>\n\n\n\n

      \"\"<\/figure>\n\n\n\n

      Enter\nthe maximum size of the Statistics log file in KB. Valid values are 16 to 10240\nKB. Click the OK button to make the change. To retain the current setting,\nclick \u2018Cancel\u2019.<\/p>\n\n\n\n

      Statistics Log File Session Counts Only<\/h3>\n\n\n\n

      If you double-click on this option, you can specify whether to record details for each session in the Statistics log or to record maximum session counts only. If you select to log only session counts, then the maximum number of Single Session TE and Dual Session TE sessions will be the only data recorded in the Statistics log file for each interval. This option can assist in tracking the high-water mark of concurrent license usage during each statistic reporting interval. <\/p>\n\n\n\n

      \"\"<\/figure>\n\n\n\n

      If you wish to have only maximum session counts logged, click \u2018Yes\u2019. If you wish to have all session details logged, click \u2018No\u2019. To retain the current setting, click \u2018Cancel\u2019. <\/p>\n\n\n\n

      \"\"<\/figure>\n\n\n\n

      Enter the number of days, hours and minutes of user ID tracking data that you want to keep in the database. Use the appropriate data entry format. Valid values are 0 minutes to 30 days and the default value is 3 days. Click the OK button to make the change. To retain the current setting, click \u2018Cancel\u2019. <\/p>\n","protected":false},"excerpt":{"rendered":"

      When you select the \u2018Usage Tracking – Change Settings\u2019 option from the server tree or the Manage menu, a list of Settings will appear in the main display panel. The various settings can be configured to control the options available for the Usage Tracking features. The contents of this settings…<\/p>\n","protected":false},"author":7,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[47],"ht-kb-tag":[43],"yoast_head":"\nConfiguring Usage Tracking – 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=\"Configuring Usage Tracking – StayLinked\" \/>\n<meta property=\"og:description\" content=\"When you select the \u2018Usage Tracking – Change Settings\u2019 option from the server tree or the Manage menu, a list of Settings will appear in the main display panel. The various settings can be configured to control the options available for the Usage Tracking features. The contents of this settings...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\" \/>\n<meta property=\"og:site_name\" content=\"StayLinked\" \/>\n<meta property=\"article:modified_time\" content=\"2022-05-27T00:15:36+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2019\/09\/Usage-Tracking-2.1-1024x694.jpg\" \/>\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=\"11 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\":\"ImageObject\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/#primaryimage\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2019\/09\/Usage-Tracking-2.1.jpg\",\"contentUrl\":\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2019\/09\/Usage-Tracking-2.1.jpg\",\"width\":1088,\"height\":737},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/#webpage\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\",\"name\":\"Configuring Usage Tracking – StayLinked\",\"isPartOf\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/#primaryimage\"},\"datePublished\":\"2019-09-23T16:18:19+00:00\",\"dateModified\":\"2022-05-27T00:15:36+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/configuring-usage-tracking\/#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\":\"Configuring Usage Tracking\"}]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","_links":{"self":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1495"}],"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=1495"}],"version-history":[{"count":1,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1495\/revisions"}],"predecessor-version":[{"id":4011,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1495\/revisions\/4011"}],"wp:attachment":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/media?parent=1495"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=1495"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=1495"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}