Kofax Values

Kofax Values consist of a set of macros that produce results based on the host Kofax application environment. For example, when you use Kofax TotalAgility, the value "{Name}" produces the name of the current runtime document.

Kofax Values by product:

Kofax Values for Kofax TotalAgility

The following Kofax Values are supported for system fields.

Value

Description

{InstanceID}

ID of the runtime document.

{ParentID}

ID of the runtime parent folder.

{RepositoryDocumentID}

Repository ID of the runtime document.

{Name}

Name of the runtime document.

{FileName}

File name of the email attachment. After ingesting an email attachment into Kofax TotalAgility, use the file name in a process, for example, as an input to a capture activity. At runtime, the file name of the email attachment is retrieved.

{Type}

Name of the document type.

{Valid}

Determines if the runtime document is valid.

{ReviewValid}

Determines if the runtime document is valid (set during document review).

{ReviewForcedValid}

Determines if the runtime document is forced valid (set during document review).

{Verified}

Determines if the runtime document is verified.

{Rejected}

Determines if the runtime document is rejected.

{RejectionReason}

Rejection reason of the runtime document.

{OnlineLearningOptions}

Online learning options of the runtime document.

{OnlineLearningComments}

Online learning comments of the runtime document.

{ErrorDescription}

Error description of the runtime document validation.

{NoOfPages}

Number of documents in the runtime folder.

{IsReadOnly}

Determines if the runtime document is read-only.

{CurrentTime}

The time at the moment of export. Represented in the format configured in the regional settings of the operating system.

Example: 11:18:58 PM

{CurrentUTCTime}

The time at the moment of export. Modified to correspond to the current time at the UTC+00:00 time zone and represented in the universal format.

Example: 07:18:58

{CurrentDate}

The date at the moment of export. Represented in the format configured in the regional settings of the operating system.

Example: 4/23/2022

{CurrentUTCDate}

The date at the moment of export. Modified to correspond to the current time at the UTC+00:00 time zone and represented in the universal format.

Example: 2022-04-23

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.