Automation Overview

This document contains an overview of DocStudio Automations and available automation bricks.

Automations

DocStudio Automations allow you to create and run workflows that perform a sequence of predefined operations automatically. An automation contains a name, an active state, and a workflow consisting of at least two connected bricks.

A brick is an individual workflow component that performs a predefined operation. Each brick has its own type, configuration, and position in the execution sequence.

Workflow structure

Each brick has a unique ID and a type that determines the operation it performs. The next property specifies which brick or bricks are executed next, allowing the workflow to follow a linear sequence or branch into multiple execution paths.

The config object contains the settings required by the selected brick type. Depending on the type, these settings can include input files, transformation expressions, filters, connection parameters, processing rules, output file names, and other operation-specific values. The configuration supported by each brick type is defined by its configSchema.

Brick types that connect to external systems or services may also require stored credentials. In this case, the brick references the required credentials using credentialsId.

Passing data between bricks

Some brick types expose named output parameters that can be used by subsequent bricks. When an output parameter matches a configuration field required by the next brick, its value is passed automatically.

In this example, envelope-trigger provides the envelope and mailbox output parameters. Because envelope-label-assignee requires parameters with the same names, their values are supplied automatically, and only label must be specified in its config.

Available bricks

The following bricks are currently available for building automation workflows:

Name	Purpose
webhook-sender	Sends data to a configured webhook URL
json2xml-converter	Converts JSON data to XML
google-document-ai	Processes documents using Google Document AI
envelope-flow-resolver	Resolves an envelope flow and replaces recipient emails with available auto-deposit mailboxes
sftp-uploader	Uploads a file through SFTP
parameter-extractor	Extracts values from input data using XPath or JSONPath expressions
envelope-initiator	Initiates an envelope using data from a source file
api-caller	Sends a GET or POST request to an external API
jsonata-converter	Transforms JSON data using a JSONata expression
sftp-receiver	Receives files through SFTP and filters them using a configured pattern
vchasno-callback-checker	Checks a Vchasno callback using the configured document type and configuration ID
envelope-trigger	Selects envelopes based on configured filters and provides the matching envelope and mailbox
xsd-validator	Validates input against an XSD schema
xslt-converter	Transforms XML data using an XSLT map
if-condition	Evaluates a condition using XPath or JSONPath
sch-validator	Validates input using a Schematron schema
as2-sender	Sends data to an external system through AS2
as2-receiver	Receives data through AS2
envelope-saver	Saves an envelope
gemini	Processes data using a configured Gemini model and prompt
openai	Processes data using a configured OpenAI model and prompt
document-extractor	Extracts a document from an envelope
webhook-receiver	Receives data through a webhook
envelope-approver	Approves an envelope
envelope-label-assignee	Assigns a label to an envelope
eancom2xml-converter	Converts EANCOM data to XML
envelope-filler	Fills an envelope
excel2xml-converter	Converts Excel data to XML
envelope-delegator	Delegates an envelope to another mailbox
envelope-sender	Sends an envelope