Private Mendix Platform User Guide

Last modified: November 4, 2024

Introduction

See the following articles for information about the business-as-usual use cases available for Private Mendix Platform.

Configuring Your User Profile and Settings

Your user account is created by the administrator of your Private Mendix Platform. After you log in for the first time, you can configure some of your profile settings by clicking the user icon in the top right corner of the screen, and then selecting Manage My Account from the drop-down.

Profile

In the Profile tab, you can configure general information about yourself. This includes the following information:

  • Full name (for example, Jane Doe)
  • User name (for example, jdoe)
  • Display language

Change Password

In the Change Password tab, you can set a new password for your account. The password must fulfill the following criteria:

  • Minimum of 8 characters
  • Contains an uppercase letter
  • Contains a number
  • Minimum one special character

Personal Access Tokens

Personal Access Tokens (PATs) are used as alternatives to passwords. They are designed to be used when the client application needs to get access on behalf of a specific platform user, but the user is not “present” at the time of access, so the user cannot login via a browser (web SSO). The client application can be any application (meaning, even an app not built with Mendix).

For more information about Personal Access Tokens, as well as creating and using them, see Personal Access Token.

Service Credentials

In the Service Credentials tab, you can view and manage the credentials for various external systems that Private Mendix Platform can connect with. These services include GitHub, GitLab, Bitbucket, and AzureDevOps, used for managing your app projects.

To create or work on app projects in Private Mendix Platform, you must create an access token in GitHub, GitLab, AzureDevOps, or Bitbucket, and then add it in the Service Credentials tab. The token must have read and write access to a repository where the app project is stored.

Installing Mendix Studio Pro

Before you can create your first app, you must first install Mendix Studio Pro by performing the following steps:

  1. Log in to Private Mendix Platform.

  2. On the home page, click Download Studio Pro and Download Studio Pro Patch file.

  3. Install Studio Pro. For more information, see Installing Studio Pro.

  4. Extract the Studio Pro patch file to the modeler directory located in the Studio Pro installation directory, and let it patch the files inside.

  5. Launch Studio Pro and log in to it with the same credentials as for Private Mendix Platform.

Creating a New App

To create a new app, perform the following steps:

  1. Log in to Private Mendix Platform.

  2. If you have not already configured an access token for a GitLab, GitHub, AzureDevOps, or Bitbucket repository, click the user icon in the top right corner of the screen, and then click Manage My Account > Service Credentials.

    For more information, see Service Credentials.

  3. On the home page, click Create App Project.

  4. Start the creation of your app by selecting a template.

    For step-by-step examples and guides for new Mendix developers, refer to the following pages:

Managing Your App

As a user of Private Mendix Platform, you can view the apps that you own directly on the home page of Private Mendix Platform.

This includes the apps that you created, as well as the apps that are shared with your user group. To view more details about an app, click on its tile.

In the General section, you can you can quickly perform a number of actions:

  • Edit details such as app name and description
  • Invite users to work on the app
  • View the Git revisions per branch for the app
  • Assign the app to a new owner or group
  • Archive the app, provided you are the only team member. You will be warned of the consequences and asked for confirmation before the app is archived.
  • Delete the app, provided you are the only team member. You will be warned of the consequences and asked for confirmation before the app is deleted.

Deploying Your App

In the Deploy section, you can configure the environment to which your app will be deployed.

  1. Optional: In the Environments tab, create a new deployment package.

  2. Click Create Environment.

  3. Select your deployment package that you want to deploy to this environment, and then click Next.

  4. Specify the following details about the environment:

    • Internal Name - An automatically generated internal name for the environment. The environment name can only contain lowercase letters and numbers.
    • Display Name - The name that will be displayed in the UI. You can have several environments for your app, for example test, acceptance, and production.
    • Cluster and Namespace - An existing cluster and its namespace.

  5. Click Next.

  6. After the environment is created, you can use the Details menu to perform additional actions such as deleting the environment, or starting and stopping the app.

Managing Marketplace Content

If your organization has enabled the Marketplace for your Private Mendix Platform, you can build your own connectors and modules, and then share them on the Marketplace, so that other teams from your organization can use the connector in their own apps.

Creating Marketplace Content

For more information about building a connector for your Mendix app, see the following topics:

Sharing Marketplace Content

To share the connector that you built, perform the following steps:

  1. In Private Mendix Platform, click My Content.

  2. Select a Content type for your component.

  3. On the General page, enter a Name for your component.

  4. Enter a Description of your component.

  5. Select the Studio Pro Version for which the component is built.

  6. Select the type of License you want applied to your app.

  7. Select the Cover Image that will be displayed for your connector.

  8. Click Continue.

  9. On the Package page, in the Upload MPK field, click Browse and select the .mpk file that you created for your component.

  10. Click Upload.

  11. Specify the Version of your component.

  12. Provide a Release Note to describe the contents of the version you are uploading.

  13. Click Save & Continue.

  14. On the Additional Info page, provide instructions for users of your component.

  15. Click Save & Continue.

  16. Review and publish your changes.

Depending on the process set up by your Private Mendix Platform administrator, your component may be subject to an approval process before it is shared with other users.

Sharing Content with Groups

On the Manage Group Content page, you can share components with the user groups to which you belong.

  1. In Private Mendix Platform, click Group Content.

  2. Select a Content type for your component.

  3. In the App Visibility section, select the group with which you want to share the component.

    If the group with which you want to share the content is not in the list, it means that you are not a member of that particular group. Contact your Private Mendix Platform administrator.

  4. Follow the instructions in Sharing Marketplace Content.