Kofax Values

{Current Time}

The current system time.

{Current Date}

The current system date.

{User Name}

Windows user name.

{Station ID}

Kofax Capture Station ID, which is the name associated with the workstation, with the Windows session number appended to it.

Kofax Capture Station ID, which is the name associated with the workstation, without the Windows session number appended to it.

{Site ID}

Kofax Capture Site ID, which is the name associated with the Kofax Capture installation.

{Batch ID}

A unique, sequential number associated with the batch; assigned when a batch is created.

{Batch Name}

The name of the current batch.

Reference passed from a batch to its child batches; used for internal purposes only.

{Batch Description}

The description of the current batch.

{Batch Creation Date}

The date the current batch was created.

{Batch Creation Time}

The time the current batch was created.

{Batch Creator's Station ID}

Kofax Capture Station ID of the computer where the batch was created.

{Batch GUID}

A type of batch ID that is unique across the central site and all remote sites that comprise a Kofax Capture installation.

{Scan Operator's Station ID}

Kofax Capture Station ID of the computer used to scan the batch.

{Scan Operator's User ID}

The user ID for the scan operator.

{Validation Operator's Station ID}

{Index Operator's Station ID}

{Batch Class Name}

The name of the associated batch class.

{Document Count}

Reserved.

{Document Creation Date}

The date the current document was created.

{Document Creation Time}

The time the current document was created.

{Operator User ID}

The user ID of the logged in Kofax Capture user. Since different Kofax Capture users may process the same batch, the user ID captured depends on the module where the value is processed: Batch Manager, Scan, Validation, or Export.

If the Kofax Capture User Profiles feature is not enabled, the logged in Windows user ID, if applicable, is used. If there is no logged in Windows user ID, the returned value is “unknown.”

{Operator Name}

The user name associated with the user profile, if any, of the logged in Kofax Capture user. The user name captured depends on the module where the Kofax Value is processed: Batch Manager, Scan, Validation, or Export.

If the Kofax Capture User Profiles feature is not selected, the logged in Windows user ID, if applicable, is used. If there is no logged in Windows user ID, the returned value is "unknown."

{Operator Description}

The description, if any, of the logged in Kofax Capture user. The description captured depends on the module where the Kofax Capture Value is processed: Batch Manager, Scan, Validation, or Export.

If the User Profiles feature is not enabled, the returned value is null.

{Queue}

Name of the process that is currently running in the batch class workflow.

{Sequence Number}

A sequence number that increments by one for each batch class. The default value for {Sequence Number} is 0. This value can increment up to 2,000,000,000. If the value becomes greater than 2,000,000,000, the value is set to 0 again.

{UTC Offset}

UTC Offset is used to provide Coordinated Universal Time (Greenwich Mean Time) as part of the generated batch name. For example, when used with Pacific Time, the UTC Offset value generates (-7:00).

{Document GUID}

A type of document ID that is unique across the central site and all remote sites that comprise a Kofax Capture installation. This Kofax Value is the concatenation of the Batch GUID and the document ID number. For example, a Batch GUID of {D3C58EE2-5627-443b-BBFA-EE7A5790482A}, and a document ID number of 123 yield {D3C58EE2-5627-443b-BBFA-EE7A5790482A}123 as the Document GUID.

{Document ID}

{Document Form Name}

The name of the associated form type.

{Document Class Name}

The name of the associated document class.

{Repository Document ID}

This is a specific value that can be read/written by export connectors to store and retrieve the document ID used by the first invoked Export Connector. This Kofax Value directly mirrors the value stored in the RepositoryDocumentID. If no value has been stored into RepositoryDocumentID, this Kofax Value resolves to an empty string.

{Remote Validation User ID}

Reserved.

You can use the preceding Kofax Value as default values in index fields. If an index field is blank at export time, and the document has not been indexed, then the default value is used (in this case the "expanded" Kofax Value).

The following values are derived from the endorsing information for the first page of the current document (when document separation has been performed at scan time). These values may be used in index fields and in export values. There is no way to retrieve endorser information for pages other than the first.

{First Page Endorsing String}

The endorsing string (prefix plus counter). Not used by Kodak scanners, except for models 1500, 2500, and 3500.

The image address (used only by Kodak scanners that support image address).

{First Page Roll Number}

The roll number for the film being scanned. Used only by Kodak scanners that support microfiche scanning.

{First Page Original File Name}

The original file name and extension of the first page of the document. The extension of image files is always .tif. Note that because the final extension of image files can be changed at export time, this name may not match the exact name of the exported image. If the first page image file was not imported and the original file name has not been set via some other means, this value returns an empty string.