Worksheet output options#
Each worksheet you include in a report can carry its own Output Options, settings that control how that worksheet appears and behaves in the generated file. They are configured on the Reports step of the Job Editor, per included worksheet, alongside the worksheet's Parameters mapping.
These options apply to a single worksheet. Report-level packaging (collating and splitting) is set through Job options.
Before you begin#
- Include at least one worksheet on the Reports step. Until an Output Options entry is added, the worksheet is generated with default behavior.
Set the options#
On the Reports step, open a worksheet's Output Options panel and set any of the following.
| Option | What it does |
|---|---|
| Sheet name | Sets the output worksheet's name, which can differ from the source tab. Use literal text plus parameter tokens, or read it from a calculated cell. The name also becomes the worksheet's PDF bookmark name. |
| Sheet tab color | Colors the worksheet tab in Excel output. Use a named color (Red, Blue), a hex code starting with # (for example #333333), or an integer ARGB value. |
| Output order | Sets the sequence in which this worksheet is rendered relative to others, as a manual integer or from a cell. Most ordering needs are met by collation in Job options. |
| PDF parent bookmark | Nests this worksheet under a parent in the PDF bookmark tree. The tree is three tiers: the root comes from Distribution Options, tier two defaults to the report name, and tier three is the worksheet name. Set a literal, tokens, or a calculated cell to group siblings under a custom parent. |
| Sheet suppression | Deletes the worksheet from the output when a cell or RWSHEETSUPPRESS formula evaluates TRUE. See below. |
| Exception check | Gates whether the whole report is sent. See below. |
When you set an option in the panel, it wins over the equivalent worksheet formula
(RW.Tools.SheetName, RW.Tools.SheetColor, and RW.Tools.SheetSuppress; the short aliases RWSHEETNAME, RWSHEETCOLOR, and RWSHEETSUPPRESS also work). The formula is used only when the panel option is left
unset.
Page breaks are not a per-worksheet Output Option. Control them from within the worksheet with the
RWPAGEBREAK function. See General report and layout functions.
Suppress a worksheet conditionally#
Sheet suppression deletes the tab from the output, it does not hide it, when its cell or
RWSHEETSUPPRESS formula evaluates TRUE (a value of 1 or a boolean true). On FALSE the tab is kept.
A common pattern is a formula that keeps a tab only when it holds data, so recipients never receive an empty schedule. A worksheet is also auto-suppressed when it carries a provider report that returns no data.
When to use it: drop lookup or staging tabs so recipients see only presentation worksheets, or hide a schedule that has nothing to show this period.
Send only on an exception (the exception check)#
The exception check turns a worksheet cell into a send gate for the whole report. The rule is an OR across every worksheet:
- If no worksheet defines an exception cell, the report always sends.
- If one or more worksheets define an exception cell, the report is delivered only when at least one of those cells, anywhere in the report, evaluates TRUE. If all of them are FALSE, delivery is suppressed.
When to use it: send a variance pack only to the managers who are actually over budget. Put an exception cell on a validation tab that turns TRUE when a threshold is breached, and recipients whose reports stay within tolerance receive nothing.
Notes and limits#
- Sheet tab color applies to Excel output; PDF parent bookmark applies to PDF output. The options are format-relevant.
- Suppression removes the tab entirely. There is no keep-but-hidden state at this layer.
Related topics#
Feedback on this page
Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.
Email feedback on this pageOr write to support@reportworq.com directly.