Skip to content

Commit 52e21f3

Browse files
authored
Merge pull request mendix#11004 from pieroguerrero-mendix/development
Reflect SP 10.9 status in Maia for Workflows docs
2 parents 3d047aa + c8959b3 commit 52e21f3

1 file changed

Lines changed: 29 additions & 67 deletions

File tree

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-workflows.md

Lines changed: 29 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -12,109 +12,71 @@ description: "Describes the features in Maia for Workflows."
1212
To use Maia for Workflows, an internet connection and signing in to Studio Pro are required.
1313
{{% /alert %}}
1414

15-
Maia for Workflows helps you generate a [workflow](/refguide/workflows/). It can also provide explanations or further improvements based on the generated elements. The current version has some known limitations. For example, it is currently intended only for use with empty workflows. Generated elements are appended to the end of the workflow, which may result in incorrectly modeled workflows if the workflow is not empty. For more details, see the [Limitations](#limitation) section below.
15+
Maia for Workflows helps you generate a [workflow](/refguide/workflows/). It can also provide explanations or further improvements based on the generated elements. The current version has some known limitations. For more details, see the [Limitations](#limitation) section below.
1616

1717
## Using Maia for Workflows
1818

19-
{{% alert color="info" %}}
20-
In Studio Pro 11.8, Maia for Workflows is not available.
21-
{{% /alert %}}
19+
Describe a business process you want to model. Maia uses this information to add relevant workflow activities, and tries to configure them where possible. For more information on how to communicate with Maia to achieve better results when configuring a workflow, see the [Best Practices for Text Input](#text-input-best-practice) section below.
2220

23-
### In Studio Pro 11.9 and Above
21+
### Version Availability
2422

25-
In Studio Pro 11.9 and above, Maia for Workflows is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia for Workflows. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
23+
#### Studio Pro 11.9 and Above
2624

27-
### In Studio Pro 11.7 and Below
25+
Maia for Workflows is incorporated into the unified [Maia Make Capabilities](/refguide/maia-make/), which are enabled by default.
2826

29-
To enable Maia for Workflows in Studio Pro 11.7 and below, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Workflows**.
27+
#### Studio Pro 11.8
3028

31-
Once enabled, you can find it in the the toolbar of a workflow:
29+
Maia for Workflows is not available.
3230

33-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-workflows/maia-for-workflows.png" max-width=80% >}}
31+
#### Studio Pro 11.7 and Below
3432

35-
After clicking **Maia for Workflow**, a dedicated chat interface appears at the right side of Studio Pro under the **Maia** tab:
33+
To enable Maia for Workflows, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Workflows**. Once enabled, you can find it in the toolbar of a workflow:
3634

37-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-workflows/chat-interface.png" max-width=42% >}}
38-
39-
Describe a business process which you want to model and Maia uses this information to add relevant workflow activities, and tries to configure them where possible. You can also supplement text input with a maximum of one image and one PDF file, which Maia uses to interpret your request more effectively. For more information, see the [Attachment Requirements](#attachment-requirements) section below.
35+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-workflows/maia-for-workflows.png" max-width=80% >}}
4036

41-
After a workflow is generated, you can continue asking Maia in the same session to further improve the workflow and provide explanations.
37+
After clicking **Maia for Workflow**, a chat interface appears at the right side of Studio Pro under the **Maia** tab:
4238

43-
{{% alert color="info" %}}
44-
In this dedicated chat, only requests related to Workflows will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface.
45-
{{% /alert %}}
39+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-workflows/chat-interface.png" max-width=42% >}}
4640

47-
#### Best Practices for Text Input
41+
### Best Practices for Text Input {#text-input-best-practice}
4842

4943
To achieve optimal results, provide context about your workflow by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your workflow, the more tailored and accurate the generated workflow will be.
5044

5145
Below are some examples of prompts you can use as a starting point:
5246

53-
* The workflow will be used to ...
47+
* Please generate a workflow for a process that...
5448
* Create a workflow based on the image.
5549
* Base the workflow on the image, but change ... to ...
5650

57-
Below are some examples of prompts you can use to ask Maia for further explanations or suggestions to improve the generated page:
58-
59-
* Can you make the timer wait for 5 days?
60-
* I want the process to run in parallel.
61-
62-
{{% alert color="warning" %}}
63-
Requests for improvements or explanations currently only work within the same session where the workflow is generated. If you close the session and start a new session on that workflow, any attempts to make changes to the workflow will result in the removal of existing elements.
64-
{{% /alert %}}
65-
66-
#### Attachment Requirements {#attachment-requirements}
67-
68-
Maia for Workflows supports adding a maximum of one image and one PDF as attachments. Support for adding a PDF file was introduced in Studio Pro 11.2.0.
69-
70-
The attachments must meet the following requirements:
71-
72-
* The image format must be PNG or JPG.
73-
* The image file size must not exceed 512 KB.
74-
* The image resolution must be no greater than 3840 × 2400 pixels.
75-
* The PDF file size must not exceed 1024 KB.
76-
77-
For example, Maia for Workflows can analyze a BPMN image representing employee onboarding, rework it using Mendix Workflows terminology, and generate the corresponding activities for you. Alongside the image, you can also use text input to specify how the generated workflow should differ from the provided image. For example, you might write: *Generate a workflows based on this BPMN image, but make sure it waits before sending an email to the new employee.*
51+
Maia for Workflows can analyze a BPMN image representing employee onboarding, rework it using Mendix Workflows terminology, and generate the corresponding activities for you. Alongside the image, you can also use text input to specify how the generated workflow should differ from the provided image. For example, you might write: *Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee.*
7852

7953
Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, BPMN schema, or a close-up picture of a drawing. Avoid heavily compressed or low quality images, as these may result in the loss of important details.
8054

81-
#### Limitations {#limitation}
55+
Below are some examples of prompts you can use to ask Maia for further explanations or suggestions to improve the generated workflow:
8256

83-
Maia for Workflows has some limitations.
84-
85-
##### Empty Workflows Only
86-
87-
Maia for Workflows is currently intended only for use with empty Workflows. Using it on existing workflows can result in incorrectly modeled business processes.
57+
* Can you explain this workflow to me?
58+
* Can you give me suggestions to improve this workflow?
59+
* Can you make the timer wait for 5 days?
60+
* I want the process to run in parallel.
8861

89-
Requests for improvements and explanations currently only work within the same session where a workflow has been generated. Once the session is closed, Maia for Workflows loses the context. Any attempts to make changes to that workflow in a new session will also result in the removal of all existing elements.
62+
## Limitations {#limitation}
9063

91-
##### Supported Workflow Elements
64+
Maia for Workflows currently has some limitations.
9265

93-
Currently, annotations are not supported. However, most of the other workflow elements are supported. See below a list of supported workflow elements:
66+
### Supported Workflow Elements
9467

95-
* [User Task](/refguide/user-task/)
96-
* [Multi-user Task](/refguide/multi-user-task/)
97-
* [Decision](/refguide/decision-in-workflows/)
98-
* [Parallel Split](/refguide/parallel-split/)
99-
* [Jump](/refguide/jump-activity/)
100-
* [Wait for Notification](/refguide/wait-for-notification/)
101-
* [Timer](/refguide/timer/)
102-
* [Call Microflow](/refguide/call-microflow/)
103-
* [Call Workflow](/refguide/call-workflow/)
104-
* [Boundary Events](/refguide/workflow-boundary-events/)
68+
Currently, [Multi-user task](/refguide/multi-user-task/) is not supported. However, most of the other workflow elements are supported.
10569

106-
##### Not All Properties Can Be Configured
70+
### Not All Properties Can Be Configured
10771

10872
Due to the complex cross-document nature of a workflow, not all properties of the workflow elements can be generated yet. The following properties cannot be configured yet:
10973

110-
* The following properties of [User Task](/refguide/user-task/):
111-
* Task page
112-
* Targeted users
113-
* Due date
114-
* Any [properties](/refguide/workflow-properties/) of the workflow document itself
74+
* From the workflow document itself
75+
* [Admin Page](/refguide/workflow-properties/#admin-page)
11576

11677
## Read More
11778

118-
* [Workflow](/refguide/workflows/)
79+
* [Maia Make Capabilities](/refguide/maia-make/)
11980
* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
81+
* [Workflow](/refguide/workflows/)
12082
* [Maia Chat](/refguide/maia-chat/)

0 commit comments

Comments
 (0)