Upgrade Templates from Checkout 3
Checkout v4.0 requires templates to go through a template version checking in order to ensure they're compatible with the latest version of the software.
How templates are validated
When a template file is installed, template validation will check for the following files within Package Contents of the template file (bundle):
| Template | Report |
|---|---|
| Invoice.html | Template.html |
| Order.html | report.py |
| PurchaseOrder.html | info.plist |
| Receipt.html | |
| Style.css | |
| info.plist | |
| icon.plist |
If any of the above files are missing, Checkout will not allow you to install the template or report.
Templates are validated using the info.plist file, which compares the <key>CFBundleShortVersionString</key> against the build version number that is set when the application is built, and the <key>TemplateType</key> that is set within info.plist.
Note: The string for <key>TemplateType</key> must be defined as either template or report in order to pass template validation.
How to Update an Existing Template
You must have the original xxxx.checkouttemplate file in order to upgrade it to Checkout v4.
If you're unsure on where this file is saved on your computer, preform a computer search for any files ending in .checkouttemplate
If wanting to update a previously customized template, it will need a slight modification to the info.plist in order to be used with Checkout v4.0 - 8182.
Please note that the variables should be re-confirmed when having to update templates. Refer to the Creating Custom Receipt Templates FAQ for additional information on the template variables.
To modify the info.plist file:
- Download the example info.plist file here
- Open the info.plist file with the texteditor of your choice
- Adjust the <key>CFBundleShortVersionString</key> string to match the current build version of Checkout - found within the Checkout > About Checkout dropdown menu
- Save the info.plist file into the template file (bundle)
- Double click the template file to install to Checkout
How to Update an Existing Report
Custom reports that have already been installed can be found inside of: ~/Library/Application Support/Checkout/Reports
If wanting to update a previously customized report, it will need a slight modification to the info.plist in order to be used with Checkout v4.0 - 8182.
Please note that the variables should be re-confirmed when having to update reports.
To modify the info.plist file:
- Download the example info.plist file here
- Open the info.plist file with the texteditor of your choice
- Adjust the <key>CFBundleShortVersionString</key> string to match the current build version of Checkout - found within the Checkout > About Checkout dropdown menu
- Save the info.plist file into the template bundle
- Double click the report template to install to Checkout