Merge pull request mendix#5792 from MichaelMendix/development

Updating App Insights documentation

Author: Luyao-Zhang-1

content/en/docs/developerportal/collaborate/product-insights.md

@@ -1,10 +1,10 @@
 ---
-title: "Mini Surveys & Product Insights"
+title: "Mini Surveys & App Insights"
 url: /developerportal/collaborate/product-insights/
 category: "Collaboration"
 weight: 4
-description: "Describes how to set up mini-surveys to gain product insights into your app and view and export the survey results."
-tags: ["mini survey", "product insights", "sprint", "developer portal"]
+description: "Describes how to set up mini-surveys to gain app insights into your app and view and export the survey results."
+tags: ["mini survey", "app insights", "sprint", "developer portal"]
 ---
 
 {{% alert color="warning" %}}
@@ -13,19 +13,30 @@ This feature is in Beta. For more information on Beta products, see [Beta Releas
 
 ## 1 Introduction
 
-By using **Mini Surveys** > **Product Insights** in the Developer Portal and the [App Insights – Mini Surveys](/appstore/modules/app-insights/) module in the Marketplace, you can set up mini-surveys for the target user groups you would like to reach and collect their feedback to gain valuable product insights.
+By using **Mini Surveys** > **App Insights** in the Developer Portal and the [App Insights – Mini Surveys](/appstore/modules/app-insights/) module in the Marketplace, you can set up mini-surveys for the target user groups you would like to reach and collect their feedback to gain valuable app insights.
 
-You begin by creating a mini-survey in **Product Insights** in the Developer Portal, and then you implement the mini-survey by configuring the **App Insights – Mini-Surveys** module in Studio Pro. After the mini-survey is running, you can view responses that have been collected in **Product Insights** and export the responses to an XLSX file.
+You begin by creating a mini-survey in **App Insights** in the Developer Portal, and then you implement the mini-survey by configuring the **App Insights – Mini-Surveys** module in Studio Pro. After the mini-survey is running, you can view responses that have been collected in **App Insights** and export the responses to an XLSX file.
 
-This document first describes all the pages in **Product Insights** in the Developer Portal, and then it describes the procedure for running a mini-survey.
+This document first describes all the pages in **App Insights** in the Developer Portal, and then it describes the procedure for running a mini-survey.
 
-## 2 Product Insights Configuration 
+### 1.1 Survey Pop-Up Behaviour 
+
+The Mini Survey has specific opt-out rules after a user is shown a Survey.
+   * **The survey opt-out scenarios are;**
+     * **Scenario 1:** – User closes Survey, without answering any questions. User is opted-out and survey will not show again.
+     * **Scenario 2:** – User Answers 1 or more questions but does not finish the survey: Survey will show again to the user. But if they close the survey before finishing (for second time), it will not show survey again.
+     * **Scenario 3:** – User Answers all questions: Survey will not show again.
+
+
+{{% alert color="info" %}}In the GA release (May/June) we will allow you customise these opt-out rules from App Insights portal.{{% /alert %}} 
+
+## 2 App Insights Configuration 
 
 ### 2.1 Survey Overview {#survey-overview}
 
 When you click **Mini Surveys** in the sidebar for an app that already has existing mini-surveys, the **Survey Overview** page opens first.
 
-On the upper-left corner of the page, you can see the name of the app currently opened. Click the app name to open a drop-down list of other apps you can navigate to that have been previously opened for Product Insights.
+On the upper-left corner of the page, you can see the name of the app currently opened. Click the app name to open a drop-down list of other apps you can navigate to that have been previously opened for App Insights.
 
 The tabs of the **Survey Overview** page are described below.
 
@@ -73,9 +84,23 @@ Clicking the mini-survey in a row on the list shows its [survey details](#survey
 
 #### 2.1.3 Settings Tab {#settings}
 
-On the **Settings** tab of **Survey Overview**, you can select **Enable Mendix SSO test users**, which marks the app team members as testers. Testers see the survey every time it is triggered, and their responses are not saved. You can view all the test data on the [Test data](#test-data) tab of the survey details page.
+On the **Settings** tab of **Survey Overview**, you can enable the test mode, and view or generate API keys.
+
+*  **Test Mode - For All Users** – After you enable this test mode, all users will become the testers of your survey. They will see the survey every time it is triggered. Their responses will not be saved, and therefore will not pollute the true survey results. You can view their responses on the [Test data](#test-data) tab of the survey details page. 
+    
+    * To enable this test mode, open your app in Studio Pro. In the **App Explorer**, go to  **Marketplace modules > AppInsights_MiniSurvey > _SETUP > 2. Set API Key & mode.**, and set the **TEST_MODE** constant to **True**.
+    
+*  **Test Mode - For Project Members** – After you enable this test mode, all team members of the app will become the testers of your survey. They will see the survey every time it is triggered. Their responses will not be saved, and therefore will not pollute the true survey results. You can view their responses on the [Test data](#test-data) tab of the survey details page.
+
+    {{% alert color="info" %}}This test mode only works for app team members who are authenticated through Mendix SSO.{{% /alert %}} 
+
+    * To enable this test mode, select **Yes** for **Test Mode - For Project Members** here.
+
+* **API Keys** – You can view API keys here, or generate an API key if there is none available. You need to use the API key as input when you configure the App Insights – Mini-Surveys module in Studio Pro to implement the mini-survey. You need only one API key per app.
+
+    *  To generate an API key, click **Generate API Key** here.
+    *  To view an existing API key, click the eye icon in the **View** column in the table.
 
-{{% alert color="info" %}}If an app team member is not authenticated through Mendix SSO, this setting does not work for them.{{% /alert %}} 
 
 ### 2.2 Survey Details {#survey-details}
 
@@ -118,14 +143,6 @@ You can collect test data using two methods:
 * Change the value of the **TEST_MODE** constant in the [App Insights – Mini-Surveys](/appstore/modules/app-insights/) module. This will show **[TEST_MODE]** on the survey widget UI.
 * Select the **Enable Mendix SSO test users"** check box on the **Settings** tab of **Survey Overview**, which marks the app team members as testers. Note that if an app team member is not authenticated through Mendix SSO, this setting does not work for them. The survey widget will not show **[TEST_MODE]** on the UI.
 
-### 2.3 Product Insights Settings {#product-insights-settings}
-
-When you click the settings icon on [Survey Overview](#survey-overview), **Product Insights Settings** opens.
-
-{{< figure src="/attachments/developerportal/collaborate/product-insights/settings-icon.png" >}}
-
-Here you can view the existing API key, or generate an API key if there is not one available. You need to use the API key as input when you configure the App Insights – Mini-Surveys module in Studio Pro to implement the mini-survey. You need only one API key per app.
-
 ## 3 Running a Mini-Survey
 
 ### 3.1 Creating a Mini-Survey {#create-survey}
@@ -180,13 +197,10 @@ Before the start time of the mini-survey is reached, you should implement the su
 
 To obtain an API key for the implementation, follow these steps:
 
-1. On the [Survey Overview](#survey-overview) page, click the settings icon.
-
-    {{< figure src="/attachments/developerportal/collaborate/product-insights/settings-icon.png" >}}
-
-2. The [Product Insights Settings](#product-insights-settings) page opens:
-
-    * If there is already an active API key, it is shown on the list. If it is suitable to use, click **View** to show the API key, then copy it and save it for later use.
+1. On the [Survey Overview](#survey-overview) page.
+2. Go to the [Setting](#settings) tab.
+3. Check the **API Keys** section:
+    * If there is already an active API key, it is shown on the table. If it is suitable to use, click **View** to show the API key, then copy it and save it for later use.
     * If there is no active API key that you can use, generate one as follows:
 
         1. Click **Generate API Key**.
@@ -201,6 +215,7 @@ To install the [App Insights – Mini-Surveys](/appstore/modules/app-insights/)
 2. Follow the instructions in [How to Use Marketplace Content in Studio Pro](/appstore/general/app-store-content/) to import the module into your app.
 3. Follow the instructions in the [Configuration](/appstore/modules/app-insights/#configuration) section of *App Insights – Mini-Surveys* to complete the implementation of the mini-survey in Studio Pro.
 
+
 ### 3.4 Viewing/Exporting Responses {#view-export-responses}
 
 When the start time that you set for the mini-survey is reached, the survey will start running automatically. Then you get [notifications](/developerportal/#notifications) on how many responses have been collected.
@@ -212,3 +227,10 @@ To check the responses that have been collected, follow these steps::
 3. On the **Active** tab, click the mini-survey to open the [survey details](#survey-details) page.
 4. Go to the **Responses** tab to see all the responses that have been collected.
 5. To export the responses to an XLSX file, click **Export Responses** on the upper-right corner of the page.
+
+## 4 FAQ
+
+### 4.1 Upgrading the module from v1.0.0. to v1.1.0.
+
+In order to fix the issue where surveys do not work locally when running multiple applications we have updated the way Mini Surveys are tracked. Due to this change if you are upgrading from release v1.0.0 to v1.1.0 then you must clear your browsers local storage/cached data to remove deprecated features. This only needs to be done one time in your browser.
+