Skip to content

[DUX-478] Add View Entity Document Changes to Existing Documentation #9355

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
eaac0b0
Revise Integration headers
quinntracy Apr 14, 2025
7d844aa
Merge pull request #9370 from mendix/qt-integration
quinntracy Apr 14, 2025
adeacf1
view entity document changes
gmzakpinar Apr 10, 2025
4e0713c
Rename refguide and howto to refguide10 and howto10
MarkvanMents Mar 28, 2025
15dfb6a
Recovered old refguide and howto (with history)
MarkvanMents Mar 28, 2025
675edb4
Update README.md
MariaShaposhnikova Feb 10, 2025
c15d608
Update README.md
MariaShaposhnikova Feb 10, 2025
23240a3
Update README.md
MariaShaposhnikova Feb 10, 2025
7cd28c4
Review readme
MariaShaposhnikova Feb 10, 2025
caf432c
Update README.md
MariaShaposhnikova Mar 28, 2025
543fc87
Change from port fix to cherry pick
blis-mendix Mar 26, 2025
ed54a22
Update "Studio Pro 10 Guide" to "Studio Pro 11 Guide"
Yiyun333 Feb 28, 2025
52d71fb
Update "Studio Pro 10 How-tos" to "Studio Pro 11 How-tos"
Yiyun333 Feb 28, 2025
4e11e27
Update version number for the "cascade" metadata
Yiyun333 Feb 28, 2025
9df18d0
Remove or update instances of "Studio Pro 10" in refguide and howto
Yiyun333 Mar 3, 2025
d9bf287
Commit one missed instance of "Studio Pro 10" in refguide
Yiyun333 Mar 3, 2025
5beda29
Remove or update instances of "Studio Pro version 10"
Yiyun333 Mar 3, 2025
69d88fc
Commit more "Studio Pro version 10" instances in refguide and howto
Yiyun333 Mar 3, 2025
9b6d0b3
Remove or update "Mendix 10" instances in refguide and howto
Yiyun333 Mar 4, 2025
60b71c7
Remove or update "Mendix version 10" instances in refguide and howto
Yiyun333 Mar 4, 2025
93c0f55
Remove or update instances of "version 10" in refguide and howto
Yiyun333 Mar 6, 2025
f29c5e6
Remove or update instances of "Mendix versions" in refguide and howto
Yiyun333 Mar 6, 2025
d8b05ce
Remove or update instances of "Studio Pro version" in refguide and howto
Yiyun333 Mar 6, 2025
4416385
Revert "Remove or update instances of "Studio Pro version 10""
Yiyun333 Mar 6, 2025
d208bbb
Move most changes back from the last revert commit
Yiyun333 Mar 6, 2025
41ae47e
App settings: Java version
Yiyun333 Mar 10, 2025
fe6f1d7
Update Installing Mendix Studio Pro
Yiyun333 Mar 10, 2025
c3e7e4a
Update System Requirements
Yiyun333 Mar 10, 2025
3c936a2
Fix cross-reference in Installing Mendix Studio Pro
Yiyun333 Mar 10, 2025
c2a1e74
Small edit to enable comment
Yiyun333 Mar 10, 2025
4262cfe
Update info alert in Configuring Parallels for SP 11
Yiyun333 Mar 11, 2025
e1f90a5
More updates in Refguide and add Todos
Yiyun333 Mar 11, 2025
ee717c4
Remove info on Bitcode Deprecation
Yiyun333 Mar 11, 2025
0bd9821
Add Todo items outside of Refguide and How-tos
Yiyun333 Mar 11, 2025
9c9d106
Improve version warning in the OIDC SSO doc
Yiyun333 Mar 12, 2025
d3db069
Small edits
Yiyun333 Mar 13, 2025
49c816f
Update oidc.md
Karuna-Mendix Mar 18, 2025
953e9e4
Update snowflake-edc.md
katarzyna-koltun-mx Mar 19, 2025
e6fce92
Remove todo item in Update forgot-password.md
Yiyun333 Mar 19, 2025
ec18d51
Mx10 references and To Dos
MarkvanMents Mar 19, 2025
b61da95
Remove JDK warning in Update system-requirements.md
Yiyun333 Mar 20, 2025
8f82767
Added ways to find the converting options
Yiyun333 Mar 21, 2025
c8b64de
Update and add a few todo items
Yiyun333 Mar 26, 2025
42b02e5
Rename refguide and howto attachments to refguide10 and howto10
MarkvanMents Apr 7, 2025
c7e6e11
Retrieve refguide and howto attachments to make copies
MarkvanMents Apr 7, 2025
8587fca
Change all links in howto10 and refguide10 to point to Mx10 attachments
MarkvanMents Apr 7, 2025
c9143dc
Update default value of OptimizeSecurityColumns
basdebakker Mar 28, 2025
ec4a378
Copy changes from #9351
MarkvanMents Apr 14, 2025
1624c54
Style
quinntracy Apr 14, 2025
f5ee1b3
Style
quinntracy Apr 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ There are different versions of the SAML module, depending on which version of M

Mendix 10 does not support the 2.0 version of the Atlas UI, so you should never use the even-numbered (Atlas 2.0-compatible) SAML patch releases with your Mendix 10 app.

{{% todo %}} Do we need to add anything here for Mendix 11? {{% /todo %}}

3. To download the required release, in the **Releases** tab, find the release that is compatible with your app per the guidelines in the **Documentation** tab, and then click the **Download** button by the number of the release.
4. Follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to import the SAML module into your app.

Expand All @@ -175,6 +177,7 @@ By default, the SAML module will be installed as the **SAML20** module in your a
Only use this setting if you are using SAML on a hybrid mobile app. Note that this functionality also requires mobile authentication tokens to be enabled in your IdP Configuration as well as changes to the hybrid app package as described in [How To Implement SSO on a Hybrid App with Mendix and SAML](/howto8/mobile/implement-sso-on-a-hybrid-app-with-mendix-and-saml/).

{{% alert color="warning" %}}Hybrid mobile apps are not available in Mendix 10.{{% /alert %}}
{{% todo %}} How about in Mendix 11? {{% /todo %}}

5. Sign in to the application and configure the SAML module as described in the [Configuration SAML Module](#config) section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Describes the steps required to use the Mendix External Database c

## Introduction

The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro at design time. For Mendix apps that use Databricks as their database, the External Database connector is the recommended integration option for Mendix 10.20.0 and up.
The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro at design time. For Mendix apps that use Databricks as their database, the External Database connector is the recommended integration option for Mendix 10.20.0 and above.

This how-to describes the steps required to enable your app to use the External Database connector with Databricks.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ OIDC is an extension of OAuth2 that propagates the end-user's identity to your a
{{% alert color="warning" %}}
This OIDC SSO module works with Mendix 9.0 and above. If you are using a previous version of Mendix, you can use the community-supported module [OpenIDConnect Single Sign-on (OIDC, OAuth2, SSO)](https://marketplace.mendix.com/link/component/117529).

If you are using Mendix 9.20 and above, ensure you are using version 2.0.0 or above of the OIDC SSO module. For Mendix 10.0 and above, you need to use version 2.2.0 or above of the OIDC SSO module.
If you are using Mendix versions from 9.20 to 9.24, ensure you are using version 2.0.0 or above of the OIDC SSO module. For all versions of Mendix 10.0, you need to use version 2.2.0 or above of the OIDC SSO module.
{{% /alert %}}

{{% todo %}} The team will update the above warning for Mendix 11 when more information is available. {{% /todo %}}

{{% alert color="warning" %}}
If you are migrating to the OIDC module version 3.0.0 and above, include the [UserCommons](https://marketplace.mendix.com/link/component/223053) module as a dependency and configure the `OIDC.Startup` microflow as part of after-startup Microflow. In the module version 3.1.0 and above, `OIDC.Startup` has been renamed to `OIDC.ASU_OIDC_Startup`. For more details, see the [Upgrading the OIDC SSO Module](#upgrade) section below.
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 10

## Introduction

The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro (design time). For Mendix apps that use Snowflake as their database, the External Database connector is the recommended integration option for Mendix 10.
The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro (design time). For Mendix apps that work with Snowflake data, the External Database connector is the recommended integration option for Mendix 10 and above.

This how-to describes the steps required to enable your app to use the External Database connector with Snowflake, and to model several common use cases.

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/catalog/manage/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Security for a Mendix app can be defined at the app-level, module-level, and ent

This security level determines which end-users of the apps will have access to the data represented by the exposed dataset. For further information, see the [Security](/refguide/published-odata-services/#security) section in *Published OData Services*.

Access to data is determined by the identification protocols of the organization and applied to all access to the data via Mendix apps. For an example of custom HTTP header validation, see the [custom HTTP header validation](/refguide/security-shared-datasets/#http-header-validation) section of *Security and Shared Datasets* in the Studio Pro 10 guide.
Access to data is determined by the identification protocols of the organization and applied to all access to the data via Mendix apps. For an example of custom HTTP header validation, see the [custom HTTP header validation](/refguide/security-shared-datasets/#http-header-validation) section of *Security and Shared Datasets*.

## Access Level of Registered Services {#access-level}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Before starting the installation and implementation process, make sure that you
{{< figure src="/attachments/deployment/mx-azure/coadmin-permission.png" class="no-border" >}}

* Familiarize yourself with the [Private Cloud](https://docs.mendix.com/developerportal/deploy/private-cloud/) concepts.
* Ensure that your Mendix Studio Pro is in version 10.10 or newer.
* Ensure that your Mendix Studio Pro is in version 10.10 or above.
* As an optional best practice, add multiple cluster manager to your clusters.

## Creating an Azure Cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@ If the SQL Server instance is an Azure SQL database, you can use [managed identi

SQL server databases are automated, on-demand databases. The **SQL Server** plan offers a good balance between automation, ease of use, and security when using Microsoft SQL Server or Azure SQL. If you would like to have more control over database configuration, consider using the [JDBC plan](#database-jdbc) instead.

If your app is using Mendix 10.10 (or a later version) consider using the [Azure managed identity authentication](#database-sqlserver-azwi) instead, for additional security.
If your app is using Mendix 10.10 (or above), consider using the [Azure managed identity authentication](#database-sqlserver-azwi) instead, for additional security.

##### Prerequisites

Expand Down Expand Up @@ -629,7 +629,7 @@ This section provides technical details on how managed identity authentication w

##### Limitations

* To use this feature, your app needs to be upgraded to Mendix 10.10 (or later), and your namespace needs to use Mendix Operator version 2.17.0 (or later).
* To use this feature, your app needs to be upgraded to Mendix 10.10 (or above), and your namespace needs to use Mendix Operator version 2.17.0 (or above).

##### Environment Isolation

Expand Down Expand Up @@ -1628,7 +1628,7 @@ In the Amazon S3 plan configuration, enter the following details:

### Azure Blob Storage {#blob-azure}

If you would like to have Mendix Operator with automation, and have full isolation between environments, use the [Azure managed identity authentication](#blob-azure-azwi) option. This option works with apps using Mendix 10.10 (or a later version).
If you would like to have Mendix Operator with automation, and have full isolation between environments, use the [Azure managed identity authentication](#blob-azure-azwi) option. This option works with apps using Mendix 10.10 (or above).

If you would like to simply share a container between environments, or to manually create a container and account per environment, use the [static credentials](#blob-azure-static) option.

Expand All @@ -1651,7 +1651,7 @@ This section provides technical details on how managed identity authentication w

##### Limitations

* To use this feature, your app needs to be upgraded to Mendix 10.10 (or later), and your namespace needs to use Mendix Operator version 2.17.0 (or later).
* To use this feature, your app needs to be upgraded to Mendix 10.10 (or above), and your namespace needs to use Mendix Operator version 2.17.0 (or above).

##### Environment Isolation

Expand Down Expand Up @@ -1725,7 +1725,7 @@ Azure workload identities allow a Kubernetes Service Account to authenticate its

This basic, on-demand option allows you to attach an existing Azure Blob Storage container and credentials (account name and secret key) to one or more environments. All apps (environments) will use the same Azure Blob Storage container and credentials.

If your app is using Mendix 10.10 (or a later version) consider using the [Azure managed identity authentication](#blob-azure-azwi) instead, for additional security.
If your app is using Mendix 10.10 (or above) consider using the [Azure managed identity authentication](#blob-azure-azwi) instead, for additional security.

##### Prerequisites

Expand Down Expand Up @@ -2148,7 +2148,7 @@ Azure recommends using [managed identity authentication](https://learn.microsoft
This guide explains how to set up and use a database and blob file storage plan using Azure best practices.

{{% alert color="warning" %}}
This feature requires an Mendix app based on Mendix 10.10 (or later) and Mendix Operator version 2.17 (or later).
This feature requires an Mendix app based on Mendix 10.10 (or above) and Mendix Operator version 2.17 (or above).
{{% /alert %}}

Before you begin, you need to create an AKS cluster and install Mendix for Private Cloud in that cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Amazon and Azure SQL servers require additional firewall configuration to allow

Some managed SQL Server databases might have restrictions or require additional configuration.

As an alternative to static password authentication, Mendix Operator can use its Kubernetes Service Account to authenticate with Azure SQL databases. The Kubernetes Service Account is linked with a Managed Identity, and the Managed Identity replaces a static username/password. This feature requires Mendix Operator version 2.17 (or later) and Mendix 10.10 (or later).
As an alternative to static password authentication, Mendix Operator can use its Kubernetes Service Account to authenticate with Azure SQL databases. The Kubernetes Service Account is linked with a Managed Identity, and the Managed Identity replaces a static username/password. This feature requires Mendix Operator version 2.17 (or above) and Mendix 10.10 (or above).

{{% alert color="info" %}}
To use a SQL Server database, the Mendix Operator requires Superuser account with permissions to create new users and databases.
Expand Down Expand Up @@ -333,7 +333,7 @@ configuration details.
Mendix Operator can perform the following tasks:

* Provide a static access key and other credentials to environments (a static config).
* Handle the lifecycle of a storage container by creating a dedicated container and Azure Managed Identity for every new environment, and ensuring that an environment can only access its dedicated container (through the environment's Managed Identity); this feature works with Mendix 10.10 (or later versions).
* Handle the lifecycle of a storage container by creating a dedicated container and Azure Managed Identity for every new environment, and ensuring that an environment can only access its dedicated container (through the environment's Managed Identity); this feature works with Mendix 10.10 and above.

A complete list of supported Azure Blob Storage modes and their required role assignments (permissions) for each one is available in [storage plan](/developerportal/deploy/standard-operator/#storage-plan) configuration details.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ If your main line is Studio Pro version 9.24.28 or above and your team role is S

Mendix recommends to combine a migration to Git with an upgrade to Mendix 10, as the advantages of Git in Mendix 9 are limited. For more details on this recommendation, see the [Recommendation on Avoiding Git Issues](/refguide/troubleshoot-repository-size/#recommendation) section in *Troubleshooting Repository Size*.

{{% todo %}} Do we need to mention anything about Mendix 11 here? {{% /todo %}}

## Apps Eligible for Migration

{{% alert type="info" %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/developerportal/global-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ To use Maia Chat, you need to be signed in to Mendix and have an internet connec
Maia Chat does not use any project, customer, or company information. It only uses the data that you have entered in the Chat. Please do not enter any personal or sensitive data!
{{% /alert %}}

Maia Chat is a built-in chat interface in the Mendix Platform powered by Generative AI. Developers can ask questions about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns.
Maia Chat is a built-in chat interface in the Mendix Platform powered by Generative AI. Developers can ask questions about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns.

Maia Chat is also available in Studio Pro 10.12.0 and above. See [Maia Chat](/refguide/maia-chat/) for more information.

Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/howto/_index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
title: "Studio Pro 10 How-tos"
title: "Studio Pro 11 How-tos"
url: /howto/
description: "Step-by-step guides on various Mendix topics that teach you how to build and customize apps."
weight: 15
no_list: false
description_list: true
cascade:
- content_type: "Studio Pro 10"
- mendix_version: 10
- content_type: "Studio Pro 11"
- mendix_version: 11
- sitemap:
priority: 0.7
#This document is mapped to the landing page, update the link there if renaming or moving the doc file.
---

## Introduction

Browse the *Studio Pro 10 How-tos* to find step-by-step guides that teach you how to build and customize apps with Mendix.
Browse the *Studio Pro 11 How-tos* to find step-by-step guides that teach you how to build and customize apps with Mendix.

## How-to Categories

The *Studio Pro 10 How-tos* are divided into the following categories:
The *Studio Pro 11 How-tos* are divided into the following categories:
2 changes: 1 addition & 1 deletion content/en/docs/howto/extensibility/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ description_list: true

One of the strengths of Mendix is that it is easy to connect your Mendix application to other systems. The [Mendix Marketplace](https://marketplace.mendix.com/) is stocked with all kinds of connectors and adapters. You are also able to extend your app by using and creating widgets.

In a related matter, one of Studio Pro's strengths is is customizability. For more information on adding your first custom extension to Studio Pro, see [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api/getting-started/) or [Get Started with the C# Extensibility API](/apidocs-mxsdk/apidocs/csharp-extensibility-api/get-started/) in our API documentation.
In a related matter, one of Studio Pro's strengths is is customizability. For more information on adding your first custom extension to Studio Pro, see [Create a Menu Extension](/apidocs-mxsdk/apidocs/extensibility-api/create-menu-extension/) in our API documentation.

## Documents in This Category
Original file line number Diff line number Diff line change
Expand Up @@ -577,11 +577,9 @@ Mendix is able to add the `?638184496048312490` query parameter because of the u

{{% alert color="info" %}}
When the [Mendix React Client](/refguide/mendix-client/react/) is enabled, the line in */deployment/web/index.html* is as follows:

```
<script src="dist/index.js?{{cachebust}}" type="module"></script>
```

{{% /alert %}}

To ensure cache busting keeps working, whenever you need to customize *index.html* or *login.html*, make sure these files are copied according to the recommendations in [Customizing index.html](#custom-web). Whenever cache busting breaks, it is likely that the query parameters have become hard coded (for example `?638184496048312490`) instead of dynamic (for example `?{{cachebust}}`) due to copying */deployment/web/index.html* instead of the correct filename */deployment/web/index-example.html*.
Expand Down
22 changes: 22 additions & 0 deletions content/en/docs/howto10/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Studio Pro 10 How-tos"
url: /howto/
description: "Step-by-step guides on various Mendix topics that teach you how to build and customize apps."
weight: 15
no_list: false
description_list: true
cascade:
- content_type: "Studio Pro 10"
- mendix_version: 10
- sitemap:
priority: 0.7
#This document is mapped to the landing page, update the link there if renaming or moving the doc file.
---

## Introduction

Browse the *Studio Pro 10 How-tos* to find step-by-step guides that teach you how to build and customize apps with Mendix.

## How-to Categories

The *Studio Pro 10 How-tos* are divided into the following categories:
14 changes: 14 additions & 0 deletions content/en/docs/howto10/data-models/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Data Models"
url: /howto/data-models/
weight: 50
description: "Presents a list of how-tos on creating data layers and setting up data validation."
no_list: false
description_list: true
---

## Introduction

This category includes how-tos on creating data layers and setting up data validation.

## Documents in This Category
Loading