Replicate output from your source system#
Replication is one report producing many outputs from a parameter's own values. Set the parameter's type so it reads the values you want, set its replication mode, and Reportworq produces one output per value at run time. Because the values are resolved on every run, the list of outputs tracks your source system with nothing to maintain in Reportworq.
Replication does not use the Bursting step, and it does not need the Burstable flag. Leave that flag off. It exists only to unlock the Bursting step, which is for burst sets, the tool for controlling individual outputs.
Before you start#
- The report is parameterized on the value you want to fan out on, for example Cost Center, Entity, or Region. See Parameterize a report.
- The parameter's type can hold more than one value. Any of the list or query types works, including a Planning Analytics subset, dimension, or MDX query, a SQL query, a Workday Adaptive, Oracle Smart View, Anaplan, or Vena dimension, an Excel range, or a typed Text List. Only Text Value is fixed to a single value. For the full catalog, see Parameters reference.
- A connection of the matching kind exists for any connector-specific type. A type appears in the list only when a connection of that kind is configured.
- The parameter is mapped on every worksheet that must replicate with it. See Parameterize a report.
Set a parameter to replicate#
- Open the job and go to the Parameters step.
- Find the parameter you want to fan out on and open its Edit sidebar.
- Set Parameter Type to the type that reads your values, then fill in the type's own editor below it: pick a subset from the tree, write the MDX or SQL query, choose the dimension members, point at the Excel range, or enter the list one value per line.
- Set Replication mode:
- One report per item produces a separate output file per value. This is the choice for per-recipient delivery.
- One page per item produces extra worksheets inside one output instead of separate files.
- No replication declares the parameter a single value.
- Leave Enable this parameter to be used in burst sets turned off.
- Select Save & Close.
Save matters. The Edit Parameters sidebar commits only on Save & Close. If you close it with Escape or the X, your changes are discarded.
Where the values come from#
The values are whatever the parameter's type resolves to at run time, so the choice of type is the choice of source. A Planning Analytics subset or MDX query reads the planning model live, so adding a member in Planning Analytics changes the roster with no change to the job. A SQL query reads the database on every run, so filtering to only the entities with activity this period makes the run scale up and down on its own. A Workday Adaptive, Oracle Smart View, Anaplan, or Vena dimension behaves the same way against those systems. An Excel range reads a workbook. A Text List is a fixed list you type.
The pattern is identical for all of them: whatever the type returns becomes the list of outputs. Choose the type that matches wherever your system of record already holds that list.
Route each output to a recipient#
Recipients are optional. If the job delivers to a fixed destination, such as one network folder or a static email list, there is nothing to configure here.
When each output needs its own recipient, the usual approach for a replicated job is contact mapping on the Distribution step: it matches a value from the replicated parameter against a field on your contacts and uses the match as that output's recipient. See Assign recipients to bursts.
What happens at run time#
Reportworq resolves every One report per item parameter to its list of values and produces one output file per combination of those values. Each output gets a stable internal name that keys its own output folder and resolves the file-name tokens for that value, so a name built from the parameter produces a distinctly named file per output. See Name and organize output files.
A One page per item parameter does not add files. It multiplies worksheets inside a single output.
The Run Jobs and Activity surfaces show a Burst chip on a job only when that job resolves to more than one output, so the chip reflects the actual fan-out for the run rather than any flag on the job.
Use cases#
- Per-cost-center P&L. A Cost Center parameter typed as a Planning Analytics subset, set to One report per item, produces one P&L per cost center, and picks up new cost centers as the model gains them.
- Per-entity forecast package. An Entity parameter driven by a SQL query against the entity master produces one packet per active legal entity, with no list kept in Reportworq.
- Per-region pack from a planning system. A Region parameter typed as a Workday Adaptive dimension produces one pack per region member.
- Monthly pack with two axes. A Period Text List and an Entity subset, both set to One report per item, produce one file per period and entity pairing.
- One workbook, a tab per department. A Department parameter set to One page per item produces a single workbook with one worksheet per department instead of many files.
Notes and limits#
- Two or more replicating parameters cross-join. Three business units and four departments produce 12 outputs. Check the arithmetic before you run.
- A "One report per item" parameter that resolves to zero values fails the run, with an error naming the parameter, rather than succeeding with nothing to deliver. A Text List whose lines are all blank resolves to zero values.
- Map the parameter to every worksheet that must replicate with it. Mapping it on one worksheet and not another leaves the second worksheet unreplicated. See Parameterize a report.
- A secured parameter is available only for "One report per item." Every value in a one-page-per-item output stays in the same workbook, so there is no per-value file to gate.
- If individual outputs need different treatment, for example a different query or a hand-picked value for one of them, replication is the wrong tool. Build burst sets instead.
Going deeper. Embedding one parameter's value inside another parameter's query, with the
%param:%and%global:%tokens, drives cascading one-report-per-item fan-out. See Advanced parameters.
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.