-
Notifications
You must be signed in to change notification settings - Fork 782
User Metering #10789
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
User Metering #10789
Changes from 13 commits
Commits
Show all changes
52 commits
Select commit
Hold shift + click to select a range
38d3f63
restructuring
Karuna-Mendix 3d04df3
moving populate user types
Karuna-Mendix 1db37f0
Add section - User Types and Definitions
Karuna-Mendix f0c3b9b
New page- User Metering
Karuna-Mendix e2c980b
User metering overview page
Karuna-Mendix 5e98588
Creating user metering category
Karuna-Mendix 866b3c3
new page- implementing user metering
Karuna-Mendix 6cf8a53
implementing user metering info
Karuna-Mendix 884ccad
(De)Activation of users
Karuna-Mendix 616cb47
Additional info
Karuna-Mendix 0ee9b29
new page- FAQ
Karuna-Mendix 44b720c
Proofreading
Karuna-Mendix 492a5da
Proofreading
Karuna-Mendix 2346ec6
Feedback comments- 1st iteration
Karuna-Mendix 48bb658
Feedback comment - 2nd iteration
Karuna-Mendix 419954a
FAQs- feedback
Karuna-Mendix 2cc66d2
feedback 3rd iteration
Karuna-Mendix 4fda763
feedback
Karuna-Mendix 707ff3b
More feedback on user metering index file
Karuna-Mendix 5ce950a
feedback 1- implementing user metering
Karuna-Mendix 5d33f14
small changes
Karuna-Mendix 82fbb12
Improving Guidelines for Unique User Identification section
Karuna-Mendix c64021e
small change
Karuna-Mendix 916df42
small change
Karuna-Mendix 8a9f5ac
Incorporated populate user types sections
Karuna-Mendix 6804817
Removed Populating user types doc.
Karuna-Mendix 3eab208
FAQ update
Karuna-Mendix 05feeaa
Proofreading
Karuna-Mendix cc0f986
Proofreading
Karuna-Mendix 5edf47d
Fixing broken links
Karuna-Mendix 615dd1f
Case sensitivity information for IAM modules
Karuna-Mendix 5733b11
USAGE_METRICS_EMAIL_FIELDS deprecation
Karuna-Mendix f24cc7d
feedback
Karuna-Mendix 2777b2e
Fix typo in licensing apps documentation
Karuna-Mendix d01fd59
Merge branch 'development' into kv-user-metering
Karuna-Mendix 49454fe
Add saml changes
Karuna-Mendix cf66b63
Rename Contract Management--> Subscription Management
Karuna-Mendix a9ae16f
Implement feedback for User Metering
Karuna-Mendix 0b86755
Implement feedback for FAQs.
Karuna-Mendix 8475398
Implement feedback for -Implementing User Metering
Karuna-Mendix b93aa34
Add small changes
Karuna-Mendix 42f0ec3
Fix small issues
Karuna-Mendix a33a1fd
Fix broken links
Karuna-Mendix caa9d6c
Update content/en/docs/deployment/general/subscription-management/use…
Karuna-Mendix ea9c8c1
Update content/en/docs/deployment/general/subscription-management/use…
Karuna-Mendix 3ed0829
Update content/en/docs/deployment/general/subscription-management/use…
Karuna-Mendix 27e6255
Implement suggestions from Nico
Karuna-Mendix a31530a
Merge branch 'kv-user-metering' of https://github.com/mendix/docs int…
Karuna-Mendix 10fe681
Update content/en/docs/deployment/general/subscription-management/use…
Karuna-Mendix fd88043
Update content/en/docs/deployment/general/subscription-management/use…
Karuna-Mendix 80e0de2
Small fix
Karuna-Mendix f0dc0ba
Merge branch 'kv-user-metering' of https://github.com/mendix/docs int…
Karuna-Mendix File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
86 changes: 86 additions & 0 deletions
86
content/en/docs/deployment/general/contract-management/user-metering/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| title: "User Metering" | ||
| url: /developerportal/deploy/user-metering/ | ||
| weight: 20 | ||
| description: "This document describes how user metering works." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| End-user metering is the process Mendix uses to determine the number and type of users accessing applications in accordance with license agreements. 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 --> | ||
|
|
||
| {{% alert color="info" %}} | ||
| End-user metering is currently available for applications deployed to Mendix Cloud and Mendix Cloud Dedicated environments. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
| {{% /alert %}} | ||
|
|
||
| Mendix licenses include user-based pricing plans. With user-based pricing, customers purchase licenses based on the number of users who need access to their Mendix applications. Customers can purchase user licenses in the following categories: | ||
|
|
||
| * Multi-App Internal User | ||
| * Single-App Internal User | ||
| * External User | ||
|
|
||
| For more information, refer to the [User Types and Definitions](/developerportal/deploy/licensing-apps-outside-mxcloud/#user-types-and-definitions) section of *Licensing apps*. | ||
|
|
||
| ### Key Features | ||
|
|
||
| * Automatic tracking – User consumption is automatically tracked from the moment your app is deployed to production and becomes functional, ensuring real-time tracking. | ||
| * Monthly reporting – Usage data is collected regularly, processed monthly, and is available in the Control Center. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
| * Application-level visibility – you get the detailed insights into named user counts for each application, helping you to identify optimization opportunities. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
| * License type classification – Users are classified by license type as External, Multi-App Internal, or Single-App Internal. This classification gives you accurate license tracking and helps optimize licensing costs. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
| * Historical data – User metering provides you with access to usage data for all months since user metering was enabled. | ||
|
|
||
| ## How User Metering Works | ||
|
|
||
| User metering in the Mendix cloud operates through a three-stage automated process, and it is enabled by default for apps deployed in Mendix Cloud environments. | ||
|
|
||
| ### Data Collection | ||
|
|
||
| Once users are classified as `Internal` or `External`, all applications on the Mendix Cloud and Mendix Cloud Dedicated automatically send user data back to the Mendix platform. The data is collected throughout the month from the production environment only. PII information (username and other user identifiers) is hashed at source before transmission to ensure data privacy. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Data Aggregation and Deduplication | ||
|
|
||
| At the end of each month, the Mendix Platform aggregates the collected data. Users are counted and rolled up to the app portfolio level. This process is detailed in the [User Aggregation and Deduplication](/developerportal/deploy/user-metering/#how-user-aggregation-and-deduplication-work) section below. | ||
|
|
||
| ### User Classification and Reporting | ||
|
|
||
| Users are thereafter automatically classified in the following sequence: | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| 1. External Users | ||
| 2. Single-App Users | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
| 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 dashboard. The reports are generally available on the 1st of each month and reflect the previous month's usage. | ||
|
|
||
| ## How User Aggregation and Deduplication Work | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| The user aggregation and deduplication process determines which user pack is consumed when a user accesses one or more of your applications. The process evaluates users in a sequence so that each user is counted according to the correct license pack without duplication. The classification follows the steps below: | ||
|
|
||
| ### Classifying External Users | ||
|
|
||
| The first step is to determine whether a user is an external user: | ||
|
|
||
| * If the customer has a valid External User Pack subscription, and | ||
| * The user is explicitly marked as `External` within the application. | ||
|
|
||
| Then the User is classified as an External user. | ||
|
|
||
| Once classified, the user is licensed under the External User Pack and excluded from further classification steps. For more information, see the [User classification](/developerportal/deploy/implementing-user-metering/#user-classification) section of *Implementing Metering*. | ||
|
|
||
| All remaining users are classified as `Internal` Users and further classified as described in the sections below. | ||
|
|
||
| ### Classifying Single-App Internal Users | ||
|
|
||
| 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 Pack, the user of the app will be classified as a single-app internal user. This user will be counted against the single-app internal user pack for that application. | ||
|
|
||
| For more details on how to assign single-app user packs to your apps, refer to the Assigning Single-App Internal User Packs section of the Control Center. <!-- Link from the Control Center doc --> | ||
|
|
||
| ### Classifying Multi-App Internal Users | ||
|
|
||
| After external users and single-app internal users have been identified, any remaining internal users are classified as multi-app internal users. | ||
| These users are licensed under the multi-app internal user pack, and no further action is required from your side. | ||
|
|
||
| ## Read More | ||
|
|
||
| * [Licensing Apps](developerportal/deploy/licensing-apps-outside-mxcloud/) | ||
108 changes: 108 additions & 0 deletions
108
content/en/docs/deployment/general/contract-management/user-metering/faq.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| --- | ||
| title: "Frequently Asked Questions on User Metering" | ||
| linktitle: FAQs on User Metering | ||
| url: /developerportal/deploy/faq/ | ||
| weight: 40 | ||
| description: "This document contains a list of frequently asked questions on user metering." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This document answers common questions about user metering, outlining user classification and users. | ||
|
|
||
| ## General Questions | ||
|
|
||
| ### 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. Data collection begins as soon as your application is deployed to a production environment. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Where Can I View My User Consumption Data? | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| Navigate to the **Control Center** > **Entitlements** > **End-Users** > **Usage Report**. | ||
| For more information, refer to the Usage Report Tab section of *End-Users*. <!-- Link from the Control Center doc --> | ||
|
|
||
| ### When Can I See My Monthly Usage Data? | ||
|
|
||
| User pack utilization is extracted regularly from the apps and available as a daily snapshot on the 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 license usage over the month. | ||
|
|
||
| ### What Happens if I Exceed My Entitlement? | ||
|
|
||
| If you exceed your licensed entitlements: | ||
|
|
||
| * No immediate service disruption: Your applications continue to run normally. | ||
| * Alert displayed: A warning icon appears in the end-of-month Usage Report on the Control Center. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
| * Compliance discussion: Your Customer Success Manager (CSM) will contact you to discuss: | ||
|
|
||
| * Purchasing additional user packs | ||
| * Optimizing user classification | ||
| * Adjusting your license agreement | ||
|
|
||
| Mendix recommends that you monitor your usage regularly and purchase additional capacity before reaching your limit. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Can I View Usage Data From Previous Months? | ||
|
|
||
| Apps across Mendix Cloud began collecting user metering data starting in November 2025. Based on when your app 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 | ||
|
|
||
| ### How Are Users Classified If I Do Not Configure User Classification? | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| If no action is taken, all users are classified as Multi-App Internal Users by default. | ||
| This means all users in your apps are aggregated together and classified as multi-app internal users. | ||
|
|
||
| ### I Have External Users in My Applications. How Do I Ensure They Are Counted Correctly? | ||
|
|
||
| Explicitly mark users as `External` in your application to ensure they are counted correctly under your External User pack. If you do not have an External User pack, these users will be classified as `Internal`, even if they are marked as `External` users. | ||
|
|
||
| For more information, refer to [User Classification](/developerportal/deploy/implementing-user-metering/#user-classification). | ||
|
|
||
| ### I Purchased a Single-App User Pack for My Application. How Do I Set It Up? | ||
|
|
||
| Assign the Single-App User Pack to your application in the Control Center. For more information, refer to Assigning Single-App Internal User Packs. <!-- Link from the Control Center doc --> | ||
|
|
||
| ### How Do I Assign Single-App User Packs to Multiple Applications With Unique User Bases? | ||
|
|
||
| You must purchase a separate Single-App User Pack for each application and assign them individually. Contact your CSM or account team to purchase additional packs. | ||
|
|
||
| ## User-Specific Questions | ||
|
|
||
| ### How Are Users Counted If They Log In Only Once Per Year? | ||
|
|
||
| Users are counted based on their active status, not login frequency. If they are marked as `Active` in your application, they are counted every month, regardless of whether they log in. | ||
|
|
||
| Note that if the user has active status during any moment in a month, they are counted as active user for that calendar month. | ||
|
|
||
| ### What Is the Best Practice for Deactivating Users Who Left the Organization? | ||
|
|
||
| Deactivate users as soon as they no longer need access. This ensures that they are not counted in future usage reports and helps maintain security. Deactivate leavers before month-end to optimize license consumption. | ||
|
|
||
| ### Should I Delete or Deactivate Users To Save on License Costs? | ||
|
|
||
| Technically, you can deactivate or remove users to optimize license costs. | ||
|
|
||
| To optimise license cost, you may choose to delete records in the `system.user` object, while maintaining data in custom user objects. | ||
|
|
||
| {{% alert color="info" %}} | ||
| Check your organization's data retention policies before purging any user data. Deactivation usually satisfies both license optimization and compliance requirements. | ||
| {{% /alert %}} | ||
|
|
||
| ### Are Anonymous Users Counted in User Metering? | ||
|
|
||
| Anonymous Users are users who access your application without logging in or authenticating. Anonymous Users are not counted in user metering. Only Named Users (users with unique login credentials) are counted. | ||
|
Karuna-Mendix marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Are API Users and Service Accounts Counted in User Metering? | ||
|
|
||
| API Users (also called Service Accounts or System Users) are non-human accounts used for: | ||
|
|
||
| * System-to-system integrations | ||
| * Automated processes | ||
| * Background jobs | ||
| * External system access via web services | ||
|
|
||
| API users with authentication count as Named Users and are included in user metering. | ||
|
|
||
| ## Read More | ||
|
|
||
| * [User Metering](/developerportal/deploy/user-metering/) | ||
| * [Implementing User Metering](/developerportal/deploy/implementing-user-metering/) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.