Skip to content

Documentation updates for improved toolbox activity names and property dialog box titles #9951

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

Open
wants to merge 16 commits into
base: development
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ A retrieve action is either an association-based retrieve or a database-based re

| Studio Pro Guide | Model SDK API docs |
| --- | --- |
| [Retrieve](/refguide/retrieve/) |[RetrieveSource](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.retrievesource.html) |
| [Retrieve object(s)](/refguide/retrieve-objects/) |[RetrieveSource](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.retrievesource.html) |
| [XPath](/refguide/xpath/) constraints |[AssociationRetrieveSource](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.associationretrievesource.html) |
| |[DatabaseRetrieveSource](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.databaseretrievesource.html) |
| |[Range](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.range.html), [ConstantRange](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.constantrange.html) and [CustomRange](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.customrange.html) |
Expand All @@ -144,7 +144,7 @@ Microflows can call other microflows by defining a mapping of expressions to par

| Studio Pro Guide | Model SDK API docs |
| --- | --- |
| [Microflow Call](/refguide/microflow-call/) |[MicroflowCallAction](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.microflowcallaction.html) |
| [Call Microflow](/refguide/microflow-call/) |[MicroflowCallAction](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.microflowcallaction.html) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the link also points to /refguide/call-microflow/ it would improve consistency.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ievgen-baida This was what I had done before I realized that we already had the exact same URL used for the Call microflow activity in the workflow editor: https://docs.mendix.com/refguide/call-microflow/. So I reverted my changes and kept the current URL.

| |[MicroflowCall](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.microflowcall.html) |
| |[MicroflowCallParameterMapping](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.microflowcallparametermapping.html) |

Expand Down Expand Up @@ -315,7 +315,7 @@ Java action calls point to a specific Java action and have a parameter mapping w

| Studio Pro Guide | Model SDK API docs |
| --- | --- |
| [Java Action Call](/refguide/java-action-call/) |[JavaAction](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/javaactions.javaaction.html) |
| [Call Java Action](/refguide/call-java-action/) |[JavaAction](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/javaactions.javaaction.html) |
| |[JavaActionParameter](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/javaactions.javaactionparameter.html) |
| |[JavaActionCallAction](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.javaactioncallaction.html) |
| |[JavaActionParameterMapping](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.javaactionparametermapping.html) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Now the application is ready to store redundant data, but you still need to keep

{{< figure src="/attachments/howto/data-models/denormalize-data-to-improve-performance/18582163.png" class="no-border" >}}

8. Drag a **Retrieve** activity from the toolbox to the line between the start and end event on the microflow, which will insert a new retrieve activity:
8. Drag a **Retrieve object(s)** activity from the toolbox to the line between the start and end event on the microflow, which will insert a new retrieve object(s) activity:

{{< figure src="/attachments/howto/data-models/denormalize-data-to-improve-performance/18582164.png" class="no-border" >}}

Expand All @@ -96,7 +96,7 @@ Now the application is ready to store redundant data, but you still need to keep

{{< figure src="/attachments/howto/data-models/denormalize-data-to-improve-performance/18582159.png" class="no-border" >}}

12. Insert another retrieve activity (as you did in step #8), double-click it to open its properties on the **Retrieve** dialog box, and do the following:
12. Insert another Retrieve object(s) activity (as you did in step #8), double-click it to open its properties on the **Edit Retrieve Object(s)** dialog box, and do the following:
* Select **From Database** as **Source**
* Click **Select...** to open the entity selector

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ Consider these additional technical suggestions for best API practices:

### Exposing JavaScript Actions

JavaScript Actions can be used in a nanoflow with a JavaScript action call activity. It is also possible to expose the actions in the activity list. This will make it easier for developers to find the actions. It is recommended to expose only the actions that will be reused often.
JavaScript Actions can be used in a nanoflow with a Call JavaScript action activity. It is also possible to expose the actions in the activity list. This will make it easier for developers to find the actions. It is recommended to expose only the actions that will be reused often.

Use **Category** to group actions, **Icon** and **Image** to give the exposed nanoflow action easy recognition inside the nanoflow:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ To create a JavaScript action that can synthesize text to speech, follow these s
}
```

9. You have just implemented your first JavaScript action! You can start using the action in your nanoflows by adding a **JavaScript action call** and selecting the newly created **SpeechToText** action:
9. You have just implemented your first JavaScript action! You can start using the action in your nanoflows by adding a **Call JavaScript action** and selecting the newly created **SpeechToText** action:

{{< figure src="/attachments/howto/extensibility/build-javascript-actions/write-javascript-actions/selectjsactioncalldetail.png" alt="select text to speech action" class="no-border" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ To create a JavaScript action that can search for users on GitHub, follow the st
}
```

16. You have just implemented an advanced JavaScript action! Start using the action in your nanoflows by adding a **JavaScript action call**, and then selecting the newly created **SearchGitHubUsers** action:
16. You have just implemented an advanced JavaScript action! Start using the action in your nanoflows by adding a **Call JavaScript action**, and then selecting the newly created **SearchGitHubUsers** action:

{{< figure src="/attachments/howto/extensibility/build-javascript-actions/write-javascript-github/select-searchgithub-users.png" alt="select search GitHub users" class="no-border" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Mendix ticket data needs to be ingested into the knowledge base. You can find a
5. In `Tickets_CreateDataset`, open the `Retrieve Ticket from database` action and reselect the entity `Ticket`. Open the `Import from JSON` action and select the **IM_Ticket**.

6. In the `ACT_TicketList_LoadAllIntoKnowledgeBase`:
* Edit the first retrieve action to retrieve objects from your new entity `Ticket`.
* Edit the first retrieve object(s) activity to retrieve objects from your new entity `Ticket`.
* In the loop, delete the second action that adds metadata to the `MetadataCollection`.
* In the last action of the loop `Chunks: Add KnowledgeBaseChunk to ChunkCollection` keep the **Human readable ID** field empty.

Expand Down Expand Up @@ -154,7 +154,7 @@ The final result for the function microflows used in this document can be found

1. Create a new microflow named `Ticket_GetNumberOfTicketsInStatus`. Add a *String* input parameter called `TicketStatus`.

2. The model can now pass a status string to the microflow, but first convert the input into an enumeration. To achieve this, add a `Microflow call` action and create a new microflow named `Ticket_ParseStatus`. The input should be the same (*String* input `TicketStatus`).
2. The model can now pass a status string to the microflow, but first convert the input into an enumeration. To achieve this, add a `Call Microflow` activity and create a new microflow named `Ticket_ParseStatus`. The input should be the same (*String* input `TicketStatus`).

3. Inside of the sub-microflow, add a decision for each enumeration value and return the enumeration value in the **End event**. For example, the *Closed* value can be checked like this:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Delete the APM Tools item that calls "APMAgent/USE_ME/IVK_OpenConsole" from navi

## Optional: Revert After Startup and Before Shutdown

Remove the microflow call action to APMAgent\USE_ME\AfterStartup from an after startup microflow. This feature is runtime configurable and by default none of the tools are started.
Remove the microflow call action to APMAgent\USE_ME\BeforeShutdown from a before shutdown microflow.
Remove the microflow call activity to APMAgent\USE_ME\AfterStartup from an after startup microflow. This feature is runtime configurable and by default none of the tools are started.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

microflow call activity

It is now called Call microflow activity. Sometimes these names of the UI elements are decorated in bold, which is also specified in Microcopy Guide.

Would be nice to adjust the formatting to conform to it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ievgen-baida That's a very good point. I'll address that.

Remove the microflow call activity to APMAgent\USE_ME\BeforeShutdown from a before shutdown microflow.
You can find the AfterStartup and BeforeShutdown microflows in the project settings.

{{< figure src="/attachments/appstore/partner-solutions/apd/ig/ig-one/ig-one-uninstall-steps/Revert_After_Startup.png" class="no-border" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ For operations that do not depend on the GenAI Commons, you can take a different
2. Drag the one you would like to use to the beginning of your microflow.
3. Double-click the microflow action to configure the required parameters and provide a value for the AWS Region. For the **ListFoundationModels** parameter, provide the `ListFoundationModelsRequest` created in step 3.
9. The `ListFoundationModelsResponse` object is returned by the **ListFoundationModels** activity.
10. From the **Toolbox**, drag a **Retrieve** activity to your microflow and place it after the **ListFoundationModels** activity.
11. Double-click the **Retrieve** activity and make sure **By Association** is selected.
10. From the **Toolbox**, drag a **Retrieve object(s)** activity to your microflow and place it after the **ListFoundationModels** activity.
11. Double-click the **Retrieve object(s)** activity and make sure **By Association** is selected.
12. Select the **FoundationModelSummary_ListFoundationModelsResponse** association, which will return a list of the type **FoundationModelSummary**.
13. To further use the response information, you can create an implementation module with copies of the `ListFoundationModelsResponse` and `ModelSummary` Entities. This way, you can use your custom user roles and access rules for those entities and keep them when updating the connector.

Expand All @@ -152,7 +152,7 @@ To build a simple microflow that uses the ChatCompletions operation to send a si

1. Make sure that you [synced models](#sync-models) before running the microflow in the app.
2. Create a new microflow and name it, for example, *AmazonBedrockChatCompletions*.
3. Add a **Microflow call** from the **Toolbox** and choose microflow *AmazonBedrockConnector.BedrockDeployedModel_Get*
3. Add a **Call microflow** activity from the **Toolbox** and choose microflow *AmazonBedrockConnector.BedrockDeployedModel_Get*
4. Double-click it to configure its parameters.
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*.
2. Click **OK**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ After you configure the authentication profile for Amazon Rekognition, you can i
2. Drag the one you would like to use to the beginning of your microflow.
3. Double-click the microflow action to configure the required parameters and provide a value for the AWS Region.
8. The `DetectLabelResponse` object is returned by the **DetectLabels** activity.
9. In the **Toolbox** pane, search for the **Retrieve** activity and drag it onto the microflow work area.
10. Position the **Retrieve** activity between the **DetectLabels** activity and the microflow end event.
11. Double-click the **Retrieve** activity.
9. In the **Toolbox** pane, search for the **Retrieve object(s)** activity and drag it onto the microflow work area.
10. Position the **Retrieve object(s)** activity between the **DetectLabels** activity and the microflow end event.
11. Double-click the **Retrieve object(s)** activity.
12. In the **Select Association** dialog box, in the **Association** section, click **Select**, and then select **DetectLabels** as the association.
13. Click **OK**.
14. Configure a method for triggering the **ACT_DetectLabels** microflow. For example, you can trigger a Microflow by associating it with a custom button on a page in your app. For an example of how this can be implemented, see [Creating a Custom Save Button with a Microflow](/refguide/creating-a-custom-save-button/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,12 @@ After you configure the authentication profile for Amazon DynamoDB, you can impl
* Click **Edit parameter value**.
* Edit the **CreateBucketRequest** parameter and let it auto-fill.

23. In the **Toolbox** pane, search for the **Retrieve** activity and drag it onto the microflow area.
24. Position the **Retrieve** activity between the **ListTables** activity and the microflow end event.
23. In the **Toolbox** pane, search for the **Retrieve object(s)** activity and drag it onto the microflow area.
24. Position the **Retrieve object(s)** activity between the **ListTables** activity and the microflow end event.

{{< figure src="/attachments/appstore/platform-supported-content/modules/aws-dynamodb/microflow.png" alt="The microflow with the Retrieve activity added" class="no-border" >}}
{{< figure src="/attachments/appstore/platform-supported-content/modules/aws-dynamodb/microflow.png" alt="The microflow with the Retrieve object(s) activity added" class="no-border" >}}

25. Double-click the **Retrieve** activity.
25. Double-click the **Retrieve object(s)** activity.
26. In the **Association** section, click **Select**.
27. In the **Select Association** dialog box, expand the **Variable** item, and then select **ListTablesResponse** as the association.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ After you configure the authentication profile for AWS IoT SiteWise, you can imp
6. Double-click the **ListAssetModels** microflow activity to configure the required parameters.
7. In the **Edit parameters** section, edit the **ENUM_Region** parameter, and provide a value by using a variable or an expression.
8. Click **OK**.
9. In the **Toolbox** pane, search for the **Retrieve** activity and drag it onto the microflow area.
10. Position the **Retrieve** activity between the **ListAssetModels** activity and the microflow end event.
11. Double-click the **Retrieve** activity.
9. In the **Toolbox** pane, search for the **Retrieve object(s)** activity and drag it onto the microflow area.
10. Position the **Retrieve object(s)** activity between the **ListAssetModels** activity and the microflow end event.
11. Double-click the **Retrieve object(s)** activity.
12. In the **Select Association** dialog box, in the **Association** section, click **Select**, and then select **ListAssetModels** as the association.
13. Click **OK**.
14. Configure a method for triggering the **ACT_ListAssetModels** microflow. For example, you can trigger a microflow by associating it with a custom button on a page in your app. For an example of how this can be implemented, see [Creating a Custom Save Button with a Microflow](/refguide/creating-a-custom-save-button/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,18 @@ After you configure the authentication profile for AWS IoT TwinMaker, you can im
18. Double-click the **ListWorkspaces** activity.
19. Click **Edit parameter value**, edit the **ListWorkspacesRequest** parameter, and let it auto-fill.
20. In the **Object name** field, enter *ListWorkspacesResponse*, and then click **OK**.
21. In the **Toolbox** pane, search for the **Retrieve** activity and drag it onto the microflow area.
22. Position the **Retrieve** activity between the **ListWorkspaces** activity and the microflow end event.
21. In the **Toolbox** pane, search for the **Retrieve object(s)** activity and drag it onto the microflow area.
22. Position the **Retrieve object(s)** activity between the **ListWorkspaces** activity and the microflow end event.

{{< figure src="/attachments/appstore/platform-supported-content/modules/aws-iot-twinmaker/microflow.png" alt="The microflow with the Retrieve activity added" class="no-border" >}}
{{< figure src="/attachments/appstore/platform-supported-content/modules/aws-iot-twinmaker/microflow.png" alt="The microflow with the Retrieve object(s) activity added" class="no-border" >}}

23. Double-click the **Retrieve** activity.
23. Double-click the **Retrieve object(s)** activity.
24. In the **Association** section, click **Select**, and then select **ListWorkspacesResponse_WorkspaceSummary** as the association.

{{< figure src="/attachments/appstore/platform-supported-content/modules/aws-iot-twinmaker/selectassociation.png" alt="Selecting the association" class="no-border" >}}

25. In the **List name** field, enter *WorkspaceSummaryList*, and then click **OK**.
26. In the **Toolbox** pane, search for the **Create List** activity, drag it onto the microflow area, and then position it after the **Retrieve** activity.
26. In the **Toolbox** pane, search for the **Create List** activity, drag it onto the microflow area, and then position it after the **Retrieve object(s)** activity.
27. Double-click the **Create List** activity.
28. In the **Action** section, click **Select**, and then select **{module name}.MyWorkspace** as the action.
29. In the **List name** field, enter *MyWorkspaceList*, and then click **OK**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ For example, to list all existing Amazon SQS subscriptions, implement the **List
14. Set the value of the **Region** parameter in the same way as for the **GetStaticCredentials** or **GetTemporaryCredentials** activity.
15. Click **Edit parameter value**, edit the **ListQueuesRequest** parameter, and let it auto-fill.
16. Click **Edit parameter value**, edit the **Credentials** parameter, and let it auto-fill.
17. In the **Toolbox** pane, search for the **Retrieve** activity and drag it onto the microflow area.
18. Position the **Retrieve** activity between the **ListQueue** activity and the microflow end event.
19. Double-click the **Retrieve** activity.
17. In the **Toolbox** pane, search for the **Retrieve object(s)** activity and drag it onto the microflow area.
18. Position the **Retrieve object(s)** activity between the **ListQueue** activity and the microflow end event.
19. Double-click the **Retrieve object(s)** activity.
20. In the **Select Association** dialog box, in the **Association** section, click **Select**, and then under **ListQueueResponse** select *ListQueue_ListQueuesResponse* as the association.
21. Click **OK**.
22. Configure a method for triggering the **ACT_ListQueues** microflow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The [Community Commons](https://marketplace.mendix.com/link/component/170/) modu

## Usage

All the functions in this package can be invoked using a [Java action call](/refguide/java-action-call/) in a microflow or from your own Java code by calling `communitycommons.<Action Folder>.<Action name>;` (for example, `communitycommons.StringUtils.hash("Mendix", 20);`).
All the functions in this package can be invoked using a [Call Java action](/refguide/call-java-action/) in a microflow or from your own Java code by calling `communitycommons.<Action Folder>.<Action name>;` (for example, `communitycommons.StringUtils.hash("Mendix", 20);`).

The module contains one constant: `CommunityCommons.MergeMultiplePdfs_MaxAtOnce`. This is used in the `MergeMultiplePdfs` Java action to restrict the number of PDFs processed at the same time. The default restriction is 10 files at once for Mendix Cloud compatibility. If you need to merge more than 10 files, increase the number here. Setting the value to `<= 0` means unlimited.

Expand Down
Loading