OptimiDoc Server Help Center
OptimiDoc Server Help Center
Breadcrumbs

Number Parameter

The Number parameter accepts a whole-number value entered on the device's numeric keypad, with optional minimum and maximum bounds. Use it for quantities, reference numbers, cost centres, and any other numeric metadata that should stay free of stray characters.

What It Is

A Number parameter restricts input to numeric entry, so the captured value is always a clean number suitable for filenames, metadata, and downstream processing. Values are treated as whole numbers.

How It Renders on the Terminal

The device panel shows a numeric keypad control labelled with the parameter's Title. The operator can only enter digits. If Required, a value must be provided before the scan starts. Any configured minimum and maximum bounds are enforced so the operator cannot submit an out-of-range value.

Configuration

In addition to the standard properties, the Number type offers optional range bounds:

Property

Description

Title

The display name shown to the operator, e.g. "Invoice Number".

Key

The internal identifier used in [key] placeholders, e.g. invoice_number.

Default Value

An optional pre-filled numeric value. Must fall within the configured bounds.

Required

Whether the operator must provide a value before scanning.

Minimum Value

(optional) The lowest value the operator may enter. Leave blank for no lower bound.

Maximum Value

(optional) The highest value the operator may enter. Leave blank for no upper bound.

When both bounds are set, the minimum must not exceed the maximum, and any Default Value must fall within the range — OptimiDoc validates this when you save the parameter and again when you set a per-workflow default override.

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

Using the Value

Reference the value by wrapping the parameter's Key in square brackets. For a parameter with key invoice_number:

Location

Example

Result

Filename

INV_[invoice_number]

INV_12345.pdf

Folder path

CostCentre\[cost_centre]\

Routes scans by cost centre

PDF metadata

(automatic)

The value is written to the PDF's document properties under the key invoice_number

Metadata sidecar

(automatic when enabled)

The value appears as a field in the XML/CSV/JSON index file

Common Use Cases

Use Case

Key

Example Value

Bounds

Invoice number

invoice_number

20260115001

—

Cost centre

cost_centre

4200

1000–9999

Order number

order_number

987654

—

Copies / quantity

quantity

25

1–999

In Summary

The Number type is the String type's disciplined sibling: identical in spirit but constrained to digits, with optional bounds that keep operators from entering impossible values. Reach for it whenever a field is genuinely numeric — the numeric keypad speeds entry on the panel and the bounds catch mistakes before the scan is committed.