Articles in this section

Documents Variables for Documents

Avatar
Chinh Nguyen
  • Updated
Follow

Overview

Documentation customization allows you to specify templates that are merged with variables to control parts of the standards documents available in the software. In the standard documents there only a small number of tags for formatting, presently limited to just <br/> for starting a new line and <hr/> for inserting a horizontal rule.

 

Document variables

 

Variables defined for all document types

printDate
The date the document was printed
primary.groupName
The name of the your company
primary.addressFormatted
The address of your company, formatted on multiple lines
primary.webAddressFormatted
The website of your company
primary.atfLicenseNumber
The ATF license number of your company
primary.atfLicenseExpiration
The ATF license expiration date of your company
quantitySummaryByCategoryDetail
One line per category, with total for open stock and total for each distinct packing for case stock for all items on the document
quantitySummaryByCategory
One line per category, with total quantity for open stock and total quantity for case stock for all items on the document
quantitySummary
One line with total quantity for open stock and total quantity for case stock for all items on the document
gwtFormatted
Total gross weight for all items on the document
gwtFormattedUnit
Unit of measure (lb or kg) for gwtFormatted
neqFormatted
Total neq for all items on the document
neqFormattedUnit
Unit of measure (lb or kg) for neqFormatted
volumeFormatted
Total volume (CBM) for all items on the document
volumeFormattedUnit
          Unit of measure (always CBM) for volumeFormatted

 

For sales or sales returns these variables are defined under the key customer. For purchases these variables are defined under the key supplier. For example, to include the name of the customer write {{customer.groupName}} in the template.

The customer/supplier variables are listed here.

 

Order variables are defined for purchase print order, purchase shipment manifest, sale print order, sale pull sheet, sale back order, and sale shipment manifest documents.

The order variables are listed here.

 

Shipment variables for manifests, pull sheets, and bill of lading

The shipment variables are listed here.

 

Magazine variables for pull sheets

facilityName
The name of the magazine
quantitySummaryByCategoryDetail
One line per category, with total for open stock and total for each distinct packing for case stock for all items on the document
quantitySummaryByCategory
One line per category, with total quantity for open stock and total quantity for case stock for all items on the document
quantitySummary
One line with total quantity for open stock and total quantity for case stock for all items on the document
gwtFormatted
Total gross weight for all items on the document
gwtFormattedUnit
Unit of measure (lb or kg) for gwtFormatted
neqFormatted
Total neq for all items on the document
neqFormattedUnit
Unit of measure (lb or kg) for neqFormatted
volumeFormatted
Total volume (CBM) for all items on the document
volumeFormattedUnit
Unit of measure (always CBM) for volumeFormatted

 

Entry description variables

 

Defined for all document types (except Bill of Lading)

productId
The product id field of the product
userCategory
The user category field of the product
internalName
The description field of the product
longDescription
The notes field of the product
caliberStringFormatted
The caliber of the product
hazardousMatId
The hazardous material identifier (UN or NA number) of the product
exNumberList
The EX number or numbers of the product
manufacturerName
The manufacturer name of the product
manufacturerProductId
The manufacturer id of the product
manufacturerCountryGeoId
The manufacturer three letter country identifier of the product
manufacturerMarkFormatted
The manufacturer mark text of the product appended with the lot identifier for the stock item
stdBinId
The standard bin id of the product
itemNoteFormatted
The item notes from all order items that reference the product
gwtFormatted
The total weight for the entry, formatted based on the application system of measure
gwtFormattedUnit
Unit (lb or kg) for formatted weight
neqFormatted
The total net explosive mass for the entry, formatted based on the application system of measure
neqFormattedUnit
Unit (lb or kg) for formatted net explosive mass

 

Additional for print purchase or sale order

quantity
Quantity value including packing
unitListPrice
List price for product from order
discount
Percentage difference from list price to price
unitPrice
Price for product from order
subTotal
Quantity multiplied by price

 

Additional for shipment manifest

quantity
Quantity value including packing
unitListPrice
List price for product from order
discount
Percentage difference from list price to price
unitPrice
Price for product from order
subTotal
Quantity multiplied by price
facilityUrlFormatted
Magazine the item was or will be pulled from
facilityUrlReceiveFormatted
For transfer, magazine the item was or will be received into

 

Bill of Lading variables

hazardousMatBasicDescription
Hazardous materials basic description
exNumberListFormatted
EX numbers for all products in shipment, sorted with duplicates removed.

 

Primary (account detail) Stored Email Variables

primary.groupName
primary.primeImage
primary.atfLicenseNumber
primary.atfLicenseExpiration
primary.hazMatContactTel
primary.hazMatContractNumber
primary.addressFormatted
primary.telecomNumberFormatted
primary.telecomHomeNumberFormatted
primary.telecomWorkNumberFormatted
primary.telecomMobileNumberFormatted
primary.telecomFaxNumberFormatted
primary.telecomDirectNumberFormatted
primary.webAddressFormatted
primary.emailHomeFormatted
primary.emailWorkFormatted
primary.emailPaymentFormatted
primary.emailBillingFormatted
 
To call the image, the source code is:
<img style="position:absolute;left:0.5in;top:38pt;height:42pt;width:216pt;object-fit:contain" src={{primary.primeImage}}>
 

Supplier Stored Email Variables for Purchase Orders

orderSupplierEmailAddressBilling
The Supplier email address with Purpose:Billing
orderSupplierEmailAddressHome
The Supplier email address with Purpose:Home
orderSupplierEmailAddressPayment
The Supplier email address with Purpose:Payment
orderSupplierEmailAddressWork
The Supplier email address with Purpose:Work

TO email all purposes in a Supplier for a PO Email, the formula is:

join(compact([email(lookup(" orderSupplierEmailAddressWork" ),lookup(" orderSupplierEmailAddressWork" )),if(lookup(" orderSupplierEmailAddressWork" ) == lookup(" orderSupplierEmailAddressHome" ),"",email(lookup(" orderSupplierEmailAddressHome" ),lookup(" orderSupplierEmailAddressHome" ))),if(lookup(" orderSupplierEmailAddressWork" ) == lookup(" orderSupplierEmailAddressPayme nt"),"",email(lookup(" orderSupplierEmailAddressPayme nt"),lookup(" orderSupplierEmailAddressPayme nt"))),if(lookup(" orderSupplierEmailAddressWork" ) == lookup(" orderSupplierEmailAddressBilli ng"),"",email(lookup(" orderSupplierEmailAddressBilli ng"),lookup(" orderSupplierEmailAddressBilli ng")))]), ", ")

 

join(compact([email(lookup("orderSupplierEmailAddressWork"),lookup("orderSupplierEmailAddressWork")),if(lookup("orderSupplierEmailAddressWork") == lookup("orderSupplierEmailAddressHome"),"",email(lookup("orderSupplierEmailAddressHome"),lookup("orderSupplierEmailAddressHome"))),if(lookup("orderSupplierEmailAddressWork") == lookup("orderSupplierEmailAddressPayment"),"",email(lookup("orderSupplierEmailAddressPayment"),lookup("orderSupplierEmailAddressPayment"))),if(lookup("orderSupplierEmailAddressWork") == lookup("orderSupplierEmailAddressBilling"),"",email(lookup("orderSupplierEmailAddressBilling"),lookup("orderSupplierEmailAddressBilling")))]), ", ")

 

Customer Email Variables for Invoices

orderCustomerEmailAddressBilling
The Customer email address with Purpose:Billing
orderCustomerEmailAddressHome
The Customer email address with Purpose:Home
orderCustomerEmailAddressPayment
The Customer email address with Purpose:Payment
orderCustomerEmailAddressWork
The Customer email address with Purpose:Work

 

To Email all purposes emails to a Customer for an Invoice Email, the formula is:

join(compact([email(lookup("orderCustomerEmailAddressWork"),lookup("orderCustomerEmailAddressWork")),if(lookup("orderCustomerEmailAddressWork") == lookup("orderCustomerEmailAddressHome"),"",email(lookup("orderCustomerEmailAddressHome"),lookup("orderCustomerEmailAddressHome"))),if(lookup("orderCustomerEmailAddressWork") == lookup("orderCustomerEmailAddressPayment"),"",email(lookup("orderCustomerEmailAddressPayment"),lookup("orderCustomerEmailAddressPayment"))),if(lookup("orderCustomerEmailAddressWork") == lookup("orderCustomerEmailAddressBilling"),"",email(lookup("orderCustomerEmailAddressBilling"),lookup("orderCustomerEmailAddressBilling")))]), ", ")

 

How to remove zero width columns from CSV/TSV exports:

Add the following into a blank template for that specific report.

{{dataTableOptions filterColumnWidthZero="TRUE"}} 

Related articles

Comments

0 comments

Article is closed for comments.