diff --git a/content/en/docs/control-center/entitlements/approval-requests.md b/content/en/docs/control-center/entitlements/approval-requests.md index 2f94bbee77d..1c5dbb35422 100644 --- a/content/en/docs/control-center/entitlements/approval-requests.md +++ b/content/en/docs/control-center/entitlements/approval-requests.md @@ -2,7 +2,7 @@ title: "Approval Requests" url: /control-center/approval-requests/ description: "Describes the Approval Requests page in the Mendix Control Center." -weight: 30 +weight: 40 no_list: false --- diff --git a/content/en/docs/control-center/entitlements/end-users.md b/content/en/docs/control-center/entitlements/end-users.md new file mode 100644 index 00000000000..bebdea8d569 --- /dev/null +++ b/content/en/docs/control-center/entitlements/end-users.md @@ -0,0 +1,104 @@ +--- +title: "End-Users" +url: /control-center/end-users/ +description: "Describes the End-Users page in the Mendix Control Center." +weight: 30 +beta: true +--- + +{{% alert color="warning" %}} +This feature is in Private Beta. For more information, refer to [Release Status](/releasenotes/release-status/). +{{% /alert %}} + +## Introduction + +End-user metering is a process that accurately measures the number and types of users interacting with Mendix apps. This is important for ensuring transparency and compliance with license agreements, while optimizing licensing costs. + +End-user metering ensures that you benefit from: + +* Automatic tracking – User consumption is tracked from the moment your app is deployed to production and running. +* Monthly reporting – Usage data is collected regularly, processed monthly, and made available in Control Center. +* App-level visibility – View named user counts per app to identify optimization opportunities. +* Subscription type classification – Users are classified as External, Multi-App Internal, or Single-App Internal based on their subscription type. +* Historical data – Access usage data for all the months since enabling user metering. + +You can read about the user metering process in [User Metering](/developerportal/deploy/user-metering/). + +The **End-Users** page allows you to keep track of end-user subscriptions and usage for all apps across your company. + +### User Types + +Mendix differentiates between these types of users: + +* Multi-app internal user – An employee or a contractor of the customer or of the affiliated company or group who can access any number of apps. + The associated licensing model is **Multi-App Internal User Subscription**. + +* Single-app internal user – An employee or a contractor of the customer or of the affiliated company or group, who holds a subscription for one specific app. + The associated licensing model is **Single-App Internal User Subscription**. + +* External user – A user who is not an employee or a contractor of the customer or of the affiliated company or group. + The associated licensing model is **External User Subscription**. + +For details on user types, refer to the [User Types and Definitions](/developerportal/deploy/licensing-apps-outside-mxcloud/#user-types-and-definitions) section of *Licensing Apps*. + +## Overview Tab + +The **Overview** tab displays end-user entitlements, and [named user](https://www.mendix.com/legal/platform-usage/order-form-definitions/#named-user) details. It also allows you to assign Internal single-app user subscriptions. + +### User Entitlements – Active Today + +The cards in this section display end-user subscription entitlements, grouped by user type, and valid as of the current date. Each card also includes the expiration date of that subscription. + +### Named User Consumption + +This section includes a list of apps and their corresponding number of named users for the current month. These are the available details: + +* **App Name** – The name of the app. +* **ID** – The unique ID of the app, with the option to copy it. +* **Environment Name** – The name of the production environment to which the app is deployed. +* **Env ID** – The unique ID of the environment to which the app is deployed. +* **Deployment Type** – The target platform to which the app is deployed. +* **Usage Extracted On** – The date and time when usage information was last recorded. +* **Named Users** – The number of named users as seen in the app. +* **Actions** – This option is only relevant for single-app internal user subscriptions, and it allows you to assign such a subscription to the app. For details, refer to [Assigning Single-App Internal User Subscriptions](#assign-subscriptions). + +### Assigning Single-App Internal User Subscriptions {#assign-subscriptions} + +If you have single-app internal user subscriptions in your account, you must assign them to an app environment deployed to production. Follow these steps to do that: + +1. In the **Named Users** list, identify the app to which you want to assign a single-app internal user subscription, and click **Assign** at the end of its row. +2. In the **Assign Internal Single-App User Subscription** dialog box, select a subscription from the **Select Single-App User Subscription** list. +3. Click **Confirm**. + +## Usage Report Tab + +The **Usage Report** tab allows you to monitor user entitlements and consumption across all available subscription types over a period of one calendar month. +The report is generated on the first day of every month for the previous month's usage. As such, the information on this tab is updated every month, and reflects the usage as processed on the last day of the previous month. + +### Entitlements & Consumption + +This is the information available in the **Entitlements & Consumption** section of the **Usage Report** tab: + +* **Usage Month** – Allows you to select the month for which you want to see consumption information. By default, the field is set to the most recent month for which a report is available. +* Subscription cards – These cards display the entitlements and consumption as calculated on the last day of the selected month. + +In case of over-usage, which means that entitlements have been exceeded, apps continue to work, with no consequences to end-users. Over-usage needs to be discussed with the Mendix CSM or representative. + + diff --git a/content/en/docs/deployment/general/subscription-management/user-metering/_index.md b/content/en/docs/deployment/general/subscription-management/user-metering/_index.md index a61cbc896a0..79e2e615e7f 100644 --- a/content/en/docs/deployment/general/subscription-management/user-metering/_index.md +++ b/content/en/docs/deployment/general/subscription-management/user-metering/_index.md @@ -7,7 +7,7 @@ description: "This document describes how user metering works." ## Introduction -Mendix uses end-user metering to determine the number and type of users accessing applications in accordance with subscription agreements. Proper user classification ensures accurate reporting and optimal licensing costs for customers. +Mendix uses end-user metering to determine the number and type of users accessing applications in accordance with subscription agreements. Proper user classification ensures accurate reporting, optimal licensing costs and transparency for both customers and Mendix. Customers can access the **Usage Report** through the [End-Users](/control-center/end-users/) page in Control Center. {{% alert color="info" %}} End-user metering is currently applied to applications deployed to Mendix Cloud and Mendix Cloud Dedicated environments. @@ -24,7 +24,8 @@ For more information, refer to the [User Types and Definitions](/developerportal ### Key Features * Automatic tracking – User logins are automatically tracked from the moment your application is deployed to production and becomes functional. -* Data processing – Usage data is collected, processed, and deduplicated regularly. +* Data processing – Usage data is collected, processed, and deduplicated regularly. +* Monthly reporting – Usage data is collected regularly, processed monthly, and is available in the Control Center [End-Users](/control-center/end-users/) page. * User subscription classification – Users are classified by user subscription type as External users, Multi-App Internal users, or Single-App Internal users. This classification yields accurate subscription tracking and helps optimize subscription costs. ## How User Metering Works @@ -51,7 +52,7 @@ Users are thereafter automatically classified in the following user buckets base 2. Single-App Internal Users 3. Multi-App Internal Users (default) - +End-of-month usage reports are generated at the beginning of each month and are made available via the Control Center [Usage Report](/control-center/end-users/#usage-report-tab) dashboard. The reports are generally available on the 1st of each month and reflect the previous month's usage. ## How User Classification and Deduplication Work {#classification-deduplication} @@ -82,8 +83,8 @@ A multi-app user who is marked as `Internal` in one application and `External` i After `External` users are classified, the classification process further classifies the single-app internal users. -If the application is associated with a Single-App Internal User Subscription, the user of the application is classified as a single-app internal user. This user is then counted against the Single-App Internal User Pack for that application. - +If the application is associated with a Single-App Internal User Subscription, the user of the application is classified as a single-app internal user. This user is then counted against the Single-App Internal User Pack for that application. +For more details on how to assign a Single-App Internal User Subscription to your apps, refer to the [Assigning Single-App Internal User Subscriptions](/control-center/end-users/#assign-subscriptions) section of the *End-Users* page. {{% alert color="info" %}} An internal user accessing multiple applications, one of which is covered under a Single-App Internal User Subscription, is counted as a single-app internal user for that application and is also counted separately for any other applications they use. diff --git a/content/en/docs/deployment/general/subscription-management/user-metering/faq.md b/content/en/docs/deployment/general/subscription-management/user-metering/faq.md index 541106b0cbd..92ff5e673e1 100644 --- a/content/en/docs/deployment/general/subscription-management/user-metering/faq.md +++ b/content/en/docs/deployment/general/subscription-management/user-metering/faq.md @@ -15,33 +15,34 @@ This document answers common questions about user metering, outlining user class ### Is User Metering Automatically Enabled? User metering is automatically enabled for all Mendix Cloud and Mendix Cloud Dedicated applications without requiring any configuration or setup for usage data collection. All running application environments transmit usage data to the Mendix Platform at regular intervals. Data collection begins as soon as your application is deployed to a production environment. - +User subscription utilization is extracted regularly from the apps and available as a daily snapshot in Control Center. +The daily snapshots are processed and deduplicated across all your apps at the end of each month and become available on the 1st of the following month as monthly usage data. Monthly reports show aggregated subscription usage over the month. +For details, refer to the [Usage Report Tab](/control-center/end-users/#usage-report-tab) section of *End-Users*. ### What Happens if I Exceed My Entitlement? If you exceed your subscription entitlements: -* No immediate service disruption: Your applications continue to run normally. - +* No immediate service disruption: Your applications continue to run normally. + Alert displayed: A warning icon appears in the end-of-month Usage Report in Control Center. * Compliance discussion: Your Customer Success Manager (CSM) will contact you to discuss: * Purchasing additional user subscriptions * Assessing user classification - +Apps across Mendix Cloud began collecting user metering data starting in November 2025. Based on when your application was onboarded on user metering, you may have access to historical usage data. Navigate to the **Usage Report** and select the desired month to see the usage data. ## Questions on User Classification @@ -55,9 +56,10 @@ This means all users in your applications are aggregated together and classified Explicitly mark users as `External` in your application to ensure they are counted correctly under your External User Subscription. If you do not have an External User Subscription, these users will be classified as `Internal`, even if they are marked as `External` users. Also, a multi-app user who is marked as `Internal` in one app, but as `External` in another app, will be counted as an Internal Multi-App User. For more information, refer to [User Classification](/developerportal/deploy/implementing-user-metering/#user-classification). - +### I Purchased a Single-App User Subscription for My Application. How Do I Set It Up? + +Assign the Single-App User Subscription to your application in Control Center. For more information, refer to the [Assigning Single-App Internal User Subscriptions](/control-center/end-users/#assign-subscriptions) section of the *End-Users* page. ### How Do I Assign a Single-App User Subscription to Multiple Applications With Unique User Bases?