Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.docpipe.ai/llms.txt

Use this file to discover all available pages before exploring further.

The pipeline editor is a visual canvas where you design your pipeline by adding nodes and connecting them with edges.

​
Node rail

The node rail is a compact icon strip on the left edge of the editor. It groups nodes into three categories:
  • Triggers
  • Actions
  • Outputs
Hover any category icon to expand the rail into a floating palette listing every node in that category, along with a Search nodes field that filters by name or description. Click an expanded category to pin the palette open so it stays visible while you work. Click it again to unpin. To add a node, drag a card from the expanded palette onto the canvas. A highlighted ring appears on the canvas while you drag to confirm the drop target.
When the canvas is empty, an inline hint reads “Drag a trigger from the left to begin.” Start there, then connect actions and outputs as you build out the pipeline.
See node types for a complete reference of all available nodes.

​
Connecting nodes

Click the output handle of one node and drag to the input handle of another node to create an edge. Edges define the flow of data through your pipeline. Rules for connections:
  • Data flows from left to right (trigger → action → output)
  • You cannot create circular connections
  • Some node types support multiple input or output connections
  • Edges between incompatible node types are prevented
When you finish dragging an edge, an inline popover appears at the edge midpoint with quick choices for the edge’s condition: Always, On success, On failure, If… (expands a field, operator, value editor inline), and Otherwise. Pick one to set the condition without opening the properties panel, or press Esc to keep the On success default. See conditional routing for the full set of edge condition types and operators.

​
Branch from a node

To author multiple outgoing branches in one shot, click the branch action in a node’s hover toolbar. The Add branches modal lets you list several rules and optionally add an Otherwise edge. DocPipe creates one outgoing edge per rule, each wired to a placeholder target that you can replace with a real node.

​
Properties panel

Click a node or edge to open the properties panel on the right side of the editor. The panel slides in from the right and shows the configuration fields for whatever you selected. Click outside the panel to close it.
  • Pin the panel using the pin button in the top-right corner to keep it open as you click between nodes. When pinned with nothing selected, the panel shows a “Select a node to edit its properties” placeholder.
  • Resize the panel by dragging its left edge. The panel width is constrained between a minimum and maximum so your canvas stays usable.

​
Data picker

When you select a node, a Data picker column opens beside the properties panel and lists every upstream node’s output as a tree of fields. The picker helps you discover what is available to reference without leaving the editor.
  • Browse: expand any upstream node to see its payload, metadata, and nested fields. Object and array fields expand inline.
  • Insert a token: click any field to insert its template token ({{nodeName.payload.field}}) into the focused template editor, or drag the field onto the editor.
  • Sample values: select a document from the toolbar to see real values from that document’s latest run beside each field. Without a document, the picker shows the field schema only.
  • Loop iteration: when the selected node sits inside a Loop body, the picker exposes the per-item iteration token alongside the loop source array so you can reference item.path instead of the full collection.
Drag the picker’s left edge to resize it.

​
Code editors

Some node configurations include code editors, such as the validation node script mode and JSON Schema fields. The editors are powered by Monaco and provide:
  • Syntax highlighting for JavaScript and JSON
  • Autocomplete suggestions including template variable autocomplete. Type {{ to see available variables from upstream nodes
  • Inline error reporting with underlined errors and hover details
  • JSON validation for schema fields, showing errors when the JSON structure is invalid

​
Editor toolbar

Above each code editor, a toolbar provides formatting buttons for common operations like indenting, commenting, and wrapping selections.

​
Fullscreen editing

Click the expand button in the top-right corner of any code editor to open it in fullscreen mode. This gives you a larger workspace for complex scripts or schemas. Press Escape or click the collapse button to return to the inline view.

​
Canvas toolbar

The toolbar sits above the canvas at full width and contains the primary editing controls:
  • Save (Ctrl+S): save the current pipeline. An amber indicator appears if the pipeline saved but has validation errors
  • Activate / Active: activate or deactivate the pipe directly from the editor
  • Undo (Ctrl+Z) and Redo (Ctrl+Shift+Z): step through edit history for your current session
  • Auto layout (Ctrl+L): reorganize nodes into a clean left-to-right layout
  • Pipeline versions: open the version history drawer (see below)
  • More actions menu: Revert to saved, Revert to last valid (when the current save is invalid), Use template to populate the canvas from a saved template, Export to file, Import from file, and Validate pipeline
A small Unsaved changes badge appears in the top-left of the canvas whenever you have pending edits. Hover it to see a list of the added, modified, and removed nodes and edges.

​
Pipeline versions

DocPipe snapshots the pipeline on every save. Click the history icon in the toolbar to open the Pipeline versions drawer. The drawer has three regions:
  • Version list on the left: every saved version, newest first, with the version number, commit message, and timestamp.
  • Diff panel on the right: when you select a version, the panel shows what differs between that version and the current draft (added, modified, and removed nodes and edges).
  • Restore vN button at the bottom: replaces the current draft with the selected version. A new entry titled Restored from vN is appended to history, so the restore itself is reversible. Unsaved draft changes are lost when you confirm.
Use versions to recover from a bad change, compare two states, or review what shipped on a given date.

​
Export and import

To move a pipeline between workspaces or share it with another DocPipe account:
  • Export to file in the More actions menu downloads the current pipeline (nodes, edges, and node configuration) as a JSON file.
  • Import from file lets you pick a previously exported JSON file. The contents replace the current draft, so save first or accept the confirmation dialog when you have unsaved changes.
Connectors are exported by name, not by ID. If the imported pipeline references a connector that does not exist in the destination workspace, DocPipe imports the pipeline and shows a warning listing the unbound connectors so you can reconfigure them.

​
Saving and validating

  • Click Save to save your current pipeline configuration
  • The editor validates your pipeline automatically and shows errors if the configuration is invalid
  • Common validation errors: missing trigger, disconnected nodes, missing required configuration

​
Testing runs

Use the run controls in the toolbar to test your pipeline with a document from the current pipe.
  • The document picker only shows documents from the current pipe
  • You can test with documents in Uploaded, Completed, or Failed status
  • The toolbar includes a Test mode and Real mode switch

​
Test step

To re-run a single node without re-executing the whole pipeline, hover any node and click the Test step action in the floating toolbar, or open the node’s execution dialog and click Test step. DocPipe creates a partial run that:
  • Reads predecessor outputs from the most recent full run for the selected document, so the node receives the same inputs it saw before.
  • Executes only the selected node. Descendants stay frozen and do not run.
  • Records the result on a new run row tagged as a partial run, so the original full run is not modified.
Use this to iterate on a node’s configuration after tweaking a schema, prompt, or template without paying credits to re-run upstream extraction every time.

​
Test mode

Use Test mode when you want to inspect output deliveries without sending callback requests or emails.
  • Callback nodes show a request preview instead of sending the request
  • Email output nodes show an email preview instead of sending the email
  • The run output clearly shows that the result is a test mode preview
Test mode only changes callback and email output delivery. Action nodes such as HTTP action and validation endpoint checks still run normally.

​
Real mode

Use Real mode when you want output nodes to send real requests and emails.
When Real mode is on, callback and email output nodes send real external outputs during the run.
If you click Run while Real mode is selected, DocPipe asks you to confirm before it starts the run.

​
Activating

After saving a valid pipeline, click Activate on the pipe to start accepting documents. You can also activate from the pipe’s settings tab.

​
Undo and redo

Use Ctrl+Z to undo and Ctrl+Shift+Z to redo changes in the editor. The undo history is maintained within your current editing session.