Learn how to organize Workbench Reports using a custom tabular structure.
About Advanced Options
On the Workbench Report, the Advanced Options section allows you to perform two (2) actions:
- Sample
- Upload
With the Sample action, you can download the sample template for the Workbench Report. This file allows you to familiarize yourself with report tokens and how Safety Workbench uses these tokens to insert data on reports. You can also edit this file and apply formatting using all of Excel’s functionality.
The Upload action allows you to upload a customized Excel template file that defines the structure of the Workbench Report data. The Excel template overrides the Workbench Report layout, including any grouping.
Navigate to Workbench > Ad Hoc Reports > [report]. Select the Edit icon and expand the Advanced Options section to make updates. When creating a new report, you must first save the report to access the Advanced Options section.
The following sections describe these actions in more detail.
Download a Sample Report File
To download the sample file of the Workbench Report, see Using Excel Report Templates. Vault generates a sample Excel template and names the file after the report.
Vault disables the Sample button if no fields (columns) have been added to the Workbench Report layout.
The Excel file contains two (2) worksheets:
- Coverpage
- Export
Vault updates a report’s sample template each time you make changes to the report. You can download the sample template and customize it however you like. A few examples include:
- Moving data between worksheets
- Adding custom worksheets
- Renaming columns
- Including headers and footers
- Updating page orientation, size, and margins
- Applying conditional formatting
- Applying cell formatting, such as bolding and background colors
However, you should not change the tokens in the sample template. Changing the tokens will prevent Vault from correctly populating the report template. If you accidentally make unwanted changes to the sample template, you can always download it again.
Excel Template: Coverpage
The first worksheet in the sample Excel template is named Coverpage and includes the following report tokens:
| Report Token | Description |
${reportName} |
Name of the report |
${runDateTime} |
Date and time the report was last run |
${exportedByUsername} |
Email of the user exporting the report |
${vaultName} |
Name of the Vault |
${domainName} |
Name of the domain |
${meddraVersion} |
Current version of the Vault's MedDRA library |
${runDataUpdatedDateTime} |
Data transfer from Vault Safety to Vault Safety Workbench occurs daily. This field defines the cut-off day and time for the transfer of Safety data that was reported on. |
${reportViewName} |
Safety view of the report |
These tokens provide more information about the parameters of the report.
If the Workbench Report contains filters, the Coverpage worksheet also includes the following filter tokens:
| Filter Token | Description |
|---|---|
${filter.view} |
Name of the safety view |
${filter.advanced_logic_number} |
Advanced logic number assigned to this filter |
${filter.field} |
Field identifier of the filter |
${filter.operator} |
Operator (like equals or is in the range) selected in the filter field |
${filter.value} |
Value entered in the filter field |
${advancedLogic} |
Advanced logic of the current report |
The Excel file displays one (1) filter per row.
The following image represents an example of a sample file’s Coverpage worksheet:
Excel Template: Export
The second worksheet in the Excel template is named Export. Each heading in the Excel template corresponds to a field (column), either the name of the field or an alias specified by a user, in the Workbench Report layout.
The following image represents an example of a sample file’s Export worksheet:
When a user runs and downloads the report in Excel format, Vault uses the tokens on the Coverpage and Export worksheets to insert the specified data into each applicable cell.
Vault allows you to use column tokens and named ranges in Excel templates. For more information about named ranges, see Microsoft’s Create a Named Range in Excel.
Note: Vault does not support column tokens in merged cells.
Optionally, you can update the Export template and upload it to the Workbench Report.
Upload a Customized Template File
An Excel template overrides the Workbench Report layout, including any grouping. Once you create a template and upload it to a Workbench Report in your Vault, Vault uses the uploaded template to organize the report data and saves it as an Excel file with the same file name as the template. If the Workbench Report is downloaded in CSV format, Vault uses the tabular structure defined in the Workbench Report layout.
To upload a customized template file to the Workbench Report, see Using Excel Report Templates. If the Excel template contains custom formatting, Vault retains this formatting in the generated report output.
You can upload a reformatted sample file or a new Excel template file.
When uploading a template file, consider the limitations in Using Excel Report Templates and the following additional restrictions:
- Vault replaces the following restricted characters with a dash (-):
<>:"/|?* - Vault truncates file names to 197 characters.
Note: Ensure the template file you upload does not contain any errors. Vault does not perform any additional verification and accepts any layout overrides that occur.
After uploading a template file, you can select the Actions menu beside it to perform additional actions such as:
- Upload and Replace: Select this option to replace the current template file.
- Download: Select this option to download the current template file. If the Workbench Report contains unsaved changes, you must first save the report to download it.
- Delete: Select this option to delete the current template file from the Workbench Report.
Standard Workbench Aggregate Report Templates
For information about standard aggregate report templates and to download them for Workbench Reports, see Use Aggregate Report Templates for Workbench Reports.