Schedule distribution of the Workbook using a Workflow task once a report book has been created. Alternatively, you can run the Report Book on an adhoc basis if they have the correct folder permissions.

Run Report Books Adhoc

You may want to run the Report Book adhoc to test that it's been set up correctly. With proper folder permissions, you can run the Report Book on an adhoc basis.

To run the Report Book Adhoc:

  1. Navigate to the Explorer module.
  2. Navigate to the folder containing the Report Book.
  3. Right-click the Report book and select Run.
    The Report Book Definition pane appears.
  4. Modify the Compilation, Output, and Destination options as required at this time.
  5. If the Report book has a report that consists of parameters, it prompts for the parameter values before running. To choose a value, select the parameter edit box and then select an option from the member selector that appears.
  6. Select Run.
    The Report Book will run and a toast message appears: Report book execution in progress. You will receive a notification when complete.
  7. When the Report Book run is complete, another toast message appears: The Report book <filename> on <tenant> has been created and is now available in the file system at <destination>. The filename, tenant, and destination are variables.

Retrieving the results depends on the Destination selected.

DestinationResults
File
  • The output file is saved in the path provided in the specified destination under Explorer as ReportBook Name_CompilationType.xlsx. 
  • Double-click the output file to download the reports.
  • If the compilation type is Merged, results are merged into one Excel workbook. The first sheet serves as an index page listing the report names. From the index page, you can access/click each link to link directly to the sheet containing the selected report.
  • If the compilation type is Zip, the reports are contained in one zip folder. Extract the contents of the zip file to view each report as separate Excel workbooks.
Email

The output is emailed to the specified address. The toast message appears: The Report Book <filename> has been created and has been distributed via email. Filename is a variable.

The recipient will receive an email with the reports either merged or zipped, depending on the compilation type selected.

SlackThe results are sent to the designated Slack channel, where the reports are either combined or compressed based on the chosen compilation method.

Run Report Books through Workflow

To create a Workflow to distribute reports using Report Books:

  1. Navigate to Explorer and navigate to the folder to create the Workflow Process.
  2. Right-click the folder, and select New > Process to create a new workflow process.
  3. Enter the name of the Workflow Process and select CREATE.
  4. Drag the Run ReportBook task onto the Workflow Editor canvas to add it.
    You can locate the Run ReportBook task in the Reporting section of the Workflow toolbox.
  5. Select the Run ReportBook task and select the Edit icon to edit the parameters in the Task Configuration pane.
  6. Select Add Report Book to add a report book in the Report Books section of the Task Configuration Pane.
    The Pick A ReportBook dialog displays. Navigate to the Report Book that you want to add and select it.
  7. Expand the details of the Report Book. The Output and Destination displays default values selected when the Report Book was created. You can override these settings by changing the selections.
  8. If the selected Report Book has been set up to use parameters, there are fields to enter the report parameters. When setting parameters for the report, these options are available:
OptionValue
Option ASelect the parameter edit box to set the member. Select a member from the member selector that displays.
Option B 

Pass the parameter in from the Workflow process options when the Run Report Book task is called from a Workflow.

Select the cog icon beside the edit box and select from a list of available process parameters to specify to use the Workflow Process options.

  1. Select OK ‌when finished adding all reports to the book. Now save the Workflow.

Start the Workflow to test. When the Workflow is done, the output is either saved in a file or sent through email or Slack, depending on the Output Type.

You can adjust your Workflow Process to run on a schedule if needed, once you have confirmed that everything is working correctly.