Configuring the Packaging Composition Viewer (Compliance Management)

Compliance Management provides the Packaging Composition Viewer on Packaging records where users can review a package’s composition in relation to its formulation data. This allows you to determine the weight and percentage of recycled content in the packaging to help identify potential risks.

The viewer displays all relevant descendent Packaging records based on the child Packaging Compositions of the parent Packaging. From within the viewer on the parent record, users can view and open active Packaging and any related Formulation records. They can also view, create, and edit Packaging Qualitative Assessments for Packaging and Qualitative Assessments for Formulations.

Packaging Composition Viewer Objects

Compliance Management uses the following core objects and object types to support the Packaging 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.
• Packaging (packaging__v): This object represents a packaging component and contains information about version information for the packaging.
• Packaging Composition (packaging_composition__v): This object is a many-to-many self-reference to Packaging and represents the composition that makes up a package.
• Packaging Qualitative Assessment (packaging_qualitative_assessment__v): This object represents the compliance status of a Packaging’s regulated category.
• Qualitative Assessment (compliance_assessment__v): This object represents the compliance status of a Formulation’s regulated category.
• Regulated Category (regulated_category__v): This object represents a registration category for a location, such as “Cosmetic” or “OTC”.

Configuration Overview

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

1. Map Regulated Categories
2. Configure assessment statuses
3. Configure the Packaging Qualitative Assessment object layout
4. Configure the Packaging object layout
5. Configure the Packaging Composition object
6. Define referenced items
7. Configure user permissions

Mapping Regulated Categories

The viewer displays data from Packaging Qualitative Assessments and 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 Packaging Qualitative Assessments and Qualitative Assessments. When users select a Regulated Category on a Packaging Qualitative Assessment or Packaging Qualitative Assessment record, Vault automatically populates the Regulated Category (Internal Name) field based on your mappings. Vault does not allow users to create 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 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 Packaging Qualitative Assessment or Qualitative Assessment records.

Configuring Assessment Statuses

The viewer displays the status value of active Packaging Qualitative Assessments and Qualitative Assessments related to the Packaging and Formulations. When users create assessments, they must select a status value from the Compliance Assessment Status picklist.

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 Packaging Qualitative Assessments and 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.

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.

1. Navigate to Business Admin > Picklists > 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 Qualitative 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.

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 Packaging Qualitative Assessment Object Layout

You must configure the Packaging Qualitative Assessment object layout in the following ways:

• Add the Compliance Assessment Status and Assessment Status Color fields to the layout so that users can select a status and color that determines how Vault displays the Compliance Assessment Status value in the viewer.
• Add the Regulated Category (Internal Name) field to the layout. Vault automatically populates this field based on regulated category mapping.

Configuring the Packaging Object Layout

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

Configuring the Packaging Composition Viewer Section

You must update the Packaging object layout so users can see the viewer. To insert the viewer section:

1. Navigate to Admin > Configuration > Objects > Packaging > Layouts > [Layout].
2. Insert the Packaging Composition Viewer control section with the slider () icon.
3. Optional: Change the Section Label.
4. Optional: Change the Section Name.
5. Optional: Enter Section Help to display to users in this section.
6. Optional: Select the Expand the section by default checkbox so that the section is always open when users open Packaging object records.
7. Optional: Select the Expand formulation records by default checkbox so that all Formulation levels are always open when users open the viewer.
8. Optional: Select the Shade hierarchical levels checkbox to help users distinguish hierarchical levels in the viewer.
9. Optional: Select the Highlight row on hover checkbox to help users distinguish the relevant column values when they hover over a specific row.
10. For Grid Columns (Packaging Compositions), select supported standard (__v) Packaging Composition fields to display on the left side of the grid. You must add the Packaging ID field as the first column. The order you add the fields is the same order they display to users.
11. For Freeze Grid Columns (Packaging Compositions), select how many Packaging Composition columns to freeze on the left side of the grid while users scroll horizontally.
12. 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 Packaging 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, the right side of the grid will not display and users cannot view Compliance Assessment Statuses in the viewer.
13. Optional: Enter VQL Criteria to constrain the Packaging records shown in the viewer based on fields on the Packaging Composition object. For example, you can use VQL Criteria to exclude tertiary types of packaging components. This field does not support IN or LIKE operators or relationships (__vr) or __cr).
14. Click Done.
15. Click Save when you finish updating the layout.

Vault supports a single Packaging Composition Viewer section on any Packaging record details page.

Supported Fields

Vault supports the following object field types in the Grid Columns (Packaging 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)

Inserting Related Object Sections

You must insert two (2) related object sections for the Packaging Composition object to the Packaging 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 Packaging Compositions to a parent Packaging record, Vault automatically includes the appropriate child Packaging records in the viewer on the parent Packaging.

Configuring the Packaging Composition Object

You must configure the Packaging Composition object to support the viewer.

Configuring Packaging Composition Fields

Depending on the business needs of your organization, you can configure the Child field on the Packaging Composition object as a required field. To allow users to create Formulation types of Packaging Composition records that will display in the viewer, you must configure the Child field to be optional.

Configuring the Packaging Composition Object Layout

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

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

We also recommend adding the following fields to the layout:

• Child
• Composition Type
• Formulation Child
• Function Target
• Unit

Defining Referenced Items

For users to utilize the Packaging Composition Viewer, you must define the appropriate Formulation, Formulation Composition, Packaging, and Packaging Composition records by creating new records or importing them into your Vault from an external connection to a third-party application, such as a PLM system.

Packaging Compositions

You must create the relevant Packaging Compositions to specify the composition type and link each parent Packaging to the appropriate child Packaging or Formulation. To create a Packaging Composition:

1. Navigate to Business Admin > Objects > Packaging Composition.
2. Click Create.
3. Optional: Enter the External ID.
4. Select the Parent Packaging record.
5. Select the Child Packaging record. Leave this field blank if you select Formulation as the Composition Type.
6. Optional: Select the Composition Type.
7. If you selected Formulation as the Composition Type, select a Formulation Child. If you selected any other value, leave this field blank.
8. Optional: Select the Function.
9. Optional: Enter the Target.
10. Optional: Select the Unit.
11. Click Save.

You can use Vault Loader to create and update fields on multiple Packaging Composition records.

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 Packaging Composition object: Read permission, including Read permission on the Parent and Child fields.
  • If you configure Atomic Security on the Child or Formulation Child fields, users must have Read permission on those fields to see child records in the viewer.
• For the Packaging object: Read permission, including Read permission on the Packaging ID field.
• If you add VQL Criteria to the Packaging Composition Viewer control section, users must have Read permission on all referenced Packaging Composition fields.
• To view Formulation types of Packaging Compositions in the viewer, users must have Read permission on the following objects:
  • Formulation, including Read permission on the Name field.
  • Formulation Composition, including Read permission on the Name field.
• To view the right side of the viewer, users must have Read permission on the following objects:
  • Packaging Qualitative Assessment, including Read permission on the Assessment Status, Packaging, and Regulated Category fields.
  • Regulated Category, including Read permission on the Regulated Category (Internal Name) field.
  • Qualitative Assessment, including Read permission on the Compliance Assessment Status, Formulation, and Regulated Category fields.
• 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 Packaging Qualitative Assessment or Qualitative Assessment objects, users can only view and populate fields for which they have permission to Read and Edit.
• Users can only see data for grid columns for which they have Read permission.