Settings

Last modified: February 16, 2024

1 Introduction

The Settings page presents an overview of your app.

On the top of page, you can see the image of the app, the app name, and the company that owns the app. You can also find the Watch / Stop Watching toggle which enables or disables notifications for this app.

The Settings page always contains the following tabs:

  • General
  • Access Management

These tabs are only available for users with the App Settings permission:

  • Cloud Settings
  • API Keys
  • Project Management
  • History
  • Story Archive

2 General

In this tab, you can find the following items:

  • Logo of the app
  • Description of the app
  • App ID
  • Technical Contact of the app
  • Danger Zone
    • Leave this app
    • Deactivate this app
    • Delete this app

3 Cloud Settings

On the Cloud Settings tab, you can select the cloud platform on which to deploy your app. The selection of cloud platforms available will depend on the features of your Mendix account.

If you select a non-Mendix Cloud platform like SAP, you will be redirected to a page to complete the setup. If you select Mendix Cloud, no additional setup is needed.

Specific steps for configuring different cloud platforms are provided here:

4 Access Management

On the Access Management tab, you can manage and invite app users. App users are end-users who can access the deployed app on specific environments. They can use and test your deployed app, and provide feedback.

To manage users or invite users for an app deployed on a specific environment, click Manage Users or Invite Users for that environment. For more information, see the Managing Users and Inviting Users section below.

On the tab, you can only see the environments that satisfy the following requirements:

4.1 Managing Users

When you click Manage Users for your environment, a dialog box opens with a list of the current app users you can remove or edit:

To remove an app user from the environment, click Remove by their name.

To edit an app user’s roles, click Edit by their name. Permissions for these roles (for example, User or Administrator) correspond to what you have configured for your app’s user roles in App Security in Mendix Studio Pro. If you have created a customized role, you need to publish the app before you are able to see and assign it here.

4.2 Inviting Users

To invite new app users to your app, click Invite Users for that environment or via the Manage Users and follow these steps:

  1. Enter the email addresses of the end-users you want to invite.
  2. Click Include your app team to include invitations to all the members of your Team. This may be useful, because people invited to join your team are not added as app users automatically.
  3. Click Add to invitee list.
  4. Select the role for the App User (for example, User or Administrator). Permissions for these roles correspond to what you have configured for your app’s user roles in App Security in Mendix Studio Pro. If you have created a customized role, you need to publish the app before you are able to see and assign it here.
  5. Click Next to send the invitation.

The invitee will receive an email asking them to authorize access to their Mendix account on this screen.

After they provide authorization, they will be brought to your deployed app.

5 API Keys

In API Keys, there is an overview of the API keys created for your app with the following information:

  • API Key Name
  • Date of Creation
  • Date Last Used

To create a new app-specific API key, click Create New API Key and follow these steps:

  1. Fill in the API key name.
  2. Click Generate API Key to be able to use the app API key.

You use these API keys to authenticate requests to the Stories API.

To delete an app API key, click Revoke.

6 Project Management

On the Project Management tab, you can select your team’s planning tool for the app. By default, Epics is the selected tool.

It is possible to migrate all or part of your content from Stories to Epics. For details, see the How to Migrate Stories to Epics section in Planning.

If you manage your projects in Jira, you can connect your apps in the Developer Portal to Jira. For more information, see Jira Connector.

7 Webhooks

Open the Webhooks tab to manage your app’s webhooks for stories and Sprints. A webhook enables the Developer Portal to talk to another website and post updated Developer Portal content (for example, Sprint updates and new stories) to that website. For example, if you want to follow the changes in your app, you can create a service with a certain URL that keeps track of the data, and then changes in the app in the Developer Portal are sent to that URL.

After clicking New Webhook to create a new webhook for stories and sprints, fill in the following details:

  • Name – the name of the webhook for stories and Sprints
  • URL – the URL to which the webhook for stories and Sprints will connect
  • Secret – the secret used by the Developer Portal to sign the data payload in order to identify the source of the data to the receiving URL (this appears when creating and editing a webhook for stories and Sprints, but it will not be displayed on the Webhooks settings page)
  • Version – the version of the webhooks feature to be used
  • Events – what types of data will be sent via the webhook for stories and Sprints (you must select at least one; this appears when creating and editing a webhook for stories and Sprints, but it will not be displayed on the Webhooks settings page)
    • Sprints
    • Stories

To edit the above details for an existing webhook for stories and Sprints, click Edit.

To delete an existing webhook for stories and Sprints, click Delete.

8 History

The History tab presents the collaboration actions for the app. On this page, you can see what change was made, who performed it, and when it occurred:

When you select a history item and click Show item, the details of the story, Sprint, or feedback item will be presented.

9 Story Archive

Once you have switched from Mendix Stories to Epics or Jira, Mendix archives any work you may have had in Mendix Stories. You can review your work on this tab, and download it if necessary.

10 Read More