Configuring the Formulation Composition Viewer (Compliance Management)

Compliance Management provides the Formulation Composition Viewer, which allows users to easily visualize a formula’s hierarchical composition, including all compositional components, and quickly check if the constituent chemicals meet regulatory requirements. Users can ensure that the formula is compliant by reviewing compliance data in the viewer, including Qualitative 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 open active Qualitative Assessments for each listed Formulation and Regulated Category. You can configure the viewer to enable users to create up to 15 Qualitative Assessments in bulk.

Note: To use this feature, each raw material in the applicable Formulation can be associated with no more than one (1) supplier.

Formulation Composition Viewer Objects

Compliance Management uses the following core objects and object types to support the Formulation Composition Viewer:

Formulation (formulation__v): This object represents a formulation and contains information about version, classification (raw material, formula, or substance), and supplier.
Formulation Composition (formulation_composition__v): This object creates a many-to-many self-reference to Formulation and represents the composition that makes up a formula.
Regulated Category (regulated_category__v): This object represents a registration category for a location, such as “Cosmetic” or “OTC”.
Qualitative Assessment (compliance_assessment__v): This object represents the compliance status of a formulation’s regulated category.

Note: In Vaults created prior to 22R3, the Qualitative Assessment object may be labeled Compliance Assessment.

About the Formulation Composition Viewer

You can configure the viewer to display Regulated Category object field columns, allowing users to view, create, and open Qualitative Assessments directly in the viewer. This also allows users to populate the Compliance Assessment Status field directly in the viewer. You can specify an additional secondary field that users can populate in the viewer.

About Bulk Create

You can enable bulk create on the viewer, allowing users to create up to 15 Qualitative Assessments at a time for a Formulation from directly in the viewer. When they click the Manage Qualitative Assessments icon for a Formulation in the viewer, the Manage Qualitative Assessments for [Formulation Title] dialog appears. The dialog includes the Qualitative Assessment Status field and, when applicable, the secondary field you configure to appear in the dialog. If any Qualitative Assessments already exist for that Formulation, those values are pre-populated in the dialog. If you’ve configured default values for either field, they are automatically populated in the dialog for users to review.

Users can populate and update values in the dialog. If they change values for any existing Qualitative Assessments, Vault inactivates the existing record and replaces it with a new record with the values specified by the user.

Configuration Overview

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

Map regulated categories
Configure assessment statuses
Configure the Formulation object layout
Configure the Qualitative Assessment object layout
Configure Formulation Composition object layout
Configure user permissions

Note: Depending on your Vault’s creation date and which features are currently enabled and configured, some of the steps described in this article may be unavailable or already complete in your Vault.

Mapping Regulated Categories

The viewer only displays data from Qualitative Assessments with Regulated Category (Internal Name) values. These values represent internal names your organization uses for regulated categories 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 Qualitative Assessments. When users select a Regulated Category on a Qualitative Assessment record, Vault automatically populates the Regulated Category (Internal Name) field based on your mappings. Vault does not allow users to create Qualitative Assessments for unmapped Regulated Categories.

To map Regulated Categories to internal names:

Add appropriate values to the Regulated Category (Internal Name) picklist for all Regulated Categories.
Add the Regulated Category (Internal Name) field to the Regulated Category object layout.
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 Qualitative Assessment records.

Configuring Assessment Statuses

The viewer displays the status value of active Qualitative Assessments related to the Formulation. When users create Qualitative Assessments, they must select a status value from the Compliance Assessment Status picklist. When Vault generates Qualitative Assessments from imported formulation questionnaire data, the Compliance Assessment Status is automatically assigned based on your pre-defined mappings.

Adding Values to Picklists

You must add values to the following picklists:

Compliance Assessment Status: This picklist contains the status values users can assign to Qualitative Assessments. We recommend adding the values “Y”, “N”, “E”, “R”, and “N/A”.
Assessment Status Color: This picklist contains the colors that users can select to specify how Compliance Assessment Status picklist values appear in the Formulation Composition Viewer. See Configuring the Assessment Status Color Picklist for more details.

Note: These picklists also display statuses in the Packaging Composition Viewer.

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 displayed in the viewer and help direct user attention to specific statuses.

Navigate to Business Admin > Picklists > Assessment Status Color.
Click Edit.
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.
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 record, Vault displays that Compliance Assessment Status value in Vault’s default hyperlink color.
Optional: Add additional colors to the picklist.
Click Save.

Vault displays the Compliance Assessment Status in the selected color in the viewer for all users. If the Assessment Status Color field is blank, Vault displays that status in Vault’s default hyperlink color for all users.

Configuring the Qualitative Assessment Object Layout

You must add the Compliance Assessment Status and Assessment Status Color fields to the Qualitative Assessment object 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 Qualitative Assessment object layout. Vault automatically populates this field based on regulated category mapping.

Configuring the Formulation Object Layout

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

Inserting the Formulation Composition Viewer Section

You must insert the Formulation Composition Viewer section to the Formulation object layout so that users see the viewer on a Formulation record’s detail page.

To insert the viewer section:

Navigate to Admin > Configuration > Objects > Formulation > Layouts > [Layout].
Insert the Formulation Composition Viewer control section with the slider () icon.
Optional: Enter a Section Label.
Optional: Enter a Section Name.
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.
Optional: Enter Section Help that users will see on Formulation object records.
Optional: Select the Expand the section by default checkbox so that the section is always open when users open Formulation object records.
Optional: Select the Shade hierarchical levels checkbox to help users distinguish hierarchical levels when they open the viewer.
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.
Optional: For Grid Columns (Formulation Compositions), select up to 20 Formulation Composition fields to display on the left side of the grid. The Formulation Name field must be the first column. This side of the grid only supports certain fields. Drag and drop the fields to determine the order the columns display to users.
Optional: For Freeze Grid Columns (Formulation Compositions), select how many columns to display on the left side of the grid while users scroll horizontally based on the order you arranged the fields. Drag and drop the fields to determine the order the columns display to users.
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 Qualitative Assessment records in these columns. Drag and drop the fields to determine the order the columns display to users. If you don’t add any fields, users cannot view Compliance Assessment Statuses in the viewer.
Optional: Enable users to bulk create Qualitative Assessments for a Formulation in the viewer:
- Select the Enable Bulk Create checkbox.
- Optional: Select a picklist field as the Bulk Create Secondary Field that users can populate when in the Manage Qualitative Assessments for [Formulation Title] dialog. This field is only enabled if you added one (1) or more object fields to the Grid Columns (Regulated Categories) field.
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 or LIKE operators or relationships (__vr or __cr).
Click Done.
Optional: Insert additional Formulation Composition Viewer sections to the layout if you want to display different composition criteria within a single Formulation record. For example, one (1) viewer section to display composition inventory status and another to display composition certifications. You can insert up to five (5) viewers to an object’s layout.
Click Save when you are finished updating the 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 insert two (2) related object sections for the Formulation Composition object to the Formulation object 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 viewer on the parent Formulation.

Configuring the Formulation Composition Object 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 layout. The viewer displays these object fields as columns on the left side of the grid.

We recommend adding the Formulation Name field to the 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 Qualitative 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 Qualitative Assessment object:
- Delete permission.
- Edit permission on the Assessment Status Color and Compliance Assessment Status fields.
- When applicable, users must have Edit permission on the field you added to the Bulk create secondary field in the Formulation Composition Viewer section.
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.
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.
If your Vault utilizes DAC for the Qualitative Assessment object, users can only view and populate fields for which they have permission to Read and Edit.

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: Picklists: Edit	Ability to modify picklist values.
Security Profile	Admin: Configuration: Objects: Create, Edit	Ability to create and modify Vault objects.
Security Profile	Admin: Security: Permission Sets: Edit	Ability to modify permission sets for users.