Skip to main content

Macros for Email Notifications


Question / Problem: 

Which Kofax Capture / Kofax Front Office Server (KFS) macros are supported for use in KFS Email Notifications?

Answer / Solution: 

KFS Email Notifications can be used to track the progress of a job/batch as it progresses through processing by the KFS Server and Kofax Capture.  Macros can be used to automatically populate the email notifications with information about the job / batch.

Kofax Capture Macros supported for use in KFS Email Notifications:
  • {Batch Class Name}
  • {Batch Creation Date}
  • {Batch Creation Time}
  • {Batch Creator's Station ID}
  • {Batch Description}
  • {Batch GUID}
  • {Batch ID}
  • {Batch Name}
  • {Batch Reference ID}
  • {Current Date}
  • {Current Time}
  • {Document Class Name}
  • {Document Count}
  • {Document Creation Date}
  • {Document Creation Time}
  • {Document Form Name}
  • {Document GUID}
  • {Document ID}
  • {First Page Endorsing String}
  • {First Page Image Address}
  • {First Page Original File Name}
  • {First Page Roll Number}
  • {Operator Description}
  • {Operator Name}
  • {Operator User ID}
  • {Remote Validation User ID}
  • {Repository Document ID}
  • {Scan Operator's Station ID}
  • {Scan Operator's User ID}
  • {Sequence Number}
  • {Side ID}
  • {Station ID}
  • {StationIDCommonName}
  • {User Name}
  • {UTC Offset}
  • {Validation Operator's Station ID}
  • {$BatchFieldName}
  • {@IndexFieldName}
KFS Macros supported for use only in the Internal Notification type:
  • ${BatchClass}
  • ${FormType}
  • ${JobID}
  • ${ShortcutName}
  • ${UserID}
  • ${UserName}
KFS Macros supported for use only in the Transaction Received Notification type:
  • ${Pages}
  • ${SubmittedTime}
  • ${SubmittedDate}

The Transaction Received notification type was introduced in KFS (KFS 4.1, Service Pack 1, Fix Pack 4)

Applies to:  

Product Version
KFS 4.1



  • Was this article helpful?