PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Allows you to find out and modify the telemetry parameters.
Example
// Forces the telemetry data to be sent every half hour
TelemetryConfigure(tcMaximumPeriodCollection, 1800)
Syntax

Finding out the telemetry parameters 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:
Versions 22 and later
tcEnableLog
New in version 22
tcEnableLog
tcEnableLog
Configure the telemetry log. Can correspond to a combination of the following constants:
  • tcFileLog: The telemetry is using a file log. The corresponding file is saved in the "<user>\AppData\Roaming\<company>\<application>" directory.
  • tcMemoryLog: The telemetry is using a memory log.
tcIdleTimeoutUsed 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.
tcStatusCurrent status of telemetry. This status can correspond to one of the following constants:
  • tsAbandon: the telemetry is abandoned after too many send errors.
  • tsCollect: the telemetry is enabled and a collection is in progress.
  • tsSend: the telemetry is enabled and information was sent.
  • tsError: the telemetry is enabled but no information was sent to the server.
  • tsInactive: the telemetry is inactive.
Versions 25 and later
tcOfflineMode
New in version 25
tcOfflineMode
tcOfflineMode
Operating mode of telemetry:
  • True (default value). Telemetry works in offline mode.
  • False. Telemetry works in online mode (default behavior before version 25)..
For more details on how telemetry works, see Telemetry: Method used to send data.
Versions 25 and later
tcNumberSendAttempts
New in version 25
tcNumberSendAttempts
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.
tcMaximumPeriodCollectionMaximum 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.
tcMinimumPeriodCollectionMinimum 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.
Versions 22 and later
tcGetMemoryLog
New in version 22
tcGetMemoryLog
tcGetMemoryLog
Returns the content of memory log.
tcMinimumSizeCollectionMinimum size of data collected for the minimum collection period (in kilobytes).
This size is set to 5 MB by default.

Modifying the telemetry parameters 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:
Versions 22 and later
tcEnableLog
New in version 22
tcEnableLog
tcEnableLog
Configure the telemetry log. Can correspond to a combination of the following constants:
  • tcFileLog: The telemetry is using a file log. The corresponding file is saved in the "<user>\AppData\Roaming\<company>\<application>" directory.
  • tcMemoryLog: The telemetry is using a memory log.
tcIdleTimeoutUsed 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.
Versions 25 and later
tcOfflineMode
New in version 25
tcOfflineMode
tcOfflineMode
Operating mode of telemetry:
  • True (default value). Telemetry works in offline mode.
  • False. Telemetry works in online mode (default behavior before version 25)..
For more details on how telemetry works, see Telemetry: Method used to send data.
Versions 25 and later
tcNumberSendAttempts
New in version 25
tcNumberSendAttempts
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.
tcMaximumPeriodCollectionMaximum 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.
tcMinimumPeriodCollectionMinimum 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.
tcMinimumSizeCollectionMinimum size of data collected for the minimum collection period (in kilobytes). This size is set to 5 MB by default.
<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 time-out not corresponding to the previous minimum collection time.
Business / UI classification : Neutral code
Component : wdxxxsimu.dll
Minimum version required
  • Version 21
This page is also available for…
Comments
Click [Add] to post a comment