Boolean Parameter | OptimiDoc Server Documentation

The Boolean parameter presents a simple Yes/No choice on the device panel, letting the operator set a binary flag at scan time — for example marking a document confidential, requesting review, or toggling an optional processing step.

What It Is

A Boolean parameter captures a true/false value. It is most useful for driving conditional destinations — sending confidential or urgent documents to a different location — but the resolved value can also appear in filenames and metadata.

How It Renders on the Terminal

The device panel shows a two-state toggle with Yes and No buttons, labelled with the parameter's Title. The starting position follows the configured default. When used in a placeholder, the value resolves to the text True or False.

Configuration

The Boolean type has no type-specific configuration. You set only the standard properties:

Property	Description
Title	The display name shown to the operator, e.g. "Confidential".
Key	The internal identifier used in `[key]` placeholders, e.g. `is_confidential`.
Default Value	The initial state: True, False, or left unset (`---`). Can be overridden per workflow.
Required	Whether the operator must confirm a value before scanning (rarely needed for Boolean).

Whether the operator can change the toggle is set per workflow on the Parameters tab. Set it to non-editable to enforce a fixed flag.

Using the Value

The value resolves to True or False. Referencing a parameter with key is_confidential:

Location	Example
Conditional destinations	Send the document to a secure folder when `is_confidential` is `True`
Filename	`scan_[is_urgent]` → `scan_True.pdf` or `scan_False.pdf`
Metadata	The value is included in PDF metadata and the metadata sidecar

Conditional Routing

Boolean parameters pair naturally with conditional additional destinations in the workflow's Output Options. You can add an extra destination that is only used when the parameter holds a particular value — for example:

When is_confidential = True → also deliver to the Secure Archive
Otherwise → deliver only to the General Documents folder

This lets a single workflow route documents differently based on the operator's choice at the panel.

Common Use Cases

Use Case	Key	Typical Default
Confidential document flag	`is_confidential`	False
Urgent processing request	`is_urgent`	False
Review required flag	`needs_review`	False
Include cover sheet	`add_cover`	False

Scan Parameters Reference — Overview of all parameter types and the [key] placeholder syntax
Output Options — Conditional additional destinations
Parameters Tab — Attaching parameters to workflows