Function Variables
The following variables can be used directly in any output.
Dates
Variables relating to dates.
| # | Name | Type | Description/Comments | Example |
|---|---|---|---|---|
| 1 | v_DateEndOfMonth | datetime | The end of the current months date. | {{DisplayDate(v_DateEndOfMonth)}} |
| 2 | v_DateEndOfWeek | datetime | The end of the current weeks date. | {{DisplayDate(v_DateEndOfWeek)}} |
| 3 | v_DateEndOfYear | datetime | The end of the current years date. | {{DisplayDate(v_DateEndOfYear)}} |
| 4 | v_DateNow | datetime | The current date and time. | {{DisplayDate(v_DateNow)}} |
| 5 | v_DateStartOfMonth | datetime | The start of the current months date. | {{DisplayDate(v_DateStartOfMonth)}} |
| 6 | v_DateStartOfWeek | datetime | The start of the current weeks date. | {{DisplayDate(v_DateStartOfWeek)}} |
| 7 | v_DateStartOfYear | datetime | The start of the current years date. | {{DisplayDate(v_DateStartOfYear)}} |
| 8 | v_DateToday | datetime | The date tomorrow. | {{DisplayDate(v_DateToday)}} |
| 1 | v_DateEndOfMonth | datetime | The end of the current months date. | {{DisplayDate(v_DateEndOfMonth)}} |
Outputs
Variables relating to features of the output.
| # | Name | Type | Description/Comments | Example |
|---|---|---|---|---|
| 9 | v_ForEmail | boolean | Whether generating an email. | {{IF(v_ForEmail)}}For Email{{ENDIF}} |
| 10 | v_OutputClass | string | The output class including quotes. | The output class is {{v_OutputClass}} |
| 11 | v_OutputClass_Nq | string | The output class excluding quotes. | The output class is {{v_OutputClass_Nq}} |
| 12 | v_OutputTable | string | The output table including quotes. | The output table is {{v_OutputTable}} |
| 13 | v_OutputTable_Nq | string | The output table excluding quotes. | The output table is {{v_OutputTable_Nq}} |
Grouping
Variables relating to grouping during the output.
| # | Name | Type | Description/Comments | Example |
|---|---|---|---|---|
| 14 | v_RecordCount | integer | The total number of records found. | {{IF(v_RecordCount > 5)}}Content{{ENDIF}} |
| 15 | v_RecordGroupCount | integer | The total number of records found in the current group. | {{IF(v_RecordGroupCount > 5)}}Content{{ENDIF}} |
| 16 | v_RecordGroupFirst | boolean | Whether the current record is the first record in the current group. | {{IF(v_RecordGroupFirst)}}First Item{{ENDIF}} |
| 17 | v_RecordGroupIndex | integer | The current index of the record in the current group starting at 1. | {{IF(v_RecordGroupIndex == 1)}}First Item{{ENDIF}} |
| 18 | v_RecordGroupLast | boolean | Whether the current record is the last record in the current group. | {{IF(v_RecordGroupLast)}}Last Item{{ENDIF}} |
