System variables
These Kofax ReadSoft Entrance system variables are available for inserting into transaction descriptions:
| System variable | Default format | Explanation |
| X(8000) | Names of image files containing appendices associated with the document. | |
|
#BatchDate |
YYYYMMDD | Batch date. (See also: Batch variables) |
|
#BatchIdx |
N(4) | Sequence number of the document within the batch, set by the system. |
|
#BatchNo |
N(6) | Batch number, set by user or system. |
|
#BatchPrefix |
X(6) | Batch prefix, set by user or system. |
|
#BatchSize |
N(4) | Number of pages in the batch, set by user or system. |
|
#BatchTime |
hhmmss | Batch time. |
|
#Buyer |
X(100) | Buyer name. |
|
#BuyerCorporateGroupID |
X(10) | Corporate group ID. |
|
#BuyerNumber |
X(50) | Buyer number. |
|
#CertRef |
X(128) | Name of a file containing a certificate included when you interpret XML documents. |
|
#Credit |
X(1) | The value of this variable is: 1 = credit
document, 0 = not credit
document.
The
Debit/Credit field can be
used instead of
#Credit. The only possible output
values for
#Credit are 0 and 1, while the
Debit/Credit field allows you to specify any value.
|
|
#Currency |
X(3) | The three-letter abbreviation for the currency of the document definition. |
|
#Date |
YYMMDD | System date when documents were scanned/read. |
|
#Description |
X(128) | This system variable is set by ReadSoft Collector. It contains the body (Body text) of an email message. The maximum length of this variable is 128 characters. |
|
#DocRef |
X(128) | When you
interpret
image files,
#DocRef gives you the name of the file
that was originally imported, even if it was a
multi-image file that
Kofax ReadSoft Entrance
subsequently divided up into individual image files. To get the
names of the resulting image files in such cases, use
#Imagefile or
#Pages.
See also: Specifying what happens to reference files during transfer |
|
#GUID |
X(38) | The GUID of the document. Kofax ReadSoft Entrance assigns a GUID to each document when it is scanned. If the document is not scanned, a GUID is assigned in Interpret. |
|
#Id |
X(20) | This system variable is set by ReadSoft Collector. It contains a unique identifier (Identification) for an email message. The maximum length of this variable is 128 characters. |
|
#Imagefile |
-" "X(260) | Name of the file containing the image of the
front of the first page of the
document. Used when you
interpret
image files.
When you interpret multi-image files, Kofax ReadSoft Entrance divides them up into individual image files (example), and #Imagefile gives you the name of the resulting image file containing the front of the first page of the document. Exception: If the Transfer job description specifies that image files are to be converted to another format, #Imagefile gives you the name of the converted image file containing the front of the first page. To get the name of the original image file in such cases, use #DocRef. |
|
#Imagefile2 |
-" "X(260) | Name of the file containing the image of the
back of the first page of a two-sided
document. Used when you
interpret
image files.
When you interpret multi-image files, Kofax ReadSoft Entrance divides them up into individual image files (example), and #Imagefile2 gives you the name of the resulting image file containing the back of the first page of the document. Exception: If the Transfer job description specifies that image files are to be converted to another format, #Imagefile2 gives you the name of the converted image file containing the back of the first page. To get the name of the original image file in such cases, use #DocRef. |
|
#ImageRef |
X(128) | Used when interpreting XML
documents.
XML Input, an Kofax ReadSoft Entrance 5-5 feature that enables import of XML invoices in various formats and transformation of them to the Kofax ReadSoft Entrance XML schema, is not supported in Kofax ReadSoft Entrance 5-7 or later. New XML Input functionality has been included in INVOICES 5-7 and later. |
| X(120) | Values of the
line item fields.
|
|
| N(3) | Number of appendix front pages that belong to the document. | |
| N(3) | Number of appendix pages (front and back pages) that belong to the document. | |
| N(3) | Number of document front pages. Does not include appendix pages. | |
| N(3) | Number of document pages (front and back pages). Does not include appendix pages. | |
| N(3) | Number of document front pages and appendix front pages. | |
| N(3) | Number of document pages and appendix pages (front and back pages). | |
|
#Originator |
X(40) | This system variable is set by ReadSoft Collector. It contains a sender name (Sender). The maximum length of this variable is 128 characters. |
| X(8000) | Names of all image files for the
document and its appendices.
When you interpret multi-image files, Kofax ReadSoft Entrance divides them up into individual image files (example), and #Pages gives you the names of the resulting image files. Exception: If the Transfer job description specifies that image files are to be converted to another format, #Pages gives you the names of the converted image files. To get the name of the original image file in such cases, use #DocRef. When XML output is used, #Pages gives you the full path to each image file. Otherwise, only the first image files includes the full path. |
|
|
#ProcessLog |
X(150) | The contents of the
process log for the
document.
This variable includes user remarks, which in earlier Kofax ReadSoft Entrance versions were inserted using #UserRemark. This value is never truncated. If the
target system parses the transaction file
based on fixed positions in the file, we recommend placing this variable at the
end of the transaction description.
If some characters are transferred incorrectly Kofax ReadSoft Entrance cannot transfer the diacritic marks used in some alphabets. For example, the letters a, c, e, l, n, ó, s, z, and z in the Polish alphabet are not transferred correctly. This is a known problem. |
|
#Profile |
X(11) | Document profile name. |
|
#StampNumber |
X(10) | Endorser number for the document. |
|
#Status |
N(2) | Document status. The value of this variable is: Complete = 02, Approved = 11, Adjusted = 13, Rejected = 14, Scanned = 17. |
|
#SupplDesc |
X(15) | The supplier's description. |
|
#Supplier |
X(15) | Sender name. |
|
#Supplier Location |
X(38) | The location of the sender. |
|
#SupplNumber |
X(50) | Sender number. |
|
#Time |
hhmmss | System time when documents scanned/read. |
|
#Title |
X(20) | This system variable is set by ReadSoft Collector. It contains the subject line (Subject) of an email message. The maximum length of this variable is 128 characters. |
|
#UserName |
X(500) | The login name of the user who approves the document. |
|
¤FileDate |
YYMMDD | Transfer date and time. For
Start and
stop transaction descriptions only.
See also: Fields commonly included in start and stop transactions |
|
¤FileTime |
hhmmss | |
| N(6) | The number of records in the transaction. For start and stop transactions only. |