Dynamics AX: Data templates

When you configure the Dynamics AX target system service, you can use the target system service settings to specify data from Kofax AP Essentials that you want to send to the transaction text field in Dynamics AX.

Note that the fields mirror the extraction fields in step one, with the exception of the purchase order field (LI_OrderNumer), which is absent. This is because PO number values are set in the account coding field.

How it works

When an invoice is interpreted and extracted by Kofax AP Essentials, purchase-order numbers in line-item tables are captured using the fields you specified above. After the invoice is verified, it is sent to Dynamics AX. The integration automatically matches PO numbers that are found in line-item tables with PO numbers in Dynamics AX. If there are no PO numbers in the line-item table, the PO number in the header field is used instead.

You specify the data templates using plain-text constants and variables enclosed in percent marks.

  • Constants - fixed values that you specify as text.
  • Variables - dynamic values that are determined by invoice data or system data. Variables are enclosed in percent characters (%).

To specify a variable for an invoice field, enclose the Type name of the field in percent characters (%).

A variable can also be preceded by:

  • # - to indicate that it is a system variable.
  • @ - to indicate that it is a history variable.
  • $ - to indicate that it is a meta-data variable.


Customer: $WebEye.CustomerID Document created: %@date0{yyyy-MM-dd}% Buyer: %#buyer.Name%

System variables

You can specify system variables to obtain the values of system variables in Kofax AP Essentials.

  • #Appendices
  • #CreditInvoice
  • #BatchPrefix
  • #buyer.Type
  • #buyer.Name
  • #buyer.Id
  • #buyer.ExternalId
  • #buyer.Description
  • #buyer.TaxRegistrationNumber
  • #buyer.OrganizationNumber
  • #buyer.Street
  • #buyer.PostalCode
  • #buyer.City
  • #buyer.CountryName
  • #buyer.PaymentTerm
  • #buyer.PaymentMethod
  • #buyer.CurrencyCode
  • #buyer.BankAccounts
  • #Currency
  • #DateTime
  • #Description
  • #DocumentTypeSystemName
  • #ImageFile2
  • #NumberOfPagesFrontAndBack
  • #NumberOfInvoicePages
  • #NumberOfInvoicePagesFrontAndBack
  • #NumberOfAppendixPages
  • #NumberOfAppendixPagesFrontAndBack
  • #Pages
  • #Permalink
  • #ProfileName
  • #EndorserNumber
  • #Supplier
  • #Supplier.Description
  • #supplier.Type
  • #supplier.Name
  • #supplier.Id
  • #supplier.ExternalId
  • #supplier.TaxRegistrationNumber
  • #supplier.OrganizationNumber
  • #supplier.Street
  • #supplier.PostalCode
  • #supplier.City
  • #supplier.CountryName
  • #supplier.PaymentTerm
  • #supplier.PaymentMethod
  • #supplier.CurrencyCode
  • #supplier.BankAccounts

History variables

You can specify history variables to obtain the user or the date and time of a specific process. You construct a history variable using one of these formats:

  • @UserX
  • @DateX
...where User specifies that you want the user associated with the process, Date specifies that you want the date the process occurred and X specifies the numerical code of the process you want to return. For example, %@Date0% returns the date a document was created. %@User0% returns the user name that created the document.

The default date format returned by the date variable is YYY-MM-ddTHH:mm:ss.FFFFFFFZ. For example: 2021-02-28T14:46:21.1265774Z.

Process status Numerical code
DocumentCreated 0
DocumentExtractionInProgress 30
DocumentExtractionSucceeded 40
DocumentPendingManualVerification 45
DocumentPendingCorrection 46
DocumentCorrectionFlowStarting 47
DocumentCorrectionFlowInProgress 48
DocumentCorrectionFlowDone 49
DocumentRejectedDuringVerification 50
DocumentRequestForInformationDuringVerification 55
DocumentManuallyVerified 60
DocumentPendingRegistration 61
DocumentRegistrationInProgress 62
DocumentRegistrationSucceeded 63
DocumentRegistrationFailed 64
DocumentPendingApproval 65
DocumentApprovalStarting 79
DocumentApprovalInProgress 66
DocumentApproved 67
DocumentApprovalSucceeded 68
DocumentApprovalRejected 69
DocumentRequestForInformation 70
DocumentPendingAllocation 71
DocumentPendingPost 74
DocumentPostInProgress 75
DocumentPostSucceeded 76
DocumentPostFailed 77
DocumentAssignedToUser 78
DocumentPendingBatchRegistration 80
DocumentPendingBatchPost 81
DocumentValidationFailed 82
DocumentPendingExport 90
DocumentExportPostponed 91
DocumentExportInProgress 95
DocumentExportFailed 99
DocumentExportSucceeded 100
DocumentSentToStorage 200
DocumentCommentAdded 201
LineItemExtractionUsed 202
DocumentFailed 900
DocumentDeleted 1000

Custom date formats

The default date format returned by the date variable is YYY-MM-ddTHH:mm:ss.FFFFFFFZ. For example: 2021-02-28T14:46:21.1265774Z.

If you use the Oracle Financials Cloud integration or the SAP S/4HANA Cloud ES integration, you can control the format of the date variable using standard date and time formats as well as custom formats. You specify the format of your choice by enclosing it in braces after the date variable, like this:


The date variable above would return for example, 2021-02-28.

Meta-data variables

You can specify these variables to obtain additional meta data from Kofax AP Essentials that is not available in the variables above:

  • $WebEye.CustomerID
  • $WebEye.BatchID
  • $WebEye.OutputImageFormat
  • $WebEye.DocumentID
  • $ExternalId
  • $UploaderUserName
  • $OriginalFileName
  • $BatchTrackId
  • $ReceiveTime
  • $DocumentId
  • $VerifierUserName