Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ We advise limiting the amount of data stored in persistable entities, and passin

Actions that may be batched or divided over multiple threads due to a large load or volume should be offloaded to the [task queue](/refguide/task-queue/). Using this method, you can simultaneously offload multiple tasks to multiple instances, and over multiple threads. You can also run these tasks in the background without having to wait for a user request. Make sure that the end user is aware that something is going on by setting a certain Task Status, or by implementing a progress log.

If you are using Studio Pro [8.18](/releasenotes/studio-pro/8.18/) or older, you can consider using the process queue. See the [Replacing Process Queue](/refguide9/task-queue/#process-queue) section of *Task Queue* for the difference between these functionalities.
Refer to the [Replacing Process Queue](/refguide9/task-queue/#process-queue) section of *Task Queue* for the difference between task queue and process queue.

## ConnectionDetails Entity

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ As of version 7.2.0 of this module, it is highly recommended that you manually r

### Java 8

As of version 7.2.0 of this module, some Java 8-native APIs are utilized that replace functionality that was previously imported from external libraries. This means that for upgrading, Java 8 is a minimum requirement! You can change your JDK directory in Studio Pro via **Edit** > **Preferences**. As of [Studio Pro 8](/releasenotes/studio-pro/8.0/), AdoptOpenJDK 11 is supported.
As of version 7.2.0 of this module, some Java 8-native APIs are utilized that replace functionality that was previously imported from external libraries. This means that for upgrading, Java 8 is a minimum requirement. You can change your JDK directory in Studio Pro via **Edit** > **Preferences**. Use AdoptOpenJDK 11.

### Breaking Change to XSSSanitize

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:
{{% alert color="warning" %}}
This document is for the Mendix Feedback module which is compatible with Studio Pro 9.18.6 and above.

If you are using the deprecated Mendix Feedback widget (compatible with Studio Pro 8.6.0 and above), see the [Legacy Feedback Widget Docs](#legacy-feedback-docs) sections below.
If you are using the deprecated Mendix Feedback widget, refer to the [Legacy Feedback Widget Docs](#legacy-feedback-docs) sections in this document.

All Mendix Feedback widgets with versions lower than 8.4.0 are disabled as of October 1, 2022. If you are using one of these versions, [upgrade your current Mendix Feedback widget with the latest version of this module](#upgrade).

Expand Down Expand Up @@ -80,7 +80,7 @@ To configure the Feedback widget, double-click it to open the **Edit Feedback**
* **Model pop-up type** – This controls what happens once you click the **Feedback** button. By default, it opens the **Share Feedback** page. If you select **Custom**, you can select a different **On click** action.
* **App ID** – This is the unique identifier of your app. You can find it under **Project ID** in your app’s [Settings](/developerportal/general-settings/) in Apps.

{{% alert color="info" %}}The original value of **App ID** is *1*, but this value should automatically change to your correct app ID. If it does not change automatically, see [Updating App ID](#update-app-id) below.
{{% alert color="info" %}}The original value of **App ID** is *1*, but this value should automatically change to your correct app ID. If it does not change automatically, refer to [Updating App ID](#update-app-id) below.
{{% /alert %}}

* **Show advanced settings** – These advanced settings allow you to customize where the widget renders and how screenshots are captured when the default behavior does not work as expected. By default, this is set to **No**. If you select **Yes**, the following items are displayed:
Expand Down Expand Up @@ -127,7 +127,7 @@ The image is allowed up to 5MB in one of the following formats: JPG, JPEG, PNG,

{{< figure src="/attachments/appstore/platform-supported-content/modules/mendix-feedback/feedback-submit-button.png" width="500px" class="no-border" >}}

After clicking **Submit**, your feedback will go straight to the [Feedback](/developerportal/app-insights/feedback/) page of the app in [Apps](https://sprintr.home.mendix.com/). Once you see the final page, you have successfully submitted your feedback.
After clicking **Submit**, your feedback will go straight to the [Feedback](/developerportal/app-insights/feedback/) page of the app in [Apps](https://sprintr.home.mendix.com/). Once the final page is displayed, you have successfully submitted your feedback.

## Upgrading the Deprecated Feedback Widget to the Feedback Module {#upgrade}

Expand All @@ -149,11 +149,11 @@ If it did not change to your app ID because of an unexpected error, you can upda

### Feedback Item Does Not Show in Apps

If you cannot see your feedback items on the **Feedback** page after opening your app in [Apps](https://sprintr.home.mendix.com/), it is possible that you have configured a wrong **App ID** or **Feedback server location**. Check if all the configurations are filled in per the [Configuring the Feedback Widget](#configuration) section above.
If your feedback items are not displayed on the **Feedback** page after opening your app in [Apps](https://sprintr.home.mendix.com/), it is possible that you have configured a wrong **App ID** or **Feedback server location**. Check if all the configurations are filled in per the [Configuring the Feedback Widget](#configuration) section above.

### Widget Cannot Be Read

If you see the following error, click **close** and then remove the duplicate old widget from your app’s folder ‘/widgets’. Look for ‘SprintrFeedbackWidget.mpk’.
If the following error is displayed, click **close** and then remove the duplicate old widget from your app’s folder ‘/widgets’. Look for ‘SprintrFeedbackWidget.mpk’.

{{< figure src="/attachments/appstore/platform-supported-content/modules/mendix-feedback/widget-error.png" width="600px" class="no-border" >}}

Expand All @@ -176,7 +176,7 @@ To show the Feedback button, do as follows:
4. Set **Show in Design mode** to **Yes**.
5. Click **OK** to save the change.

### Users Do not See Their Image Afte Uploading a File from Their Computer
### Users Do not See Their Image After Uploading a File from Their Computer

1. In [Apps](https://sprintr.home.mendix.com/link/myapps), open your app.
2. In your **Apps** [navigation pane](/developerportal/#navigation-pane), go to **Environments**.
Expand Down Expand Up @@ -224,7 +224,7 @@ You can configure the widget for certain actions in your app. All the configurat
1. **Project** tab
* **App ID** – the unique identifier of your app, which you can find under **Project ID** in your app’s [Settings](/developerportal/general-settings/) in [Apps](https://sprintr.home.mendix.com/)l

{{% alert color="info" %}}The original value of **App ID** is 1, but this value should automatically change to your correct app ID. If it does not change automatically, see [Updating App ID](#legacy-update-app-id) below.
{{% alert color="info" %}}The original value of **App ID** is 1, but this value should automatically change to your correct app ID. If it does not change automatically, refer to [Updating App ID](#legacy-update-app-id) below.
{{% /alert %}}

**Allow screenshots** – controls whether the app user can take a screenshot or not
Expand All @@ -244,7 +244,7 @@ You can configure the widget for certain actions in your app. All the configurat
* **User name attribute**– selects the attribute of **name** from the **User** entity
* **Email attribute** – selects the attribute of **email** from the **User** entity

See the screenshot below for an example:
Refer to this screenshot for an example:

{{< figure src="/attachments/appstore/platform-supported-content/modules/mendix-feedback/custom-authentication.png" class="no-border" >}}

Expand All @@ -258,7 +258,7 @@ You can configure the widget for certain actions in your app. All the configurat

* **Decrypted Token Value** – recommended that you select the **Value** attribute from it (the default if **Value** in the MendixSSO module).

See the screenshot below for an example:
Refer to this screenshot for an example:

{{< figure src="/attachments/appstore/platform-supported-content/modules/mendix-feedback/mendixsso-authentication.png" class="no-border" >}}

Expand Down Expand Up @@ -313,7 +313,7 @@ The Feedback widget uses the HTML2Canvas library which attempts to make an image

#### Feedback Item Does Not Show in Apps

If you cannot see your feedback items on the **Feedback** page after opening your app in [Apps](https://sprintr.home.mendix.com/), it is possible that you have configured a wrong **App ID** or **Feedback server location**. Check if all the configurations are filled in per the [Configuration](#legacy-configuration) section above.
If your feedback items are not displayed on the **Feedback** page after opening your app in [Apps](https://sprintr.home.mendix.com/), it is possible that you have configured a wrong **App ID** or **Feedback server location**. Check if all the configurations are filled in per the [Configuration](#legacy-configuration) section above.

#### Creating a New Microflow to Retrieve DecryptedToken {#create-a-new-microflow-to-retrieve-decryptedtoken}

Expand All @@ -328,6 +328,6 @@ The **tokenType** argument is **MendixSSO.TokenType.ID_TOKEN**:

#### Widget Cannot Be Read

If you see the following error, click **close** and then go to your widget folder to remove the duplicate old widget.
If the following error is displayed, click **close** and then go to your widget folder to remove the duplicate old widget.

{{< figure src="/attachments/appstore/platform-supported-content/widgets/mendix-feedback/widget-error.png" width="600px" class="no-border" >}}
Loading