Automatic Transmissions of the Usage Report

  • Published on Sep 17, 2024
  • 1 minute(s) read

In v39 and later, on-premise, internet-connected instances send Usage Reports to Hyperscience. These reports are sent daily and contain data on the use and configuration of Hyperscience over the past seven days. To learn more about the contents of the Usage Report, see Usage Report.

The automatic transmission of Usage Reports is enabled by default. It is not possible to change the frequency or content of the automatic transmissions. 

Instances not connected to the internet

If your instance is not connected to the internet, you need to disable automatic transmissions by entering the following in your “.env” file:

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_ENABLED=false

Because automatic transmission is the default method for sending usage data to Hyperscience, you need to send your usage data to Hyperscience through an alternate method that your Hyperscience representative has reviewed and agreed to.

Instances connected to the internet

Depending on your organization’s security measures, you may need to take additional action to allow the automatic transmission of Usage Reports.

Configuring a proxy

Your IT team may determine that a proxy is needed in order to transmit Usage Report. If you’ve already configured a proxy for Hyperscience by following the steps in Proxy Server, that proxy configuration will be used to transmit the Usage Report. If a different proxy is required, you will need to enter values for the ".env' variables that are relevant to your organization’s security policies:

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_USERNAME=<username>

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_HTTP=<address in the form proto://host:port>

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_HTTPS=<address in the form proto://host:port>

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_CERTIFICATE_PATH=<path to certificate>

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_KEY_PATH=<path to key>

Configuring a firewall for outbound requests

If your IT team has configured a firewall that prevents the system from issuing outbound requests, work with them to allow requests to be sent to https://usage-reporting.hyperscience.net.