This feature is currently in beta. To have it enabled for your organization, contact Omni support.
Use cases
Workflows are flexible. A workflow can be as simple as a one-line prompt or as detailed as a multi-step agent with specific output formats and decision logic. Some examples:- Standardized reports — Generate a weekly sales summary with specific metrics, groupings, and comparisons, consistently formatted every time.
- Guided lookup — Ask the user for an account name, then pull relevant records and summarize findings in a structured format.
- Data quality checks — Run a series of queries to identify anomalies, missing values, or threshold breaches, and summarize the results.
- Onboarding helpers — Walk new users through a dataset by querying key metrics and explaining what each one means.
How workflows work
When a user clicks a workflow button:- The workflow’s
input(if defined) anddescriptionare sent to the AI as a prompt - The AI follows the instructions, which may involve generating queries, asking the user for input, summarizing results, or performing multi-step analysis — all routed through the relevant topic
- Results are displayed in the chat interface, and the user can continue the conversation to refine or follow up
Where workflows appear
- AI Assistant — In the standalone chat interface, workflow buttons display below the input field
Defining workflows
Workflows are defined in your model’s YAML files and can be set at two levels: Define workflows at the root of your model file to make them available across all topics:Workflow properties
The display name shown on the workflow button. Keep this short — aim for 2-4 words that clearly describe the task.
The instructions sent to the AI when the workflow is triggered. This can range from a single sentence to a detailed, multi-step prompt with specific output formats, decision logic, and references to topics.Write this as if you’re instructing an analyst: be specific about which data to query, how to structure the output, and what steps to follow.
An opening message that sets the initial interaction. This is sent to the AI before the
description and is useful for:- Greeting the user and explaining what the workflow does
- Asking the user for input before proceeding (e.g., an account name or date range)
input is set, the AI will typically respond to the input first, then use the description as its instructions for the rest of the conversation.Examples
Simple: one-step query
A workflow that generates a single, well-defined query:Interactive: ask the user for input first
Useinput to collect information from the user before running the analysis:
Advanced: multi-step process with structured output
For more complex workflows, thedescription can include detailed steps, output formatting, and decision logic:
Using file uploads with workflows
Users can attach files during a workflow conversation to provide additional context for the AI to work with. For example, a workflow might ask the user to upload a CSV of target accounts, then cross-reference that list against data in Omni. Supported file types include CSV, PDF, JSON, YAML, TXT, and images (PNG, JPEG). Files are processed client-side and are not stored on Omni’s servers.The Query Assistant > File uploads AI setting must be enabled for users to attach files in the chat.
Workflows vs sample queries
Both workflows and sample queries appear as buttons in the AI interface, but they serve different purposes:| Workflows | Sample queries | |
|---|---|---|
| Purpose | Provide the AI with instructions to follow | Demonstrate example questions users can ask |
| How they work | Send a prompt (simple or multi-step) to the AI | Run a predefined query with specific field selections |
| Best for | Repeatable processes, guided analysis, structured outputs | Showcasing available data and common queries |
Tips for writing effective workflows
- Be specific in the description. The more detail you provide, the more consistent the AI’s output will be. Include the fields, time ranges, groupings, metrics, and output format you want.
- Use
inputto collect context. If your workflow needs user-specific input (like an account name or date range), use theinputfield to ask for it before the AI begins its analysis. - Structure complex workflows with numbered steps. For multi-step processes, numbered steps help the AI follow your intended sequence and produce organized results.
- Specify output format. Tell the AI how to present results — tables, summaries, sections with headers, health scores — to get consistent, readable output.
- Reference topics when helpful. If your workflow should use a specific topic, mention it in the description (e.g., “use the Orders topic”).
- Test and iterate. Try your workflow in the AI Assistant to see how the AI interprets the instructions, then refine the description as needed.
- Keep labels short. Labels appear as buttons, so aim for 2-4 words that clearly describe the task.