Report Books combine several reports into a single report or package. It can then be distributed on a scheduled basis to users via a file location in Explorer, email, or Slack using the Run Report Book workflow task.
When you create a Report Book, you specify the reports to include in the package along with various distribution options.
- You can add both Anaplan XL reports and Anaplan Forms (XML Reports) to a Report Book.
- Some Anaplan XL Report or Anaplan Forms (XML Reports) are configured so that values for members such as Entity, Date, and Scenario, can be passed in as report parameters. You define the values for these parameters when creating the Report Book.
Once a report book is created, you can schedule the distribution of the workbook using a workflow task.
For more information on creating Report Books, see Report Books.
Configuration pane parameters
The key parameters include:
| Parameter | Description |
| Name | Enter the name of the Run Report Book task. |
| Report Books | Select from the list of Report Books, along with their respective parameters. |
| Report Book Parameter – Output | Select the destination/location in which the reports need to be distributed.
|
| Report Book Parameter – Destination | It corresponds to the Output selection. Select from these options:
|
| Advance Rule | Specify how to advance to the task. The default is All predecessors have completed. |
Configure a Run Report Book task
To configure the Run Report Book task:
- Drag the Run Report Book task onto the Workflow Editor canvas to add it.
Find the Run Report Book task in the Reporting section of the Workflow toolbox. - Select the Run Report Book task and select the Edit icon to edit the parameters in the Task Configuration pane.
- Select Add Report Book in the Report Books section to add a report book.
The Pick a Reportbook dialog appears. - Select the report book to add.
- Expand the details of the report book.
- The Output and Destination default to the values selected when the Report Book was created. Change the selections to override these settings.
- If the Report Book contains Parameters, fill in the values to use. The options available at the time of setting parameters include:
- Option A: Select the parameter edit box and then a member from the member selector to set the parameter.
- Option B: Pass the parameter in from the Workflow process options when the Run Report Book task is called from a workflow. To specify to use the Workflow process options, select on the cog icon and select from a list of available process parameters.
- Continue adding Report Books as needed.
- Select OK to apply your changes in the Task Configuration pane. Now, select Save to save the workflow.
- Select Play in the Workflow Editor toolbar to start the workflow. When the workflow starts, any parameter values you select are passed to the report parameters that were set to a Process Parameter.
- When the workflow is done, the output is either saved in a file or sent through email or Slack, depending on the Output Type.
Adjust your workflow process to run on a schedule if needed. For example, if you want to distribute the Report Book monthly.