Skip to content

Commit 994b8be

Browse files
committed
Merge branch 'development' of https://github.com/mendix/docs into development
2 parents 69ffb86 + d60d210 commit 994b8be

22 files changed

Lines changed: 281 additions & 147 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ After you create a microflow that connects to an AWS service, expose it as a mic
136136
4. In the **Category** field, enter the name of the AWS service.
137137
5. In the **Icon** section, select the official AWS icon.
138138

139-
For more information, see [Microflow Properties: Expose as Microflow Action](/refguide/microflow/#expose-as-microflow).
139+
For more information, see [Microflow Properties: Expose as Microflow Action](/refguide/microflow/#expose-as-microflow-action).
140140

141141
## Best Practices
142142

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ By default, autocommit is set to false for design time queries.
285285

286286
When using JDK versions 17 or 21 (or any version above 16), you may encounter compatibility issues if database you are connecting to has a dependency on Apache Arrow.
287287

288-
#### To resolve Apache Arrow dependency issue in Snowflake:
288+
#### Resolving Apache Arrow Dependency Issues in Snowflake
289289

290290
The Snowflake JDBC Driver uses Arrow as the default result format for query execution to improve performance. However, you can override this default setting by switching the result format to JSON.
291291

@@ -296,9 +296,9 @@ To set the result format at the Snowflake session or user level, use the followi
296296
```
297297

298298
This approach ensures compatibility with JDK 16+.
299-
[For more details](https://community.snowflake.com/s/article/Getting-java-lang-NoClassDefFoundError-for-class-RootAllocator).
299+
For more information, see [Getting Java Lang NoClassDefFoundError](https://community.snowflake.com/s/article/Getting-java-lang-NoClassDefFoundError-for-class-RootAllocator) in Snowflake documentation.
300300

301-
#### To resolve Apache Arrow dependency issue in Databricks:
301+
#### Resolve Apache Arrow Dependency Issues in Databricks {#apache-arrow-databricks}
302302

303303
The Databricks JDBC Driver uses Arrow for serialization as it improves performance.
304304

@@ -307,4 +307,7 @@ To override this setting add below parameter to JDBC URL
307307
```sql
308308
EnableArrow=0
309309
```
310-
[For more details](https://community.databricks.com/t5/data-engineering/java-21-support-with-databricks-jdbc-driver/td-p/49297)
310+
For more information, see:
311+
312+
* [Java 21 Support with Databricks](https://community.databricks.com/t5/data-engineering/java-21-support-with-databricks-jdbc-driver/td-p/49297) in Databricks documentation
313+
* [Configure the External Database Connector for Databricks](/appstore/modules/databricks/external-database-connector/)

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,3 +121,7 @@ After you have created a table with some entries, you can now be query from your
121121
{{< figure src="/attachments/appstore/platform-supported-content/modules/databricks/JA_Query.png" >}}
122122

123123
7. Link the microflow to a microflow button and use the Debugger to test if the objects are properly returned.
124+
125+
## Read More
126+
127+
* [External Database Connector: Resolving Apache Arrow dependency issue in Databricks](/appstore/modules/external-database-connector/#apache-arrow-databricks)

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

Lines changed: 137 additions & 40 deletions
Large diffs are not rendered by default.

content/en/docs/deployment/mendix-cloud-deploy/pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Evaluate results of the [Maia Best Practice Recommender](/refguide/best-practice
165165
* Import the [Unit Testing](https://marketplace.mendix.com/link/component/390) module into your Mendix application from the Marketplace.
166166
* The environment in which Unit Testing needs to happen should be in a running state.
167167

168-
Since a remote API password is required to trigger Unit Tests and it is not advisable to have sensitive credential information in the pipeline definition, use variables within pipelines. These variables can then be easily referenced in the pipeline design. For more information, see the [Running Unit Tests Through the Remote API](/appstore/modules/unit-testing/#running-unit-tests-through-the-remote-api) section of *Unit Testing*.
168+
Since a remote API password is required to trigger Unit Tests and it is not advisable to have sensitive credential information in the pipeline definition, use variables within pipelines. These variables can then be easily referenced in the pipeline design. For more information, see the [Running Unit Tests Through the Remote API](/appstore/modules/unit-testing/#using-the-remote-api) section of *Unit Testing*.
169169

170170
Using **Timeout (in seconds)** field, users can restrict the execution time of unit tests. If the tests exceed the predefined duration or timeout, the test step fails. It helps to avoid unnecessary waiting if tests are stuck in a loop.
171171

content/en/docs/deployment/on-premises-design/ms-windows/automate-mendix-deployment-on-microsoft-windows.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,43 @@ Update-MxApp $appName -LiteralPath $literalPath
7575
Start-MxApp $appName -SynchronizeDatabase
7676
```
7777

78-
{{% alert color="info" %}}
78+
{{% alert color="warning" %}}
79+
Stopping your app before you update it is a necessary part of the process. Do not attempt to extract the deployment package into your app while the app is running.
80+
{{% /alert %}}
81+
82+
You can find the parameters for `Start-MxApp` cmdlet in the sections below:
83+
84+
#### `NoService`
85+
7986
To start your app as a local process instead of a service, add a `-NoService` argument to the `Start-MxApp` cmdlet, as in the following example:
8087

8188
```
8289
Start-MxApp $appName -NoService -SynchronizeDatabase
8390
```
8491

85-
{{% /alert %}}
92+
#### `EnableDebugger`
8693

87-
{{% alert color="warning" %}}
88-
Stopping your app before you update it is a necessary part of the process. Do not attempt to extract the deployment package into your app while the app is running.
89-
{{% /alert %}}
94+
`EnableDebugger` allows Studio Pro to connect to a Mendix app for debugging.
95+
96+
```
97+
Start-MxApp $appName -EnableDebugger "Abcd@1234"
98+
```
99+
100+
#### `LicenseKey`
101+
102+
The `LicenseKey` parameter to the `Start-MxApp` cmdlet allows you to activate a license for a Mendix app.
103+
104+
```
105+
Start-MxApp $appName -LicenseKey "Abcd@1234"
106+
```
107+
108+
#### `AdminPassword`
109+
110+
the `AdminPassword` parameter to the Start-MxApp cmdlet sets the administrator password for a Mendix app.
111+
112+
```
113+
Start-MxApp $appName -AdminPassword "Abcd@1234"
114+
```
90115

91116
### Sample Script - Determine the Mendix Runtime Version
92117

@@ -144,6 +169,17 @@ $level = 'Log level which needs to be assigned'
144169
Set-MxLogLevel $appName -SubscriberName $subscriberName -Level $level
145170
```
146171

172+
### Sample Script - Create a Windows Service for Mendix app
173+
174+
The following script example demonstrates how to create a Windows service for a Mendix app.
175+
176+
```text
177+
$appName = 'Name of Mendix app'
178+
179+
# Create new Windows service
180+
Install-MxService $appName
181+
```
182+
147183
## Troubleshooting
148184

149185
If you encounter any issues while automating Mendix deployment on Windows using cmdlets, use the following troubleshooting tips to help you solve them.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ aliases:
1212

1313
An annotation is an element that can be used to put comments to a flow.
1414

15-
In the example below, you use a **Show message** activity to warn end-users about unpaid orders with a pop-up message in the client. Later you want to extend this warning with an email message send to the user. You can use an annotation as a reminder and put it above the current activity.
15+
In the example below, you use a **Show message** activity to warn end-users about unpaid orders with a pop-up message in the client. Later you want to extend this warning with an email message sent to the user. You can use an annotation as a reminder and put it above the current activity.
1616

1717
{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/annotation/anotation.png" class="no-border" >}}
1818

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ description: "Presents an overview of all the elements that can be used in a mic
88

99
## Introduction
1010

11-
Microflows allow you to express the logic of your application. A microflow can perform actions such as creating and updating objects, showing pages and making choices. It is a visual way of expressing what traditionally ends up in textual program code.
11+
Microflows allow you to express the logic of your application. A microflow can perform actions such as creating and updating objects, showing pages, and making choices. It is a visual way of expressing what traditionally ends up in textual program code.
1212

1313
Microflows run in the runtime server and can therefore not be used in offline apps. For application logic within offline apps, see [Nanoflows](/refguide/nanoflows/). For information on how nanoflows and microflows differ, see the [Differences between Microflows and Nanoflows](/refguide/microflows-and-nanoflows/#differences) section in *Microflows and Nanoflows*.
1414

1515
This page is a summary of the elements which make up a microflow, together with their visual representation within the microflow. It also covers [keyboard support](#keyboard) when editing microflows.
1616

17-
For the properties of the microflow itself, see [Microflow Properties](/refguide/microflow/). For more best practice details, see [Microflow Naming Conventions](/refguide/dev-best-practices/#microflow-naming-conventions), [Microflow General Best Practices](/refguide/dev-best-practices/#microflow-dev-best-practices), and [Microflow Best Practices from the Community](/refguide/community-best-practices-for-app-performance/#microflow-community-best-practices).
17+
For the properties of the microflow itself, see [Microflow Properties](/refguide/microflow/). For microflow best practices, see [Microflow Naming Conventions](/refguide/dev-best-practices/#microflow-naming-conventions), [Microflow General Best Practices](/refguide/dev-best-practices/#microflow-dev-best-practices), and [Microflow Best Practices from the Community](/refguide/community-best-practices-for-app-performance/#microflow-community-best-practices).
1818

1919
For information on using microflows as data sources, see [Microflow Source](/refguide/microflow-source/).
2020

@@ -32,38 +32,38 @@ A microflow is composed of elements. Below is a categorized overview of all elem
3232
* [Parameter](#parameter) is data that serves as input for the microflow.
3333
* [Annotation](#annotation) is an element that can be used to put comments in a microflow.
3434

35-
### Events{#events}
35+
### Events {#events}
3636

3737
Events represent start and endpoints of a microflow and special operations in a loop.
3838

3939
| Graphic | Name | Description |
4040
| --- | --- | --- |
41-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/start-event.png" link="/refguide/start-event/" class="no-border" >}} | [Start Event](/refguide/start-event/) | A start event is the starting point of the microflow. A microflow can only have one start event. |
42-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/end-event.png" link="/refguide/end-event/" class="no-border" >}} | [End Event](/refguide/end-event/) | An end event defines the location where the microflow will stop. Depending on the return type of the microflow in some cases a value must be specified. There can be more than one end event. |
43-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/error-event.png" link="/refguide/error-event/" class="no-border" >}} | [Error Event](/refguide/error-event/) | An error event defines a location where the microflow will stop and throw an error that occurred earlier. If you call a microflow, you may want to know whether any errors occurred within the microflow or not. |
41+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/start-event.png" link="/refguide/start-event/" class="no-border" >}} | [Start Event](/refguide/start-event/) | A start event is the starting point of a microflow. A microflow can only have one start event. |
42+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/end-event.png" link="/refguide/end-event/" class="no-border" >}} | [End Event](/refguide/end-event/) | An end event defines the location where a microflow stops.Depending on the return type of the microflow, in some cases a value must be specified. There can be more than one end event. |
43+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/error-event.png" link="/refguide/error-event/" class="no-border" >}} | [Error Event](/refguide/error-event/) | An error event defines a location where a microflow stops and throws an error that occurred earlier. If you call a microflow, you may want to know whether any errors occurred within the microflow or not. |
4444
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/continue-event.png" link="/refguide/continue-event/" class="no-border" >}} | [Continue Event](/refguide/continue-event/) | A continue event is used to stop the current iteration of a loop and continue with the next iteration. Continue events can only be used inside a [Loop](/refguide/loop/). |
45-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/break-event.png" link="/refguide/break-event/" class="no-border" >}} | [Break Event](/refguide/break-event/) | A break event is used to stop iterating over the list of objects and continue with the rest of the flow after the loop. Break events can only be used inside a [Loop](/refguide/loop/). |
45+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/break-event.png" link="/refguide/break-event/" class="no-border" >}} | [Break Event](/refguide/break-event/) | A break event is used to stop iterating over a list of objects and continue with the rest of the flow after the loop. Break events can only be used inside a [Loop](/refguide/loop/). |
4646

47-
### Flows{#flows}
47+
### Flows {#flows}
4848

4949
Flows form the connection between elements.
5050

5151
| Graphic | Name | Description |
5252
| --- | --- | --- |
5353
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/sequence-flow.png" link="/refguide/sequence-flow/" class="no-border" >}} | [Sequence Flow](/refguide/sequence-flow/) | A sequence flow is an arrow that links events, activities, decisions, and merges with each other. Together they define the order of execution within a microflow. |
54-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/annotation-flow.png" link="/refguide/annotation/#annotation-flow" class="no-border" >}} | [Annotation flow](/refguide/annotation/#annotation-flow) | An association is a connection that can be used to connect an annotation to another element. |
54+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/annotation-flow.png" link="/refguide/annotation/#annotation-flow" class="no-border" >}} | [Annotation flow](/refguide/annotation/#annotation-flow) | An annotation flow is a dashed line that is used to connect an [annotation](#annotation) to another element. |
5555

5656
### Decisions {#decisions}
5757

5858
Decisions deal with making choices and merging different paths again.
5959

60-
| Graphic | Name | Description |
61-
| ------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------------ |
62-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/decision.png" link="/refguide/decision/" class="no-border" >}} | [Decision](/refguide/decision/) | A decision makes a decision based on a condition and follows one and only one of the outgoing flows. There is no parallel execution in microflows. |
63-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/object-type-decision.png" link="/refguide/object-type-decision/" class="no-border" >}} | [Object Type Decision](/refguide/object-type-decision/) | An object type decision is an element that makes a choice based on the [specialization](/refguide/entities/) of the selected object. You can give the specialized object a name using a [cast object](/refguide/cast-object/) action. |
64-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/merge.png" link="/refguide/merge/" class="no-border" >}} | [Merge](/refguide/merge/) | A merge can be used to combine multiple sequence flows into one. If a choice is made in a microflow and afterwards some common work needs to be done, you can combine the two (or more) paths using a merge. |
60+
| Graphic | Name | Description |
61+
| --- | --- | --- |
62+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/decision.png" link="/refguide/decision/" class="no-border" >}} | [Decision](/refguide/decision/) | A decision makes a decision based on a condition and follows one and only one of the outgoing flows. There is no parallel execution in microflows. |
63+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/object-type-decision.png" link="/refguide/object-type-decision/" class="no-border" >}} | [Object Type Decision](/refguide/object-type-decision/) | An object type decision is an element that makes a choice based on the [specialization](/refguide/entities/) of the selected object. You can give the specialized object a name using a [cast object](/refguide/cast-object/) activity. |
64+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/merge.png" link="/refguide/merge/" class="no-border" >}} | [Merge](/refguide/merge/) | A merge is used to combine multiple sequence flows into one. If a choice is made in a microflow and afterwards some common work needs to be done, you can combine the two (or more) paths using a merge. |
6565

66-
### Activities{#activities}
66+
### Activities {#activities}
6767

6868
[Activities](/refguide/activities/) are the actions that are executed in a microflow:
6969

@@ -75,11 +75,11 @@ A [loop](/refguide/loop/) is used to iterate over a list of objects:
7575

7676
{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/loop.png" alt="Loop" class="no-border" >}}
7777

78-
For every object the flow inside the loop is executed. A loop activity can contain all elements used in microflows, with the exception of start and end events.
78+
For every object, the flow inside the loop is executed. A loop activity can contain all elements used in microflows, with the exception of start and end events.
7979

8080
### Parameter {#parameter}
8181

82-
A [parameter](/refguide/parameter/) is data that serves as input for the microflow.
82+
A [parameter](/refguide/parameter/) is data that serves as input for a microflow.
8383

8484
{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/parameter.png" alt="Parameter" class="no-border" >}}
8585

0 commit comments

Comments
 (0)