Commit 92f6a1d
authored
Workflows 9.4 content — part A (#6048)
## Summary
Adds documentation for the step categories, triggers, and authoring
patterns that ship in Workflows 9.4 GA. Follow-up to the IA restructure
([#5950](#5950)). All
schemas in this PR were cross-checked against the Kibana source of truth
([`elastic/kibana`](https://github.com/elastic/kibana)
`workflows_execution_engine`, `workflows_extensions`, `cases`, and
`agent_builder` plugins).
## What's new
**11 new reference and how-to pages:**
| Page | Covers |
|---|---|
| `steps/cases.md` | All 27 `cases.*` step types |
| `steps/data.md` | 11 `data.*` transformation steps |
| `steps/streams.md` | 3 `kibana.streams.*` steps (tech preview) |
| `steps/composition.md` | `workflow.execute`, `workflow.executeAsync`,
`workflow.output`, `workflow.fail` (tech preview) |
| `steps/while.md` | `while` step |
| `steps/switch.md` | `switch` step |
| `steps/loop-break.md` | `loop.break` step |
| `steps/loop-continue.md` | `loop.continue` step |
| `steps/wait-for-input.md` | `waitForInput` step |
| `triggers/event-driven-triggers.md` | `workflows.failed` trigger (tech
preview) |
| `authoring-techniques/human-in-the-loop.md` | HITL pattern using
`waitForInput` + resume API |
| `authoring-techniques/migrate-from-9.3.md` | 9.3 → 9.4 migration guide
|
**Expansions to existing pages:**
- `steps/ai-steps.md` — adds `ai.classify` and `ai.summarize` as
first-class step types; updates `ai.agent` with the `attachments` input
parameter and the correct output shape (`message` / `structured_output`
/ `conversation_id`).
- `steps/kibana.md` — documents `kibana.SetAlertsStatus` (all 5 body
params) and `kibana.SetAlertTags` with their PascalCase type IDs; lists
the deprecated Case aliases.
- `steps/flow-control-steps.md` — restructured as an overview of all 8
flow-control types with links to per-step child pages.
- `steps/action-steps.md` and `steps.md` — add Cases, Streams, Data, and
Composition to the step-category overview.
- `triggers.md` — adds event-driven trigger section.
## Open questions for reviewers
- **SME check requested on `workflows.failed`**: Does this trigger
support `on.condition` KQL filtering? The PM docs reference it, but the
common trigger schema doesn't currently expose it. If the filter exists
elsewhere in the registration pipeline, we'll add a filter section to
`triggers/event-driven-triggers.md`. /cc @shahargl
- **Resume API body shape on `waitForInput`**: The Kibana README example
shows direct output access (`steps.<name>.output.approvedBy`). PM docs
said the resume API wraps the body in `{ "input": ... }`. The HITL page
uses the README's direct-access form with a `%` comment flagging this.
Please confirm which is accurate before merge.
- **Cases step schemas beyond the five I read directly** (`createCase`,
`setCustomField`, `createCaseFromTemplate`, `updateCase`, `findCases`,
`addAlerts`, `addObservables`, plus the shared config): parameters for
the other 20 are adapted from PM docs. Engineering confirmation
appreciated, especially on `cases.findCases` query fields and
`cases.updateObservable`.
## How to review
1. **Nav diff**: See `explore-analyze/toc.yml` lines 464–494 for the new
IA shape.
2. **Big pages to read carefully**: `steps/cases.md` (27 sections),
`triggers/event-driven-triggers.md` (schema rewrite),
`authoring-techniques/migrate-from-9.3.md`.
3. **Small, mechanical changes**: `applies_to` bumps from `preview 9.3`
→ `ga 9.4` across ~20 existing files.
## Test plan
- [ ] Docs build passes with no broken internal links
- [ ] All 44 toc-referenced files resolve
- [ ] No Vale errors (warnings are false positives for Vale regex
matching "etc" inside "Fetch" / "getSignificantEvents")
- [ ] Nastasha: structural and style review
- [ ] Tinsae: confirm the new `cases.*`, `data.*`, and `composition`
content reflects the 9.4 GA product
- [ ] Engineering: resolve the two SME questions above
## Out of scope (for PR B and PR C)
- End-to-end pattern tutorials (alert→enrich→case, approval-gated
remediation, and so on) — PR B, as children under the Use cases outcome
sections.
- Reference lookup content: cheat sheet, step type A–Z index, full
context variables reference, Liquid filters reference, glossary,
troubleshooting FAQ — PR C.
- Anatomy of a workflow page, Settings page, enhanced error handling —
PR C.
## Related
- Parent IA restructure: #5950
- PM internal docset (private, Elastic-only):
elastic/workflows-internal-docs
- Kibana workflows plugins:
`src/platform/plugins/shared/{workflows_execution_engine,workflows_management,workflows_extensions}`;
`x-pack/platform/plugins/shared/cases/common/workflows/steps/`;
`x-pack/platform/plugins/shared/agent_builder/common/step_types/`
## Generative AI disclosure
1. Did you use a generative AI (GenAI) tool to assist in creating this
contribution?
- [x ] Yes — Claude 4.7 / Cursor
- [ ] No1 parent ddc5592 commit 92f6a1d
45 files changed
Lines changed: 2816 additions & 252 deletions
File tree
- explore-analyze
- workflows
- authoring-techniques
- get-started
- steps
- triggers
- use-cases
- security
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
471 | 471 | | |
472 | 472 | | |
473 | 473 | | |
| 474 | + | |
474 | 475 | | |
475 | 476 | | |
| 477 | + | |
476 | 478 | | |
477 | 479 | | |
478 | 480 | | |
479 | 481 | | |
480 | 482 | | |
481 | 483 | | |
482 | 484 | | |
| 485 | + | |
483 | 486 | | |
484 | 487 | | |
485 | 488 | | |
486 | 489 | | |
487 | 490 | | |
488 | 491 | | |
| 492 | + | |
| 493 | + | |
489 | 494 | | |
490 | 495 | | |
491 | 496 | | |
492 | 497 | | |
493 | 498 | | |
| 499 | + | |
| 500 | + | |
494 | 501 | | |
| 502 | + | |
| 503 | + | |
| 504 | + | |
495 | 505 | | |
| 506 | + | |
| 507 | + | |
496 | 508 | | |
497 | 509 | | |
498 | 510 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
| 3 | + | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
5 | | - | |
| 4 | + | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
22 | 23 | | |
23 | 24 | | |
| 25 | + | |
24 | 26 | | |
25 | 27 | | |
26 | 28 | | |
| |||
Lines changed: 158 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
5 | | - | |
| 4 | + | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
0 commit comments