Task table fields allow you to display Task and labour line information from WorkGuru transactions in your document templates. The following Task fields are available:
Document Compatibility
Not every Task field is available on every document type. Task table fields may be available on:
- Quotes - see Quote Document Templates
- Invoices - see Invoice Document Templates
- Projects - see Project Document Templates
- Production Jobs - see Production Job Document Templates
- Credit Notes - see Credit Note Document Templates
Some fields are specific to particular document types or workflows. For example:
- Task Options are used on Quotes.
- Progress Amounts are used on Invoices.
- Actual Task cost and billable fields are used on Projects.
- Task Phase is useful on Quotes and Projects using phases.
If a merge field does not return a value, confirm that the field is supported by the document type being generated. Unlike Universal Fields, Task fields must be placed inside a correctly configured table. WorkGuru uses the table to automatically repeat the row for each applicable Task on the transaction. Merge fields and Table Alt Text are case sensitive and must be entered exactly as displayed below.
Setting Up a Tasks Table
Task merge fields must be placed inside a correctly configured table. The table requires:
- A header row
- A Task line row containing your merge fields
- The correct Alt Text Description
- Set the table’s Alt Text Description to:
- Tasks
When WorkGuru generates the document, the Task line row is repeated for each applicable Task. For detailed setup instructions, see Table Field Setup in WorkGuru Document Templates.
Task Information
| Description | Merge Field | Notes |
|---|---|---|
Task Name | [TaskName] | |
Task Description | [TaskDescription] | |
| Task Phase | [TaskPhase] | Not Supported on Credit Notes and Project Group Invoices |
Task Quantities
| Description | Merge Field | Notes |
|---|---|---|
Task Quantity | [TaskQuantity] | |
Forecast Task Quantity | [TaskForecastQty] | Project Invoices Only |
Task Pricing
Displays the individual task rates
| Description | Merge Field | Notes |
|---|---|---|
Task Rate | [TaskRate] | |
Task Cost Price | [TaskCostPrice] | Quotes and Credit Notes Only |
Task Margin | [TaskMargin] | Quotes, Projects and Production Only |
Actual Task Cost | [TaskCostActual] | Projects and Production Only |
Task Amounts
Displays the totals for the task line (quantity x rate)
| Description | Merge Field | Notes |
|---|---|---|
Task Amount Excluding Tax | [TaskAmount] | |
Task Tax Amount | [TaskTaxAmount] | |
Task Tax Name | [TaskTaxName] | |
Task Total Including Tax | [TaskTotalAmount] | |
Task Unit Tax | [TaskUnitTax] | |
Actual Task Billable Amount | [TaskBillableAmountActual] | Projects and Production Only |
Task Progress Amounts
Task tables on Invoice templates can use progress fields to display how much of each Task has previously been invoiced, how much is being invoiced now, and how much remains. Note: These Fields are NOT supported on Project Group Invoices and Credit Notes.
| Description | Merge Field |
|---|---|
Amount Invoiced to Date Including Current Invoice | [TaskInvoicedAmount] |
Amount Previously Invoiced | [TaskPrevInvoicedAmount] |
| Percentage Invoiced to Date | [TaskInvoicedPercentage] |
| Percentage on Current Invoice | [TaskPercentage] |
Amount Remaining | [TaskRemaining] |
Forecast / Quoted Amount | [TaskForecast] |
Task Options
Quote templates can display Tasks that have been assigned as Options separately from standard Tasks. The TaskOptions table can use the same Task merge fields as the standard Tasks table, including phase information. This allows standard Quote Tasks and optional Quote Tasks to appear in separate sections of the document. Create a separate table and set its Alt Text Description to: TaskOptions
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 [TaskName] 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.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article