OptimiDoc Server Help Center
OptimiDoc Server Help Center
Breadcrumbs

Folder Parameter

The Folder parameter lets the operator browse the workflow's destination at scan time and choose (or create) the exact subfolder the document should land in. Rather than a fixed path, the destination folder becomes an interactive choice made at the panel.

What It Is

A Folder parameter is a live folder browser tied to the workflow's destination. When the operator runs the workflow, OptimiDoc connects to that destination — a network folder, OneDrive, Google Drive, SharePoint, Dropbox, Box, and so on — lists its folders, and lets the operator drill down and pick a target. The chosen folder is then substituted into the destination path, so the scan is delivered exactly where the operator selected.

This is different from every other parameter type: its options are not configured in the parameter definition, they come entirely from the destination it is used with.

How It Renders on the Terminal

The panel shows a folder browser labelled with the parameter's Title:

  • It opens at the destination's root and lists the folders there.

  • Tapping a folder drills into it and lists its sub-folders, so the operator can navigate to any depth.

  • The operator can create a new folder at the current level and select it.

  • Selecting a folder records it as the parameter's value.

OptimiDoc reads and creates folders using the destination's own credentials, so the operator only ever sees folders they are entitled to through that destination's connection.

Configuration

The Folder type has no type-specific configuration and no default value — its behaviour is defined by the destination it is bound to. You set only:

Property

Description

Title

The display name shown to the operator, e.g. "Save to folder".

Key

The parameter's internal identifier, referenced in the destination path as [key].

Required

Whether the operator must choose a folder before scanning.

Binding the parameter to a destination

For the browser to work, the workflow's destination path (connection string) must reference the parameter's key. For example, with a Folder parameter whose key is target_folder, a folder destination path might be:

\\server\share\Scans\[target_folder]

At scan time the operator's chosen folder replaces [target_folder], and the document is written there. Attach the Folder parameter to the workflow on the Parameters tab exactly like any other parameter.

Folder vs Site

The Site parameter is the SharePoint Online counterpart of Folder: it browses SharePoint Online sites rather than folders. The two are often used together on a SharePoint Online destination — a Site parameter to choose the site/library, then a Folder parameter to choose the folder within it.

Folder Parameter vs Fixed Folder Destination

Feature

Folder parameter

Fixed folder destination

Where the folder is decided

By the operator at scan time

By the administrator in the workflow

Flexibility

Dynamic — a different folder each scan

Fixed — the same path for every scan

Best for

Operators who must choose where each document goes

Standardised, hands-off workflows

Use a Folder parameter when the destination folder legitimately varies per scan; use a fixed Folder Destination path (optionally with other placeholders such as [user_name] or [current_year]) when it does not.

In Summary

The Folder parameter hands the "where does this go?" decision to the operator, backed by a real browse of the destination itself. It carries no configuration of its own — bind its key into the destination path, mark it Required if a choice is mandatory, and the panel takes care of navigation and folder creation against the destination's live structure.