Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Summary

This article details the configuration options available when adding invoice templates to EngageIP for use.

...

Below is an example of an invoice template configuration.  You can access the Template by loading the Setup tab page and clicking on Invoice Templates.

...

For information on finding the available tokens in your EngageIP system and creating custom invoice tokens see the Developer Documentation article: https://developer.logisense.com/invoice-template-design/ Invoice Template Design Overview article.

Custom tokens make use of existing database tables or views in the database or based on custom views that are created to show specific information.

Once a custom token is created and associated to an invoice template, any invoices generated using that template will include the data from the custom token in the XML that is generated. That data in the XML can then be called out in the XSLT template for display or calculations on the invoice itself

To add a custom invoice token:

  1. Go to Setup tab

  2. Click link ‘Custom Invoice Token’

  3. Click ‘Add’

  4. Type Name of custom token, this will reflect on your invoice template configuration page

  5. Enter the table name OR the view name that the data is coming from

  6. Select the invoice identifier - this tells the system to return data specific to InvoiceID or UserID

  7. Click Save

To add a custom token to an invoice template:

  1. Go to Setup tab

  2. Click ‘Invoice Template’ link

  3. Click the link of the template you wish to add the custom token to

  4. Scroll to the bottom section named ‘Custom invoice Token’

  5. Click Add

  6. Locate and add the token you just created

To use the data from the custom token do this:

  1. Go to an invoice that makes use of the template that was updated

  2. Open and Close the invoice to generate the XML and reload the data which will now include the new token data

  3. Update the template itself to make use of the new XML data as needed

  4. Render the invoice on the customer again to reflect the updated template changes

To view the XML data to confirm the data exists that you need, go to the account, check the box beside an invoice that was opened / closed, and click ‘XML’ button. Open the file in Notepad to see all the data that can be extracted or used on the invoice template.

Invoice Optimization

How to optimize your configuration for for database space efficiency and overall system speed

...

Once  you are done unselecting the options you think you don't need, render an invoice again (by going to the account, clicking invoices tab, clicking the date of the invoice you want to render, click save without updating the date value, then load the invoice again).

...

Configuration for Receipt Printing

  1. Enter a template under Setup/Branding to enable receipt printing

  2. Install the receipt printer driver on the appropriate computers
    Notice: the name of the printer must include the word "Receipt". If no installed printers contain this word then receipt printing will not be available. If multiple printers contain the word the first one found will be used (the order is not predictable)

  3. Go to AdminPortal and log in

  4. Configure the browser to allow unsigned ActiveX controls. Under Tools/Internet Options click the Security tab and click the "Custom Level" button. Set the "Download unsigned ActiveX Controls" to "Prompt" and save the changes

  5. Go to the Transactions

...

  1. page

  2. Click the security notification message at the top of the browser window

  3. Click "Install ActiveX Control..."

  4. When the security warning dialog comes up click the Install button

  5. When it finishes installing the Receipt button should be available on the Payments list

  6. You can use "Tools/Manage Add-ons..." to verify that the ReceiptPrinterControl was correctly installed

Troubleshooting

Errors On Invoice Template Save

...

You

...

do

...

not

...

have

...

a

...

correctly

...

formatted

...

HTML

...

document

  • Check for missing tags (particularly closing tags). Fully review to confirm the template is up to HTML standards

  • For EngageIP 8.5.22.0 or earlier: ensure the host's IIS App pool set to .Net 2.0 instead of .Net 4.x. Having the App pool set to 4 may cause reference errors as well