Skip to content

Commit d2a7a64

Browse files
Merge branch 'development' of https://github.com/mendix/docs into development
2 parents 0fd8327 + c306f51 commit d2a7a64

File tree

59 files changed

+393
-1354
lines changed

Some content is hidden

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

59 files changed

+393
-1354
lines changed

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-property-types.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -916,6 +916,33 @@ The editability property allows a pluggable widget to have an editable configura
916916
<systemProperty key="Editability"/>
917917
```
918918

919+
## Converting Properties {#converting-properties}
920+
921+
When a pluggable widget's property type changes, the Mendix Platform will automatically migrate the value of the property to the new type. The following table lists the property type changes that are supported:
922+
923+
| From | To |
924+
|----------------|----------------|
925+
| `TextTemplate` | `Expression` |
926+
| `Expression` | `TextTemplate` |
927+
| `Expression` | `String` |
928+
| `Expression` | `Boolean` |
929+
| `Expression` | `Integer` |
930+
| `Expression` | `Decimal` |
931+
| `String` | `Expression` |
932+
| `Boolean` | `Expresson` |
933+
| `Integer` | `Expression` |
934+
| `Decimal` | `Expression` |
935+
| `Decimal` | `Integer` |
936+
| `Integer` | `Decimal` |
937+
| `Attribute` | `Expression` |
938+
| `Attribute` | `TextTemplate` |
939+
940+
{{% alert color="warning" %}}
941+
When converting from `decimal` to `integer`, the value will be rounded to the closest integer.
942+
943+
When converting from `TextTemplate` to `Expression`, only the text template of the active language is migrated; fallback texts are not included.
944+
{{% /alert %}}
945+
919946
## Read More
920947

921948
* [Pluggable Widgets API](/apidocs-mxsdk/apidocs/pluggable-widgets/)

content/en/docs/refguide/general/studio-pro-overview/keyboard-shortcuts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ The tables in the following sub-sections present the shortcut keys that can be u
142142
| <kbd>F2</kbd> | <kbd>Fn</kbd> + <kbd>F2</kbd> | Rename the variable returned by the selected element. |
143143
| <kbd>Shift</kbd> + <kbd>F2</kbd> or just start typing | <kbd>Shift</kbd> + <kbd>Fn</kbd> + <kbd>F2</kbd> or just start typing | Open the **Properties** pane and edit the caption of the selected element. |
144144
| Context-menu key or <kbd>Shift</kbd> + <kbd>F10</kbd> | <kbd>Shift</kbd> + <kbd>Fn</kbd> + <kbd>F10</kbd> | Open the context-menu for the currently selected element. |
145+
| <kbd>Shift</kbd> | <kbd>Shift</kbd> | When holding <kbd>Shift</kbd>, connection points are shown while hovering over elements.<br><br>{{% alert color="info" %}}This keyboard shortcut does not work out of the box when running Studio Pro in Parallels on MacOS. To resolve the issue, navigate to the virtual machine **configuration** > **Hardware** > **Mouse & Keyboard** and enable the **Optimize for games** option. This ensures that an event is sent to the virtual machine whenever a modifier key is pressed.{{% /alert %}}|
145146

146147
## Workflow Editor Shortcut Keys {#workflow-editor-shortcut-keys}
147148

content/en/docs/refguide/installation/upgrading-from-10-to-11.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Regardless of which major version you are upgrading from, we recommend you upgra
2727

2828
1. Back up your app.
2929
1. Upgrade to the latest patch of Studio Pro.
30-
1. Upgrade widgets, modules, Marketplace components, templates, and connectors.
30+
1. Upgrade widgets, modules, Marketplace components, and connectors.
3131
1. Fix deprecations and test your app.
3232
1. Upgrade app to Mendix 11.
3333

@@ -55,7 +55,10 @@ In general, you should not remove and re-import modules unless this is recommend
5555

5656
After the upgrade of your marketplace content, take the next steps:
5757

58-
1. Fix any deprecation warnings you see in development in Studio Pro, as well as in the Mendix Runtime using your console and browser console.
58+
1. Fix any deprecation warnings you see in development in Studio Pro, as well as in the Mendix Runtime using your console and browser console. These deprecations could include, but are not limited to, the following:
59+
* [Document Templates](/refguide/document-templates/): deprecated in 10.24
60+
* [Dojo-based Mendix Client](/refguide/mendix-client/): deprecated in 11.0
61+
* Deprecated Java Version: depending on your Java version you may see errors — to resolve those errors, see [Java Version Migration](/refguide/java-version-migration/)
5962
1. Review the major changes in the sections below.
6063
1. Run your app, test all functionality, and ensure it works without error.
6164
1. Back up or commit your Mendix 10 app so you can return to it if necessary.
@@ -78,6 +81,16 @@ We recommend you also upgrade Atlas Web Content if it is in your app.
7881

7982
For optimal implementation, ensure all UI modules either use CSS variables or have their variables defined within the module. If an app uses CSS variables inside **theme/web/custom-variables.scss** while some UI modules still rely on old Atlas SASS variables, those usages will fallback to Atlas default values. Therefore, we recommend you to transition to CSS variables only after confirming that all company design modules no longer depend on Atlas SASS variables.
8083

84+
### Using the **ShowHomePage** Microflow in the **System** Module {#apply-entity-access}
85+
86+
In Studio Pro versions prior to 11, the default configuration was insecure: **Apply entity access** was set to `false`. In Studio Pro version 11, the **ShowHomePage** microflow in the **System** module now enforces a secure default for entity access. As a result, after upgrading to version 11, your application may report errors that were previously not detected.
87+
88+
Below is an example of a potential error that may occur after upgrading to version 11, along with recommended approaches for resolving it.
89+
90+
After the upgrade, your app may report the following new error: `A microflow that does not apply entity access can only call microflows that also do not apply entity access`. This error occurs when a microflow that does not apply entity access attempts to call the **ShowHomePage** microflow in the **System** module, which now enforces entity access. In earlier versions, the **ShowHomePage** microflow did not have entity access applied, so this error did not arise before the upgrade.
91+
92+
You can resolve the error by enabling entity access for the microflow that calls the **ShowHomePage** microflow. However, this may not always align with your intended access control strategy. Alternatively, you can create a custom microflow that includes the [Show home page](/refguide/show-home-page/) activity without enabling entity access. You can then call this new microflow instead of the one in the **System** module. Another approach is to call the **Show home page** activity directly within your microflow.
93+
8194
### Other
8295

8396
* Studio Pro 10.21 and above requires your application to use Java 21. The Java version of an application can be configured in the runtime settings. Java 21 is available in 9.24.23 and above. Please consider the Java Version Migration guide for a list of changes between Java versions. For on-premises deployments, ensure that JDK 21 is installed in the environments where Mendix 10 applications are deployed.
@@ -99,3 +112,4 @@ For optimal implementation, ensure all UI modules either use CSS variables or ha
99112
* When COALESCE function in OQL has attributes of different numeric types, the result type is defined according to type precedence. Before, the result type would match the type of the first argument.
100113
* Client API `mx.logger` is no longer supported. All calls to it should be replaced with standard `console.log`, `console.warn`, and other such standard calls. All widgets that use the `mx.logger` need to be updated.
101114
* We no longer convert `empty` values sent to the client into empty strings. All client side expressions must be adjusted accordingly.
115+
* We no longer support the runtime API class `com.mendix.modules.email.EmailModule` which was deprecated in [Mendix 10.12](https://docs.mendix.com/releasenotes/studio-pro/10.12/#deprecate-email). We recommend using the [Email Connector](https://marketplace.mendix.com/link/component/120739) module instead.

content/en/docs/refguide/mobile/building-efficient-mobile-apps/offlinefirst-data/_index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases:
99
- /refguide/mobile/building-efficient-mobile-apps/offlinefirst-data/
1010
---
1111

12-
## Introduction
12+
## Introduction{#intro}
1313

1414
The Mendix platform offers support to build fully offline-first applications, whether it is a native mobile app or a progressive web app.
1515

@@ -19,7 +19,11 @@ Offline-first applications work regardless of the connection to provide a contin
1919
It is essential to understand that offline-first is an architectural concept and not an approach based on the device's network state. Offline-first apps do not rely on a connection. Still, they can use network connections (for example, you can call microflows, use a Google Maps widget, or use push notifications).
2020
{{% /alert %}}
2121

22-
Mendix supports building offline-first applications for [native mobile](/refguide/native-mobile/) and [progressive web apps](/refguide/mobile/introduction-to-mobile-technologies/progressive-web-app/). Both native and progressive web apps (PWAs) share the same core, giving them the same offline-first capabilities. Native mobile apps are always offline-first, but for progressive web apps this is optional. You can configure your PWA to be offline-first by adding an offline-first PWA navigation profile to your app. For more information, see [Progressive Web Apps](/refguide/mobile/introduction-to-mobile-technologies/progressive-web-app/).
22+
Mendix supports building offline-first applications for [native mobile](/refguide/native-mobile/) and [progressive web apps](/refguide/mobile/introduction-to-mobile-technologies/progressive-web-app/). Both native and progressive web apps (PWAs) share the same core, giving them the same offline-first capabilities.
23+
24+
Starting in Studio Pro 11.0.0, the feature of adding online date in offline apps is generally available. This means developers have more flexibility than ever when building apps and configuring when and how they pass data.
25+
26+
Native mobile apps are always offline-first, but for progressive web apps this is optional. You can configure your PWA to be offline-first by adding an offline-first PWA navigation profile to your app. For more information, see [Progressive Web Apps](/refguide/mobile/introduction-to-mobile-technologies/progressive-web-app/).
2327

2428
{{% alert color="info" %}}
2529
**Online Synchronization Mode**

content/en/docs/refguide/modeling/app-explorer/app/app-settings/_index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,3 @@ When enabled, the names that Studio Pro suggests in microflows will start with a
463463
### Activity Default Colors
464464

465465
This table allows you to select a default color for each microflow activity type that is available in your app. The selected color will be used as the background color for all microflow activities of that type in your app. It is possible to override this default value for individual activities in the microflow editor. If you change the default color for an activity type, and there are activities of that type present in the app that have an individual background color specified, a dialog will be shown that allows you to apply the new default color to these activities as well.
466-
467-
### Automatically Encode Parameter Values in Send REST Request Microflow Activities
468-
469-
You can disable the encoding of the URL parameters for the Send REST Request microflow activity. This allows parameter values to be used as provided.
470-
471-
When enabled, the behavior will be inconsistent with the Consumed REST service.

content/en/docs/refguide/modeling/app-explorer/app/app-settings/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ A configuration contains the following:
2626
* [Constants tab](#constants)
2727
* [Custom tab](#custom)
2828
* [Headers tab](#headers)
29+
* [Tracing tab](/refguide/tracing-in-runtime/#min-configuration)
2930

3031
### Database {#database}
3132

content/en/docs/refguide/modeling/app-explorer/modules/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ There are the following type of modules:
5656
| --- | --- |
5757
| [Constants](/refguide/constants/) | Constants are used to define a constant value (for example, to store a URL for a web service). |
5858
| [Datasets](/refguide/data-sets/) | A dataset can be used for reporting and is defined using either an OQL query or a custom Java action. |
59-
| [Document Templates](/refguide/document-templates/) | Document templates are used to model a template needed as input for a document export action that can generate all kinds of documents based on application data. They are composed much in the same way as forms. |
59+
| [Document Templates](/refguide/document-templates/) | **Deprecated in 11.0.0** Document Templates were used to design templates for exporting documents based on application data. |
6060
| [Java Actions](/refguide/java-actions/) | With Java actions, you can extend the functionality of your application in situations where it would be hard to implement the functionality in microflows. You can call a Java action from a microflow. |
6161
| [Regular Expressions](/refguide/regular-expressions/) | A regular expression is used by [validation rules](/refguide/validation-rules/) on an entity to describe a set of criteria that a string can match. |
6262
| [Rules](/refguide/rules/) | A rule defines a set of criteria. With a certain input, the rule will result in a Boolean or enumeration, depending on the criteria met. It can be called from a decision to determine the direction the microflow should go once a decision is reached. |

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,11 @@ These activities can only be used in microflows.
9898
| ---| --- | --- |
9999
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/log-message.png" alt="log message" link="/refguide/log-message/" max-width=60% class="no-border" >}} | [Log message](/refguide/log-message/) | Allows you to create messages that appear in the log of your Mendix application. |
100100

101-
## Document Generation Activities
101+
## Document Generation Activities (Deprecated)
102+
103+
{{% alert color="warning" %}}
104+
Document generation using Document Templates was deprecated in 11.0.0. See [Document Templates](/refguide/document-templates/) for alternatives.
105+
{{% /alert %}}
102106

103107
| Graphic | Name | Description |
104108
| --- | --- | --- |

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ description: "Describes generating documents from a microflow. "
66
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
77
---
88

9-
{{% alert color="info" %}}
10-
This activity can only be used in microflows.
9+
{{% alert color="warning" %}}
10+
**Document generation** using Document Templates was deprecated in 11.0.0 Please see the documentation of [Document Templates](/refguide/document-templates/) for alternatives.
1111
{{% /alert %}}
1212

1313
## Introduction
1414

15-
The **Generate document** activity is used to write a document to a file, based on a [document template](/refguide/document-templates/).
15+
The **Generate document** microflow activity is used to write a document to a file, based on a [document template](/refguide/document-templates/).
1616

1717
For more information on which types of documents can be created, see [Document Type](#document-type).
1818

0 commit comments

Comments
 (0)