The Formulation Composition Viewer allows users to easily visualize a formula’s hierarchical composition, including all compositional components, and quickly check if the constituent chemicals meet regulatory requirements. This allows users to ensure that the formula is compliant by reviewing compliance data in the viewer, including Compliance Assessments generated from formulation questionnaire responses, before approving it for use by your organization.

The viewer displays all relevant child Formulations based on the child Formulation Compositions of the parent Formulation. From within the viewer, users can view, create, and update active Compliance Assessments for each listed Formulation and Regulated Category.

Configuration Overview

Configuring your Vault to use the Formulation Composition Viewer involves the following steps:

Mapping Regulated Categories

The Formulation Composition Viewer only displays data from Compliance Assessments with Regulated Category (Internal Name) values. These values represent internal names such as “TSCA” for the “Toxic Substance Control Act” Regulated Category. The viewer uses these internal names as column headers on the right side of the grid.

You must create internal names and map them to Regulated Categories so that the viewer displays relevant Compliance Assessments. When users select a Regulated Category on a Compliance Assessment record, Vault automatically populates the Regulated Category (Internal Name) field based on your mappings. Vault does not allow users to create Compliance Assessments for unmapped Regulated Categories.

To map Regulated Categories to internal names:

  1. Add appropriate values to the Regulated Category (Internal Name) picklist for all Regulated Categories.
  2. Add the Regulated Category (Internal Name) field to the Regulated Category object page layout.
  3. Populate the Regulated Category (Internal Name) field on all Regulated Categories in your Vault.

You cannot edit any picklist values that are currently referenced in any Compliance Assessment records.

Configuring Compliance Assessment Statuses

When creating Compliance Assessments, users must select a status to assign to the record and that status is displayed in the viewer. When Vault generates Compliance Assessments from formulation questionnaire data, the Compliance Assessment Status is automatically assigned based on pre-defined mappings.

Adding Values to Picklists

You must add values to the following picklists:

  • Compliance Assessment Status: This picklist contains the values of compliance assessment status and is used when users create and update Compliance Assessment records. We reccommend adding the values “Y”, “N”, “E”, “R”, “N/A”.
  • Assessment Status Color: This picklist contains the different colors that users can select for how Compliance Assessment Status values appear in the Formulation Composition Viewer. See Configuring the Assessment Status Color Picklist for more details.

Configuring the Assessment Status Color Picklist

You can configure the Assessment Status Color picklist to allow users to select specific colors to display Compliance Assessment Status values in the viewer. This allows users to draw special attention to a specific record’s compliance status for a certain category and alert all users of that status. We recommend configuring only a small number of colors to maximize the visual impact of colors in the viewer and help to direct user attention to specific statuses.

  1. Navigate to Admin > Business Admin > Assessment Status Color.
  2. Click Edit.
  3. In the Picklist values section, type a new color value such as “Red” and press Enter on your keyboard to add the new Picklist Value Label. The new value will also automatically populate the Picklist Value Name field for the new color.
  4. In the Picklist Value Name field for the new color value, replace the automatically populated color value with a six (6) digit hex color code such as “ff0000” for the color red. If you enter an invalid hex color code and a user selects that picklist value on a Compliance Assessment record, Vault displays that Compliance Assessment Status value in Vault’s default hyperlink color.
  5. Optional: Add additional colors to the picklist.
  6. Click Save.

When a user selects an Assessment Status Color for a Compliance Assessment record, Vault displays the Compliance Assessment Status in the selected color in the Formulation Composition Viewer for all users with Read permission for the Compliance Assessment Status field on the Compliance Assessment object.

If the Assessment Status Color field on a Compliance Assessment record is blank, Vault displays the Compliance Assessment Status in the Formulation Composition Viewer in Vault’s default hyperlink color for all users.

Configuring the Compliance Assessment Object Page Layout

You must add the Compliance Assessment Status and Assessment Status Color fields to the Compliance Assessment object page layout so that users can select a status and color that determines how Vault displays the Compliance Assessment Status value in the viewer.

You must also add the Regulated Category (Internal Name) field to the Compliance Assessment object page layout. Vault automatically populates this field based on regulated category mapping.

Configuring the Formulation Object Page Layout

You must update the Formulation object page layout so that users can see the Formulation Composition Viewer and add the appropriate child and parent records.

Adding the Formulation Composition Viewer Section

You must add the Formulation Composition Viewer section to the Formulation object page layout so that users see the viewer on a Formulation record’s detail page. To do this:

  1. Navigate to the object page editor for the Formulation object.
  2. Click Add Section and select the Formulation Composition Viewer control section with the slider (Slider Icon) icon.
  3. Optional: Enter a Section Label.
  4. Optional: Enter a Section Name.
  5. Optional: In the Show the section only in these lifecycle states field, select one (1) or more lifecycle states. This option only appears if the object uses a lifecycle.
  6. Optional: Enter Section Help that users will see on Formulation object records.
  7. Optional: Select the Expand the section by default checkbox so that the section is always open when users open Formulation object records.
  8. Optional: Select the Shade hierarchical levels checkbox to help users distinguish hierarchical levels when they open the viewer.
  9. Optional: Select the Highlight row on hover checkbox to help users distinguish the relevant column values for a Formulation when they hover on a specific row.
  10. Optional: For Grid Columns (Formulation Compositions), select up to 19 Formulation Composition fields to display on the left side of the grid. The Formulation Name field always displays as the first column, so you do not have to add it. This side of the grid only supports certain fields. Drag and drop the fields to determine the order the columns display to users.
  11. Optional: For Grid Columns (Regulated Categories), select up to 15 Regulated Categories to display as headers on the right side of the grid. The viewer will display Compliance Assessment Status picklist values for the applicable active Compliance Assessment records in these columns. If you don’t add any fields, the users cannot view or update Compliance Assessment Statuses in the viewer. Drag and drop the fields to determine the order the columns display to users.
  12. Optional: Enter VQL Criteria to constrain the Formulation records shown in the viewer based on fields on the Formulation Composition object. For example, to display only Formulations related to Formulation Compositions classified as “Raw Materials”, enter formulation_classification__c = 'raw_material__c'. This field does not support IN and LIKE operators or relationships (__vr or __cr).
  13. Click Done.
  14. Optional: Add additional Formulation Composition Viewer sections to the page layout if you want to display different composition criteria within a single Formulation record. For example, one (1) viewer section to display raw materials and another to display substances.
  15. Click Save when you are finished updating the Formulation page layout.

Supported Fields

Vault supports the following object field types in the Grid Columns (Formulation Compositions) field:

  • Name
  • Number
  • Object
  • Object Type
  • Picklist
  • Text
  • Yes/No
  • Lookup (so long as the type is a supported type listed above)
  • Formula (so long as the return type is a supported type listed above)

You must add two (2) related object sections for the Formulation Composition object to the Formulation object page layout. We recommend labeling the sections “Parent Compositions” and “Child Compositions” so that users can easily add and create relevant related records. When users add child Formulation Compositions to a parent Formulation record, Vault automatically includes the appropriate child Formulation records in the Formulation Composition Viewer on the parent Formulation.

Configuring the Formulation Composition Object Page Layout

You must add all fields you included in the Grid Columns (Formulation Compositions) field in the Formulation Composition Viewer section to the Formulation Composition object page layout. The viewer displays these object fields as columns on the left side of the viewer.

We recommend adding the Formulation Name field to the page layout. When users add child Formulation Compositions to a parent Formulation, Vault automatically populates this field with the Title of the Formulation users select for the Child field.

Limitations

If you plan to configure formulation questionnaire data import, do not use a lifecycle on the Compliance Assessment object.

Configuring User Permissions

You must ensure users have the appropriate read and create permissions to access the appropriate objects and object fields in addition to the following permissions:

  • For the Compliance Assessment object:
    • Delete permission and Edit permission on the Compliance Assessment Status field.
    • Edit permission on the Assessment Status Color field to modify the field value.
  • For the Formulation object: Read permission.
  • For the Formulation Composition object:
    • Read permission, including Read permission on the Formulation Name field.
    • Edit permission on any fields included in the Grid Columns (Formulation Compositions) field on the Formulation Composition Viewer section on the Formulation object.
  • For the Regulated Category object: Read permission, including Read permission on the Regulated Category (Internal Name) field.
  • If your Vault utilizes Atomic Security on fields, users must also have Edit permission on the appropriate lifecycle states for the applicable fields.

You can complete all the steps in this article with the standard System Administrator or Vault Owner security profile. If your Vault uses custom security profiles, your profile must grant the following permissions:

Type Permission Controls
Security Profile Admin: Configuration: Objects: Create, Edit Ability to create and modify Vault objects.
Security Profile Admin: Configuration: Picklists: Edit Ability to modify picklist values.
Security Profile Admin: Permission Sets: Read, Create, Edit Ability to make changes to permission sets for users.