Skip to content

Commit 706f7df

Browse files
Merge branch 'development' into kv-SAML
2 parents 1203f97 + 687d320 commit 706f7df

282 files changed

Lines changed: 7441 additions & 2309 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,11 +399,11 @@ An object with the following key-value pairs:
399399

400400
| HTTP Status | Error code | Description |
401401
| --- | --- | --- |
402+
| 200 | ALREADY_STARTED | Cannot start app. App is already running. |
402403
| 400 | INVALID_APPID | Invalid AppId |
403404
| 404 | APP_NOT_FOUND | App not found |
404405
| 500 | NO_MDA_HAS_BEEN_DEPLOYED | Cannot start app. There is no MDA deployed. |
405406
| 500 | APP_ALREADY_HAS_A_STARTING_JOB | Cannot start app. There is already a starting job id found. |
406-
| 500 | ALREADY_STARTED | Cannot start app. App is already running. |
407407

408408
##### Example Output
409409

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/creating-the-domain-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ invoice.location = { x: 400, y: 100 };
6868

6969
*Studio Pro Guide*
7070

71-
* [Domain Model](/refguide/domain-model/)
71+
* [Data in the Domain Model](/refguide/domain-model/)
7272
* [Entities](/refguide/entities/)
7373

7474
Metamodel reference guide

content/en/docs/appstore/use-content/platform-supported-content/modules/SAML/_index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -456,9 +456,10 @@ You can set up custom user provisioning by selecting the **IdP Configuration** t
456456
* By default, the value is set to *Name*.
457457
* **Allow the module to create users** – This enables the module to create users based on user provisioning and attribute mapping configurations. When disabled, it will still update existing users. However, for new users, it will display an exception message stating that the login action was successful but no user has been configured.
458458
* By default, the value is set to *Yes*.
459-
* **User role** – the role which will be assigned to newly created users.
460-
* **User Type** – this allows you to configure end-users of your application as internal or external.
461-
* By default, the value is set to *Internal*.
459+
* **Default Userrole** – the role assigned to newly created users and remains unchanged even when the user's details are updated. You can select one default user role. To assign additional roles, use the Access Token Parsing Microflow. If the Access Token Processing Microflow is selected, OIDC verifies the updated default role configuration and applies any changes to the user's role. Note that, bulk updates for existing users are not automated when the default role configuration is changed.
460+
* **User Type** – this allows you to configure end-users of your application as internal or external. It is created upon the creation of the user and updated each time the user logs in.
461+
* By default, the value is set to *Internal*.
462+
462463
2. Under **Attribute Mapping**, for each piece of information you want to add to your custom user entity, select an **IdP Attribute** (claim) and specify the **Configured Entity Attribute** where you want to store the information.
463464
464465
Note the following:
@@ -475,6 +476,8 @@ You can set up custom user provisioning by selecting the **IdP Configuration** t
475476
476477
The microflow must return a **System.User** object to ensure proper user provisioning and updates. It will be executed after user creation or update of user. However, starting from version 2.0.0 of the UserCommons module, this is no longer mandatory. If you have added a new microflow, you will need to refresh the module containing your microflow as described in the [Mx Model Reflection](/appstore/modules/model-reflection/). This selection can be blank if you do not want to add custom logic.
477478
479+
4. Click **Save** to save the configuration.
480+
478481
### Custom Behavior
479482
480483
This section describes the microflows that you may want to customize if needed.
@@ -601,4 +604,4 @@ Your SAML IdP can consume the following endpoints at your app. Typically the SP-
601604
{{% alert color="info" %}}You must log into the Mendix Platform to see the lecture above.{{% /alert %}}
602605
* [Advanced configuration for SAML](/appstore/modules/saml/advanced-configuration/)
603606
* [Reference Guide for SAML IdP Configuration](/appstore/modules/saml/idp-attributes/)
604-
* [OIDC SSO](/appstore/modules/oidc/)
607+
* [OIDC SSO](/appstore/modules/oidc/)

content/en/docs/appstore/use-content/platform-supported-content/modules/SAML/advanced_configuration.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ description: "Describes the advanced configuration for the SAML module"
1111

1212
This document outlines the advanced configurations for the SAML module. For basic configuration and usage, refer to the [SAML](/appstore/modules/saml/) documentation.
1313

14-
### Multi-tenant Behavior
14+
### Multitenant Behavior
1515

1616
The resource folder contains a file called *SAMLConfig.properties*. In this file, you can optionally override advanced settings from the SAML module. Usage of this file is optional. When the file does not exist or you do not specify a setting, the module will use its default behavior.
1717
This file contains the documented properties, and example lines show the default values of these options.
18-
With these settings, you can configure the behavior of this module and improve the multi-tenant behavior of your application. For plain SAML authentication, it is best to leave this file unchanged.
18+
With these settings, you can configure the behavior of this module and improve the multitenant behavior of your application. For plain SAML authentication, it is best to leave this file unchanged.
1919

2020
If you are using a custom URL, see [How Do I Get my SAML Metadata or CommunityCommons.GetApplicationUrl to Use the Custom URL?](/developerportal/deploy/custom-domains/#use-custom-url) in the *Custom Domains* documentation.
2121

@@ -54,7 +54,13 @@ You need to customize this login page when end-users have different ways of logi
5454
1. Go to the **App** > **Show App Directory in Explorer** > **\implementation\DiscoveryHandler.java**
5555
2. Find the template **saml2-discovery-binding.vm** and add your customization.
5656

57+
### Custom Settings
58+
59+
The resources folder contains the *SAMLConfig.properties* file, and through this file, advanced settings can be configured for the module. This file contains the settings along with documentation on the settings. Through this file, it is possible to alter the URLs used as well as how the application behaves in a multitenant environment. The file also specifies all the default values and behavior in more detail.
60+
61+
If you are using a custom URL, see [How Do I Get my SAML Metadata or CommunityCommons.GetApplicationUrl to Use the Custom URL?](/developerportal/deploy/custom-domains/#use-custom-url) in the *Custom Domains* documentation.
62+
5763
## Read More
5864

5965
* [OIDC SSO](/appstore/modules/oidc/)
60-
* [Reference Guide for SAML IdP Configuration](/appstore/modules/saml/idp-attributes/)
66+
* [Reference Guide for SAML IdP Configuration](/appstore/modules/saml/idp-attributes/)

content/en/docs/appstore/use-content/platform-supported-content/modules/SAML/idp_attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,4 +206,4 @@ For information, see the [User Provisioning](/appstore/modules/saml/#user-provis
206206
## Read More
207207

208208
* [SAML](/appstore/modules/saml/)
209-
* [Advanced configuration for SAML](/appstore/modules/saml/advanced-configuration/)
209+
* [Advanced configuration for SAML](/appstore/modules/saml/advanced-configuration/)

content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ Amazon Bedrock is a fully managed service that makes foundation models (FMs) fro
2525

2626
The Amazon Bedrock connector requires Mendix Studio Pro version 9.24.2 or above.
2727

28-
To authenticate with Amazon Web Service (AWS), you must also install and configure the [AWS Authentication connector version 3.0.0 or higher](https://marketplace.mendix.com/link/component/120333). It is crucial for the Amazon Bedrock connector to function correctly. For more information about installing and configuring the AWS Authentication connector, see [AWS Authentication](/appstore/modules/aws/aws-authentication/).
28+
To authenticate with Amazon Web Service (AWS), you must install and configure the [AWS Authentication connector version 3.0.0 or higher](https://marketplace.mendix.com/link/component/120333). It is crucial for the Amazon Bedrock connector to function correctly. For more information about installing and configuring the AWS Authentication connector, see [AWS Authentication](/appstore/modules/aws/aws-authentication/).
2929

30-
You must also install the [GenAI Commons version 2.0.0 or higher](/appstore/modules/genai/commons/). To make integration of generative AI capabilities as easy as possible, the Amazon Bedrock connector depends on the generic domain model and operations provided by the GenAI Commons module.
30+
You must have the latest [GenAI Commons](/appstore/modules/genai/commons/) version, available in the [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) bundle. To make integration of generative AI capabilities as easy as possible, the Amazon Bedrock connector depends on the generic domain model and operations provided by the GenAI Commons module.
31+
32+
To ensure that your app can connect to Bedrock, you must also install and configure the [Encryption module](/appstore/modules/encryption/#configuration).
3133

3234
### Licensing and Cost
3335

@@ -105,7 +107,7 @@ You can follow a similar approach to implement any of the other operations in **
105107

106108
### Chatting with Large Language Models using the ChatCompletions Operation
107109

108-
A common use case of the Amazon Bedrock Connector is the development of chatbots and chat solutions. The **ChatCompletions (without history / with history)** operations offer an easy way to connect to most of the text-generation models available on Amazon Bedrock. The ChatCompletions operations are built on top of Bedrock's Converse API, allowing you to talk to different models without the need of a model-specific implementation. For more information on the ChatCompletion operations, see [GenAI Commons: Chat Completions](/appstore/modules/genai/commons/#text-files-operations).
110+
A common use case of the Amazon Bedrock Connector is the development of chatbots and chat solutions. The **ChatCompletions (without history / with history)** operations offer an easy way to connect to most of the text-generation models available on Amazon Bedrock. The ChatCompletions operations are built on top of Bedrock's Converse API, allowing you to talk to different models without the need of a model-specific implementation. For more information on the ChatCompletion operations, see [GenAI Commons: Chat Completions](/appstore/modules/genai/commons/#genai-generate).
109111

110112
For an overview of supported models and model-specific capabilities and limitations, see [Amazon Bedrock Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features) in the AWS documentation.
111113

@@ -115,7 +117,7 @@ To build a simple microflow that uses the ChatCompletions operation to send a si
115117
2. Create a new microflow and name it, for example, *AmazonBedrockChatCompletions*.
116118
3. Add a **Microflow call** from the **Toolbox** and choose microflow *AmazonBedrockConnector.BedrockDeployedModel_Get*
117119
4. Double-click it to configure its parameters.
118-
1. For the **ModelID** parameter, enter the model id of the LLM you want to send a message to. The model id of Claude 3.5 Sonnet is *anthropic.claude-3-5-sonnet-20240620-v1:0*.
120+
1. For the **ModelID** parameter, enter the model id of the LLM you want to send a message to. The model id of Claude 3.5 Sonnet is *anthropic.claude-3-5-sonnet-20240620-v1:0*.
119121
2. Click **OK**.
120122
5. In the **Toolbox**, search for the **Chat Completions (without history)** activity in the *GenAI (Generate)* and drag it onto your microflow.
121123
6. Double click on the activity to see its parameters.

content/en/docs/appstore/use-content/platform-supported-content/modules/aws/aws-authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ To help you work with signature version 4 headers, the following sections of thi
218218

219219
#### Domain Model {#domain-model}
220220

221-
The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Domain Model](/refguide/domain-model/).
221+
The domain model is a data model that describes the information in your application domain in an abstract way. For more information, see [Data in the Domain Model](/refguide/domain-model/).
222222

223223
You can view the domain model in the **App Explorer** in the **AWS Authentication** > **Domain model** section. The following entities are relevant for signature version 4 headers authentication:
224224

@@ -311,7 +311,7 @@ It takes the following parameters as input:
311311
* A `Credentials` object
312312
* A `ENUM_Region` enumeration value
313313

314-
The output is a boolean indicating whether the credentials are valid.
314+
The output is a Boolean indicating whether the credentials are valid.
315315

316316
## Read More
317317

content/en/docs/appstore/use-content/platform-supported-content/modules/database-connector-mx10.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ If you need to connect to other database types, check out the [Database Connecto
3131

3232
### Features {#features}
3333

34+
{{% alert color="info" %}}
35+
36+
From [Studio Pro 10.19](/releasenotes/studio-pro/10.19/), you can connect to any database by using the Java dependency specified by the user for the respective database. For more information, see the [Configure for Any Database](#byod) section below.
37+
38+
{{</alert>}}
39+
3440
This connector supports connections to the following database types:
3541

3642
* Microsoft SQL
@@ -39,8 +45,6 @@ This connector supports connections to the following database types:
3945
* Oracle
4046
* Snowflake – GA support from [Studio Pro 10.12](/releasenotes/studio-pro/10.12/) (Beta versions are available from [Studio Pro 10.10](/releasenotes/studio-pro/10.10/)). For more information, see [Configure the External Database Connector for Snowflake](/appstore/modules/snowflake/external-database-connector/)
4147

42-
If you are looking for another database type, follow the prompt to request support your database when you open the database connection wizard.
43-
4448
This connector supports the following statements:
4549

4650
* `SELECT`
@@ -210,3 +214,45 @@ To connect to PostgreSQL when the application is running in Mendix Cloud, follow
210214
1. To configure SSL-based authentication in Mendix Cloud, add a CA certificate and client certificate for server configuration and the selected SSL mode. For more details, see the [Running in the Cloud](/howto/integration/use-a-client-certificate/#running-in-the-cloud) section of *Use a Client Certificate*.
211215
2. After the client certificate has been added, double-click the client certificate and add the value `ClientCertificateIdentifier` to `Use Client Certificate for specific services`. This must match the value provided for the constant `ClientCertificateIdentifier`.
212216
3. Add the required values to the constants created for DBSource, DBUsername, DBPassword, and ClientCertificateIdentifier.
217+
218+
## Configure for Any Database {#byod}
219+
220+
### Prerequisites
221+
222+
* Ensure you have the appropriate Java Database Connectivity (JDBC) JAR file for the specific database.
223+
* Gather the external connection details, including login credentials and the JDBC connection string.
224+
225+
### Connect to the Database
226+
227+
1. Open the module settings and add the JDBC JAR File.
228+
229+
* Alternatively, place the downloaded JAR file in the userlib folder of your application.
230+
231+
2. Run the app with the latest version of the External Database Connector.
232+
233+
3. Create a New External Database Connection.
234+
4. Open the connection settings and under Database Type, select **Other**.
235+
5. Enter the login credentials and JDBC connection string.
236+
6. Click **Test Connection** to ensure the database connection is successful.
237+
7. Click **Save** to save the connection details.
238+
239+
### Configure Database Schema Information
240+
241+
The Browse Database Schema tab might not display a comprehensive overview of all available schemas for certain databases. You can customize this behavior using the Configure option. To do so, follow these steps:
242+
243+
1. Open the **App** menu and select **Deploy for Eclipse**.
244+
2. Extend the class MxQueryBasedSchemaInfoProvider.
245+
3. Override the following methods based on your requirements:
246+
* getTableMetaDataQuery
247+
* getViewMetaDataQuery
248+
* getProcedureMetaDataQuery
249+
* getFunctionMetaDataQuery
250+
4. Use the provided example, MxDb2SchemaInfoProvider for IBM Db2, for a better understanding of how to customize the schema information.
251+
252+
### Running Queries and Handling Query Responses
253+
254+
Execute queries as you would with supported databases, and retrieve responses in the associated entity. Refer to the documentation of your specific JDBC library for detailed syntax and execution options.
255+
256+
{{% alert color="info" %}}
257+
By default, autocommit is set to false for design time queries.
258+
{{% /alert %}}

content/en/docs/appstore/use-content/platform-supported-content/modules/encryption.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ Set the `EncryptionKey` constant in your application, which can be found in the
3232

3333
For versions below 2.2.0, ensure the key is 16 characters long to support the 128 bits key length.
3434

35-
When running the application locally, set the **Value** for the `EncryptionKey` constant in the **App Settings** > **Configurations** tab.
35+
When running the application locally, add a random 32-character string **Value** for the `EncryptionKey` constant in the **App Settings** > **Configurations** tab. For more information, see the [Constants](/refguide/configuration/#constants) section of *Configurations*.
36+
37+
{{< figure src="/attachments/appstore/platform-supported-content/modules/encryption/encryption-constant.png" class="no-border" >}}
3638

3739
#### EncryptionPrefix Constant
3840

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/Mx GenAI Connector.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 60
88

99
## Introduction
1010

11-
The Mendix Cloud GenAI connector (delivered as part of [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931)) lets you utilize Mendix Cloud GenAI resource packs directly within your Mendix application. It allows you to integrate generative AI by dragging and dropping common operations from its toolbox.
11+
The Mendix Cloud GenAI connector (delivered as part of [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931)) lets you utilize Mendix Cloud GenAI resource packs directly within your Mendix application. It allows you to integrate generative AI by dragging and dropping common operations from its toolbox. Feel free to contact [genai-resource-packs@mendix.com](mailto:genai-resource-packs@mendix.com) to learn more.
1212

1313
### Typical Use Cases
1414

@@ -74,7 +74,7 @@ To use this connector, you need configuration keys to authenticate to the Mendix
7474

7575
## Installation
7676

77-
Add the [Dependencies](#dependencies) listed above from the Marketplace. On the Marketplace, the Mendix Cloud GenAI connector is bundled inside of [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) which also contains GenAI commons operations and logic. To import this module into your app, follow the instructions in the [Use Marketplace Content](/appstore/use-content/).
77+
Add the [dependencies](#dependencies) listed above from the Marketplace. On the Marketplace, the Mendix Cloud GenAI connector is bundled inside of the [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) which also contains GenAI commons operations and logic. To import this module into your app, follow the instructions in the [Use Marketplace Content](/appstore/use-content/).
7878

7979
## Configuration {#configuration}
8080

0 commit comments

Comments
 (0)