Mendix Feedback

Last update: Edit

1 Introduction

The Mendix Feedback widget allows end-users of your application to directly submit feedback into your app project. The feedback widget is fully integrated with the Feedback page in the Developer Portal, where you can review feedback and convert it into user stories to improve your app.

The Mendix Feedback widget is easy to set up and automatically attaches additional information to each submitted issue such as the user’s name, role, active form, browser version, and screen resolution.

The sections below cover the Mendix Feedback widget version 8.1.0 and above as well as version 5.1.3 and below. The usage and configuration steps depend on the versions of the widget.

1.1 Typical Usage Scenario

  • Gathering feedback from end-users in an acceptance or production environment
  • Reducing the length of the feedback loop

1.2 Features

  • Gathers detailed information about the client state

1.3 Limitations

  • Only usable in combination with Mendix app projects

2 Using Widget Version 8.1.0 & Above

The sections below describe using and configuring the latest versions of the Mendix Feedback widget.

2.1 Using the Widget

The Mendix Feedback widget can be used for a variety of purposes, which are described below.

2.1.1 Submitting Feedback on an App

When you click the Feedback icon, the Mendix Platform first checks if you are signed in. If you are already signed in, you will be in Feedback Mode right away. If you are not signed in, you will need to either Sign in to Mendix or Continue as a guest to enter feedback mode:

Once you are in feedback mode, you can click anywhere on the screen to leave a comment:

And voila! A screenshot of the current page is created automatically, which you can choose to attach to your feedback. After clicking Send, your feedback will go straight to the Feedback page of the app project in the Developer Portal.

When you have left your feedback, you need to exit the feedback mode by clicking this button:

2.1.2 Editing the App

Clicking the Edit icon opens the app page in Mendix Studio. If you have permissions to edit the app, you can start editing and collaborating right away.

2.1.3 Viewing the App

When you click the Mobile view icon, a pop-up window is displayed that enables viewing your app on a mobile device:

You can access this mobile view by installing the Mendix Mobile app and then scanning the QR code in the pop-up window. For more information, see Getting the Mendix Mobile App.

2.1.4 Sharing the App

When you click the Share icon on the widget, a pop-up window appears for sharing your app via Email:

You can add as many email addresses as you like and email your app to colleagues for further collaboration and feedback.

2.1.5 Switching Between Apps

When you click the App Switcher button, a pop-up window appears with a list of other Mendix SSO-enabled apps that you have access to:

When you click an app, you are redirected to it.

2.2 Adding & Configuring the Widget

You should use the latest version of the Mendix Feedback widget, as it will provide the most up-to-date features for leaving feedback and communicating with the App Tea.

2.2.1 Adding the Widget to Your App Project

To ensure you have the latest version of the widget included in your app, follow these steps:

  1. Download the latest version of the Mendix Feedback widget from the App Store. You are strongly encouraged to use version 8.2.1 or above of the widget.
  2. When the widget is included in your app project, ensure that it is added to the homepage of the application. Open the homepage from your app’s Project > Navigation:

  3. If the widget has not been added automatically, add it to the desired page or layout by selecting Add widget > Add-on widgets > Feedback & Collaboration Widget and dropping it into a position in the page:

2.2.2 Configuring the Widget

You can configure the widget for certain actions in your app project (for example, to allow screenshots, to hide the Mendix logo, and to hide the Share button). All the configuration properties are explained on the various tabs of the properties dialog box for the widget.

The feedback feature requires the following properties to be set:

  • Project tab > App ID – the unique identifier of your app project available in your app’s General settings in the Developer Portal
  • Advanced tab > Feedback server location – the URL of the Developer Portal server (usually https://sprintr.home.mendix.com)

For the best user experience, your are strongly encouraged to apply Mendix SSO to your app and connect the Mendix SSO module to version 8.2.1 or above of the Mendix Feedback widget. For version 8.1.0 or above of the widget, you need to set the following:

  • MendixSSO Authentication tab > Decrypted Token Entity – select the entity DecryptedToken from the Mendix SSO module
  • MendixSSO Authentication tab > Decrypted Token Value – after selecting Decrypted Token Entity, select the Value attribute from it
  • MendixSSO Authentication tab > ID token provider – select the DS_GetCurrentIdToken microflow from the Mendix SSO module

The result should look like this:

The app switcher feature requires the Mendix SSO module to be implemented and the following property to be set:

  • Advanced tab > Show App Switcher button – set to Yes

You can also configure the widget for certain actions in your app project, for example:

  • Project tab > Allow screenshots
  • Project tab > Hide Mendix logo
  • Collaboration tab > Share button

2.3 Troubleshooting

2.3.1 Upgrading the Widget from Studio Pro Version 7 to 8

If you are trying to upgrade your Mendix Feedback widget from version 7 to version 8, Studio Pro will not recognize the current configuration of this widget. Add the Mendix Feedback widget into your page again and configure it accordingly. Then delete the old one.

2.3.2 MPK Error

If you encounter the following issue, you need to delete the old .mpk file in the /widgets/FeedbackWidget.mpk folder of your app project:

2.3.3 Configuring the Widget for an iOS Hybrid App

For troubleshooting information, see How to Configure the Mendix Feedback Widget for iOS.

3 Widget Version 5.1.3 & Below

The sections below describe using and configuring earlier versions of the Mendix Feedback widget.

3.1 Submitting Feedback on an App

To provide feedback via the earlier versions of the Mendix Feedback widget, follow these steps:

  1. Click the Feedback button on the right-side of the screen.
  2. Fill in the feedback you want to send to Mendix. The feedback can be an Issue, Idea, or Question. A description of the feedback (in Additional information) and a screenshot of the screen (via the Include a snapshot of this page check box) are recommended.
  3. Click Send Feedback:

After clicking Send feedback, the feedback will go straight to the Feedback page of the app project in the Developer Portal.

3.2 Configuring the Widget in Your App Project

To configure the Mendix Feedback widget, follow these steps:

  1. Open the widget Properties by double-clicking the widget on the page.
  2. Select the User entity that is used in your application to store the name and email address of the user. Note that this object must be a specialization of the User entity within the System module (for example, Account in the Administration module).
  3. Select the Username attribute that stores the name of the user and the Email address attribute. This will be used to automatically fill in the name and email address of the user who is logged in when submitting feedback in the app.
  4. Decide whether you want to allow users to upload a file and screenshot to the feedback item (via Allow file upload and Allow screenshot upload, respectively).

    1. Open the Configuration tab of the widget properties.
    2. Ensure that the Feedback server is set to https://sprintr.home.mendix.com/.
    3. Ensure that the Project identifier is filled in correctly. The project identifier is your App ID, and it is automatically filled in for the Mendix Feedback widget. If necessary, you can find the identifier of your app in the Developer Portal by opening your app and clicking General under the Settings category:

    4. If you have configured multiple home pages for different user roles, you need to add the Mendix Feedback widget to each home page for the user role from which you want to gather feedback. This can easily be done by copying the configured widget to the other relevant layouts and pages.