Available Tokens


The following tokens are available at the "bundle" level and "document" level.

NameSpace Token Name Example Usage Description
UTIL     Utility Tokens
    The values for the date related tokens in this namespace are captured once at the start of
the bundling process and are never modified afterward.
  empty $$UTIL.empty$$ empty string
  guid $$UTIL.guid$$ system generated 32 character GUID
  linefeed $$UTIL.linefeed$$ carriage return / linefeed
  date $$UTIL.date$$ current date (no time) Usually used with extended token syntax with a format mask
  dateTime $$UTIL.dateTime$$ current datetime with second precision
  dateTimeExt $$UTIL.dateTimeExt$$ current datetime with millisecond precision
  dateTimeUtc $$UTIL.dateTimeUtc$$ current datetime formattted with UTC universal sortable format mask (u)
  dateTimeUtcExt $$UTIL.dateTimeUtcExt$$ current datetime formattted with UTC rount-drip sortable format mask (o)
  xdate $$UTIL.xdate$$ current date formatted with mask: yyyyMMdd
  xdateTime $$UTIL.xdateTime$$ current date formatted with mask: yyyyMMddHHmmss
  xdateTimeExt $$UTIL.xdateTimeExt$$ current date formatted with mask: yyyyMMddHHmmssfff
  xtime $$UTIL.xtime$$ current date formatted with mask: HHmmss
  xtimeExt $$UTIL.xtimeExt$$ current date formatted with mask HHmmssfff
       
PROC     Real Time Processing Tokens
    The PROC namespace has the same available token names as the UTIL namespace plus
the additions listed below. However, the date field related tokens in the PROC namespace
are reset at each internal processing step (stepCount), such as the start of processing of each bundled document, etc.
  stepCount $$PROC.stepCount$$ internal processing step count
  elapsedTime $$PROC.elapsedTime$$ elapsed time span since processing began
  elapsedTimeSec $$PROC.elapsedTimeSec$$ elapsed total time in seconds
       
USER     User Object (IXUser)
  userName $$USER.userName$$ user logon name / username 
  userId  $$USER.userId$$  internal XDOC user id 
  firstName  $$USER.firstName$$   
  lastName  $$USER.lastName$$   
  displayName $$USER.displayName$$    
  email $$USER.email$$  
  isExternal $$USER.isExternal$$  
  externalId $$USER.externalId$$ for externally authenticated users, the internal user id of the external system
       
CONTAINER     Container Attributes returned from the Integrated Application
    These include the internal attributes listed below, plus any attributes returned by the
Integrated Application.
  containerId $$CONTAINER.containerId$$ XDOC internal Container Id (19 digits)
  containerKey $$CONTAINER.containerKey$$ Internal id of the object. E.g.: internal loan id
  containerRef $$CONTAINER.containerRef$$ Human readable unique key for the object. E.g.: loan number
  containerName $$CONTAINER.containerName$$ Container Name property returned from the integrated application
  <<other>> $$CONTAINER.loanNumber$$ Any other attributes of the container returned from the Integrated Application. E.g.:
loanNumber
       
PROFILE     Bundle Profile Definition Object
      From the Bundle Template or Profile definition UI.
  profileId $$PROFILE.profileId$$  
  name $$PROFILE.name$$  
  description $$PROFILE.description$$  
       
PROPERTY     Bundle Definition Custom Properties
    Custom Properties from the Bundle Template / Profile definition UI. The token name needs
to match the "schemaId" of the custom property.
    $$PROPERTY.customerCode$$ E.g.: Assumes there is a Custom Property called "customerCode" on the Bundle Profile /
Template definition UI
       
ADDRESS     Components of the Delivery Address associated with the Bundle Profile
      These are the individual fields associated with the Delivery address properties. These are generally not used. Their token names are cryptic internal property ids. See the [Address Token Properties] worksheet for valid component ids.
       
CONTROL     Bundle Generation Control Properties
  packageId $$CONTROL.packageId$$ unique internal id created each time a bundle is run
  createDateTime $$CONTROL.createDateTime$$ datetime the bundle was generated. Usually this is used with extended syntax with
formatting
  totalFileCount $$CONTROL.totalFileCount$$ number of documents included in the output bundle package
  totalPageCount $$CONTROL.totalPageCount$$ total page count of all documents included in the bundle
  generateStartDateTime $$CONTROL.generateStartDateTime$$ Datetime the package generation started
  generateEndDate $$CONTROL.generateEndDate$$  
       
PARAMETER    

Parameters passed into the bundle generation engine. This namespace is primarily used for investor / partner systems that use the internal XDOC Bundle APIs to pass additiona instruction and data parameters to the bundle engineI. If using this namespace, the token name is the parameter name passed in.

 

The following tokens are available only at the document level

NameSpace Token Name Example Usage Description
ITEM     Represents each document type in the bundle profile item/document list. The item/document list is either defined specifically in the bundle profile, or by using a document stack.
  itemId $$ITEM.itemId$$ internal document id
  name $$ITEM.name$$ Document Definition name
  label $$ITEM.label$$ Document Definition label
  sequence $$ITEM.sequence$$ Integer sequence of the item in the list
  isRequired $$ITEM.isRequired$$ Boolean (1 or 0) indicating if the item is required
       
DOCDEF     Repository Document Definition object that represents the ITEM.
  schemaId $$DOCDEF.schemaId$$  
  code $$DOCDEF.code$$  
  name $$DOCDEF.name$$  
  label $$DOCDEF.label$$  
  description $$DOCDEF.description$$  
       
DOCFIELD <<schemaId>> $$DOCFIELD.approved$$ Returns the value of that field specified by <> or code. E.g.: DOCFIELD.externalAccess
       
NAMING     If document naming stack is defined, then these values come from the Repository
Document Stack definition. Otherwise, they come from the Document (DOC) object.
  code $$NAMING.code$$  
  name $$NAMING.name$$  
  label $$NAMING.label$$  
  refValue $$NAMING.refValue$$  
  description $$NAMING.description$$  
  sequence $$NAMING.sequence$$  
       
FILE     Properties of the actual output file generated from the ITEM.
      From the Bundle Template or Profile definition UI.
  documentId $$FILE.documentId$$ Internal ID of the underlying document
  sequence $$FILE.sequence$$ sequence of the file within the bundle. Usually the same as ITEM.sequence
  pageCount $$FILE.pageCount$$ number of pages in the file
  name $$FILE.name$$ file name without the path  
  fullName $$FILE.fullName$$ full file name with relative directory
  extension $$FILE.extension$$ file extension part of the file name
  fileFormat $$FILE.fileFormat$$ will evaluate to either PDF or TIF
  relativePath $$FILE.relativePath$$ file relative directory
       
PROPERTY     Bundle Definition Custom Properties
      Custom Properties from the Bundle Template / Profile definition UI. The token name needs
to match the "schemaId" of the custom property.
    $$PROPERTY.customerCode$$ E.g.: Assumes there is a Custom Property called "customerCode" on the Bundle Profile /
Template definition UI
       
ADDRESS     Components of the Delivery Address associated with the Bundle Profile
      These are the individual fields associated with the Delivery address properties. These are generally not used. Their token names are cryptic internal property ids. See the [Address Token Properties] worksheet for valid component ids.
       
CONTROL     Bundle Generation Control Properties
  packageId $$CONTROL.packageId$$ unique internal id created each time a bundle is run
  createDateTime $$CONTROL.createDateTime$$ datetime the bundle was generated. Usually this is used with extended syntax with
formatting
  totalFileCount $$CONTROL.totalFileCount$$ number of documents included in the output bundle package
  totalPageCount $$CONTROL.totalPageCount$$ total page count of all documents included in the bundle
  generateStartDateTime $$CONTROL.generateStartDateTime$$ Datetime the package generation started
  generateEndDate $$CONTROL.generateEndDate$$  
       
PARAMETER    

Parameters passed into the bundle generation engine. This namespace is primarily used for investor / partner systems that use the internal XDOC Bundle APIs to pass additiona instruction and data parameters to the bundle engineI. If using this namespace, the token name is the parameter name passed in.

 

Token Enhancement Requests for Future Releases

Bundle Level Tokens: under consideration for a future release

DOCLIST      
  schemaId $$DOCLIST.schemaId$$ Aggregate token that will return a list of the document type schemaIds in the bundle
  name $$DOCLIST.name$$ Aggregate token that will return a list of the document type names in the bundle