Skip to content

Steps

A step is a unit of processing that a workflow runs in order from top to bottom. Add one from Add step in the editor, and drag to reorder. See Limits for the maximum number of steps.

Steps are grouped as follows when you add them.

GroupContents
Codatum actionsRun Query / Run Report / Screenshot / Email / LLM
IntegrationsSlack integrations you've already created (shown by integration name)

Each step can have an execute-if condition. For embedding values in the body, messages, and so on, see Template variables.

Run Query

Runs the specified saved query and makes the result available to later steps.

ItemDescription
QueryThe saved query to run. You select it together with its connection

Later steps can reference up to 20 rows of the result through template variables (see Limits). For example variables, see Template variables.

If you create a workflow from the right sidebar on a query detail, this step opens already configured.

Run Report Beta

Runs a report. Placing it right before a Screenshot step lets you capture the latest results.

INFO

This feature is in beta. The specification might change without notice.

ItemDescription
ReportThe report to run
Use default parametersOff by default. When on, resets parameters to the report's default values before running
Timezone for relative datesShown when Use default parameters is on. UTC is used if not set
Update report after runOff by default. When on, saves the run's results back to the report

Screenshot Beta

Captures a specific report page as a PNG. The resulting file URL can be used in a later Email or Slack attachment.

INFO

This feature is in beta. The specification might change without notice.

ItemDescription
ReportThe target report
PageThe page to capture
Run IDThe ID of the report run. If a Run Report step immediately precedes this one, a template variable referencing that step's runId might be filled in automatically
FormatType is PNG only. Theme is Light / Dark (default is light). Locale is en-US / ja-JP (defaults based on browser language)

Email

Sends email to users or groups in the workspace.

ItemDescription
ToChoose 1-20 users or groups (Limits)
SubjectUp to 200 characters. Supports template variables
BodySent as HTML. Supports template variables (up to 5,000 characters)
AttachmentOptional. You can specify a file URL from an earlier step, such as Screenshot, using a template variable

The sender is noreply@workflow.codatum.com. The email footer includes a link back to the workflow.

LLM

Runs natural language processing using an AI profile. Not selectable if Codatum AI is disabled for the workspace. When the workflow runs, the context (notebooks or folders) linked to the AI profile isn't loaded.

ItemDescription
AI ProfileThe AI profile to use. Create and review profiles under AI Profile settings
PromptThe content sent to the LLM. Supports template variables (up to 5,000 characters)

Slack

Sends a message to a specified channel. Requires a Slack integration to be created first.

Creating the integration

  1. Open global nav > Workspace settings > Options > Integrations.
  2. Select New integration, then choose Slack.
  3. In Create Slack integration, select Connect and approve on the Slack side.

Add the Codatum app to the destination channel in Slack with /invite @Codatum. If a channel doesn't appear in the list, check that the app has been invited there too.

You can also open the same settings screen from Create integration when adding a step.

Settings

The display name is the integration's name.

ItemDescription
ChannelThe destination. Select Refresh channels to fetch the list again
Message TextSupports template variables (up to 5,000 characters). For formatting syntax, see Slack's message formatting guide
FileOptional. You can specify a file URL from an earlier step
Thread (optional)Specify the message timestamp from an earlier Slack step to reply in that thread
Include Link to CodatumOn by default. Adds a link back to the workflow. Viewing the link requires owner permission