Telemetry: Configuration of WINDEV and WINDEV Mobile applications

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Telemetry functions

Overview
Enabling the telemetry
Enabling the telemetry in the project description
Enabling the telemetry in the description of a configuration
Enabling the telemetry when creating the executable
Installing the application
Installing an application that support the telemetry
Installing an application that support the telemetry

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Telemetry: Configuration of WINDEV and WINDEV Mobile applications

Overview

To use the telemetry in a WINDEV or WINDEV Mobile application, you must:

Enable the telemetry in the application. This activation can be done:
- in the project description. In this case, this activation is performed for all the existing project configurations.
- in the platform description.
- when creating the executable.
Deploy the:
- Create the setup program for the application.
- Install the application.

Note: By default, telemetry data is anonymous.. You have the ability to identify the user by using TelemetryIdentifyUser.

Enabling the telemetry

The telemetry can be enabled:

in the project description. In this case, this activation is performed for all the existing project configurations.
in the platform description.
when creating the executable.

Enabling the telemetry in the project description

To enable the telemetry in the project description:

Open the project description window. To do so, go to the "Project" tab, "Project" group, and click "Description".
In the window that is displayed, select the "Telemetry" tab.
Check "Enable the telemetry for the project" and specify the requested parameters:
- Server location:
  - Local, network or Internet server: In this case, you can specify the protocol used: HTPP or HTTPS..
    Note: For HTTPS protocol, you need to install a certificate on your Web server (IIS or Apache).
  - CLOUD platform. In this case, all you have to do is specify the CLOUD account to use.
    Note: A telemetry platform is required..
- Address:
  - Address of server or address of PCCloud platform.
  - Username and associated password. This data was given at the end of setup of telemetry server.
  Check the connection to the telemetry server to make sure that the data is correct.
- Telemetry of application:
  - Application name. This name will be proposed in the telemetry dashboard.
  - The mode for triggering the collection of information. By default, data collection is enabled automatically, but it can be enabled programmatically using TelemetryEnable.
Validate.

These parameters are defined for the current project and for all its configurations. The telemetry can be customized or disabled for each project configuration.

Enabling the telemetry in the description of a configuration

To configure the telemetry for the current configuration:

On the "Project" tab, in the "Project configuration" group, click "Current configuration".
Select the "Telemetry" tab to configure the telemetry.
Several options are available:
- Use project telemetry parameters: This option lets you use the telemetry parameters specified in the project description..
  Warning: If telemetry is not enabled in the project, the current configuration will not use telemetry..
- Use specific telemetry parameters: This option allows you to define specific telemetry parameters for the current configuration.. You can for example disable the telemetry on the project and enable it on a configuration only. You also have the ability to use specific parameters for a type of configuration (for example, the Windows and mobile configurations do not use the same server).
- Disable telemetry for this configuration: This option allows you not to use telemetry for the current configuration..

Note: If you select the "Use specific telemetry parameters" option, it is necessary to define all telemetry parameters..

Specify the location of telemetry server:
- Local, network or Internet server: In this case, you can specify the protocol used: HTPP or HTTPS..
  Note: For HTTPS protocol, you need to install a certificate on your Web server (IIS or Apache).
- CLOUD platform. In this case, all you have to do is specify the CLOUD account to use.
Specify the address of the telemetry server to use:
- Server address,
- Username and associated password. This data was given at the end of setup of telemetry server.
Check the connection to the telemetry server to make sure that the data is correct.
The option "Telemetry of the application" is used to configure:
- The application name. This name will be proposed in the telemetry dashboard.
- The mode for triggering the collection of information. By default, data collection is enabled automatically, but it can be enabled programmatically using TelemetryEnable.

Enabling the telemetry when creating the executable

When creating a Windows executable, you have the ability to enable and configure the telemetry.

Follow these steps:

Select (if necessary) the configuration corresponding to the executable.
Create the executable: in the "Project" pane, in the "Generation" group, click on "Generate".
In the different steps regarding the "EXE definition", the "Telemetry" step is used to specity the telemetry options.
Several options are available:
- Use project telemetry parameters: This option lets you use the telemetry parameters specified in the project description.. This option cannot be used if the telemetry is not enabled in the project.
- Disable telemetry for this configuration: This option allows you not to use telemetry for the configuration linked to the executable currently being generated.
- Use specific telemetry parameters: This option lets you define specific telemetry parameters for the configuration linked to the executable being created.. When this option is selected, all the telemetry parameters must be defined.
  1. Specify the location of telemetry server:
    Local, network or Internet server: In this case, you can specify the protocol used: HTPP or HTTPS..
    Note: For HTTPS protocol, you need to install a certificate on your Web server (IIS or Apache).
    CLOUD platform. In this case, all you have to do is specify the CLOUD account to use.
  2. Specify the address of the telemetry server to use:
    Server address,
    Username and associated password. This data was given at the end of setup of telemetry server.
  3. Check the connection to the telemetry server to make sure that the data is correct.

Follow the different wizard steps to create your executable.

Remark: Telemetry data sent to the server are processed every two hours.. Therefore, it will not be immediately visible in the telemetry dashboard.

Installing the application

Installing an application that support the telemetry

The procedure for creating the setup of an application that supports the telemetry is identical to the procedure for creating a standard setup, with an additional step.

Start the application installation procedure: in the "Project" pane, in the "Generation" group, click on "Setup procedure".
Create the executable if necessary.
In the left section of the wizard, select "Skin template of installer".
Follow the different wizard steps until you reach the "Enabling the telemetry" step.

In this screen, you can:
- Display an information message to the user during the setup. This information message informs the end user that the telemetry will be used on his application.
  Important note: Whether this message is displayed or not, telemetry will be activated in the application.
  If TelemetryIdentifyUser was used in the application code, the default message does not specify that the transmitted data is anonymous data.
- Allow the user to disable the telemetry during the setup.
  In this case, the end user can check (or not) the option "I accept to contribute to the improvement of XXXX". No data will be collected if the end user refuses.
  Note: If the option "When updating, telemetry will be automatically proposed to the user even if he has disabled it" is ticked, the question will be asked of the end user at each new update.

Then, the procedure for setup creation is the standard one.

Reminder: By default, the installation program is supplied in English and French.. To translate the setup program into other languages, a setup custom program must be created.

When the application is installed, the data is sent to the server:

every hour. This frequency can be modified by TelemetryConfigure.
when closing the application.

Installing an application that support the telemetry

The procedure for creating the setup of an application that supports the telemetry is identical to the procedure for creating a standard setup.

The telemetry is automatically enabled when starting the application (or via TelemetryEnable).

The telemetry data is sent whenever possible:

when starting the application,
when closing the application,
every hour,
when moving to the background.

Remarks:

In order for the telemetry data to be sent, a connection to the telemetry server is required.
Using the telemetry in the mobile application does not consume a lot of data.
The frequency for collecting information can be defined by TelemetryConfigure. Indeed, the default frequency of one hour can be reduced in a mobile application (a mobile application is often used for less than 1 hour and the collection frequency can be reduced to 5 minutes, for example).
Windows service-specific events do not collect data for telemetry and cannot use telemetry functions.