Welcome to Kofax Capture Help > Administration > Kofax Capture Values / Kofax Values

Kofax Capture Values / Kofax Values

Kofax Capture supports a set of macros that produce results based on the current Kofax Capture environment. These macros, called Kofax Capture Values or Kofax Values, can be used to fill batch fields, index fields, endorser strings, and/or export values.

Note Throughout the product, the term Kofax Capture Values is used, except in the context of export connectors, where the term Kofax Values is used.

For example, the value {Batch Class Name} produces the name of the batch class associated with the current batch. If your processing requirements dictate that the names of your batches be exported with your batches, you might use {Batch Name} as the default value for a batch field that you export with each batch.

Furthermore, you can enter special Kofax Capture Values for Index fields, export links, endorsing text, or batch fields. When the system processes such fields, the Kofax Capture Values are translated into their actual values.

Using Kofax Capture Values on Localized Systems

When using Kofax Capture Values on localized systems (or across regions), keep the following in mind.

KCN Server

Kofax Capture Values, used for endorsing strings, batch field defaults, batch field values, index field defaults, index field values, and export connector setup links, are correctly translated into the language of the localized version of Kofax Capture when a batch class is downloaded from the central site or a batch is transferred between sites.

If a Kofax Capture Value (such as {Validation Operator's Station ID}) exists in a batch field or index field when a batch is uploaded, that Kofax Capture Value is correctly translated into the language of the localized version.

English Kofax Capture Values

You can submit English Kofax Capture Values irrespective of the localized version of Kofax Capture when using the following:

  • Export Setup Link

  • Retrieve Export Value

  • Batch Field Default Value

  • Index Field Default Value

  • Batch Field Value

  • Index Field Value

  • ACCI (OCX/Input Script)

Using Export Setup Link is limited to export connectors because all current export connectors do not allow the user to type in Kofax Capture Values that are not in the localized set of suggested values. For example, an English export connector can save an English Kofax Capture Value in the export link table. During export, the Kofax Capture Value is correctly translated on a localized version of Kofax Capture.

For Retrieve Export Value, suppose during export setup the English {Batch ID} Kofax Capture Value is linked by hard coding the value in English. In this case, on a localized version of Kofax Capture, the English {Batch ID} is correctly expanded during export.

English Kofax Capture Values have the following limitations:

  • English Kofax Capture Values (on non-English versions of Kofax Capture) cannot be used for endorsing strings.

  • You can only use Kofax Capture Values that are available on the localized version of Kofax Capture.

  • You cannot use English Kofax Capture Values (on non-English versions of Kofax Capture) in the Export Setup user interface. This is because all export connectors limit the user to setting only those Kofax Capture Values that are in the list of localized possible values.

List of Kofax Capture Values

The following Kofax Capture Values are supported for batch fields, endorser strings, and index fields.

Table 1. Values for Batch Fields, Endorser Strings, Index Fields

Value

Description

{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.

{StationIDCommonName}

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.

{Batch Reference ID}

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}

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

{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 Kofax Capture 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 Capture 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).

The following values can be used for index fields and export values.

Table 2. Values for Index Fields and Export Values

Value

Description

{Document GUID}

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

{Document ID}

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

{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 Capture Value directly mirrors the value stored in the RepositoryDocumentID. If no value has been stored into RepositoryDocumentID, this Kofax Capture Value resolves to an empty string.

{Remote Validation User ID}

Reserved.

You can use the preceding Kofax Capture Values 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 Capture 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.

{First Page Image Address}

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.

A special value type can be used to produce the value of a batch field. The sequence to enter this is a { character followed by the $ character, followed by the batch field name, followed by the } 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.