diff --git a/content/en/docs/refguide/modeling/menus/help-menu/_index.md b/content/en/docs/refguide/modeling/menus/help-menu/_index.md index 6c505e0dc83..9f96aad74fb 100644 --- a/content/en/docs/refguide/modeling/menus/help-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/help-menu/_index.md @@ -20,7 +20,7 @@ The **Help** menu items are described in the table below: | **Help Contents** | Opens the home page of the documentation in the default web browser. | | **Ask a Question** | Opens the Mendix Community in the default web browser. | | **Submit Feedback...** | Opens the [Help us improve](/refguide/feedback-survey/) dialog to gather input on your experience using Mendix Studio Pro. | -| **Support Tools** | Provides tools that can be used to share with Mendix Support, especially when you encounter issues with performance or high memory consumption. Support tools include the following:
| +| **Support Tools** | Provides tools that can be used to share with Mendix Support, especially when you encounter issues with performance or high memory consumption. Support tools include the following:
| | **Open Log File Directory** | Opens the log files written by Studio Pro. Studio Pro retains these logs for the last 30 days, with files organized from most recent to oldest. You can use log files to diagnose issues or share them with Mendix Support when you submit a ticket. | | **Welcome** | Opens the **Welcome** page, which displays information about the current Studio Pro version and includes links to release notes, Mendix platform blogs, Maia Learn, and Maia Chat. | | **About Mendix Studio Pro** | Displays information about the current version of Mendix Studio Pro. | diff --git a/content/en/docs/refguide/modeling/menus/help-menu/collect-support-information.md b/content/en/docs/refguide/modeling/menus/help-menu/collect-support-information.md new file mode 100644 index 00000000000..578df1d2912 --- /dev/null +++ b/content/en/docs/refguide/modeling/menus/help-menu/collect-support-information.md @@ -0,0 +1,114 @@ +--- +title: "Collect Support Information" +url: /refguide/collect-support-information/ +description: "Describes how to collect support information from Studio Pro, including device-specific information from the Make It Native app for native mobile apps." +--- + +## Introduction + +When you report an issue to Mendix Support, it helps to share details about your environment. **Collect Support Information** gathers these details in one place: information about your computer, Studio Pro, and your app, together with the Studio Pro log files. + +If your app has a native mobile profile, Studio Pro can also include device-specific information from the Make It Native app running on your phone or tablet. This information includes the device model, the operating system, network status, and the recent client logs of your app. It helps Support reproduce problems that only occur on a specific device or only at runtime. Including device information is available in Studio Pro 11.17 and above. + +To start collecting support information, click **Help** > **Support Tools** > **Collect Support Information…**. + +## What Is Collected + +### Studio Pro and Computer Information + +The following information is shown in the **Support Information** dialog and is always included in the saved ZIP file: + +* System information (operating system, processor, screens, and so on) +* CPU, memory, graphics, and disk information +* Java and .NET information +* Open panes and session length +* Project information + +### Device Information from the Make It Native App {#device-information} + +Device information is not shown in the **Support Information** dialog. Studio Pro collects it from the device when you save the support information, and adds it to the ZIP file. This happens when your app has a native mobile profile and a device is connected. The following information is added: + +| Section | Contents | +| --- | --- | +| **Device** | Model, manufacturer, operating system and version, whether the device is an emulator or simulator, total memory, free disk space, and battery level | +| **Network** | Connection type and whether the device is connected to a network | +| **App** | App version, build number, bundle version, runtime URL, whether the app is a developer app, and the database name | +| **Locale** | Device languages and time zone | +| **Logs** | The most recent client log entries generated by the app on the device | + +{{% alert color="info" %}} +Information that is not available on a device is shown as `N/A` in the report. For example, network information is only available when the app runs in the Make It Native app. +{{% /alert %}} + +The client logs are kept in a limited buffer on the device. Only the most recent entries are collected (up to 500 entries or 200 KB). If the log was shortened, the report states how many entries were available in total. + +## Prerequisites + +To include device-specific information in the ZIP file, the following conditions must be met when you save the support information: + +* Your app has a native mobile profile. +* The Studio Pro native packager is running. This is the case when you view your app on a device through Studio Pro. +* The Make It Native app, or a custom developer app, is running on your device and is connected to the runtime of your app. + +If one of these conditions is not met, the ZIP file contains all other support information, but the device-specific information is skipped. Studio Pro does not display a warning in this case. + +## Collecting Support Information + +1. Click **Help** > **Support Tools** > **Collect Support Information…**. +1. Wait for Studio Pro to finish gathering the information. You can cancel the process at any time from the progress dialog. +1. Review the report in the **Support Information** dialog. +1. Click **Save** and select a folder. Studio Pro collects the device-specific information at this moment, if the [prerequisites](#prerequisites) are met, and saves everything in a ZIP file. + +For more information about the dialog and the ZIP file, see [Working with the Report](#working-with-the-report). + +### Including Device Information {#include-device-information} + +Studio Pro collects the device logs when you click **Save**, not while the report is being built. The logs only contain entries from the time the app was connected. To make sure the ZIP file contains the information that Support needs, do the following before you click **Save**: + +1. Connect the Make It Native app to the runtime of your app. For more information, see [Getting Started with Mobile](/refguide/mobile/getting-started-with-mobile/). +1. Reproduce the scenario you want to report, so that the app generates the relevant logs. + +{{% alert color="info" %}} +Studio Pro does not ask for confirmation when no device is connected. If the Make It Native app is not connected, the ZIP file is saved without device-specific information. +{{% /alert %}} + +## Working with the Report + +The **Support Information** dialog shows the collected Studio Pro and computer information as text. You can do the following: + +* **Copy to Clipboard** – copies the report so you can paste it into a support ticket or message +* **Save** – asks you to select a folder and saves a `Support_Information__