Devtools
Devtools is a runtime debugging and analysis tool that allows you to inspect an application built with Studio on any device, and see its registers and arrays in real time. This tool speeds up the process of detecting logic issues in building and QA instances after publishing an application.
Devtools synchronizes remotely with an application already installed on any device and lets you perform several actions, such as:
visualizing an app's configuration,
seeing registers and arrays in different contexts,
modifying registers and arrays' values for testing purposes on your configuration,
adding new registers and arrays,
creating context snapshots for a specific moment within your application,
exporting and burning contexts, and
executing commands on a console to implement them in real time.
Note
Devtools supports binaries generated from 7.6.0 branches or higher for mobile, both for Android and iOS apps.
Prerequisites
To run and test an app with Devtools, make sure you meet the following prerequisites:
Generated your app's build or builds in Mobile Builder with Devtools enabled. You must add the Devtools SDK when creating the app in Mobile Builder together with the API Token provided by Support.
Downloaded your app's configuration and installed it in your device.
Important
Devtools is not available in production environments.
Before inspecting an application using the Google Chrome browser, you might need to change some security settings to avoid getting a CORS (Cross-Origin Resource Sharing) error. Read Fix CORS error on Chrome below to learn how to do this.
To enable Devtools on a binary generated in Mobile Builder, follow these steps:
Create or edit an application in your Mobile Builder environment.
In the SDKs section, click Add. In the modal that opens, select Devtools.
After selecting one or more platforms for the SDK (iOS, Android and Harmony), you must also enter the API token in the Global section, which is provided by Support.
Finally, in Select isQAEnvironment, choose False, and add the SDK to the application.
Note
If you are editing an existing application in a production environment, and the Devtools SDK is already configured, the Devtools chip appears marked in red, and you must remove it from the SDKs section to save any changes in your application.
If you are generating a binary from the AP, copy the property vtua.ini.debug.interfaces=Y into your binary's configuration file.
When you try to open Devtools on Google Chrome for the first time, you might encounter a CORS error. To fix this issue, follow these steps:
Click Not secure (warning icon to the left of Devtools' URL) and then Site Settings.
On the Security and Privacy page, find the Insecure Content field on the Permissions section, and choose Allow.
Access the URL detailed on Devtools' homepage: chrome://flags/#block-insecure-private-network-requests. Find the Block insecure private network requests section and choose Disabled on the drop-down menu. Restart Chrome to apply changes.
Note
These settings are saved on your browser, so you only need to follow these steps the first time you access Devtools.
To learn how to navigate Devtools and inspect applications, go to Inspect Apps with Devtools.
Access and Navigate Devtools
Access Devtools by logging into Workspace with your platform credentials, and then look for the Devtools shortcut on the platform components list on the left. You can also access Devtools with your environment's URL and log in with your platform credentials.
When you log in, you will only visualize devices that belong to your client that are available to inspect. Devices are detected only when the app is running. If you need to narrow down the list of devices on the Devices section, use any of the filters explained below.
Search by device name | Enter a keyword to filter devices by name. |
Platform | Click the drop-down icon to filter devices by platform. The options are: Web, Android and iOS. |
Filters | Click to display additional filters you can apply to your search. The options are: client, environment, product code and configuration type. |
Clear all | Click to delete all filters applied. |
To connect to a device, open the app you want to inspect on the device and click its card on the Devtools homepage. To learn how to inspect, debug and analyze an application, read Inspect an App with Devtools.