Password Parameter | OptimiDoc Server Documentation

The Password parameter is a masked text field: characters are hidden as they are typed, so sensitive values such as PDF encryption passwords can be collected safely on a shared device. Functionally it behaves like a String, but the input is never shown on screen.

What It Is

A Password parameter collects a confidential value without displaying it. Its most common use is supplying the password that encrypts the output PDF, letting each operator set their own password at scan time instead of sharing a fixed one.

How It Renders on the Terminal

The device panel shows a text field labelled with the parameter's Title, but each character appears as an asterisk as it is typed. This keeps the value hidden from anyone watching the panel. If Required, a value must be entered before scanning.

Configuration

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

Property	Description
Title	The display name shown to the operator, e.g. "PDF Password".
Key	The parameter's internal identifier used in `[key]` placeholders, e.g. `pdf_password`.
Default Value	An optional pre-filled value. Setting a default reduces the security benefit — use with care.
Required	Whether the operator must enter a value before scanning.

Whether the operator can change the value is set per workflow on the Parameters tab.

PDF Encryption Integration

The primary use case is PDF encryption. In a workflow's PDF Settings tab:

Enable Encryption.
Reference the Password parameter as the encryption password (as a [key] placeholder, e.g. [pdf_password]).
When the operator scans and enters the password, OptimiDoc uses it to encrypt the output PDF.

This gives every scan an operator-chosen password without storing a shared secret in the workflow.

How the Value Is Handled

Location	Behaviour
PDF encryption	Primary use — the value encrypts the output PDF
Embedded PDF metadata	Password parameters are automatically excluded — OptimiDoc never writes a Password-type value into the PDF's document properties
Filename	Not recommended — a password must never be exposed in a file name
Metadata sidecar	Avoid referencing password parameters in sidecar output; treat the value as secret

Security Considerations

Consideration	Recommendation
Screen visibility	Characters are masked on entry — safe for shared devices
Default values	Avoid a default password unless your policy requires one
PDF metadata	Handled for you — Password parameters are never written to PDF document properties
Transmission	The value travels over OptimiDoc's secure communication channel
Retention	The value exists only for the duration of the scan job; it is not stored afterwards

Password vs String

Feature	Password	String
Input masking	Characters hidden	Characters visible
Screen security	Safe on shared devices	Visible to bystanders
PDF metadata	Excluded automatically	Included automatically
Functionality	Free-text input	Free-text input

Use Password whenever the value must not be seen on screen; use String for all other text input.

Scan Parameters Reference — Overview of all parameter types and the [key] placeholder syntax
PDF Settings — PDF encryption configuration
String Parameter — Visible free-text input
Parameters Tab — Attaching parameters to workflows