diff --git a/content/en/docs/apidocs-mxsdk/apidocs/private-mendix-platform/_index.md b/content/en/docs/apidocs-mxsdk/apidocs/private-mendix-platform/_index.md index e7b564662c1..f2dac5ae796 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/private-mendix-platform/_index.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/private-mendix-platform/_index.md @@ -23,7 +23,7 @@ For more information, see [API (Application Programming Interface)](https://www. ## Prerequisites -Authentication for the API uses a personal access token (PAT). You can generate a PAT in the **Personal Access Tokens** section of your [Private Mendix Platform Profile](/private-mendix-platform/user-guide/#profile). +Authentication for the API uses a personal access token (PAT). You can generate a PAT in the **Personal Access Tokens** section of your [Private Mendix Platform Profile](/private-mendix-platform/user-profile/#profile). Each available API has its own set of scopes that define the access level for the token. As a best practice, consider restricting the token's scope to the lowest access level required to perform the necessary operations. diff --git a/content/en/docs/private-platform/pmp-user-guide.md b/content/en/docs/private-platform/pmp-user-guide.md deleted file mode 100644 index be3f300b636..00000000000 --- a/content/en/docs/private-platform/pmp-user-guide.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -title: "Private Mendix Platform User Guide" -url: /private-mendix-platform/user-guide/ -description: "Documents the business-as-usual administrator tasks for the Private Mendix Platform." -weight: 50 -aliases: - - /private-mendix-platform-user-guide/ ---- - -## 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. - -{{< figure src="/attachments/private-platform/pmp-ug1.png" class="no-border" >}} - -### Profile {#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 - -{{% alert color="info" %}} -You cannot change your email, user role, or user group. If this information must be updated, contact your Private Mendix Platform administrator. -{{% /alert %}} - -### 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](/portal/user-settings/#pat). - -### Service Credentials {#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**. - - {{< figure src="/attachments/private-platform/pmp-ug2.png" class="no-border" >}} - -3. Install Studio Pro. For more information, see [Installing Studio Pro](/refguide/install/#install). -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 {#create-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](#service-credentials). - -3. On the home page, click **Create App Project**. - - {{< figure src="/attachments/private-platform/pmp-ug3.png" class="no-border" >}} - -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: - - * [Quick Starts](/quickstarts/) - * [Learning path: Become a Rapid Developer](https://academy.mendix.com/link/paths/31/Become-a-Rapid-Developer) - -## Managing Your App {#manage-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. - -{{< figure src="/attachments/private-platform/pmp-ug4.png" class="no-border" >}} - -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. - -{{< figure src="/attachments/private-platform/pmp-ug5.png" class="no-border" >}} - -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 {#deploy} - -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. - -### Deployment Purpose and DTAP Mode - -When creating a new environment to deploy, you can select the environment purpose, which can be Development, Test, Acceptance, or Production. For the deployed Mendix App, this purpose corresponds to the runtime's `dtapMode`, which affects security and licensing. For example, whether demo users are available after deployment, whether production security is enabled, or whether the environment requests a license from the license manager service. Once the environment has been created, the environment purpose cannot be changed. - -On Private Mendix Platform, environments with the Development and Test purpose set the `dtapMode` to `D` (for Development), while Acceptance and Production environments operate in `dtapMode` `P` (for Production). This association cannot be changed. Please select the appropriate environment purpose when you're creating a new environment. - -#### Runtime Behavior in Development Mode {#runtime-behavior-development-mode} - -When the `dtapMode` is set to `D` (Development), the Mendix Runtime behaves differently than it does in Production mode. The following changes apply: - -* The admin password strength is not verified. -* The admin password can be a single character (for example, `1`). -* Project security can be disabled in the model. -* Some log lines are printed at the info level instead of the debug level. -* Demo users are created if enabled. -* During shutdown, task queues stop after a shorter grace period. -* Enables additional websockets. - -Do not use Development mode for production environments. Use Production mode (`P`) for environments that require the full security and runtime behavior. - -## 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: - -* [Build a Connector](/appstore/creating-content/connector-guide-build/) -* [Best Practices for Building Connectors](/appstore/creating-content/connector-guide-best-practices/) - -### Sharing Marketplace Content {#sharing} - -To share the connector that you built, perform the following steps: - -1. In Private Mendix Platform, click **My Content**. - - {{< figure src="/attachments/private-platform/pmp-ug7.png" class="no-border" >}} - -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](/appstore/creating-content/connector-guide-build/#export-as-mpk) 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. - - {{< figure src="/attachments/private-platform/pmp-ug8.png" class="no-border" >}} - -13. Click **Save & Continue**. -14. On the **Additional Info** page, provide instructions for users of your component. - - {{< figure src="/attachments/private-platform/pmp-ug9.png" class="no-border" >}} - -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**. - - {{< figure src="/attachments/private-platform/pmp-ug10.png" class="no-border" >}} - -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. - - {{< figure src="/attachments/private-platform/pmp-ug11.png" class="no-border" >}} - - 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](#sharing). - -## Monitoring - -"Grafana, Loki, and Prometheus are the recommended monitoring stack for Kubernetes-based services like Private Mendix Platform. The customer is responsible for configuring the stack. For more information, see [Grafana Integration for Private Mendix Platform](/private-mendix-platform/grafana/). - -### Logs & Events - -From the **Logs** page, you can access the logs produced by your app. For information about configuring - -To access the logs, perform the following steps: - -1. Open your app in the Private Mendix Platform portal. -2. In the left navigation pane, click **Monitoring > Logs & Events**. -3. Select the environment for which you want to view the logs. - -You can filter the results by the following properties: - -* **Container** - The container instance. -* **Retrieve last** - The number of results to retrieve. -* **Timespan** - The date and time range to display. -* **Filter by Log Level** - The highest log level to display. The following log levels are available: - - * **Trace** - Provides highly detailed information. Trace level messages are written only to logs. - * **Debug** - Provides detailed information, typically of interest only when diagnosing problems. - * **Info** - Confirms that things are working as expected. - * **Warning** - Indicates that something unexpected happened or warns about an upcoming problem (for example, *disk space low*). The application is still working as expected. - * **Error** - Indicates a serious problem that prevented the application from performing some function. - * **Critical** - Indicates that a serious error has occurred; the application may be unable to continue running. - -* **Keyword** - A keyword to use for filtering. - -#### Help Me Function - -On the **Logs & Events** page, you can also download the **Help Me** package, containing diagnostic logs which you can attach to a support ticket if needed. For more information about the **Help Me** function, see [Private Mendix Platform Events and the Help Me Function](/private-mendix-platform/support-help-me/). - -### Metrics - -The **Metrics** page contains detailed graphs about your app and its environment. You can use this page to monitor the performance and health of your app; for example, you can track the usage growth of your app or debug performance problems. - -These statistics are displayed as trends over time. - -To view the graphs on **Metrics** page, perform the following steps: - -1. Open your app in the Private Mendix Platform portal. -2. In the left navigation pane, click **Monitoring > Metrics**. -3. Select the environment and pod. - -You can filter the results by the following properties: - -* **Container** - The container instance. -* **Retrieve last** - The number of results to retrieve. -* **Timespan** - The date and time range to display. -* **Filter by Log Level** - The highest log level to display. The following log levels are available: - - * **Trace** - Provides highly detailed information. Trace level messages are written only to logs. - * **Debug** - Provides detailed information, typically of interest only when diagnosing problems. - * **Info** - Confirms that things are working as expected. - * **Warning** - Indicates that something unexpected happened or warns about an upcoming problem (for example, *disk space low*). The application is still working as expected. - * **Error** - Indicates a serious problem that prevented the application from performing some function. - * **Critical** - Indicates that a serious error has occurred; the application may be unable to continue running. - -* **Keyword** - A keyword to use for filtering. - -### Webhooks {#webhooks} - -Webhooks allow you to send information about your licensed Mendix app deployed to Private Mendix Platform to an external app or workflow. You can use them to trigger a step in an automated [Build](/private-mendix-platform/reference-guide/admin/system/#build-steps) or [Deployment](/private-mendix-platform/reference-guide/admin/system/#deploy-steps) pipeline. - -#### Creating a New Webhook {#setting-up} - -To set up a webhook, do the following: - -1. On the **Webhooks** page, click **New Webhook**. -2. Enter the following information: - - * **Webhook Name** – This is a name which you can use to identify the webhook. - * **URL** – This is the endpoint that will receive the payload when one of the event types selected in **Available Events** occurs. - * **Validation Secret** – This is a secret that is shared with the endpoint to verify that it has been triggered by this webhook. If you leave this blank, a secret is generated automatically. You can see the generated value any time you return to edit the webhook. - * **Available Events** – This is the event (or events) that triggers the webhook to send information to the endpoint. Company administrators can activate or deactivate specific event types in the **Webhooks > Event Management** tab of administrator menu. For more information, see [Company Administrators: Webhooks](/private-mendix-platform/reference-guide/admin/company/#webhooks). - * **Custom Headers** – This is a key-value pair that is sent as an HTTP header to the endpoint. Company administrators can configure a predefined custom header in the **Webhooks > Preset Headers** tab of administrator menu. For more information, see [Company Administrators: Webhooks](/private-mendix-platform/reference-guide/admin/company/#webhooks). - -You can edit or delete an existing webhook by clicking **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the **Action** column for the webhook you want to change, and then selecting **Edit** or **Delete**. diff --git a/content/en/docs/private-platform/reference/_index.md b/content/en/docs/private-platform/reference/_index.md index 40fded45d17..36a58e3e825 100644 --- a/content/en/docs/private-platform/reference/_index.md +++ b/content/en/docs/private-platform/reference/_index.md @@ -1,15 +1,30 @@ --- -title: "Private Mendix Platform Reference Guide" -url: /private-mendix-platform/reference-guide/ -description: "Provides details on the features and functionality of the Private Mendix Platform." -weight: 60 +title: "Private Mendix Platform Administrator Guide" +linktitle: "Administrator Guide" +url: /private-mendix-platform/reference-guide/admin/ +description: "Provides details on the features and functionality of the Private Mendix Platform that are available to administrators." +weight: 10 +aliases: + - /private-mendix-platform-administration/ + - /private-mendix-platform/administration/ + - /private-mendix-platform/reference-guide/ --- ## Introduction -The Private Mendix Platform Reference Guide provides a map of the menus and functionalities of the Private Mendix Platform. For detailed information about their use, refer to the [Private Mendix Platform User Guide](/private-mendix-platform/user-guide/). +The Private Mendix Platform Administrator Guide provides information about the menus and functionalities of the Private Mendix Platform that are available to administrator users. For information about functionalities available for all users, refer to the [Private Mendix Platform User Guide](/private-mendix-platform/user-guide/). -The reference guide has the following sections: +## Switching to Admin Mode -* [Functionalities available for all users](/private-mendix-platform/reference-guide/common/) -* [Functionalities available for admin users](/private-mendix-platform/reference-guide/admin/) +As an administrator, you can access the options described in this section by clicking on your user icon in the upper right corner of the screen, and then selecting **Switch to Admin Mode**. + +{{< figure src="/attachments/private-platform/pmp-admin5.png" class="no-border" >}} + +## Administrator Roles in Private Mendix Platform + +Private Mendix Platform distinguishes between the following types of administrator roles: + +* Company admin - This role primarily manages business-as-usual tasks, for example inviting new users to an app, or approving Marketplace contents. Settings relevant for company admins are available in the [Manage](/private-mendix-platform/reference-guide/admin/company/#manage) section of the admin navigation menu. +* Systems admin - This role primarily manages key settings which must be configured during the initial implementation, and which are rarely modified during normal operation. Settings relevant for systems admins are available in the [Settings](/private-mendix-platform/reference-guide/admin/system/#settings) section of the admin navigation menu. + +{{< figure src="/attachments/private-platform/pmp-admin4.png" class="no-border" >}} diff --git a/content/en/docs/private-platform/reference/admin/_index.md b/content/en/docs/private-platform/reference/admin/_index.md deleted file mode 100644 index e4a294937c8..00000000000 --- a/content/en/docs/private-platform/reference/admin/_index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Administrators" -linktitle: "Administrators" -url: /private-mendix-platform/reference-guide/admin/ -description: "Provides details on the features and functionality of the Private Mendix Platform that are available to administrators." -weight: 10 -aliases: - - /private-mendix-platform-administration/ - - /private-mendix-platform/administration/ ---- - -## Introduction - -This section of the Private Mendix Platform Reference Guide provides information about the menus and functionalities of the Private Mendix Platform that are available to administrator users. As an administrator, you can access the options described in this section by clicking on your user icon in the upper right corner of the screen, and then selecting **Switch to Admin Mode**. - -{{< figure src="/attachments/private-platform/pmp-admin5.png" class="no-border" >}} - -Private Mendix Platform distinguishes between the following types of administrator roles: - -* Company admin - This role primarily manages business-as-usual tasks, for example inviting new users to an app, or approving Marketplace contents. Settings relevant for company admins are available in the [Manage](/private-mendix-platform/reference-guide/admin/company/#manage) section of the admin navigation menu. -* Systems admin - This role primarily manages key settings which must be configured during the initial implementation, and which are rarely modified during normal operation. Settings relevant for systems admins are available in the [Settings](/private-mendix-platform/reference-guide/admin/system/#settings) section of the admin navigation menu. - -{{< figure src="/attachments/private-platform/pmp-admin4.png" class="no-border" >}} diff --git a/content/en/docs/private-platform/reference/common/_index.md b/content/en/docs/private-platform/reference/common/_index.md deleted file mode 100644 index 194ef4a2a05..00000000000 --- a/content/en/docs/private-platform/reference/common/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - All Users" -linktitle: "All Users" -url: /private-mendix-platform/reference-guide/common/ -description: "Provides details on the features and functionality of the Private Mendix Platform that are common for all types of users." -weight: 10 ---- - -## Introduction - -This section of the Private Mendix Platform Reference Guide provides information about the menus and functionalities of the Private Mendix Platform that are common for administrator and developer users. - -* [Sign In](/private-mendix-platform/reference-guide/common/signin/) -* [Top Navigation Bar](/private-mendix-platform/reference-guide/common/navigation/) -* [My Apps](/private-mendix-platform/reference-guide/common/my-apps/) -* [My Group Apps](/private-mendix-platform/reference-guide/common/group-apps/) -* [Get Studio Pro](/private-mendix-platform/reference-guide/common/get-studio/) -* [My Content](/private-mendix-platform/reference-guide/common/my-content/) -* [Group Content](/private-mendix-platform/reference-guide/common/group-content/) -* [Company Content](/private-mendix-platform/reference-guide/common/company-content/) -* [Manage My Account](/private-mendix-platform/reference-guide/common/account/) -* [Manage My Group](/private-mendix-platform/reference-guide/common/manage-group/) diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-account.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-account.md deleted file mode 100644 index ca40f9293da..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-account.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Manage My Account" -linktitle: "Manage My Account" -url: /private-mendix-platform/reference-guide/common/account/ -description: "Provides details on the features and functionality of the Manage My Account menu of Private Mendix Platform." -weight: 90 ---- - -## Introduction - -The **Manage My Account** menu contains the options that you need to make or manage your account. It consists of the following sections: - -### Profile - -Use the **Profile** page to add a profile picture, as well as view and edit your profile information. Some fields are fixed or only editable by an admin. - -{{< figure src="/attachments/private-platform/pmp-manage-profile.png" class="no-border" >}} - -### Change Password - -Use the **Change Password** page to reset your password by doing the following steps: - -1. Enter your current password. -2. Enter the new password. -3. Confirm the new password. -4. Click **Update**. - -### Personal Access Tokens - -A Personal Access Token (PAT) is used to identify the user account and its corresponding privileges/permissions when interacting with PMP over API's and other non-GUI interactions. For example, when setting up automated API calls between an external service and PMP. For more information, see [APIs for Private Mendix Platform](/apidocs-mxsdk/apidocs/private-platform/). - -{{< figure src="/attachments/private-platform/pmp-manage-pat.png" class="no-border" >}} - -The **Personal Access Tokens** page shows a list of previously created Personal Access Tokens along with the following information: - -* **Name** -* **Scope** -* **Expiry date** -* **Actions** - * **View details** - Explains the token scope. - * **Copy PAT** - Copies the token to clipboard. - * **Delete** - Deletes the token. -* **New Token** - Creates a new token with the following information: - * **Input Name** – Enter a meaningful name for the token. - * **Expiry Date** – Specify the expiry date of the token according to your company restrictions. As a best practice, never set the expiration time for the token to be more than one year. - * **Project scopes** – Specify the scopes that are needed for this token. To reduce risk and impact, follow the least-privilege principle for token scope and use different tokens for different purposes instead of creating one token with a large scope. - -### Service Credentials - -Service credentials are used to establish the user account's identity with external services that Private Mendix Platform is integrated with, such as the version control server. Depending on settings configured by the admin, they can automatically provisioned through the integrations or manually configured for the user account. - -{{< figure src="/attachments/private-platform/pmp-manage-credentials.png" class="no-border" >}} - -The **Service Credentials** page shows a card for each previously created set of credentials. You can edit, delete, or create new credentials on this page. - -### Notifications {#manage-notifications} - -The preferences displayed on the **Notifications** page cannot be changed in the current version of Private Mendix Platform and are offered for information only. In a future release, preferences for additional notification channels such as email and push notifications will be configurable on this page. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-company.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-company.md deleted file mode 100644 index 66fcb5d99ce..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-company.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Company Content" -linktitle: "Company Content" -url: /private-mendix-platform/reference-guide/common/company-content/ -description: "Provides details on the features and functionality of the Company Content page of Private Mendix Platform." -weight: 80 ---- - -## Introduction - -The **Marketplace** page is a local version of the Mendix Marketplace, enclosed entirely within the Private Platform. - -{{< figure src="/attachments/private-platform/pmp-refguide-company-content.png" class="no-border" >}} - -The page shows content available to end users, organized by category. You can click **View More** to view all items from a particular category. You can also click a content item to view or download it from the Private Platform Marketplace. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-getstudio.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-getstudio.md deleted file mode 100644 index 1ab381f11a6..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-getstudio.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Get Studio Pro" -linktitle: "Get Studio Pro" -url: /private-mendix-platform/reference-guide/common/get-studio/ -description: "Provides details on the features and functionality of the Get Studio Pro page of Private Mendix Platforms." -weight: 50 ---- - -## Introduction - -The **Get Studio Pro** page is the download page for compatible Studio Pro versions. - -{{< figure src="/attachments/private-platform/pmp-ref-download-studio.png" class="no-border" >}} - -Not all Studio Pro versions published by Mendix on the [Mendix Marketplace](https://marketplace.mendix.com/) are compatible with Private Mendix Platform. Private Mendix Platform offers predefined compatible versions of Studio Pro, which are tied to supported Runtime versions and reusable components (such as Starter App templates). Company admins can specify which of these supported versions are available the end users of their Private Mendix Platform. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-group.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-group.md deleted file mode 100644 index bbf4c1b68f0..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-group.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Manage My Group" -linktitle: "Manage My Group" -url: /private-mendix-platform/reference-guide/common/manage-group/ -description: "Provides details on the features and functionality of the Manage My Group page of Private Mendix Platform." -weight: 100 ---- - -## Introduction - -The **Manage My Group** page enables users with the Group Admin role to manage the membership of their user groups. The left navigation menu lists all groups managed by this admin. - -{{< figure src="/attachments/private-platform/pmp-manage-my-group.png" class="no-border" >}} - -The page shows a list of members for a particular group. Group admins can use it to add and remove members, or search for Platform users by their name or email and add them to the group. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-groupapps.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-groupapps.md deleted file mode 100644 index fe342be0f4f..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-groupapps.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - My Group Apps" -linktitle: "My Group Apps" -url: /private-mendix-platform/reference-guide/common/group-apps/ -description: "Provides details on the My Group Apps page of the Private Mendix Platform." -weight: 40 ---- - -## Introduction - -The **My Group Apps** page shows an overview of all apps owned by the groups to which a user belongs. - -{{< figure src="/attachments/private-platform/pmp-refguide-groupapps.png" class="no-border" >}} - -It contains the following elements: - -* Search bar - Use the search bar to search through apps by name or description. -* A card for each app owned by all your user groups. - - * If you are a member of this app's project team, you can click the card to see the app details. - * If you are not a member of the project, clicking the card opens a dialogue window with basic information about this app. From there, you can click **Request Access** to notify the app owner that you want to join the app team. If the app has been deployed, you can also click **Launch App** to open the URL of this app's most recently deployed environment. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-groupcontent.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-groupcontent.md deleted file mode 100644 index 42ec5b4c085..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-groupcontent.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Group Content" -linktitle: "Group Content" -url: /private-mendix-platform/reference-guide/common/group-content/ -description: "Provides details on the features and functionality of the Group Content page of Private Mendix Platform." -weight: 70 ---- - -## Introduction - -The **My Content** page shows a list of all the content owned by the groups to which the user belongs. Only items that have been shared with the relevant group are displayed here. Draft versions of content are not shown on the page. - -{{< figure src="/attachments/private-platform/pmp-refguide-mygroupcontent.png" class="no-border" >}} - -You can click **Add Content** to add a new content item. For more information, see [Sharing Marketplace Content](/private-mendix-platform/user-guide/#sharing-content-with-groups). - -You can also click a content item to view or download it from the Private Platform Marketplace. - -{{< figure src="/attachments/private-platform/pmp-group-content-details.png" class="no-border" >}} diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-myapps.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-myapps.md deleted file mode 100644 index 930b51ab3a6..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-myapps.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - My Apps" -linktitle: "My Apps" -url: /private-mendix-platform/reference-guide/common/my-apps/ -description: "Provides details on the My Apps page of the Private Mendix Platform." -weight: 30 ---- - -## Introduction - -The **My Apps** page is the landing page of Private Mendix Platform. - -{{< figure src="/attachments/private-platform/pmp-homepage.png" class="no-border" >}} - -It contains the following elements: - -### Onboarding {#onboarding} - -The top section of the **My Apps** page contains elements that help new users get started with the Private Mendix Platform. It consists of the following blocks: - -* **Download & Install Studio Pro** - Click this block to download the highest version of Studio Pro available in your Private Mendix Platform. -* **Patch Studio Pro** - Click this block to download the required patch file for Studio Pro. -* **Create a New App Project** - Click this block to create a new app. For more information, see [Creating a New App](/private-mendix-platform/user-guide/#create-app). - -To hide the **Onboarding** section, click **Hide onboarding**. - -### My Apps Overview - -The bottom section of the **My Apps** page contains an overview of your active and archived applications. It contains the following elements: - -* Search bar - Use the search bar to search through apps by name or description. -* **Active** tab - Displays all currently active apps. Each tile shows the current member count for the app, as well as a sub-menu to archive or delete it. To view more details about an app, click on its tile. For more information, see [Managing Your App](/private-mendix-platform/user-guide/#manage-app). -* **Archived** tab - Displays all archived apps. To reactivate an archived project, click on its tile. Apps cannot be archived if they have more than one member. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-mycontent.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-mycontent.md deleted file mode 100644 index bd96540b210..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-mycontent.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - My Content" -linktitle: "My Content" -url: /private-mendix-platform/reference-guide/common/my-content/ -description: "Provides details on the features and functionality of the My Content page of Private Mendix Platform." -weight: 60 ---- - -## Introduction - -The **My Content** page shows a list of all the content owned by the user. - -{{< figure src="/attachments/private-platform/pmp-refguide-mycontent.png" class="no-border" >}} - -You can click **Add Content** to add a new content item. For more information, see [Sharing Marketplace Content](/private-mendix-platform/user-guide/#sharing). - -You can also click a content item to view or edit its details. - -{{< figure src="/attachments/private-platform/pmp-content-details.png" class="no-border" >}} diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-nav.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-nav.md deleted file mode 100644 index 1f188afce73..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-nav.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Top Navigation Bar" -linktitle: "Top Navigation Bar" -url: /private-mendix-platform/reference-guide/common/navigation/ -description: "Provides details on the top navigation menu of Private Mendix Platform." -weight: 20 ---- - -## Introduction - -The top navigation bar displays your location within the Platform (for example, *Apps* or *Marketplace*). The branding of the bar, such as the logo and title, can be customized by a Company Admin. - -From the navigation bar, you can access the following items: - -* [Platform Navigation](#navigation) (({{% icon name="layout-1-filled" %}})) -* [Notifications](#notifications) (({{% icon name="alarm-bell" %}})) -* [Account Menu](#account) - -### Platform Navigation {#navigation} - -The navigation menu contains the options that you need to make or manage your apps. - -{{< figure src="/attachments/private-platform/pmp-navigation-menu.png" class="no-border" >}} - -It consists of the following sections: - -* **Make** - * **Mendix Home** - Click this option to go to the [My Apps](/private-mendix-platform/reference-guide/common/my-apps/) page. - * **Group Apps** - Click this option to go to the [My Group Apps](/private-mendix-platform/reference-guide/common/group-apps/) page. - * **Get Studio Pro** - Click this option to go to the [Get Studio Pro](/private-mendix-platform/reference-guide/common/get-studio/) page. -* **Manage** - * **My Content** - Click this option to go to the [My Content](/private-mendix-platform/reference-guide/common/my-content/) page. - * **Group Content** - Click this option to go to the [Group Content](/private-mendix-platform/reference-guide/common/group-content/) page. - * **Company Content** - Click this option to go to the [Company Content](/private-mendix-platform/reference-guide/common/company-content/) page. - -### Notifications {#notifications} - -The **Notifications** center shows notifications for the following events: - -* App events - * You were added to an app. - * You were removed from an app. - * Your role in an app changed. - * A user requested access to your an app. - * You were made the owner of an app. - * Your app has received new feedback. -* Deployment events - * Your deployment package was successfully created. - * Your deployment package could not be created because of an error. - * Your app was deployed. - * Your app could not be deployed due to an error. -* Marketplace events - * A Marketplace component that you are following was updated. - * A Marketplace component that you own was approved for publication. - * A new version of your Marketplace component was approved for publication. - * A Marketplace component that you own was rejected from publication. - * A new version of your Marketplace component was rejected from publication. - * You were made the owner of a Marketplace component. - -{{< figure src="/attachments/private-platform/pmp-notifications.png" class="no-border" >}} - -You can click a notification to view the related page or link. You can also mark a notification as read or unread by clicking the status dot on the left. To set your notification preferences, go to [Manage My Account > Notifications](/private-mendix-platform/reference-guide/common/account/#manage-notifications). - -### Account Menu {#account} - -The Account menu contains the options that you need to make or manage your account. - -{{< figure src="/attachments/private-platform/pmp-account-menu.png" class="no-border" >}} - -It consists of the following sections: - -* **Manage My Account** - Click this option to go to the [Manage My Account](/private-mendix-platform/reference-guide/common/account/) section. -* **Manage My Group** - This option is available only to users who have the Group Admin role. Click it to go to the [Manage My Group](/private-mendix-platform/reference-guide/common/manage-group/) page. -* **Switch to Admin Mode** - This option is available only to users who have the Company Admin and System Admin roles. Click it to go to the Administration section of Private Mendix Platform. -* **Show Onboarding** - Click this option to re-enable the [Onboarding](/private-mendix-platform/reference-guide/common/my-apps/#onboarding) section if you previously hid it. -* **Sign out** - Click this option to end the session and go back to the login screen. diff --git a/content/en/docs/private-platform/reference/common/pmp-ref-common-signin.md b/content/en/docs/private-platform/reference/common/pmp-ref-common-signin.md deleted file mode 100644 index 9eed0ea4b70..00000000000 --- a/content/en/docs/private-platform/reference/common/pmp-ref-common-signin.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Private Mendix Platform Functionalities - Sign In" -linktitle: "Sign In" -url: /private-mendix-platform/reference-guide/common/signin/ -description: "Provides details on the login page of Private Mendix Platform." -weight: 10 ---- - -## Introduction - -The initial login screen is the same for all users, whether or not they have administrator access rights. The following login methods are available: - -* A local user login with a username and password -* Optionally, an SSO login which redirects to an SSO provider - -{{< figure src="/attachments/private-platform/pmp-ref-signin.png" class="no-border" >}} - -After signing in, all users regardless of their role are initially directed to the **My Apps** page. Users with the administrator role can switch to admin view by clicking the user icon in the top right corner, and then selecting **Switch to Admin Mode**. diff --git a/content/en/docs/private-platform/reference/admin/pmp-ref-admin-manage.md b/content/en/docs/private-platform/reference/pmp-ref-admin-manage.md similarity index 100% rename from content/en/docs/private-platform/reference/admin/pmp-ref-admin-manage.md rename to content/en/docs/private-platform/reference/pmp-ref-admin-manage.md diff --git a/content/en/docs/private-platform/reference/admin/pmp-ref-admin-system.md b/content/en/docs/private-platform/reference/pmp-ref-admin-system.md similarity index 100% rename from content/en/docs/private-platform/reference/admin/pmp-ref-admin-system.md rename to content/en/docs/private-platform/reference/pmp-ref-admin-system.md diff --git a/content/en/docs/private-platform/secret-management/_index.md b/content/en/docs/private-platform/secret-management/_index.md index 47253541487..82a0a8a7b72 100644 --- a/content/en/docs/private-platform/secret-management/_index.md +++ b/content/en/docs/private-platform/secret-management/_index.md @@ -3,6 +3,8 @@ title: "Configuring Secret Management for Private Mendix Platform" url: /private-mendix-platform/secret-management/ description: "Documents the configuration of secret management for the Private Mendix Platform." weight: 32 +no_list: false +description_list: true --- ## Introduction diff --git a/content/en/docs/private-platform/secret-management/pmp-key-vault-integration.md b/content/en/docs/private-platform/secret-management/pmp-key-vault-integration.md index 29e617d0c57..727de0c0944 100644 --- a/content/en/docs/private-platform/secret-management/pmp-key-vault-integration.md +++ b/content/en/docs/private-platform/secret-management/pmp-key-vault-integration.md @@ -151,7 +151,7 @@ For environments which will use an `azure-wi` storage or database plan, the mana The configuration requires the following steps: -1. The customer (portal user) or Mendix Operator [creates the environment](/private-mendix-platform/user-guide/#deploy) in the Private Mendix Platform wizard, selecting the following options: +1. The customer (portal user) or Mendix Operator [creates the environment](/private-mendix-platform/apps/#deploy) in the Private Mendix Platform wizard, selecting the following options: * **Cluster** and **Namespace** - Select the cluster and namespace where you previously enabled secret store support. * **Database Plan** and **Storage Plan** - Select an azure-wi database and/or storage plan. @@ -174,7 +174,7 @@ Kubernetes ServiceAccount does not exist, Private Mendix Platform detects that i The configuration requires the following steps: -1. The customer (portal user) [creates the environment](/private-mendix-platform/user-guide/#deploy) in the Private Mendix Platform wizard, selecting the following options: +1. The customer (portal user) [creates the environment](/private-mendix-platform/apps/#deploy) in the Private Mendix Platform wizard, selecting the following options: * **Cluster** and **Namespace** - Select the cluster and namespace where you previously enabled secret store support. * **Database Plan** and **Storage Plan** - Select a database and/or storage plan without `azure-wi`. diff --git a/content/en/docs/private-platform/user-guide/_index.md b/content/en/docs/private-platform/user-guide/_index.md new file mode 100644 index 00000000000..dae3b5cb4c3 --- /dev/null +++ b/content/en/docs/private-platform/user-guide/_index.md @@ -0,0 +1,14 @@ +--- +title: "Private Mendix Platform User Guide" +url: /private-mendix-platform/user-guide/ +description: "Documents the business-as-usual administrator tasks for the Private Mendix Platform." +weight: 50 +no_list: false +description_list: true +aliases: + - /private-mendix-platform-user-guide/ +--- + +## Introduction + +The Private Mendix Platform User Guide provides information about the business-as-usual use cases available for Private Mendix Platform. diff --git a/content/en/docs/private-platform/user-guide/pmp-creating-apps.md b/content/en/docs/private-platform/user-guide/pmp-creating-apps.md new file mode 100644 index 00000000000..5539cd762cd --- /dev/null +++ b/content/en/docs/private-platform/user-guide/pmp-creating-apps.md @@ -0,0 +1,95 @@ +--- +title: "Creating and Managing Apps" +url: /private-mendix-platform/apps/ +description: "Documents creating and managing apps in Private Mendix Platform." +weight: 20 +--- + +## Introduction + +Refer to the following sections for information about creating, managing, and deploying your applications. + +## Installing Studio Pro {#install-studio-pro} + +Before you can create your first app, you must first install Mendix Studio Pro. Not all Studio Pro versions published by Mendix on the [Mendix Marketplace](https://marketplace.mendix.com/) are compatible with Private Mendix Platform. Private Mendix Platform offers predefined compatible versions of Studio Pro, which are tied to supported Runtime versions and reusable components (such as Starter App templates). + +1. Log in to Private Mendix Platform. +2. On the home page, click **Download Studio Pro** +3. Download the Studio Pro release, the patch, and optionally the dependency package. + + {{< figure src="/attachments/private-platform/pmp-ug2.png" class="no-border" >}} + +4. If required, install the tools included in the dependency package. +5. Install Studio Pro. For more information, see [Installing Studio Pro](/refguide/install/#install). +6. Extract the Studio Pro patch file to the *modeler* directory located in the Studio Pro installation directory, and let it patch the files inside. +7. Launch Studio Pro and log in to it with the same credentials as for Private Mendix Platform. + +## Creating a New App {#create-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](/private-mendix-platform/user-profile/#service-credentials). + +3. On the home page, click **Create App**. + + {{< figure src="/attachments/private-platform/pmp-ug3.png" class="no-border" >}} + +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: + + * [Quick Starts](/quickstarts/) + * [Learning path: Become a Rapid Developer](https://academy.mendix.com/link/paths/31/Become-a-Rapid-Developer) + +## Managing Your App {#manage-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. + +{{< figure src="/attachments/private-platform/pmp-ug5.png" class="no-border" >}} + +In the **General** section, you can you can quickly perform a number of actions: + +* 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 {#deploy} + +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. + +### Deployment Purpose and DTAP Mode + +When creating a new environment to deploy, you can select the environment purpose, which can be Development, Test, Acceptance, or Production. For the deployed Mendix App, this purpose corresponds to the runtime's `dtapMode`, which affects security and licensing. For example, whether demo users are available after deployment, whether production security is enabled, or whether the environment requests a license from the license manager service. Once the environment has been created, the environment purpose cannot be changed. + +On Private Mendix Platform, environments with the Development and Test purpose set the `dtapMode` to `D` (for Development), while Acceptance and Production environments operate in `dtapMode` `P` (for Production). This association cannot be changed. Please select the appropriate environment purpose when you're creating a new environment. + +#### Runtime Behavior in Development Mode {#runtime-behavior-development-mode} + +When the `dtapMode` is set to `D` (Development), the Mendix Runtime behaves differently than it does in Production mode. The following changes apply: + +* The admin password strength is not verified. +* The admin password can be a single character (for example, `1`). +* Project security can be disabled in the model. +* Some log lines are printed at the info level instead of the debug level. +* Demo users are created if enabled. +* During shutdown, task queues stop after a shorter grace period. +* Enables additional websockets. + +Do not use Development mode for production environments. Use Production mode (`P`) for environments that require the full security and runtime behavior. \ No newline at end of file diff --git a/content/en/docs/private-platform/user-guide/pmp-marketplace.md b/content/en/docs/private-platform/user-guide/pmp-marketplace.md new file mode 100644 index 00000000000..44b0884b9e0 --- /dev/null +++ b/content/en/docs/private-platform/user-guide/pmp-marketplace.md @@ -0,0 +1,98 @@ +--- +title: "Managing Marketplace Content" +linktitle: "Marketplace Content" +url: /private-mendix-platform/marketplace/ +description: "Documents creating, managing, and sharing Marketplace content in Private Mendix Platform." +weight: 30 +--- + +## Introduction + +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: + +* [Build a Connector](/appstore/creating-content/connector-guide-build/) +* [Best Practices for Building Connectors](/appstore/creating-content/connector-guide-best-practices/) + +## Sharing Marketplace Content {#sharing} + +To share the connector that you built, perform the following steps: + +1. In the [Private Mendix Platform navigation menu](/private-mendix-platform/reference-guide/common/signin/#navigation), click **Marketplace > My Content**. + + {{< figure src="/attachments/private-platform/pmp-ug7.png" class="no-border" >}} + +2. Click **Upload Content**. +3. In the **Upload Component** tab, perform the following actions: + + 1. Enter a **Component name** and select one of the following **Component Types**: + + * **Module** - Software functionality that can include a data model, logic, and UI with a portable security model. + * **Widget** - Single user-interface elements like containers, drop-down menus, and buttons. + * **Service** - Software functionality that can be re-used for different use cases. Services usually include APIs that you can interact with by configuring a connection in the app's module. + * **Solution** - Out-of-the-box solutions that are aimed at industry and domain problems, delivering instant value. These solutions are usually at least 80% ready for use, and need minimal adaptation to make them work for a customer-specific use case. + * **Sample** - A project that provides an overview of the capabilities a product can perform. The project can act as an example, sales play, demo, or template. + * **Starter Template** - Sample projects that have certain capabilities in place to provide a basis for you to start developing your own app. You do not need to create an app from a blank template, as you can use a template that already has some features configured. In addition, a template can have a personalized style that can be shared and used to enrich other apps with a specific design. + * **Industry Template** - Accelerators for implementing industry-specific processes. Industry templates increase speed-to-value and time-to-market, and are great starting points for common use cases within the relevant industry. Contrary to solutions, industry templates are starter templates intended to provide inspiration for utilizing Mendix to create apps for industry-specific processes. They usually cover around 20% of the process. + + 2. Click **Next**. + 3. In the **Upload MPK** field, click **Browse** and select the [.mpk file](/appstore/creating-content/connector-guide-build/#export-as-mpk) that you created for your component. + 4. In the **Studio Pro Version** drop-down, select the minimum version of Studio Pro required by your component. + 5. In the **Release Version** section, select the **Major**, **Minor**, and **Patch** version of your component. + 6. Provide **Release Notes** to describe the contents of the version you are uploading, and click **Next**. + + {{< figure src="/attachments/private-platform/pmp-ug8.png" class="no-border" >}} + +4. In the **General Info** tab, perform the following actions: + + 1. Select the **Cover Image** that will be displayed for your connector. The suggested image resolution is 600x240 px. + 2. In the **Tagline** field, include a short description of what your component does. + 3. In the **About** field, describe the purpose and use cases of your component in detail. + 4. From the **Industry** drop-down list, select up to three industries that are applicable to your component. + 5. From the **Category** drop-down list, select up to three areas of expertise that are applicable to your component. + +5. In the **Support and Licensing** tab, perform the following actions: + + 1. Optional: Enter the URL of your support portal, if available. + 2. Provide a support department contact email for the users of your component. + 3. Specify whether the component should be **visible for everyone**, or **visible for specific groups**. + 4. Select the type of **License** you want applied to your app. For details about the available open-source software licenses and their requirements, refer to [Open-Source Software Licenses](/appstore/submit-content/#license). + 5. In the **Owner** field, select the group that owns the component, and then click **Next**. + +6. In the **Media and Documentation** tab, perform the following actions: + + 1. Use the **Upload Screenshots** option to add a maximum of 10 screenshots of your component. + 2. In the **YouTube Video** field, add a URL for a demo of your component. + 3. In the **Documentation** field, add details on requirements and configuration for your component. + + Follow the template for the recommended content: + + * The **Typical usage scenario** for the component + * The **Features and limitations** of the component + * Any **Dependencies** (for example, the required Studio Pro version, modules, images, and styles) + * The **Installation** steps and details + * The **Configuration** steps and details + * Any **Known bugs** + * Any **Frequently Asked Questions** + + This field supports rich text. + + 4. In the **Resources** section, add up to 5 URLs for resources that your users might find useful, such as a **GitHub URL**. + 5. Click **Show Preview** if you want to preview your component, or **Publish** if you want to publish it directly. + +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. + +## Accessing Company and Group Content + +The **Marketplace** page is a local version of the Mendix Marketplace, enclosed entirely within the Private Platform. You can access it by clicking **Marketplace > Company Content** in the Private Mendix Platform navigation menu. + +{{< figure src="/attachments/private-platform/pmp-ug8.png" class="no-border" >}} + +The page shows content available to end users, organized by category. You can click **View More** to view all items from a particular category. You can also click a content item to view or download it from the Private Platform Marketplace. + +{{< figure src="/attachments/private-platform/pmp-refguide-company-content.png" class="no-border" >}} + +To view all the components owned by your groups, use the **My Group Contents** page. You can access it by clicking **Marketplace > Group Content** in the Private Mendix Platform navigation menu. Only items that have been shared with the relevant group are displayed here. Draft versions of content are not shown on the page. \ No newline at end of file diff --git a/content/en/docs/private-platform/user-guide/pmp-monitoring.md b/content/en/docs/private-platform/user-guide/pmp-monitoring.md new file mode 100644 index 00000000000..faac06229f8 --- /dev/null +++ b/content/en/docs/private-platform/user-guide/pmp-monitoring.md @@ -0,0 +1,88 @@ +--- +title: "Monitoring Private Mendix Platform" +linktitle: "Monitoring" +url: /private-mendix-platform/monitoring/ +description: "Documents the recommended monitoring stack for Private Mendix Platform." +weight: 30 +--- + +## Introduction + +Grafana, Loki, and Prometheus are the recommended monitoring stack for Kubernetes-based services like Private Mendix Platform. The customer is responsible for configuring the stack. For more information, see [Grafana Integration for Private Mendix Platform](/private-mendix-platform/grafana/). + +## Logs & Events + +From the **Logs** page, you can access the logs produced by your app. For information about configuring + +To access the logs, perform the following steps: + +1. Click on your app on the Private Mendix Platform [Home page](/private-mendix-platform/reference-guide/common/signin/). +2. In the left navigation pane, click **Monitoring > Logs & Events**. +3. Select the environment for which you want to view the logs. + +You can filter the results by the following properties: + +* **Container** - The container instance. +* **Retrieve last** - The number of results to retrieve. +* **Timespan** - The date and time range to display. +* **Filter by Log Level** - The highest log level to display. The following log levels are available: + + * **Trace** - Provides highly detailed information. Trace level messages are written only to logs. + * **Debug** - Provides detailed information, typically of interest only when diagnosing problems. + * **Info** - Confirms that things are working as expected. + * **Warning** - Indicates that something unexpected happened or warns about an upcoming problem (for example, *disk space low*). The application is still working as expected. + * **Error** - Indicates a serious problem that prevented the application from performing some function. + * **Critical** - Indicates that a serious error has occurred; the application may be unable to continue running. + +* **Keyword** - A keyword to use for filtering. + +### Help Me Function + +On the **Logs & Events** page, you can also download the **Help Me** package, containing diagnostic logs which you can attach to a support ticket if needed. For more information about the **Help Me** function, see [Private Mendix Platform Events and the Help Me Function](/private-mendix-platform/support-help-me/). + +## Metrics + +The **Metrics** page contains detailed graphs about your app and its environment. You can use this page to monitor the performance and health of your app; for example, you can track the usage growth of your app or debug performance problems. + +These statistics are displayed as trends over time. + +To view the graphs on **Metrics** page, perform the following steps: + +1. Open your app in the Private Mendix Platform portal. +2. In the left navigation pane, click **Monitoring > Metrics**. +3. Select the environment and pod. + +You can filter the results by the following properties: + +* **Container** - The container instance. +* **Retrieve last** - The number of results to retrieve. +* **Timespan** - The date and time range to display. +* **Filter by Log Level** - The highest log level to display. The following log levels are available: + + * **Trace** - Provides highly detailed information. Trace level messages are written only to logs. + * **Debug** - Provides detailed information, typically of interest only when diagnosing problems. + * **Info** - Confirms that things are working as expected. + * **Warning** - Indicates that something unexpected happened or warns about an upcoming problem (for example, *disk space low*). The application is still working as expected. + * **Error** - Indicates a serious problem that prevented the application from performing some function. + * **Critical** - Indicates that a serious error has occurred; the application may be unable to continue running. + +* **Keyword** - A keyword to use for filtering. + +## Webhooks {#webhooks} + +Webhooks allow you to send information about your licensed Mendix app deployed to Private Mendix Platform to an external app or workflow. You can use them to trigger a step in an automated [Build](/private-mendix-platform/reference-guide/admin/system/#build-steps) or [Deployment](/private-mendix-platform/reference-guide/admin/system/#deploy-steps) pipeline. + +### Creating a New Webhook {#setting-up} + +To set up a webhook, do the following: + +1. On the **Monitoring > Webhooks** page, click **New Webhook**. +2. Enter the following information: + + * **Webhook Name** – This is a name which you can use to identify the webhook. + * **URL** – This is the endpoint that will receive the payload when one of the event types selected in **Available Events** occurs. + * **Validation Secret** – This is a secret that is shared with the endpoint to verify that it has been triggered by this webhook. If you leave this blank, a secret is generated automatically. You can see the generated value any time you return to edit the webhook. + * **Available Events** – This is the event (or events) that triggers the webhook to send information to the endpoint. Company administrators can activate or deactivate specific event types in the **Webhooks > Event Management** tab of administrator menu. For more information, see [Company Administrators: Webhooks](/private-mendix-platform/reference-guide/admin/company/#webhooks). + * **Custom Headers** – This is a key-value pair that is sent as an HTTP header to the endpoint. Company administrators can configure a predefined custom header in the **Webhooks > Preset Headers** tab of administrator menu. For more information, see [Company Administrators: Webhooks](/private-mendix-platform/reference-guide/admin/company/#webhooks). + +You can edit or delete an existing webhook by clicking **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the **Action** column for the webhook you want to change, and then selecting **Edit** or **Delete**. \ No newline at end of file diff --git a/content/en/docs/private-platform/user-guide/pmp-ref-common-signin.md b/content/en/docs/private-platform/user-guide/pmp-ref-common-signin.md new file mode 100644 index 00000000000..a3528be8dd2 --- /dev/null +++ b/content/en/docs/private-platform/user-guide/pmp-ref-common-signin.md @@ -0,0 +1,76 @@ +--- +title: "Signing in and Navigating the Private Mendix Platform Home Page" +linktitle: "Sign In and Navigation" +url: /private-mendix-platform/reference-guide/common/signin/ +description: "Provides details on the login and home page of Private Mendix Platform." +weight: 5 +--- + +## Introduction + +The initial login screen is the same for all users, whether or not they have administrator access rights. The following login methods are available: + +* A local user login with a username and password +* Optionally, an SSO login which redirects to an SSO provider + +{{< figure src="/attachments/private-platform/pmp-ref-signin.png" class="no-border" >}} + +After signing in, all users regardless of their role are initially directed to the **Home** page. Users with the administrator role can switch to admin view by clicking the user icon in the top right corner, and then selecting **Admin Mode** from the **User Mode** drop-down. + +## Home Page + +The **Home** page is the landing page of Private Mendix Platform. + +{{< figure src="/attachments/private-platform/pmp-homepage.png" class="no-border" >}} + +It shows an overview of your applications and groups. You can use it to perform the following tasks: + +* See the number of your apps total and your deployed apps. +* [Download Studio Pro](/private-mendix-platform/apps/#install-studio-pro). +* [Create a new app](/private-mendix-platform/apps/#create-app). +* Access specific apps. +* View the groups to which you belong. +* Add or remove members to groups where you have the Group Admin role. + +## Top Navigation Bar + +The top navigation bar displays your location within the Platform (for example, *Apps* or *Marketplace*). The branding of the bar, such as the logo and title, can be customized by a Company Admin. + +From the navigation bar, you can access the following items: + +* [Platform Navigation](#navigation) (({{% icon name="layout-1-filled" %}})) +* [Notifications](#notifications) (({{% icon name="alarm-bell" %}})) +* [Account Menu](#account) + +### Platform Navigation {#navigation} + +The navigation menu contains the options that you need to make or manage your apps. + +{{< figure src="/attachments/private-platform/pmp-navigation-menu.png" class="no-border" >}} + +It consists of the following sections: + +* **Home** - Click this option to go to the Home page. +* **Apps > Direct Access** - Click this option to go to the **Direct Access** section of the [My Apps](/private-mendix-platform/reference-guide/common/my-apps/) page. +* **Apps > Access via Groups** - Click this option to go to the **Access via groups** section of the [My Apps](/private-mendix-platform/reference-guide/common/my-apps/) page. +* **Groups** - Click this option to go to the [My Group](/private-mendix-platform/reference-guide/common/manage-group/) page. +* **Marketplace > Company Content** - Click this option to go to the [Company Content](/private-mendix-platform/reference-guide/common/company-content/) page. +* **Marketplace > Group Content** - Click this option to go to the [Group Content](/private-mendix-platform/reference-guide/common/group-content/) page. +* **Marketplace > My Content** - Click this option to go to the [My Content](/private-mendix-platform/reference-guide/common/my-content/) page. +* **Create App** - Click this option to [start creating your application](/private-mendix-platform/apps/) page. +* **Download Studio Pro** - Click this option to go to the [Get Studio Pro](/private-mendix-platform/reference-guide/common/get-studio/) page. + +### Notifications {#notifications} + +The **Notifications** center shows notifications for the following events: + +* **Alerts** - Notifications about events that require attention, for example, app availability and status +* **Following** - Notifications about comments and reactions to your stories, posts, or projects +* **Recommendation** - Notifications about new Private Mendix Platform releases +* **Requests/Approvals** - Notifications about status changes for your requests, for example, the publication of a Marketplace content item + +You can click a notification to view the related page or link. You can also mark a notification as read or unread by clicking the status dot on the left. To set your notification preferences, go to [Manage My Account > Notifications](/private-mendix-platform/user-profile/#notifications). + +### Manage My Account {#account} + +The **Manage My Account** menu contains the options that you need to make or manage your account. For more information, see [Configuring Your User Profile and Settings](/private-mendix-platform/user-profile/). \ No newline at end of file diff --git a/content/en/docs/private-platform/user-guide/pmp-user-guide.md b/content/en/docs/private-platform/user-guide/pmp-user-guide.md new file mode 100644 index 00000000000..8a5407d6890 --- /dev/null +++ b/content/en/docs/private-platform/user-guide/pmp-user-guide.md @@ -0,0 +1,77 @@ +--- +title: "Configuring Your User Profile and Settings" +linktitle: "User Profile and Settings" +url: /private-mendix-platform/user-profile/ +description: "Documents the user profile configuration for the Private Mendix Platform." +weight: 10 +--- + +## Introduction + +Your user account is created by the administrator of your Private Mendix Platform. After you log in for the first time, you can configure your profile settings by clicking the user icon in the top right corner of the screen, and then clicking **Manage My Account**. + +{{< figure src="/attachments/private-platform/pmp-ug1.png" class="no-border" >}} + +## Profile {#profile} + +On the **Profile** page, you can view general information about yourself. This includes the following information: + +* Full name (for example, Jane Doe) +* User name (for example, jdoe) +* Email (for example, `jdoe@example.com`) +* Platform role (for example, System Admin) +* Group (for example, Digitalization Project Group) + +{{% alert color="info" %}} +You can update your full name yourself. To update other information in this section, contact your Private Mendix Platform administrator. +{{% /alert %}} + +{{< figure src="/attachments/private-platform/pmp-manage-profile.png" class="no-border" >}} + +## 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 + +A Personal Access Token (PAT) is used to identify the user account and its corresponding privileges and permissions when interacting with Private Mendix Platform over APIs and other non-GUI interactions, for example, when setting up automated API calls to and from an external service. For more information, see [APIs for Private Mendix Platform](/apidocs-mxsdk/apidocs/private-platform/). + +### Creating a PAT {#create-pat} + +On the **Personal Access Tokens** page, you can create a new PAT. To do so, click **New Token**, and set the following characteristics of the PAT: + +* **Token Name** - Give the PAT a name that reflects where or why you intend to use it. +* **Expiry Date** - Specify the date and time after which the token will expire. As a best practice, never set the expiration time for the token to be more than one year. +* **Scopes** - Select the scopes (authorizations) that you want to grant to your PAT. To reduce risk and impact, follow the least-privilege principle for token scope and use different tokens for different purposes instead of creating one token with a large scope. + +After you click **Create**, the PAT appears on the **Personal Access Tokens** page. To copy it to your clipboard, click **Actions > Copy PAT**. + +### Managing a PAT + +To see the scopes of a PAT you have created, click **Actions > View Details**. + +{{% alert color="info" %}} +You cannot see the secret token of a PAT here. You can only see that the PAT exists, along with its scopes. +{{% /alert %}} + +To delete a PAT, click **Actions > Delete**. This will prevent anyone who has obtained the PAT's secret token from successfully using it. + +## Service Credentials {#service-credentials} + +On the **Service Credentials** page, 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. Depending on settings configured by the admin, they can automatically provisioned through the integrations or manually configured for the user account. + +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 on the **Register Credentials** screen. The token must have read and write access to a repository where the app project is stored. + +## Notifications {#notifications} + +On the **Notification Settings** page, you can enable or disable the following notification types for Private Mendix Platform: + +* **Alerts** - Notifications about events that require attention, for example, app availability and status +* **Following** - Notifications about comments and reactions to your stories, posts, or projects +* **Recommendation** - Notifications about new Private Mendix Platform releases +* **Requests/Approvals** - Notifications about status changes for your requests, for example, the publication of a Marketplace content item \ No newline at end of file diff --git a/content/en/docs/releasenotes/private-platform/1/1.15.md b/content/en/docs/releasenotes/private-platform/1/1.15.md index 3b3b7d7f781..e3ba13ed517 100644 --- a/content/en/docs/releasenotes/private-platform/1/1.15.md +++ b/content/en/docs/releasenotes/private-platform/1/1.15.md @@ -17,7 +17,7 @@ Version 1.15.0 of Private Mendix Platform introduces a number of bug fixes and i ##### Starting and Stopping Deployed Apps -You can now easily start and stop deployed applications by using a new option available in the environment management menu. For more information, see [Private Mendix Platform User Guide: Deploying Your App](/private-mendix-platform/user-guide/#deploy). +You can now easily start and stop deployed applications by using a new option available in the environment management menu. For more information, see [Private Mendix Platform User Guide: Deploying Your App](/private-mendix-platform/apps/#deploy). ##### System Admin Account Can Be Disabled in Bulk diff --git a/content/en/docs/releasenotes/private-platform/2/2.7.md b/content/en/docs/releasenotes/private-platform/2/2.7.md index bb0eb420c58..de59b6d0413 100644 --- a/content/en/docs/releasenotes/private-platform/2/2.7.md +++ b/content/en/docs/releasenotes/private-platform/2/2.7.md @@ -35,7 +35,7 @@ To help you streamline your deployment process, we have provided the following e * If an environment has a deployed package, you can promote the package to another environment (for example, from *Test* to *Acceptance*) by clicking **Promote** directly on the Environment Overview page. * You can reorder environments on the Environment Overview page. -For more information, see [Deploying Your App](/private-mendix-platform/user-guide/#deploy). +For more information, see [Deploying Your App](/private-mendix-platform/apps/#deploy). ##### Enhanced Control over Studio Pro Download Options diff --git a/static/attachments/private-platform/pmp-homepage.png b/static/attachments/private-platform/pmp-homepage.png index 0ecfb89edb8..bb6ce8a9e55 100644 Binary files a/static/attachments/private-platform/pmp-homepage.png and b/static/attachments/private-platform/pmp-homepage.png differ diff --git a/static/attachments/private-platform/pmp-ug1.png b/static/attachments/private-platform/pmp-ug1.png index 4301875cb60..9fea7a9418d 100644 Binary files a/static/attachments/private-platform/pmp-ug1.png and b/static/attachments/private-platform/pmp-ug1.png differ diff --git a/static/attachments/private-platform/pmp-ug2.png b/static/attachments/private-platform/pmp-ug2.png index ef701d782ec..4e020ec8799 100644 Binary files a/static/attachments/private-platform/pmp-ug2.png and b/static/attachments/private-platform/pmp-ug2.png differ diff --git a/static/attachments/private-platform/pmp-ug3.png b/static/attachments/private-platform/pmp-ug3.png index 8bc469e5b5a..56abac88534 100644 Binary files a/static/attachments/private-platform/pmp-ug3.png and b/static/attachments/private-platform/pmp-ug3.png differ diff --git a/static/attachments/private-platform/pmp-ug7.png b/static/attachments/private-platform/pmp-ug7.png index ca830536771..11ee2e76053 100644 Binary files a/static/attachments/private-platform/pmp-ug7.png and b/static/attachments/private-platform/pmp-ug7.png differ diff --git a/static/attachments/private-platform/pmp-ug8.png b/static/attachments/private-platform/pmp-ug8.png index 32fe98311ac..25e9328c3f4 100644 Binary files a/static/attachments/private-platform/pmp-ug8.png and b/static/attachments/private-platform/pmp-ug8.png differ