The String parameter is a free-text field the operator fills in at scan time. It is the most versatile parameter type, used for capturing metadata such as document titles, reference numbers, or short descriptions that vary from one scan to the next.
What It Is
A String parameter prompts the operator for any text value. It is the default type for a new parameter and carries no restrictions on the characters that can be entered, which makes it the right choice whenever the input does not fit a more specific type (a number, a date, or a fixed list).
How It Renders on the Terminal
When a workflow with a String parameter is run, the device panel shows a single-line text field with the parameter's Title as its label and the on-screen keyboard for entry. If the parameter is marked Required, the operator cannot start the scan until a value is entered. If a Default Value is configured, it is pre-filled and the operator can accept or overwrite it (unless the workflow has made the parameter non-editable, in which case the fixed value is shown but cannot be changed).
Configuration
The String type has no type-specific configuration. You set only the standard parameter properties:
|
Property |
Description |
|---|---|
|
Title |
The display name shown to the operator, e.g. "Document Title". |
|
Key |
The internal identifier used in |
|
Default Value |
An optional pre-filled value. Can be overridden per workflow. |
|
Required |
Whether the operator must provide a value before scanning. |
Whether the operator can edit the value is set per workflow on the Parameters tab, together with the per-workflow default-value override.
Using the Value
Reference the collected value by wrapping the parameter's Key in square brackets. For a parameter with key document_title:
|
Location |
Example |
Result |
|---|---|---|
|
Filename |
|
|
|
Folder path |
|
Routes into a per-department folder |
|
Email subject |
|
Inserts the text into the subject |
|
PDF metadata |
(automatic) |
The value is written to the PDF's document properties under the key |
|
Metadata sidecar |
(automatic when enabled) |
The value appears as a field in the XML/CSV/JSON index file |
Best Practices
|
Practice |
Rationale |
|---|---|
|
Use a clear, descriptive Title |
The Title is what the operator sees on the panel — make it obvious what to enter |
|
Keep the Key short and stable |
It appears in every |
|
Set a Default Value where sensible |
Reduces typing on device touchscreens |
|
Mark as Required for critical metadata |
Prevents scans that are missing essential information |
|
Prefer a List when input is from a fixed set |
A List avoids typos and keeps values consistent |
Related Articles
-
Scan Parameters Reference — Overview of all parameter types and the
[key]placeholder syntax -
Number Parameter — Numeric input with optional bounds
-
Password Parameter — Masked text input for sensitive values
-
Parameters Tab — Attaching parameters to workflows