Product Table Fields Reference

Product table fields contains an extensive list of fields to allow you to display product line information from WorkGuru transactions in your document templates. The following product fields are available:

• Product Information
• Product Quantities
• Product Pricing
• Product Amounts
• Product Progress Amounts
• Product Discounts
• Product Images
• Product Weight and Volume
• Product Options

Document Compatibility

Product table fields be supported on:

• Quotes - see Quote Document Templates
• Invoices - see Invoice Document Templates 
• Stock Sales - see Stock Sale Document Templates
• Projects - see Project Document Templates
• Production Jobs - see Production Job Document Templates
• Purchase Orders - see Purchase Order Document Templates
• Credit Notes - see Credit Note Document Templates

However, not every Product field is available on every document type. Some fields are specific to a particular document type. For example:

• Dispatched Quantity is specific to Stock Sales.
• Progress Amount fields are specific to Invoices.
• Product actuals are specific to Projects.
• Product source fields are specific to Purchase Orders.
• Product margin is specific to Quotes.

If a merge field does not return a value, confirm that the field is supported by the document type being generated. Unlike Universal Fields, Product fields must be placed inside a table in your document template. WorkGuru uses the table to automatically repeat the row for each applicable product line on the transaction. Merge fields are case sensitive and must be entered exactly as displayed below.

Setting Up a Products Table

Product merge fields must be placed inside a correctly configured table. The table requires:

• A header row
• A repetition line row containing your merge fields
• The correct Alt Text Description. Set the table’s Alt Text Description to:
  • Products

When WorkGuru generates the document, the product line row is repeated for each applicable product on the transaction. For detailed instructions, see Table Field Setup in WorkGuru Document Templates.

Product Information

Product Quantities

Product Pricing

Displays product unit pricing.

Product Amounts

Displays the totals for the line (quantity x price). Note: Actuals Fields are only available on Projects and Production Jobs.

Product Progress Amounts

These fields can be used within Invoice product tables to display invoicing progress against individual product lines. Note: Only available for Project and Project Group Invoices

Product Discounts

Product discount fields allow you to display discounts applied to individual product lines.

Product Images

Product images are scaled up or down to the required size (100 or 300px). Recommend using images in the correct size and aspect ratio for best results.

Product Weight and Volume

Note: Total weight and volume fields only supported on Projects, Stock Sales and Production Jobs.

Product Options

Quote templates can also display products that have been assigned as Options. To display optional products, create a separate table and set its Alt Text Description to: ProductOptions.  The ProductOptions table can use the same product merge fields as the standard Products table, including phase information. This allows quoted products and optional products to be displayed separately on the quote.

Troubleshooting

Table Does Not Populate

Check that:

• The Alt Text Description is correct.
• Capitalisation matches the required table name - alt text descriptions are case sensitive.
• There is only one table of the same type on the document.
• The table is supported by the document type.
• There is applicable data to display.
• The table has a header

Merge Fields Appear in the Generated Document

If fields such as [ProductName] appear instead of actual values, check:

• The spelling of the merge field. 
• Check capitalisation - merge fields are case sensitive.
• Confirm the field belongs to the table type being used.
• Confirm the field is supported by the document type.

Table Formatting Is Incorrect

Check that:

• Header and repetition row columns align.
• Cells have not been incorrectly merged.
• Nested tables are configured correctly.
• Each table has the correct Alt Text Description.