Lifecycle DocScript System Variables for v4.6

Building Lifecycle Applications for v4.5 and v4.6


The following variables are used by the generic connector and can be referenced at any time during the script: 

Variable Name Description
{batchn} The name of the current batch.
{batchid} The ID of the current batch.
{filepath} Stores the Root Address of the document. This also includes any calculated folders to provide the actual path to the document.
{filepathrel} Stores the Relative Root Address of the document. This also includes any calculated folders to provide the actual path to the document
{docname} The name of the current document with the extension, excluding the path
{docnamenx} The name of the current document without the extension, excluding the path
{fdocname} The name of the current document with the extension, including the path
{docpath} The document file path without the name of the document, without the trailing "\"
{odocname} The name of the document from its source location, excluding the path
{odocnamenx} The name of the document from its source location without the extension, excluding the path
{ofdocname} The name of the document from its source location with the extension, including the path
{odocpath} The document file path from its source location without the name of the document, without the trailing "\"
{ignore} If set to True, it allows a document to be ignored during capture, indexing or distribution
{batchdocs} An array documents inside the batch, used in Distribution
{cbatchdoc} Current position in the batchdocs array
{docpages} Used when documents are split into smaller documents using business rules. The docpages is an array that stores the documents broken down from a master document
{luidxnames} Used in Capture or Distribution to store an array of index names to be used in a lookup against the target document management system.
{luaction} This is used in conjunction with luindxnmes. If a match found of the all the index values referenced in the luidxnames then luaction determines what function to perform:
  • newdoc - creates a new document
  • appenddoc - appends the current document found
  • newver - creates a new version of the document found. Append currently works with TIFF documents
{revcomment} This can be set if the newver of the document this can be set for reference
{docrevision} This can be set if the newver of the document this can be set for reference
{squote} This is literal for a '.
{crlf} This is a literal for carriage return, line feed.