Skip to content

Commit 40ba753

Browse files
committed
Add End-Users docs
1 parent 7007079 commit 40ba753

4 files changed

Lines changed: 126 additions & 17 deletions

File tree

content/en/docs/control-center/entitlements/approval-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Approval Requests"
33
url: /control-center/approval-requests/
44
description: "Describes the Approval Requests page in the Mendix Control Center."
5-
weight: 30
5+
weight: 40
66
no_list: false
77
---
88

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: "End-Users"
3+
url: /control-center/end-users/
4+
description: "Describes the End-Users page in the Mendix Control Center."
5+
weight: 30
6+
beta: true
7+
---
8+
9+
{{% alert color="warning" %}}
10+
This feature is in Private Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
11+
{{% /alert %}}
12+
13+
## Introduction
14+
15+
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.
16+
17+
End-user metering ensures that you benefit from:
18+
19+
* Automatic tracking – User consumption is tracked from the moment your app is deployed to production and running.
20+
* Monthly reporting – Usage data is collected regularly, processed monthly, and made available in Control Center.
21+
* App-level visibility – View named user counts per app to identify optimization opportunities.
22+
* Subscription type classification – Users are classified as External, Multi-App Internal, or Single-App Internal based on their subscription type.
23+
* Historical data – Access usage data for all the months since enabling user metering.
24+
25+
You can read about the user metering process in [User Metering](/developerportal/deploy/user-metering/).
26+
27+
The **End-Users** page allows you to keep track of end-user subscriptions and usage for all apps across your company.
28+
29+
### User Types
30+
31+
Mendix differentiates between these types of users:
32+
33+
* 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.
34+
The associated licensing model is **Multi-App Internal User Subscription**.
35+
36+
* 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.
37+
The associated licensing model is **Single-App Internal User Subscription**.
38+
39+
* External user – A user who is not an employee or a contractor of the customer or of the affiliated company or group.
40+
The associated licensing model is **External User Subscription**.
41+
42+
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*.
43+
44+
## Overview Tab
45+
46+
The **Overview** tab displays end-user entitlements, and named user details. It also allows you to assign Internal single-app user subscriptions.
47+
48+
### User Entitlements – Active Today
49+
50+
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.
51+
52+
The information is refreshed in real time.
53+
54+
### Named User Consumption
55+
56+
This section includes a list of apps and their corresponding number of named users for the current month. These are the available details:
57+
58+
* **App Name** – The name of the app.
59+
* **ID** – The unique ID of the app, with the option to copy it.
60+
* **Environment Name** – The name of the production environment to which the app is deployed.
61+
* **Env ID** – The unique ID of the environment to which the app is deployed.
62+
* **Deployment Type** – The target platform to which the app is deployed.
63+
* **Usage Extracted On** – The date and time when usage information was recorded.
64+
* **Named Users** – The number of named users who hold a subscription for the app.
65+
* **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).
66+
67+
### Assigning Single-App Internal User Subscriptions {#assign-subscriptions}
68+
69+
If you have single-app internal user subscriptions in your account, you must assign them to apps deployed to production. Follow these steps to do that:
70+
71+
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.
72+
2. In the **Assign Internal Single-App User Subscription** dialog box, select a subscription from the **Select Single-App User Subscription** list.
73+
3. Click **Confirm**.
74+
75+
## Usage Report Tab
76+
77+
The **Usage Report** tab allows you to monitor user entitlements and consumption across all available subscription types over a period of one calendar month.
78+
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.
79+
80+
### Entitlements & Consumption
81+
82+
This is the information available in the **Entitlements & Consumption** section of the **Usage Report** tab:
83+
84+
* **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.
85+
* Subscription cards – These cards display the entitlements and consumption as calculated on the last day of the selected month.
86+
87+
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.
88+
89+
<!--
90+
91+
Usage in Apps
92+
The Usage in Apps section of the Usage Report tab displays the number of consumption units per app, detailed as follows:
93+
94+
App Name – The name of the app where units were consumed.
95+
96+
Environment Name – The name of the app environment where units were consumed.
97+
98+
Deployment Type – The platform to which the app is deployed.
99+
100+
Multi-App Users – The number of multi-app users who consumed units in the app.
101+
102+
Single-App Users – The number of single-app users who consumed units in the app.
103+
104+
External Users – The number of external users who consumed units in the app.
105+
106+
-->

content/en/docs/deployment/general/subscription-management/user-metering/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "This document describes how user metering works."
77

88
## Introduction
99

10-
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. <!-- *Proper user classification ensures accurate reporting, optimal licensing costs and transparency for both customers and Mendix. Customers can access Usage Report through the Control Center application on the Mendix Platform*. Link Usage Report from the Control Center doc -->
10+
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.
1111

1212
{{% alert color="info" %}}
1313
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
2424
### Key Features
2525

2626
* Automatic tracking – User logins are automatically tracked from the moment your application is deployed to production and becomes functional.
27-
* 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. -->
27+
* Data processing – Usage data is collected, processed, and deduplicated regularly.
28+
* Monthly reporting – Usage data is collected regularly, processed monthly, and is available in the Control Center [End-Users](/control-center/end-users/) page.
2829
* 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.
2930

3031
## How User Metering Works
@@ -51,7 +52,7 @@ Users are thereafter automatically classified in the following user buckets base
5152
2. Single-App Internal Users
5253
3. Multi-App Internal Users (default)
5354

54-
<!-- End-of-month usage reports are generated at the beginning of each month and are made available via the Control Center dashboard. The reports are generally available on the 1st of each month and reflect the previous month's usage. -->
55+
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.
5556

5657
## How User Classification and Deduplication Work {#classification-deduplication}
5758

@@ -82,8 +83,8 @@ A multi-app user who is marked as `Internal` in one application and `External` i
8283

8384
After `External` users are classified, the classification process further classifies the single-app internal users.
8485

85-
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.
86-
<!-- *For more details on how to assign Single-App Internal User Pack to your apps, refer to the Assigning Single-App Internal User Packs section of the Control Center.* Link from the Control Center doc -->
86+
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.
87+
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.
8788

8889
{{% alert color="info" %}}
8990
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.

content/en/docs/deployment/general/subscription-management/user-metering/faq.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,34 @@ This document answers common questions about user metering, outlining user class
1515
### Is User Metering Automatically Enabled?
1616

1717
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.
18-
<!-- ### Where Can I View My User Consumption Data?
18+
19+
### Where Can I View My User Consumption Data?
1920

2021
Navigate to the **Control Center** > **Entitlements** > **End-Users** > **Usage Report**.
21-
For more information, refer to the Usage Report Tab section of *End-Users*.
22+
For more information, refer to the [Usage Report Tab](/control-center/end-users/#usage-report-tab) section of *End-Users*.
2223

2324
### When Can I See My Monthly Usage Data?
2425

25-
User subscription utilization is extracted regularly from the apps and available as a daily snapshot on the Control Center.
26-
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.
27-
Link from the Control Center doc -->
26+
User subscription utilization is extracted regularly from the apps and available as a daily snapshot in Control Center.
27+
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.
28+
For details, refer to the [Usage Report Tab](/control-center/end-users/#usage-report-tab) section of *End-Users*.
2829

2930
### What Happens if I Exceed My Entitlement?
3031

3132
If you exceed your subscription entitlements:
3233

33-
* No immediate service disruption: Your applications continue to run normally.
34-
<!--* Alert displayed: A warning icon appears in the end-of-month Usage Report on the Control Center. -->
34+
* No immediate service disruption: Your applications continue to run normally.
35+
Alert displayed: A warning icon appears in the end-of-month Usage Report in Control Center.
3536
* Compliance discussion: Your Customer Success Manager (CSM) will contact you to discuss:
3637

3738
* Purchasing additional user subscriptions
3839
* Assessing user classification
3940

40-
<!--Mendix recommends that you monitor your usage regularly and purchase additional capacity before reaching your limit.
41+
Mendix recommends that you monitor your usage regularly and purchase additional capacity before reaching your limit.
4142

4243
### Can I View Usage Data From Previous Months?
4344

44-
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.-->
45+
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.
4546

4647
## Questions on User Classification
4748

@@ -55,9 +56,10 @@ This means all users in your applications are aggregated together and classified
5556
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.
5657

5758
For more information, refer to [User Classification](/developerportal/deploy/implementing-user-metering/#user-classification).
58-
<!--### I Purchased a Single-App User Subscription for My Application. How Do I Set It Up?
5959

60-
Assign the Single-App User Subscription to your application in the Control Center. For more information, refer to Assigning Single-App Internal User Subscription. Link from the Control Center doc -->
60+
### I Purchased a Single-App User Subscription for My Application. How Do I Set It Up?
61+
62+
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.
6163

6264
### How Do I Assign a Single-App User Subscription to Multiple Applications With Unique User Bases?
6365

0 commit comments

Comments
 (0)