Workbench Report Sets allow you to generate, run, and download multiple Workbench Reports that have a common purpose from a single record. You can create reusable Workbench Report Sets by:
- Creating Workbench Report Set Definitions: To group Workbench Report Definitions so that they can be reused together for report generation, and to provide report parameters from a Principal View. From this record, users can generate Workbench Report Sets and its respective child reports.
- Creating Workbench Report Definitions: To provide the layout and other parameters (for example, Workbench View and Document Sensitivity) for a Workbench Report.
The following example is a use case for configuring reusable Workbench Report Sets: PADER aggregate reports require the same set of report definitions for each generation, therefore, you can create a Workbench Report Set Definition and add the Workbench Report Definitions required in PADER generation. Users can generate a report set from this Workbench Report Set Definition to efficiently produce the PADERs and then run these reports at an interval depending on their business needs.
Prerequisite
You must enable reusable Workbench Report Sets.
Create Workbench Report Set Definitions
To create Workbench Report Set Definitions:
- Navigate to Business Admin > Objects > Workbench Report Set Definitions.
- Select Create.
- On the Create Workbench Report Set Definition page, complete the following information:
- Name: Enter a Name for the Workbench Report Set Definition.
- API Name: Enter an API Name ending in
__c. - Description: Enter a Description for the Workbench Report Set Definition.
- Select Save.
Add Workbench Report Definitions
To add Workbench Report Definitions to the Workbench Report Set Definition:
- In the Workbench Report Set Definition, expand the Workbench Report Definitions section.
- Select Add.
- In the Search: Workbench Report Definition dialog, select definitions from the list or use the search bar and filters to refine your search.
- To create a new report definition, select Create.
- On the Create Workbench Report Definition page, complete the applicable fields and select Save.
- Select OK.
- Set up the Layout section. Workbench Report Definitions can reference up to five Dynamic Views in the Layout.
- Select Save.
You can add up to 50 Workbench Report Definitions on a Workbench Report Set Definition. If you copy a Workbench Report Set Definition, the new record includes the same Workbench Report Definitions as the original record. Additionally, if you delete a Workbench Report Set Definition, Vault does not delete the associated Workbench Report Definitions.
Workbench Report Definition Fields
The following fields may be available:
| Field | Description |
|---|---|
| Name | Enter a Name for the Workbench Report Definition. |
| API Name | Enter an API Name ending in __c. |
| Workbench View | Select a value from the drop-down or use the Advanced Search ( ) icon to use filters and refine your search. |
| Report Category | Select a value from the drop-down. Vault selects Ad Hoc by default. For more information on Report Categories, see Manage Workbench Reports. |
| Report Subcategory | Select a value from the drop-down. |
| Document Sensitivity | Select a value from the drop-down. For more information about Document Sensitivity values, see Manage Workbench Reports. When you generate reports from an associated report set, the report inherits this value. |
| Excel Template | Upload an Excel template by dragging and dropping the file from your local folder to this field or by selecting the Upload ( ) icon. As best practice, run a Workbench Report with this template to test before uploading it to a Workbench Report Definition. |
| Timezone | Select a value from the drop-down. |
Workbench Report Set Definition Filters
A Workbench Report Set Definition includes inherited filters from all associated Workbench Report Definitions. However, if there are multiple filters where the filter field API name has the same filter operator, Vault displays this filter only once. If a filter is required on any Workbench Report Definition, even if all other report definitions list it as optional, Vault sets this filter as required.
When configuring a Workbench Report Set Definition, filters are shared across all Workbench Reports. For example, the PADER Workbench Report Set has the Appendix: List of Death Cases and 15 Day and Non-15-Day Summary report definitions. If you add a required cancer__c filter to the Appendix: List of Death Cases safety view, after a user performs the Generate Report Set action, the cancer__c filter will appear:
- In the Filters section under the Required subsection for Appendix: List of Death Cases.
- In the Filters section under the Optional subsection on all other report definitions for the report set; in this case, for 15 Day and Non-15-Day Summary.