User List Parameter | OptimiDoc Server Documentation

The User List parameter lets the operator pick a person from the OptimiDoc user directory at scan time. You choose which user attribute the selection resolves to — email address, home folder, or login — so the same picker can drive an email recipient, a personal delivery folder, or a login-based value.

What It Is

A User List parameter shows the OptimiDoc users as a searchable list. The operator selects a person; the value stored is not the person's display name but the configured attribute of that user (their email, home-folder path, or login). This makes the type genuinely useful for routing — for example resolving a chosen recipient straight to their email address or personal folder.

How It Renders on the Terminal

The device panel shows a searchable selection list labelled with the parameter's Title. Because user directories are usually large, the list is searchable: the operator types part of a name or value to filter, and OptimiDoc matches against the user's first name, surname, and the selected attribute value. Selecting a user stores that user's attribute value.

Configuration

The User List type has two type-specific settings:

Field	Description
User Attribute	Which attribute of the selected user is stored as the value: Email, Home folder, or Login. Choose the one that matches how you will use the value (e.g. Email for an email destination, Home folder for personal delivery).
Prefetch Data	When enabled, the user list is loaded ahead of time for faster display. When disabled, users are fetched (and searched) on demand as the operator types — better for very large directories.

Standard properties

Property	Description
Title	The display name shown to the operator, e.g. "Recipient".
Key	The parameter's internal identifier used in `[key]` placeholders, e.g. `recipient`.
Default Value	Optional. Use the [CURRENT_USER] button to default to the signed-in operator's own attribute value. Can be overridden per workflow.
Required	Whether the operator must select a user before scanning.

The [CURRENT_USER] default is special: at scan time it resolves to the logged-in operator's value for the chosen attribute (their own email, home folder, or login). This is a common way to deliver a scan back to the person who made it.

User Data Source

The list is drawn from the OptimiDoc user directory and includes users from every source:

Synchronised from Active Directory / LDAP or Azure AD
Imported via CSV import
Created locally

Only users who have a value for the selected attribute (e.g. an email address) contribute a usable entry.

Using the Value

The value is the selected user's chosen attribute. For a parameter with key recipient and attribute Email:

Location	Example	Result
Email destination	Recipient address `[recipient]`	Delivers to the selected user's email
Folder path (attribute = Home folder)	`[recipient]\Scans\`	Delivers into the selected user's home folder
Filename	`[recipient]_[timestamp]`	Includes the attribute value in the name
Metadata	(automatic)	The value is included in PDF metadata and the metadata sidecar

Common Use Cases

Use Case	Key	Attribute
Send scan to a chosen colleague	`recipient`	Email
Deliver to a chosen person's home folder	`owner`	Home folder
Record the responsible login	`approver`	Login
Deliver back to myself	`me` (default `[CURRENT_USER]`)	Email or Home folder

In Summary

The User List parameter is more than a name picker: by resolving to a concrete user attribute, it turns "who?" into an actionable email address, folder, or login. Pick the attribute that matches the downstream use, offer [CURRENT_USER] when the operator is usually the recipient, and let the searchable panel handle even large directories.

Scan Parameters Reference — Overview of all parameter types and the [key] placeholder syntax
List Parameter — Inline key/value list
Email Destination — Using a parameter value as the recipient
Parameters Tab — Attaching parameters to workflows