PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Overview
  • Create a custom telemetry
  • Creating sensors and associated widgets for the custom telemetry
  • Creating sensors for the custom telemetry
  • Creating widgets associated with non-categorized sensors
  • Creating widgets associated with categorized sensors
  • Include in the code the calls required to manage the sensors
  • Deploying the custom telemetry
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview
Custom telemetry allows you to define the elements that will be included in the analytics. These elements are defined via "sensors".
  • These sensors can be configured in the telemetry editor.
  • The value of the sensors can be modified in the code of the application, using different WLanguage functions.
The results of this custom telemetry will be displayed in specific widgets.
To use custom data in the telemetry, you must:
  • Create a custom telemetry.
  • Create the widgets displayed by the telemetry.
  • Configure the widgets by defining what information picked up by the sensors will be displayed.
  • Include in the code the calls required to manage the sensors.
  • Deploy the application and its custom telemetry.
Create a custom telemetry
A custom telemetry can be created:
  • via the "Project explorer" pane.:
    1. In the "Project explorer" pane, select the "Custom telemetries" folder.
    2. In the context menu of the folder (right click), select "New custom telemetry".
    3. The "Custom telemetry" pane appears in the editor ribbon.
    4. Create the different sensors and widgets for the custom telemetry.
    5. Save the custom telemetry (Ctrl + S or in the quick access buttons).
  • via the telemetry editor:
    1. On the "Telemetry" tab, in the "Custom telemetry" group, click "New".
    2. The "Custom telemetry" pane appears in the editor ribbon.
    3. Create the different sensors and widgets for the custom telemetry.
    4. Save the custom telemetry (Ctrl + S or in the quick access buttons).
Creating sensors and associated widgets for the custom telemetry

Creating sensors for the custom telemetry

To create a sensor in a custom telemetry:
  1. On the "Custom telemetry" tab, in the "Sensors" group, click "Sensor".
  2. The sensor configuration window appears.
    In this window, you can specify:
    • The type of sensor:
      • Waypoint: This type of sensor makes it possible to count the elements taken into account by the telemetry. For example, it can count the number of new invoices, cancelled invoices, users who used a given feature, etc.
      • Value measurement: This type of sensor is used to count an element. For example, it can count the number of products per invoice, etc.
      • Time measurement: This type of sensor is used to measure the time it takes to complete an action. For example, it can measure the time it takes to prepare an order.
    • The aggregation mode used by the sensor:
      • According to time only: The data will be grouped only by time.
      • According to time and to a category: The data will be grouped according to time and the specified category.
    • The name of the sensor. This name will be used to identify the sensor in the WLanguage code.
    • The WLanguage code for calling the sensor is automatically generated. This code can be copied and pasted into the WLanguage code that will call the sensor.
  3. Validate. The new sensor appears in the "List of sensors" widget.

Creating widgets associated with non-categorized sensors

You can create different types of widgets to display the data from a non-categorized sensor:
  • Value widget:
    1. On the "Custom telemetry" tab, in the "Widgets" group, click "Values".
    2. The widget configuration window appears:
      In this window, you can specify:
      • The widget caption.
      • The information to be displayed:
        • The name of the sensor to use.
        • The information to be displayed: Number, Time, Number of passages, Number of users, Percentage of users, ...
          The information varies according to the type of sensor.
        • The legend
    3. Several values can be displayed in the same widget. Click the "+" button to add a new value to display.
    4. Validate the window for widget configuration.
  • Chart widget:
    1. On the "Custom telemetry" tab, in the "Widgets" group, click "Chart".
    2. The widget configuration window appears:
      In this window, you can specify:
      • The type of chart to be displayed: Column, Stacked Column or Line
      • The widget caption.
      • The elements to be displayed:
        • The name of the sensor to use.
        • The information to be displayed: Number, Time, Number of passages, Number of users, Percentage of users, ...
          The information varies according to the type of sensor.
        • The legend
    3. You can display multiple values in the same chart. Click the "+" button to add a new value to display.
    4. Validate the window for widget configuration.

Creating widgets associated with categorized sensors

You can create different types of widgets to display the data from a categorized sensor:
  • Table widget:
    1. On the "Custom telemetry" tab, in the "Categorized widgets" group, click "Table".
    2. The widget configuration window appears:
      In this window, you can specify:
      • The widget caption.
      • The sensor to be used.
      • The information to be displayed in the table columns:
        • the first column shows the category.
        • for the other columns, specify the column title and the value to be displayed.
  • Time widget:
    1. On the "Custom telemetry" tab, in the "Widget" group, click "Time".
    2. The widget configuration window appears:
      In this window, you can specify:
      • The widget caption.
      • The sensor to be used
      • The type of chart to be displayed: Column, Stacked Column or Line
      • The values displayed in the axes of the chart.
  • Breakdown widget:
    1. On the "Custom telemetry" tab, in the "Widget" group, click "Breakdown".
    2. The widget configuration window appears:
      In this window, you can specify:
      • The widget caption.
      • The sensor to be used.
      • The type of chart to be displayed: "Value Column chart" or "Value Pie chart".
      • The information to be displayed.
    3. Validate the window for widget configuration.
You can edit the different widgets via the context menu (button at the lower-right corner of the widget). You can:
  • Edit the widget.
  • Versions 27 and later
    Duplicate the widget.
    New in version 27
    Duplicate the widget.
    Duplicate the widget.
  • Delete the widget.
Include in the code the calls required to manage the sensors
One or more sensors are created along with a widget.
To save the data from these sensors, they must be managed in the application processes. Two WLangage functions are available:
Versions 21 and later
TelemetryAddMeasure
New in version 21
TelemetryAddMeasure
TelemetryAddMeasure
Adds a measure for a value sensor or for a time sensor.
Versions 21 and later
TelemetryAddPassage
New in version 21
TelemetryAddPassage
TelemetryAddPassage
Signals the code execution for a passage sensor.
For example:
  • Measurement sensor:
    // A "NumberProducts" sensor was defined in the editor
    // Whenever an order is validated, the number of products found in the order is added
    TelemetryAddMeasure(NumberProducts, ProductTable..Count)
  • Passage sensor:
    // An "OrderCancellation" sensor was defined in the editor.
    // Whenever an order is canceled, we identify the use of the feature
    // by the user
    TelemetryAddPassage(OrderCancellation)
Deploying the custom telemetry
In order for a custom telemetry to be taken into account, you must:
  1. Deploy the custom telemetry on the server.
  2. Generate and deploy the application containing the calls to the different sensors.
To deploy the custom telemetry, click the "Deploy" option found in the "Custom telemetry" pane.
Minimum version required
  • Version 21
This page is also available for…
Comments
Click [Add] to post a comment