iFlow Documenter

Generate a comprehensive Markdown technical document from any extracted iFlow — BPMN flow path, adapters, parameters, scripts, mappings and lint results — in one click.

Availability: iFlow Documenter is an Enterprise feature. Enhanced mode additionally requires an OPENAI_API_KEY for the AI executive summary.

What It Does

Open any iFlow in the Script Editor, then click the 📄 Doc button in the toolbar. CPI Studio reads the extracted iFlow directory and assembles a single Markdown document covering everything a developer or architect needs to understand the integration:

SectionSourceDetails
OverviewMANIFEST.MF + metainfo.propName, version, vendor, description, last changed
BPMN Flow Path.iflw file (BPMN 2.0 XML)Ordered step list: channels, adapters, call activities, gateways with routing conditions, error sub-processes
Adapters.iflw XML + ifl:propertyAll sender/receiver channels with adapter type and key properties
Parameters.prop + .propdef filesAll externalized parameters — value, type, description
Scripts.groovy / .js filesFile names, line counts, imported classes, function signatures
Mappings.xsl / .mmap filesXSLT and message mapping summaries
Lint ResultsCPILinter (live run)All issues found: severity, rule, location and suggestion

Modes

⚡ Quick Mode

No AI. Parses the iFlow files directly and assembles the document in seconds. The output is a complete, structured Markdown file you can save to your wiki or hand to a new developer immediately.

✨ Enhanced Mode

Adds a 2–3 sentence AI executive summary at the top — written in plain language explaining what the iFlow does, what it connects, and any notable complexity. Requires OPENAI_API_KEY and a Pro/Enterprise licence.

Using the Documenter

  1. Open any iFlow in the Script Editor.
  2. Click 📄 Doc in the toolbar.
  3. Choose Quick or Enhanced mode.
  4. Optionally tick Include source code to embed script bodies and XSLT in full.
  5. Optionally tick Include lint analysis to run CPILinter and append all findings.
  6. Click Generate.
  7. Review the rendered output inside the modal, then click ⬇ Download .md to save the file.

LeanIX Sync

If LeanIX is configured, a Sync to LeanIX checkbox appears. When ticked, the generated document is automatically pushed to the matching LeanIX fact sheet's description field after generation. The description is formatted as a clean plain-text summary (max 4 000 characters) — not the full Markdown.

Tip: LeanIX sync is additive — it replaces the fact sheet description only, not the entire fact sheet. Tags, links, and other metadata are untouched.

Output Format

The document is a standard .md file you can commit to Git, paste into Confluence, upload to SharePoint, or use as the starting point for an integration design document. Example structure:

# Order Routing iFlow — Technical Documentation

> AI Summary: This iFlow receives inbound IDOC orders from SAP ECC, routes them
> by order type through an exclusive gateway, and dispatches confirmed orders to
> a REST backend while sending rejections to an error queue.

## Overview
| Field       | Value                   |
|-------------|-------------------------|
| Name        | OrderRouting            |
| Version     | 1.4.2                   |
| Vendor      | Acme Corp               |
| Description | Routes inbound orders…  |

## BPMN Flow Path
1. **Start** — IDOC Sender (idoc)
2. **Process** — Set Properties
3. **Gateway** — Route by Order Type
   - [Standard] → Confirm Order
   - [Reject]   → Error Queue
...

## Parameters (12 total)
| Parameter         | Value              | Type   |
|-------------------|--------------------|--------|
| backendUrl        | https://api.…      | xsd:st…|
...

## Lint Results — 3 issues
| Severity | Rule               | Location      |
|----------|--------------------|---------------|
| ⚠ WARN   | HardcodedPassword  | script1.groovy|
...

Tips

← LeanIX Integration Next: Environment Vars →