Qt Insight Onboarding Instructions

• Intro
• Basic Setup
• Qt Insight Console
• Using Qt Design Studio with Qt Insight Tracker library
• Enabling Data Tracking in Qt Design Studio
• Setting sending cadence
• Predefined categories
• Custom categories
• Using custom categories

Intro

Qt Insight allows device manufacturers to collect usage data from Qt applications running in devices. The solution is based on the Tracker library, which is linked to the tracked Qt applications, and which transfers the data from the device to the data backend. The library can be also used together with Qt Design Studio, which allows adding tracked items without writing any programming code.

These instructions explain how to get started with Tracked library without or with Qt Design Studio.

Basic Setup

Users must have a valid Qt commercial license in order to begin using the beta program of Qt Insight.

Any commercial license can be used. If you do not have a commercial Qt license, you may request an evaluation license at  https://www.qt.io/download by clicking on “Try Qt Framework and Tools”.

The full Qt Insight product, once launched in 2023, can be used with any Qt license, including open source.

All the required Qt Insight SW components are distributed as Qt offline installers. You may download the installers using the following links. By downloading the installers, you accept the Qt Insight Tracker license agreement.

• Windows installer
• Linux installer
• macOS installer

There are two installers for each platform Windows, Linux, and macOS. The Insight Tracker installer contains the necessary Qt libraries for development in addition to the tracker library itself. So, it is sufficient to download only the tracker library package for your platform.

Tracker library will be linked to the Qt application and will run on the target device. It sends the tracked events to the cloud data storage. The payload is defined as a JSON scheme for each event type. 

• Run the Qt Insight Tracker library offline installer for your platform

qt-enterprise-<your selected platform>-universal-qtinsighttracker-6.4.1

• Run the installer
• Note that you need to have a commercial license associated with your Qt Account. Otherwise, the login will fail with an error message: “Authentication failed”.
• Select a suitable folder, where the SW components will be installed. 
• In the “Select components” view, pick up at least Qt for your toolchain and Qt Insight Tracker library. In Linux and macOS, there is only one toolchain, but in Windows you may select between MinGW and MSVC toolchains.

• Click on the Next button to proceed with the installation.

After the installation is finished, you will find two examples showing how to use Tracker library in the

<Qt Installation folder>/Qt6.4.1.Insight/Examples/Qt6.4.1/insighttracker

folder. The library documentation is available here.

IMAGE < Views>   <Check Qt Insights

Check Qt Insights, the View menu opened

To send the tracked data into the pipeline, you will need an access token. You will get the access token from the Qt Insight Console.

Qt Insight Console

After setting up the tracker library, you need to create an account for the Qt Insight Console https://insight.qt.io. Log in with the Qt Account and enter name of your organization. You will become an administrator for the given organization. As an administrator you can add and invite other users to your organization.  Note the access token created for the organization. This token needs to be copied to the tracker library configuration to send the tracked data.

For more information about using Qt Insight Console see the help section of the application.

Using Qt Design Studio with Qt Insight Tracker library

Qt Design Studio is installed using the online installer. The online installer is available in the customer portal in the Downloads section. Launch Qt Design Studio after installation.

Download the installer and run it. Note that you may need to give execution permission in Linux as previously. Install Qt Design Studio 3.9.0 or later. Qt Design Studio is located in the Developer and Designer Tools folder. 

After installation, launch Qt Design Studio and create a new project. If the Qt Insight View is not visible when a Qt Design Studio Project is open, Navigate to Views in the View menu 

Create a new Qt Design Studio project. If the Qt Insight View is not visible when a Qt Design Studio Project is open, Navigate to Views in the View menu

IMAGE < Views>   <Check Qt Insights

Check Qt Insights, the View menu is opened.

Enabling Data Tracking in Qt Design Studio

Tracking is enabled and disabled using Qt Insight View. Enable tracking by activating Tracking Switch

IMAGE < enable tracking>

Enter the token, you will get from Qt Insight web page. Token has 64 alphanumeric characters.

Please note that it is not advisable to share the token outside your team or your corporate. Anyone having the token (and schema and collector endpoint) can send analytics data to the organisation's storage.

IMAGE < Qt insight view>

Setting sending cadence

Sending cadence settings defines how often tracked data is sent

• Send cadence is set to 1 minute by default
• Adjust the cadence by using controls in the field

IMAGE < Send cadence>

Predefined categories

›    Predefined categories contain a list of categories for component types which can be tracked.  For example there can be interactive components like buttons, which can be identified automatically. Using predefined categories allow to control what kind of data is gathered and sent. These categories cannot be edited by users.

• User can select one or more categories that are used
• Check “ Select all” to use all listed categories
•  Unchecking  selection(s)  filters tracking off which helps to reduce the amount of sent data.

IMAGE < predefined categories>

Custom categories

Custom categories are managed by users and they are used with custom components. For example, if user selects a drink from machine, drink type categories are could be coffee, tea, hot chocolate. Defined options are available in Property panel.

• User can add, rename and delete custom categories 
• Add new category by clicking + icon “Add new category”  
• Type a unique name for new category 
• Remove a category by clicking x icon after category name 
• Renaming categories only changes the configuration files, but not the qml files where they might be referenced.
• Select all and uncheck to filter off works similarly than in Predefined categories

IMAGE < add and delete>

• Custom categories are available for use in in Property panel’s Analytics section

IMAGE < property options>

Using custom categories

• Select an interactive element  or a view( Screen) from design.  Screen can be also a state. 
• choose a  custom property to be used from a drop ComboBox  in Property panel’s Analytics section

IMAGE < using categories>

The [None] entry is for resetting the attached property and it is also use to show that nothing is set on the currently selected item.

IMAGE < none>

Red" text means the category isn't available

• This can happen if a user puts in the code themselves or if a category was set and afterwards renamed.

IMAGE < red>