Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/howto/security/best-practices-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ You may need to store sensitive information, such as credentials, in your app. T
* Credentials are recorded in [constants](/refguide/constants/) which can be set when your app is deployed—in the [Mendix Portal](/developerportal/deploy/environments-details/#constants), for example, if you are deploying to Mendix Cloud.
* The constants should be blank by default (not populated with the credentials) in the app.

* Values for the constants can be provided during testing by creating a [configuration](/refguide/configuration/#constants).
* Values for the constants can be provided during testing by creating a [configuration](/refguide/configurations-tab/#constants).

* Only authorized people should be given access to set the constants when the app is deployed. This is done through the [app roles](/developerportal/general/app-roles/) and (for Mendix Cloud) the [node permissions](/developerportal/deploy/node-permissions/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Studio Pro enforces consistency during both development and implementation, and
{{% alert color="info" %}}

* This is an exception to the cyclic dependency rule, in that a solution module may have an open module counterpart while they work together as one module.
* Be sure to configure the [Solution](/refguide/app-settings/#solution) tab of **App Settings** to allow for distribution as an adaptable solution and for creating solution modules.
* Be sure to configure the [Solution](/refguide/solution-tab/) tab of **App Settings** to allow for distribution as an adaptable solution and for creating solution modules.

{{% /alert %}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ There are different versions of the SAML module, depending on which version of M

By default, the SAML module will be installed as the **SAML20** module in your app’s Marketplace modules. You can find all microflows and other configuration elements in this module.

1. Configure the **Startup** microflow in the SAML module (**SAML20.Startup**) to run as (part of) the [After startup](/refguide/app-settings/#after-startup) microflow. This microflow will initialize the custom request handler `/SSO/` (please note the importance of using the final `/` for all instances of `/SSO/`), validate all IdP configurations, and prepare the configuration entities required during the configuration.
1. Configure the **Startup** microflow in the SAML module (**SAML20.Startup**) to run as (part of) the [After startup](/refguide/runtime-tab/#after-startup) microflow. This microflow will initialize the custom request handler `/SSO/` (please note the importance of using the final `/` for all instances of `/SSO/`), validate all IdP configurations, and prepare the configuration entities required during the configuration.
2. If you have set up path-based access restrictions in your cloud (for example [Path-Based Access Restrictions](/developerportal/deploy/environments-details/#path-based-restrictions) in Mendix Cloud), ensure that access to `/SSO/` is allowed.
3. Add the **OpenConfiguration** microflow to the navigation, and then allow the administrator to access this microflow.
4. Review and configure all the constants:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ The [Administration](https://marketplace.mendix.com/link/component/23513) module

1. Make sure that your app contains the Mendix SSO module. If it does not, import the [Mendix SSO](https://marketplace.mendix.com/link/component/111349) module from the Marketplace.

2. Configure the **MendixSSO_AfterStartup** microflow from the Administration module as the [after startup](/refguide/app-settings/#after-startup) microflow. If there is already an after startup microflow, do not replace it, but add the **MendixSSO_AfterStartup** microflow as a sub-microflow in the existing microflow.
2. Configure the **MendixSSO_AfterStartup** microflow from the Administration module as the [after startup](/refguide/runtime-tab/#after-startup) microflow. If there is already an after startup microflow, do not replace it, but add the **MendixSSO_AfterStartup** microflow as a sub-microflow in the existing microflow.

{{% alert color="info" %}}If you previously used the Mendix SSO in your application, use the **MendixSSO_MigrateUsersToAccount** microflow to migrate users from the `MendixSSOUser` to the `Administration.Account` specialization. Before executing the migration, carefully read the instructions in the microflow.{{% /alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ To install the component, follow the instructions in the [Importing Content from

## Configuration

1. Configure the **Startup** microflow in the Advanced Audit Trail module (`AdvancedAuditTrail.ConfigureAuditTrail`) to run as (part of) the [After Startup](/refguide/app-settings/#after-startup) microflow.
1. Configure the **Startup** microflow in the Advanced Audit Trail module (`AdvancedAuditTrail.ConfigureAuditTrail`) to run as (part of) the [After Startup](/refguide/runtime-tab/#after-startup) microflow.
2. Set up your application roles to include the right module roles. For more information, see the [Configuring Module Roles](#module-roles) section below.
3. Configure the right constant values for the right snapshots. For more information, see the [Configuring Constants](#constants) section below.
4. Implement the **Before Commit** (**BCo**) and **Before Delete** (**Bde**) events. Use the events on the domain model settings (**BCo** / **BDe**). For example, the configuration in the image below is for the **Before Commit** handler, whereas for the **Before Delete** handler, the value of **Is delete** should be set to *true*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Set the `EncryptionKey` constant in your application, which can be found in the

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

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*.
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/configurations-tab/#constants) section of *Configurations*.

{{< figure src="/attachments/appstore/platform-supported-content/modules/encryption/encryption-constant.png" class="no-border" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ For example: `*Database*_DBsource.`
Values for these constants are stored in the active configuration of the user. The password is stored as a private value.

{{% alert color="info" %}}
Constants are an environment variable whose values can differ per environment, When you deploy an app on Mendix Cloud, values for constants are not added. For more information, see [Constants](/refguide/configuration/#constants).
Constants are an environment variable whose values can differ per environment, When you deploy an app on Mendix Cloud, values for constants are not added. For more information, see [Constants](/refguide/configurations-tab/#constants).

For free apps, make sure to add the default values to the constant in Studio Pro. For more information, see the [Deploying a Free App](/developerportal/deploy/mendix-cloud-deploy/deploying-an-app/#deploy-free-app) section of *Deploying an App to Mendix Cloud*. {{% /alert %}}

Expand Down Expand Up @@ -202,7 +202,7 @@ The certificates below are required for server configuration and the SSL mode se

You can configure custom settings that are only used when you run your app locally. To do this, follow these steps:

1. Add the authority certificate (CA) to the **Certificates** tab in the App Settings. See the [Certificates Tab](/refguide/app-settings/#certificates-tab) section of *App Settings* for information about adding certificates.
1. Add the authority certificate (CA) to the **Certificates** tab in the App Settings. See the [Certificates Tab](/refguide/certificates-tab/) section of *App Settings* for information about adding certificates.

{{< figure src="/attachments/appstore/platform-supported-content/modules/external-database-connector/certificates-tab.png" class="no-border" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ For more information about configuring your app for OIDC with Amazon Cognito, se

In version 2.3.0 and above, you can configure the OIDC SSO module using app [constants](/refguide/constants/) rather than using the app administration pages. As the developer of an app using OIDC SSO, you can set default values. These values can be overridden using the app constants.

To enable the use of app constants to configure the OIDC SSO module, configure your app to run the Startup microflow in the OIDC module (OIDC.ASU_OIDC_Startup) as (part of) the [after startup](/refguide/app-settings/#after-startup) microflow.
To enable the use of app constants to configure the OIDC SSO module, configure your app to run the Startup microflow in the OIDC module (OIDC.ASU_OIDC_Startup) as (part of) the [after startup](/refguide/runtime-tab/#after-startup) microflow.

Use the following security best-practices when setting up your constants:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The following Java dependencies are shipped with the module. For Mendix versions
## Configuration {#configuration}

1. Add the module role **TestRunner** from the module to all app user roles that should be able to run and view unit tests.
1. In the runtime settings of your app, configure the **Startup** microflow for the [after startup property](/refguide/app-settings/#after-startup). If there is already an after startup microflow set, add the **Startup** microflow as an action in the existing microflow.
1. In the runtime settings of your app, configure the **Startup** microflow for the [after startup property](/refguide/runtime-tab/#after-startup). If there is already an after startup microflow set, add the **Startup** microflow as an action in the existing microflow.
1. Add the **UnitTestOverview** microflow to your navigation structure, or include the **UnitTestOverview** snippet on a custom page.

{{% alert color="info" %}}When using the snippet in your own page, the snippet should be placed on the top level of the page (not in a layout grid or container), to enable independent scrolling for the left and right panels.S{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Workflow Audit Trail is a detailed, chronological record that tracks all changes

### Configuration {#configuration}

Workflow Audit Trail uses [workflow events](/refguide/workflow-events/#configuration) to store data of a single or all workflows in your app. You can configure the audit trail to keep track of a specific set of events which you can configure in the **Event handlers** setting in [App Settings](/refguide/app-settings/#event-handlers) or through [workflow properties](/refguide/workflow-properties/#event-handlers). For more information about event handlers in workflows, see the [Event Handlers](/refguide/workflow-properties/#event-handlers) section in *Workflow Properties*.
Workflow Audit Trail uses [workflow events](/refguide/workflow-events/#configuration) to store data of a single or all workflows in your app. You can configure the audit trail to keep track of a specific set of events which you can configure in the **Event handlers** setting in [App Settings](/refguide/workflow-tab/#event-handlers) or through [workflow properties](/refguide/workflow-properties/#event-handlers). For more information about event handlers in workflows, see the [Event Handlers](/refguide/workflow-properties/#event-handlers) section in *Workflow Properties*.

{{% alert color="info" %}}The event handlers added in workflow properties override the app-wide event handlers in **App Settings**. When adding event handlers at workflow level while the event handlers defined at app level are still applicable, then they should be added at workflow level as well. {{% /alert %}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Every end-user that is known in **Admin** module also needs to be known in the O
1. **Edit** the **Administrator** module role.
1. Give **Read** **Access rights** to the **AccountDetail_Account** association.
1. Open the **Runtime** tab of the app's **Settings**.
1. Add the **OpenIDConnectProvider.ASU_Start_All** microflow as an [After Startup](/refguide/app-settings/#after-startup) microflow.
1. Add the **OpenIDConnectProvider.ASU_Start_All** microflow as an [After Startup](/refguide/runtime-tab/#after-startup) microflow.
1. Finally, ensure that your app has the following Administration navigation items:

| Caption | Action | User Roles |
Expand Down Expand Up @@ -459,7 +459,7 @@ You need to configure the OIDC SSO module in your app which is using the IAM bro
1. Create an app containing the OIDC SSO module as described in [OIDC SSO](/appstore/modules/oidc/).

{{% alert color="info" %}}If you are testing locally, you will need to run your OIDC client in a separate copy of Studio Pro and on a different port from the IAM broker.
In the [Server](/refguide/configuration/#server) tab of the active configuration of your client app, change the **Runtime port** and **Admin port** to be different from those of your IAM broker app. For example, if your IAM broker is running using `8080` and `8090`, you could use `8081` and `8091` respectively.
In the [Server](/refguide/configurations-tab/#server) tab of the active configuration of your client app, change the **Runtime port** and **Admin port** to be different from those of your IAM broker app. For example, if your IAM broker is running using `8080` and `8090`, you could use `8081` and `8091` respectively.
{{% /alert %}}

1. When you get to [IdP Configuration](/appstore/modules/oidc/#idpconfiguration), you already have the values from the previous section.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To set up the necessary Pusher app, follow these steps:
* `cluster` – `Pusher_Cluster`

{{% alert color="info" %}}
Make sure you have different apps (keys) created for each app and environment (development, acceptance, and production). When the credentials are shared, messages could go across environments and have unwanted side effects. The configuration can also be set per developer via **App Settings** > **Edit** configuration > [Constants](/refguide/configuration/#constants).
Make sure you have different apps (keys) created for each app and environment (development, acceptance, and production). When the credentials are shared, messages could go across environments and have unwanted side effects. The configuration can also be set per developer via **App Settings** > **Edit** configuration > [Constants](/refguide/configurations-tab/#constants).
{{% /alert %}}

## Configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you app does not have an after-startup microflow set, follow these steps:

1. Create a **Startup** microflow and add the **Viewer3D/USE_ME/VisServerAction** Java action to it.
2. Set the return type of the microflow to **Boolean** with a **Value** of **true**.
3. Set this microflow as the **After startup** step via **App Settings** > **Runtime** > [After startup](/refguide/app-settings/#after-startup).
3. Set this microflow as the **After startup** step via **App Settings** > **Runtime** > [After startup](/refguide/runtime-tab/).

If your app already has a microflow set to execute after startup, you need to extend it with the **Viewer3D/USE_ME/VisServerAction** Java action and configure it as described in the above steps.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ If you want to use the [Siemens Insights Hub Widgets](https://marketplace.mendix
To enable this, you will have to do two things:

1. Ensure that the constant **EnableMindSphereApiReverseProxy** is set to *true* to ensure this can happen.
2. Add the microflow **RegisterApiReverseProxy** to the [After Startup](/refguide/app-settings/#after-startup) microflow (or microflows) which are run when the app is started.
2. Add the microflow **RegisterApiReverseProxy** to the [After Startup](/refguide/runtime-tab/#after-startup) microflow (or microflows) which are run when the app is started.

{{< figure src="/attachments/partners/siemens/mindsphere/mindsphere-api-only/AfterStartup.png" alt="AfterStartup" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "Describes the commands related to private values for the mx comman

The commands in this group are related to showing and deleting private values.

Studio Pro stores private values, such as values for [private constants](/refguide/configuration/#constants), in an encrypted way in the user's local app data. These private values are defined by:
Studio Pro stores private values, such as values for [private constants](/refguide/configurations-tab/#constants), in an encrypted way in the user's local app data. These private values are defined by:

* The path of the `.mpr` file of the app
* The version of Studio Pro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ To troubleshoot issues related to the Make it Native app, see the sections below

#### Port Issues

Mendix recommends keeping the **Runtime port** in your [configuration](/refguide/configuration/#server) on **8080**. If you change it, do not change it to **8083**, because that is designated for app packaging.
Mendix recommends keeping the **Runtime port** in your [configuration](/refguide/configurations-tab/#server) on **8080**. If you change it, do not change it to **8083**, because that is designated for app packaging.

#### Wifi Network Settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ In order for your app to use to use the Push Connections Module, configure the f
1. Add a new open page navigation item to the **Responsive** navigation profile.
1. Select the **Administration** page from the **PushNotifications** module. This page is located in the **_USE ME/Admin** folder of the **PushNotifications** module.
1. Add a microflow sub-call to your **AfterStartup** microflow for the microflow **AfterStartup_PushNotifications**:<br />
* If you do not have an **AfterStartup** microflow configured yet, read the [After Startup](/refguide/app-settings/#after-startup) section of *App Settings* for more information.
* If you do not have an **AfterStartup** microflow configured yet, read the [After Startup](/refguide/runtime-tab/#after-startup) section of *App Settings* for more information.

Now you are able to start your app and move on to the next section.
Loading