Kofax Capture supports a set of macros that produce results based on the current Kofax Capture environment. For example, the value {Batch class} produces the name of the batch class for the current batch.

{Batch Class Name}

The name of the associated batch class.

{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 Description}

The description of the current batch.

{Batch ID}

A unique, sequential number associated with the batch. It is assigned by Kofax Capture when a batch is created.

{Batch Name}

The name of the current batch.

{Current Date}

The current system date.

{Current Time}

The current system time.

{Document Class Name}

The name of the associated document class.

{Document Count}

Reserved. This value is currently used by Kofax Capture, but may be implemented in a future version.

{Document Form Name}

The name of the associated form type.

{Document GUID}

A type of document ID that is unique across the central site and all remote sites that comprise an Kofax Capture installation. This Kofax Capture 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 of 123 will yield {D3C58EE2-5627-443b-BBFA-EE7A5790482A}123 as the document GUID.

{Document ID}

A unique, sequential number associated with the document. This ID is assigned by Kofax Capture.

Kofax Values for First Page Endorsing Information

The following values are derived from the endorsing information for the first page of the current document (when endorsing has been performed at scan time). These values may be used in index fields and in export values. Note that there is currently 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.

{First Page Image Address}

The image address. Used only by Kodak scanners that support image address.

{First Page Original File Name}

The original file name and extension of the first page of the document. The extension of image files is .tif (unless the document is an eDocument or JPEG). 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.

{First Page Roll Number}

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

In addition, a special value type can be used to produce the value of a batch field. The sequence to enter this is an opening brace character { followed by the dollar sign $ character, followed by the batch field name, followed by the closing brace } character. For example, the value {$Text1} would produce the runtime value of the batch field Text1. Batch field values may be utilized in endorser strings, index fields, and export fields.

{Index Operator's Station ID}

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

Note The value {Index Operator's Station ID} has been deprecated, and replaced by {Validation Operator's Station ID}. It is strongly recommended that you use {Validation Operator's Station ID} instead.

{Operator Description}

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

Batch Manager

If the User Profiles feature is not enabled, the returned value will be NULL.

{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 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, will be used. If there is no logged in Windows user ID, the returned value will be unknown.

{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, will be used. If there is no logged in Windows user ID, the returned value will be unknown.

{Remote Validation User ID}

The user ID of the remote validation operator who processed the document.

{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 value directly mirrors the value stored in the RepositoryDocumentID (exportData Object). Notice that when you are passing the RepositoryDocumentID to a different export connector, the export connector must exist within the same document class using multiple export. In addition, the export connector that is passing the RepositoryDocumentID information must be placed first in the list on the Export Connectors window. Only the first export connector that sets the RepositoryDocumentID value can use the document ID.

When this value is used by a subsequent connector, the value is the document image URL in SharePoint.

Subsequent export connectors can only read this value.

If no value has been stored into RepositoryDocumentID, the value resolves to an empty string.

{Scan Operator's Station ID}

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

{Site ID}

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

{Station ID}

Kofax Capture Station ID, which is the name associated with the export workstation.

{User Name}

Windows user name.

{Validation Operator's Station ID}

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