Navigator > Setup > Invoicing System > Invoice HTML Designer
Use the Invoice HTML Designer to design HTML versions of Invoices, Credits, Quotes and Packing Slips generated from IN. HTML invoice documents are used as the body of the email when an invoice is sent via Mail Message with Format HTML Document. HTML invoice documents have the file extension .pfj.
You can design your own HTML invoice documents or open and modify an existing design. To design a document quickly, use the HTML Document Designer Wizard or start with an existing design, save it with a different name, then modify it. A sample HTML invoice document (INInvoice.pfj) is installed with the Accredo server install.
Note: If you modify HTML invoice documents that are provided with Accredo it is important to save them with different names, as when Accredo updates are installed, the documents can be overwritten.
Select the design to be used as the email body in the Default HTML Document field in IN Settings - Email tab.
Main menu |
||
File Menu |
Some file menu options are also displayed on the Menu toolbar, see below. The last 9 files accessed are listed at the end of the menu. |
|
Edit Menu |
You can use shortcut keys. You can also right-click on objects to bring up the edit menu options. |
|
View Menu |
You can show or hide the Property Editor, Iterators and Code Editor. View All Code replaces HTML Designer window with a single multi-panel view of the MaxBasic code. |
|
Menu toolbar |
||
|
New |
Create a new HTML document design. |
|
Open |
Open an existing HTML document design. |
|
Save |
Save the current design as a .pfj file. You can reload the file in the designer at any time to refine it or use it as a base for a new design. On save, the previous design version is retained as a backup copy. The backup copy has the original design file name with the extension .BAK. Previous backups of the design file will be renamed to increment the backup extension .BAK to .BK1, .BK1 to .BK2 and so on, through to .BK8 to .BK9. The oldest backup, previously .BK9 will be overwritten. Recover previous versions by loading the backup file and saving it under the correct file name. |
|
Generate using wizard |
Open the IN HTML Document Designer Wizard to generate a starting HTML document from selections. |
|
Run Report |
Run the report. A preview email is displayed. |
Iterator Panel (Custom Reports) |
||
Query Bands |
Click |
|
Use the Wizard to generate a starting design from selections, then refine it in the designer.
Related Designers
Use IN Invoice Designer to design the invoice itself (the .pfd document) when sending invoices as PDF or other disk-file attachments rather than as the email body.
Use IN Invoice Email Designer to design the email template (subject, body and signature) used when invoices are sent as a Mail Message attachment rather than as the entire invoice in the email body.
Use IN Email Invoices to send invoice emails in bulk in the selected format. Invoices can also be sent individually by Printing to Destination Mail Message.
The Invoice HTML Designer is based on the Report Designer and has similar functionality. Full report design facilities including MaxBasic are available.
Designer Window |
|
Title bar |
The title bar shows the company, the application name (Invoice HTML Designer) and the current file (for example, INInvoice.pfj). The window is divided into the following panes: |
Iterators |
Across the top. Lists the iterators in the design with columns for Name, Bands, Sort Order and Filter. |
Property pane |
Down the left. Shows the properties of the currently selected band or component (for example, BandName, BandType, BeforeBand, AfterBand, Enabled, GroupExpression, Repeated). |
HTML Editor |
The main area, where you lay out the HTML document. A WYSIWYG toolbar provides standard formatting (cut, copy, paste, undo, redo, bold, italic, underline, strikethrough, subscript, superscript, alignment, lists, indent, hyperlink, special character, image, spell check, style, font and font size, foreground and background colour, and table tools). |
Insert buttons |
Operators, Objects, Functions, Components, Procedures and Help let you insert merge fields, expressions and report components into the document at the cursor position. |
Status bar |
Across the bottom. Indicates the band and code section currently selected (for example, bandTitle.AfterBand). |
Usually an HTML Invoice document consists of a:
Iterators are available to create sub-sets of records. Bands are assigned to iterators, which iterate through the records associated with the document. You can filter and sort iterators to control which records are included and in which order.
Name |
Iterators determine the records shown in the report. Available Iterators are:
|
Bands |
The Bands in the report to apply the iterator to. |
Sort Order |
Optionally select fields to sort records in the iterator. |
Filter |
Optionally select fields to further filter the iterator. |
Objects available in the Invoice Designer in addition to the standard objects are:
BankAccount |
Fields from the Bank Account record. |
BankLine |
Fields from the Bank line records. |
Branch |
Fields from the Branch record. |
Contact |
Fields from the Customer Contact records. If a Contact has been specified, this object is populated with the information associated with the document. If no Contact is specified, this object is populated with the primary contact information (if specified). |
Customer |
Fields from the Customer record. |
CustomerBackOrder |
Fields from the Back-order summary records for the Customer. |
DeliveryAddress |
Fields from the delivery address records. |
InvoiceBackOrder |
Summary of items back ordered on orders that this invoice is for. |
InvoiceHead |
Fields from the Invoice header record. |
InvoiceLine |
Fields from the Invoice line records. |
itBank |
Properties of the Bank iterator. |
itCustomerBackOrder |
Properties of the CustomerBackOrder iterator. |
itInvoiceBackOrder |
Properties of the InvoiceBackOrder iterator. |
itJobDescription |
Properties of the JobDescription iterator. |
itShipping |
Properties of the Shipping iterator. |
itBackOrder* |
Properties of the BackOrder iterator. |
itDescription* |
Properties of the JobDescription iterator. |
itSupply |
Properties of the Supply iterator. |
itTracking |
Properties of the Tracking iterator. |
Job |
Fields from the Job (if a JC Invoice). |
JobDescription |
Fields from the Job description records (if a JC Invoice). |
JobTransaction |
Fields from the Job transaction records (if a JC Invoice). |
OrderHead |
Fields from the Order Header record. |
OrderLine |
Fields from the Order line records. |
Product |
Fields from the Product specified in the Invoice line. |
ProductQty |
Fields from the quantity for the Product specified in the Invoice line. |
SalePerson |
Fields from the SalesPerson record. |
Shipper |
Fields from the Shipper record. |
ShipperLine |
Fields from the Shipper line records. |
Tracking |
Fields from the Tracker record. |
Use IN Invoice Designer to design the invoice itself (the .pfd document) when sending invoices as PDF or other disk-file attachments rather than as the email body.
Use IN Invoice Email Designer to design the email template (subject, body and signature) used when invoices are sent as a Mail Message attachment rather than as the entire invoice in the email body.
Use IN Email Invoices to send invoice emails in bulk in the selected format. Invoices can also be sent individually by Printing to Destination Mail Message.
The Invoice HTML Designer is based on the Report Designer and has similar functionality. Full report design facilities including MaxBasic are available.