This section lists the macros that produce results based on the current Kofax Capture environment. For example, {Batch Class Name} produces the name of the batch class associated with the current batch.

{Batch Class Name}

The name of the batch class associated with the 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 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 GUID}

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

{Batch Name}

The name of the current batch.

{Batch Reference ID}

The reference ID of the 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 Creation Date}

The date the current document was created

{Document Creation Time}

The time the current document was created

{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 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 is performed at scan time). These values may be used in index fields and 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 {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 Kofax Values are 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 will depend on the module where the Kofax Values are 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 will depend on the module where the Kofax 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.

{Queue}

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

{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 (ReleaseData 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, this value is the document image CMIS Object ID (or for SharePoint, it is the SharePoint Document ID). Subsequent export connectors can only read this value.

For IBM Content Manager Enterprise: The RepositoryDocumentID is used to store the CMIS Object ID, which is equivalent to the Document ID, such as 923 ICM8 icmnlsdb12 ICMDRFOLDERS59 26 A1001001B80C16B64808I5935418B80C16B64808I593541 14 1005.

If no value has been stored into RepositoryDocumentID, then this Kofax Value resolves to an empty string.

{Scan Operator's Station ID}

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

{Scan Operator's User ID}

Kofax Capture User ID of the operator that scanned the batch.

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

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

{User Name}

Windows user name.

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

{Validation Operator's Station ID}

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

This section lists the macros that produce results based on the current Kofax TotalAgility environment. For example, {NoOfPages} produces the number of pages in the runtime document.

{Instance ID}

ID for the runtime document.

{Name}

Name of the runtime document.

{Type}

Name of the document type.

{ParentID}

ID for the runtime parent document.

{NoOfPages}

Number of pages in the runtime document.

{Valid}

Indicates whether the runtime document is valid.

{Error Description}

Error description of the runtime document validation.

{ReviewValid}

Indicates whether the runtime document is valid (set during Document Review).

{ReviewForcedValid}

Indicates whether the runtime document is forced valid (set during Document Review).

{Verified}

Indicates whether the runtime document is verified.

{Rejected}

Indicates whether the runtime document is rejected.

{RejectionReason}

Rejection reason for the runtime document.

{IsReadOnly}

Indicates whether the runtime document is read only.

{OnlineLearningOptions}

Online learning options for the runtime document.

{OnlineLearningComments}

Online learning option comments for the runtime document.

{FileName}

File name for the runtime document.

This section lists the macros that produce results based on the current Kofax Express environment. For example, {User Name} produces the name of the current logged-in user.

{Batch Creation Date}

Batch creation date in the format of the current locale.

{Batch Creation Time}

Batch creation time in the format of the current locale.

{Batch Name}

Name of the batch.

{Current Date}

Current system date in the format of the current locale.

{Current Time}

Current system time in the format of the current locale.

{Document Count}

Number of documents in the batch.

{Document ID}

A unique, sequential number associated with the document.

{Document Number}

Sequential document order within the current batch.

{Document Number with Zeros [8]}

Sequential document order within the current batch, with leading zeros.

{First Page Original File Name}

Original file name of the first page when imported. Example: 000000001.tif

{Job Name}

Name of the job.

{Station ID}

Current computer/workstation name.

{User Name}

Current logged-in user.

{UTC Offset}

UTC offset for the current time zone. Example: (+7:00)