Job options: collation and splitting#
Job Options is a control in the Distribution Job Editor's chrome band, alongside the job's title, Save, and Discard. It sets job-level output behavior: how the job's worksheets are assembled into files. These are job-wide settings, distinct from the per-worksheet settings on the Reports step (see Worksheet output options).
Before you begin#
- Have a distribution job with at least one worksheet. Job Options is available throughout authoring from the editor chrome.
Set the options#
- In the job editor chrome, select Job Options.
- Set the options you need:
| Option | What it does |
|---|---|
| Enable manual collation | Turns on manual control over how worksheets and outputs are collated (grouped and ordered) into the produced files, instead of the default automatic collation. |
| Split worksheets | Splits the job's worksheets into separate outputs, for example one file per worksheet, rather than combining them into a single workbook. |
| Succeed when Sheet Suppression removes every report | Unticked by default, and then a run in which Sheet Suppression removes every worksheet of every report fails with "No reports included in job output". Ticked, such a run finishes as Success: nothing is sent, the step log says "Information: No reports were produced: Sheet Suppression removed every worksheet.", and Release All has nothing to release. |
Split worksheets is how you produce CSV. A CSV file holds exactly one sheet of data, so a multi-worksheet job has to be split before it can be written out as CSV. Turn on Split worksheets and select the CSV output format, and each worksheet becomes its own
.csv. Leave it off and only one worksheet can survive the conversion. See Output formats.
These options are also surfaced as Manual Collation and Split Worksheets in the Distribution step's advanced options.
When to use each#
- Enable manual collation when the order in which worksheets are packaged into the delivered file matters and the default assembly is not right, for example forcing statement, then supporting schedules, then notes in a monthly pack. Manual collation also works with "one page per item" replication so pages can interleave by parameter across worksheets (see the replication modes in the Parameters reference).
- Split worksheets when each worksheet should be delivered as its own file rather than as one combined workbook, for example one file per department, or one file per cost-center worksheet for individual distribution.
- Succeed when Sheet Suppression removes every report for a job that is meant to produce nothing on some runs, for example a burst where a slice has nothing to report and its only worksheet is suppressed. Leave it unticked if an empty result should be treated as a problem. The box covers Sheet Suppression only: a report with nothing to output for another reason (every included worksheet hidden in Excel, say) still fails. A job held back by an exception check is not affected either way: that run already succeeds and only the delivery is skipped.
Notes and limits#
- Job Options are job-wide. Per-tab naming, color, ordering, and suppression are handled by the per-worksheet Worksheet output options.
- Format-specific packaging such as zipping outputs and combining emails is set on the Distribution step, not here.
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.