Overview
Frends 6.0 introduces AI-Assisted Process Documentation, allowing users to automatically generate structured documentation for integration processes in Markdown format. This feature eliminates blank page syndrome by leveraging AI to analyze process execution flows and configuration data, generating detailed descriptions of process logic and technical details.
How It Works
AI Analyzes Process Data
The LLM receives two key inputs:
BPMN Process Flow: Describes the process flow using BPMN 2.0 schema and notation.
Element Parameter Configurations : Provides technical configurations for each BPMN element, including parameterized references (e.g., #var.foobar, #env.db.connectionString).
Generating Documentation
The AI structures documentation using a standardized format:
Description: Summary of the integration’s purpose, involved systems, dependencies, and potential exceptions.
Execution Logic: Bullet-point breakdown of the process flow, including task names, functions, and key configuration details.
Error Handling Practices: Summary of error-handling mechanisms in the BPMN flow.
Editing & Refinement
Users can refine the generated Markdown document manually, adding business context, external dependencies, or custom notes.
Process Documentation & Versioning
Process documentation in Frends is always tied to a Major and Minor version of a Process (e.g., 1.2.x).
Documentation is stored per version, ensuring that updates or changes to a Process do not affect historical documentation.
When a new Major or Minor version is created, documentation needs to be reviewed and updated accordingly.
Patch versions (x in 1.2.x) do not affect documentation.
Accessing AI-Assisted Documentation
You can access this feature in the Process Editor from the settings side panel or from the Process list context menu, where you have the option to:
Write documentation manually in Markdown.
Use the Frends Assistant to generate an initial description based on process configuration and bpmn flow.
Context Panel: Understanding Data Sent to the AI
The Context Panel (accessible via the top-right button in the documentation editor) displays all data being sent to the LLM, including:
BPMN Process Flow
Element Parameter Configurations
🔒 Security Note: Only metadata and variable references are shared—no actual data values are sent.
Security & Privacy
We prioritize security and transparency:
No Training on User Data: The AI does not retain or learn from your data.
Customizable Context: Users can review and modify what information is shared.
Audit Log for Transparency:
Admins can track all LLM sessions and review data sent to the AI.
Admins can delete log entries that may contain sensitive data.
Best Practices for AI-Generated Documentation
To make the most of this feature, follow these best practices:
Review AI Suggestions: AI-generated text is a starting point—always verify accuracy.
Refine & Expand: Add specific business logic, external dependencies, or other details not covered by the AI.
Use Markdown Effectively: Format documentation with headings, lists, tables, and code blocks for clarity.