|
|
|
|
|
TelemetryConfigure (Function) In french: TélémétrieParamètre Gets and sets the telemetry settings. // Forces telemetry data to be sent every 30 minutes TelemetryConfigure(tcMaximumPeriodCollection, 1800) Syntax
Getting the telemetry settings Hide the details
<Result> = TelemetryConfigure(<Parameter>)
<Result>: Integer Value of specified parameter. <Parameter>: Integer constant Parameter to retrieve. This parameter corresponds to one of the following constants: | | tcEnableLog | Configure the telemetry log. Can correspond to a combination of the following constants: - tcFileLog: Telemetry uses a file log. The corresponding file is saved in the "<user>\AppData\Roaming\<company>\<application>" directory.
This constant is not available. - tcMemoryLog: Telemetry uses a memory log.
| tcGetMemoryLog | Returns the content of memory log. | tcIdleTimeout | Used to count the activity time on a window: the count stopwatch is automatically stopped after this idle time. This timeout is set to 1 minute by default. | tcMaximumPeriodCollection | Maximum periodicity for collecting the telemetry data (in seconds). The data will be sent at the end of this period, regardless of the size of collected data. This period is set to 1 hour by default. | tcMinimumPeriodCollection | Minimum periodicity for collecting the telemetry data (in seconds). The data can be sent at the end of this period if the minimum size is reached. This period is set to 5 minutes by default. | tcMinimumSizeCollection | Minimum size of data collected for the minimum collection period (in kilobytes). This size is set to 5 MB by default. | tcNumberSendAttempts | Maximum number of attempts to send telemetry data in online mode: - 0. Attempts are not counted. Data is sent every time, even if the server does not respond.
- 1. Data is sent only once when the application is started. If the server does not respond, there will be no more attempts.
- other value (3 by default). Allows you to set a total number of attempts within a given period to send data.
By default, tcNumberSendAttempts = 3 and tcMaximumPeriodCollection = 1 so there are 3 hours of attempts. | tcOfflineMode | Operating mode of telemetry: - True (default value). Telemetry works in offline mode.
- False. Telemetry works in online mode (default behavior before version 25)..
| tcStatus | Current status of telemetry. This status can correspond to one of the following constants: - tsAbandon: telemetry is abandoned after too many sending errors.
- tsCollect: telemetry is enabled and data is being collected.
- tsWaiting: telemetry is enabled but could not send data to the server. Data is waiting to be sent at a later date.
- tsSend: telemetry is enabled and has successfully sent data.
- tsError: telemetry is enabled but could not send data to the server.
- tsInactive: telemetry is inactive.
|
Setting the telemetry settings Hide the details
<Result> = TelemetryConfigure(<Parameter> , <New value>)
<Result>: Integer Former value of specified parameter. <Parameter>: Integer constant Parameter to modify. This parameter corresponds to one of the following constants: | | tcEnableLog | Configure the telemetry log. Can correspond to a combination of the following constants: - tcFileLog: Telemetry uses a file log. The corresponding file is saved in the "<user>\AppData\Roaming\<company>\<application>" directory.
- tcMemoryLog: Telemetry uses a memory log.
| tcIdleTimeout | Used to count the activity time on a window: the count stopwatch is automatically stopped after this idle time. This timeout is set to 1 minute by default. | tcMaximumPeriodCollection | Maximum periodicity for collecting the telemetry data (in seconds). The data will be sent at the end of this period, regardless of the size of collected data. This period is set to 1 hour by default. | tcMinimumPeriodCollection | Minimum periodicity for collecting the telemetry data (in seconds). The data can be sent at the end of this period if the minimum size is reached. This period is set to 5 minutes by default. | tcMinimumSizeCollection | Minimum size of data collected for the minimum collection period (in kilobytes). This size is set to 5 MB by default. | tcNumberSendAttempts | Maximum number of attempts to send telemetry data in online mode: - 0. Attempts are not counted. Data is sent every time, even if the server does not respond.
- 1. Data is sent only once when the application is started. If the server does not respond, there will be no more attempts.
- other value (3 by default). Allows you to set a total number of attempts within a given period to send data.
By default, tcNumberSendAttempts = 3 and tcMaximumPeriodCollection = 1 so there are 3 hours of attempts. | tcOfflineMode | Operating mode of telemetry: - True (default value). Telemetry works in offline mode.
- False. Telemetry works in online mode (default behavior before version 25)..
|
<New value>: Integer New value for the parameter. Remarks TelemetryConfigure can be called before TelemetryEnable. If TelemetryConfigure is called after TelemetryEnable, the new parameters will be taken into account after a timeout not corresponding to the previous minimum collection time. Business / UI classification: Neutral code
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|