Learn how to configure your Vault to support generating tabulations using Aggregate Report Sections.
About the Feature
When authoring aggregate reports using Sections, you can generate and manage tabulations from each Section. This gives you more granular control over your aggregate reports because tabulations can be generated or updated for specific areas of the report as needed.
For more information, see Generate Tabulations Using Aggregate Report Sections.
The following sections provide instructions to enable this feature in your Vault.
Note: Depending on other Aggregate Reporting features you have enabled, you may already have some of this configuration in your Vault.
Enable Setting to Generate Tabulations Using Sections
Complete the following steps to enable your Vault to generate tabulations using Aggregate Report Sections. When this setting is not enabled, your Vault will generate tabulations at the Aggregate Report level only.
- Go to Admin > Settings > Aggregate Report Settings.
- Select Edit.
- In the Aggregate Report Authoring section, select the Generate Tabulations Using Sections checkbox.
- Select Save.
Update Labels
Starting in 24R1, Aggregate Report Tasks are called Aggregate Report Sections. Complete the following steps to update this label across your Vault:
- Go to Admin > Configuration > Objects > Aggregate Report Task.
- Select Edit and update the fields as follows:
- Object Label: Enter “Aggregate Report Section”
- Object Plural Label: Enter “Aggregate Report Sections”
- Select Save.
- On the Object Types tab, select Authoring Task.
- Select Edit and update the fields as follows:
- Label: Enter “Authoring Section”
- Plural Label: Enter “Authoring Sections”
- Select Save.
- On the Fields tab, select Aggregate Report Task Type.
- Select Edit and in the Label field, enter “Aggregate Report Section Type”.
- Select Save.
- On the Fields tab, select Task Order.
- Select Edit and in the Label field, enter “Section Order”.
- Select Save.
Configure Layouts
Layouts are managed through Admin > Configuration > Objects > [object] > Layouts.
Configure the Aggregate Report Template Item Layout
Complete the following steps to configure this layout:
- Go to Objects > Aggregate Report Template Item > Layouts > Aggregate Report Template Item Detail Page Layout.
- To ensure that only the documents you can generate for the selected Aggregate Report Type appear in the dropdown, in the Details section, add the Document to Generate field.
- Select Save.
Configure the Aggregate Report Section Layout
Complete the following steps to configure this layout:
- Go to Objects > Aggregate Report Section > Layouts > Aggregate Report Section Detail Page Layout.
- In the Details section, add the following fields:
- Report Document (Masked)
- Report Document (Log)
- Tabulation Generation Date
- To ensure that only the documents you can generate for the selected Aggregate Report Type appear in the dropdown, in the Details section, add the Document to Generate field.
- Select Save.
Configure Action to Generate Tabulations
Complete the following steps to configure an action on the Aggregate Report Section object to generate tabulations:
- Go to Admin > Configuration > Objects > Aggregate Report Section > Actions and select Create.
- In the Create Action dialog, select Generate Aggregate Report Tabulation and then select Continue.
- On the Create Action page, enter a Label and Name for the action.
- Select Save.
Add Action to the Safety Tabulation Object Type
Complete the following steps to associate this action with the Safety Tabulation object type of the Aggregate Report Section object. This enables users to initiate the action from Safety Tabulation type Sections.
- In the Aggregate Report Section object, go to the Object Types tab.
- On the top-right corner, select Actions.
- From the Actions menu, select Edit Object Type Actions.
- For the Safety Tabulation object type, select the Generate Aggregate Report Tabulation checkbox.
- For all other object types, clear the Generate Aggregate Report Tabulation checkbox.
- Select Save
Configure the Aggregate Report Tabulation Document Lifecycle
Go to Admin > Configuration > Document Lifecycles > Aggregate Report Tabulation and complete the following steps:
Update Permissions for the Assigned To Role
Complete the following steps to grant permissions to the Assigned To role for each lifecycle state:
- In the States section, select Draft > Security Settings.
- Select Edit.
- Grant the same permissions to the Assigned To role as granted to the Editor role.
- Select Save.
Configure the Aggregate Report Section Object Lifecycle
Go to Admin > Configuration > Object Lifecycles > Aggregate Report Section Lifecycle and complete the following steps:
Add User Action
Complete the following steps to add a user action to the Open and In Progress states:
- In the States section, select Open.
- In the User Actions section, select Edit > Create Rule.
- Create the following rule and select Save:
- Perform with conditions > Aggregate Report Section Type > equals > Safety Tabulation > Generate Aggregate Report Tabulation
- Repeat steps 2 and 3 for the In Progress state.
Add Entry Actions
Complete the following steps to add entry actions to the Complete state:
- In the States section, select Complete.
- In the Entry Actions section, select Edit > Create Entry Action.
- Create the following rules and select Save:
- Always > Change related document lifecycle state > Report Document (Masked) > Steady State
- Select the Skip change state if document version is not found checkbox.
- Always > Change related document lifecycle state > Report Document (Log) > Steady State
- Select the Skip change state if document version is not found checkbox.
- Always > Change related document lifecycle state > Report Document (Masked) > Steady State
Create the Aggregate Report Section - Safety Tabulation Stage Group
Complete the following steps to create this group and associate its stages with states:
- Go to Admin > Configuration > Lifecycle Stage Groups and select Create.
- In the Create Lifecycle Stage Group dialog, select Object Stage Group and then select Continue.
- On the Create Lifecycle Stage Group page, complete the fields as follows and select Save:
- Stage Group Label: Enter “Aggregate Report Section - Safety Tabulation”
- Object Lifecycle: Select Aggregate Report Section Lifecycle
- Object Type: Select Safety Tabulation
- Select Save.
- On the Aggregate Report Section - Safety Tabulation page, in the Stages section, select Create and create the following stages in order:
- Open
- In Progress
- Complete
- Add states to each stage according to the table below. To add a state, go to [Stage] > States and select Add. Then select the Plus icon next to the state you want to add and select OK.
Stage | State to Add |
---|---|
Open | Open |
In Progress | In Progress |
Complete | Complete |
Update Permission Sets
Permission sets are managed through Admin > Users & Groups > Permission Sets. The following sections describe how to update various permission sets in your Vault to grant access to this feature:
Administration Actions
Update this permission set as follows:
- Go to the Administration Actions permission set.
- In the Objects tab, select Edit.
- Grant Read permissions on the following object:
- Aggregate Report Section:
- Safety Tabulation
- Aggregate Report Section:
- Grant Read, Create, and Edit permissions on the following object:
- Aggregate Report Template Item:
- Safety Tabulation
- Aggregate Report Template Item:
Aggregate Report Writer
Update this permission set as follows:
- Go to the Aggregate Report Writer permission set.
- In the Objects tab, select Edit.
- Grant Read, Create, Edit, and Delete permissions on the following objects:
- Aggregate Report Section:
- Safety Tabulation
- Aggregate Report Template Item:
- Safety Tabulation
- Aggregate Report Section:
Safety Operations Actions
Update this permission set as follows:
- Go to the Safety Operations Actions permission set.
- In the Objects tab, select Edit.
- Grant Read, Create, Edit, and Delete permissions on the following objects:
- Aggregate Report Section:
- Safety Tabulation
- Aggregate Report Template Item:
- Safety Tabulation
- Aggregate Report Section: