How do I add a new report template to my store file?

Started by David Johns, February 08, 2010, 04:27:50 AM

Previous topic - Next topic

David Johns

SuperManager uses HTML report templates so they are easy to customize and make new ones.  To add a report template to your store file following these steps:

1. Generate the template.  You can create templates by using one of the default templates as a starting point.  There are just a couple of limitations to keep in mind:

  • Templates use field variables to show where information from your orders belong.  You can find the list of variables in appendix A of the user's manual
  • Variables starting with "item_", "shipment_", "total_" and "payment_" are expected to be in a table row.  When SuperManager finds these variables, it finds the preceding <TR> element and the </TR> element after the variable and makes a copy of that HTML row for each of the items, shipments, totals or payment events in the order.
  • For the preceding functionality to work correctly, the <TR> element may not have any attributes
  • SuperManager uses the style "pagebreak" to insert a pagebreak.  If this style does not appear your report will be generated without page breaks between the orders exported.

2. Go to "View" | "Store Settings..." and select the "Reports" tab.  Note that this is not available in The SuperManager Lite Special Edition for Quickbooks? Users.



3. Click the "Add" button and give the report a name.  You can choose anything for this name, but it is recommended not to use the same name twice.

4. With the new report selected on the list, press the "Browse..." button and select the new report template html file.  Note that the default templates are copied to "C:\Program Files\SuperManager\" when The SuperManager is installed.  It is not necessary to store all your store templates here, but this might be a good place to keep all of them.

5. Select the type of report you have made.  The following types are available:

  • Invoice - For orders that are intended to have one page per order
  • Summary - For orders that are intended to show agregate totals of the orders you have selected (for example, a financial summary showing the total income for a set of orders)
  • Range - For orders that are intended to have a common set of order information and one body of item information for the selected orders (for example, for a picklist where you want one entry per item per order)
  • Packing Slip - Similar to invoices, but only shows the items in a single shipment in the order
  • Purchase Order

6. Set any other options:

  • Set as default - There may be one default report of each type.  Default reports can be generated using the default menu option at the top of the report list.
  • Autoprint for new orders - When checked, this report will be printed for each new order downloaded. (not if SuperManager overwrites an existing order)
  • Exclude canceled/fraud orders - When printed any canceled or fraud orders will not be printed

7. Press "OK" to save and close the store settings.

After adding the template, to print it go to "View" | "Orders", select the orders for which you want to print the report, right click and choose "Print Report" and then the name of the report template you added.
SuperManager Support
info@thesupermanager.com