Skip to content

Commit 1f85091

Browse files
afgambinclaude
andcommitted
docs(modeling-guidance): reframe toolContainer as retroactive and document reapply fix
The io.camunda.agenticai.toolContainer property was added to all AI Agent element template versions retroactively, so it is not gated on 8.10.0-alpha4. Because templates declare it as a hidden property, the Extension properties section is unavailable while a template is applied, so the manual fix only applies to sub-processes with no template. Document unlink-and-reapply as the path for existing processes that use a template. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 34f8075 commit 1f85091

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

docs/components/modeler/reference/modeling-guidance/rules/_declaring-agentic-subprocess.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
## Declare a sub-process as agentic
22

3-
This rule applies only within an ad-hoc sub-process recognized as a tool container. Camunda's provided AI Agent element templates are compatible with this rule, regardless of the template version. An ad-hoc sub-process is recognized as a tool container in either of the following ways:
3+
This rule applies only within an ad-hoc sub-process recognized as a tool container. An ad-hoc sub-process is recognized as a tool container in either of the following ways:
44

55
- Its `zeebe:modelerTemplate` attribute is set to `io.camunda.connectors.agenticai.aiagent.jobworker.v1`, which identifies the AI Agent job worker template. Any version of this template is supported.
6-
- It has a `zeebe:property` named `io.camunda.agenticai.toolContainer` with the value `true`, regardless of whether its tools are invoked by an AI Agent task in the same process or in a separate process. Starting with Camunda `8.10.0-alpha4`, the out-of-the-box AI Agent element templates add this property automatically. This property is the supported long-term approach.
6+
- It has a `zeebe:property` named `io.camunda.agenticai.toolContainer` with the value `true`, regardless of whether its tools are invoked by an AI Agent task in the same process or in a separate process. This property is the supported long-term approach.
77

8-
If you are not using an out-of-the-box template, or if your template version predates this change, add the property manually. Select the ad-hoc sub-process, open the **Extension properties** section in the properties panel, and add a property named `io.camunda.agenticai.toolContainer` with the value `true`. The property appears as a standard extension property rather than as a dedicated control:
8+
Every Camunda-provided AI Agent element template sets the `io.camunda.agenticai.toolContainer` property. The property was added to all template versions retroactively, so it isn't tied to a particular Camunda release. Templates declare it as a hidden property, so it never appears as a control in the properties panel.
9+
10+
An element template writes its properties into the diagram only when you apply it, so an ad-hoc sub-process you modeled before the property was added keeps its original XML. Existing processes need to be updated.
11+
12+
### Update an existing process
13+
14+
While an element template is applied, the properties panel shows only the sections the template defines, and the **Extension properties** section isn't available. Instead of adding the property by hand, unlink and reapply the template:
15+
16+
1. Select the ad-hoc sub-process and [unlink](../../../../hub/workspace/modeler/element-templates/using-templates.md#removing-templates) the element template. Unlinking keeps the properties you already configured.
17+
1. Apply the same element template again. Reapplying writes `io.camunda.agenticai.toolContainer` into the diagram.
18+
19+
If the ad-hoc sub-process has no element template applied, add the property manually. Select the sub-process, open the **Extension properties** section in the properties panel, and add a property named `io.camunda.agenticai.toolContainer` with the value `true`:
920

1021
![Extension properties section showing the toolContainer property on an ad-hoc sub-process with no element template applied](./img/agentic-subprocess/extension-properties.png)
1122

docs/components/modeler/reference/modeling-guidance/rules/agent-fromai-contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A `fromAi()` call within an ad-hoc sub-process that is not recognized as a tool
3535

3636
<DeclaringAgenticSubprocess />
3737

38-
Clicking this report in the Problems panel selects the tool task rather than the ad-hoc sub-process. To add the property, select the sub-process directly in the diagram. The Problems panel does not navigate to it for you.
38+
Clicking a tool container report in the Problems panel selects the tool task rather than the ad-hoc sub-process, and the Problems panel does not navigate to the sub-process for you. Select the sub-process directly in the diagram to apply either fix.
3939

4040
## References
4141

0 commit comments

Comments
 (0)