Learn how to automatically generate Aggregate Report documents from reports in your Vault.
Note: Depending on your Admin’s configuration, object, field, and section labels, lifecycle states, and workflows may differ from the general information on this page. Refer to your organization’s business processes for guidance.
About Generating Aggregate Report Documents from Vault Reports
Vault SafetyDocs supports automatically generating aggregate report documents from Vault reports and linking them to related Aggregate Report Sections.
You can set up reports in your Vault to gather data such as custom interval line listings and custom tabulations, and then link them to Aggregate Report Sections where this data is needed. When you choose to generate a document from one of these reports, the system creates a document with data from the report and links it to the associated Aggregate Report Section. This process eliminates the need for manually running reports and uploading updated documents every time any information changes.
The following sections provide more details about the document generation process.
Prerequisite
Your Admin must enable Aggregate Report Management.
Link a Report to an Aggregate Report Section
To automatically generate a document from a report, you must link the report to an Aggregate Report Section by completing the following steps:
- Go to the Aggregate Report record on which you want to link a report to a Section.
- Create Aggregate Report Sections.
- If you are automatically generating Sections using a template and your Admin has completed the fields in the table below on the corresponding Template Item, the system automatically creates a Vault Report type Section and links it to the respective report.
- If you are manually creating Sections, in the Create Aggregate Report Section dialog, select Vault Report.
- In the Details section, complete the following fields and select Save:
| Field | Description |
|---|---|
| Source Report | The string of characters identifying the report from which this document will be generated.
From the report's URL, copy the 15-character string and paste it into this field. See the image below for reference. |
| Source Report Prompt | If your report has additional parameters, this is the string of characters identifying the specific parameter related to the document you want to generate.
From the report's URL, copy the string of characters after the question mark ( |
| Report Format | Select the format in which you want the document to be generated. The available options include the following:
|
Tokens for Source Report Prompts
If the report from which you are generating documents uses filters, you can use tokens in the Source Report Prompt field to represent the related field values. Every time you generate a document from this linked report, the system replaces the token with the most updated value of the field it represents. This process eliminates the need for manually updating the source report prompt every time some information changes.
Vault SafetyDocs supports the following dynamic tokens for source report prompts:
| Token | Source Field |
|---|---|
| ${AggregateReport} | Aggregate Report |
| ${ProductFamily} | Product Family |
| ${DataPeriodStart} | Data Period Start |
| ${DataPeriodEnd} | Data Period End |
| ${HealthAuthority} | Health Authority
This field applies to Local Sections only. |
| ${ApplicableMarket} | Applicable Market
This field applies to Local Sections only. |
Generate Documents
Once the report has been linked to the Aggregate Report Section, go to the All Actions menu of that Section record and select Generate Vault Report Document.
Result
This action initiates the following:
- The system uses the values entered in the related fields to identify which report to run.
- The associated report is run and a document is generated in your Vault library with data from the report.
- The document is linked back to the Aggregate Report Section in the Report Document field.
During the authoring process, if your Aggregate Report Sections have not reached the Complete state, you can initiate the Generate Vault Report Document action again to update this document. When the action is re-initiated, the system runs the associated report again and upversions the document with the updated details.