Controlled vocabularies in PromoMats allow you to restrict picklist options based on other field values and to prompt users to enter field information during workflow tasks. You can configure controlled vocabularies on document and object fields.

Configuring Vocabularies

To create controlled vocabularies:

  1. Navigate to Business Admin > Picklists > Controlled Vocabulary Type.
  2. Click Edit.
  3. Enter a Picklist Value Label, then press the Enter key or click .
  4. Navigate to Business Admin > Objects > Controlled Vocabularies.
  5. Click Create.
  6. Enter a Controlled Vocabulary Name. Controlled Vocabulary Names are the picklist options.
  7. Optional: Enter an Abbreviation.
  8. Select a corresponding Controlled Vocabulary Type.
  9. Click Save to finish or click Save + Create to create additional vocabularies.

Once you create controlled vocabularies, you can begin applying constraints.

Adding Constraints

The Constraint object stores allowed metadata combinations. You can use the Constraint object to define when users can select controlled vocabularies. The constraint’s object types indicates which values the CV fields represent. For example, if you create a Constraint object record with the type Submission, the CV1 field on the Constraint contains submission types while the CV2 field contains health authority decisions.

Adding Constraint Object Types

You can create new Constraint object types if your Controlled Vocabulary is unrelated to the existing types, or if you have already added criteria VQL expressions to the CV fields in the existing object types.

To add a new object type:

  1. Navigate to Admin > Configuration > Objects > Constraint > Object Types.
  2. Enter a Label.
  3. Enter a Plural Label.
  4. Enter a Name.
  5. Click Save.
  6. Click the Actions menu and select Edit Object Type Fields.
  7. Select the appropriate fields, including one (1) or all of the CV fields, then click Save.

Next, you can create reference constraints:

  1. Navigate to Admin > Configuration > Objects > Constraint > Object Types.
  2. Click the object type label, then select one of the CV fields.
  3. Click Edit.
  4. Set up a reference constraint.
  5. Click Save.

Create Constraint Records

To create Constraint records:

  1. Navigate to Business Admin > Objects > Constraints.
  2. Click Create.
  3. Select a Constraint Type.
  4. Optional: Select a Country.
  5. Optional: Select a CV1. This references a Controlled Vocabulary.
  6. Optional: Repeat step 5 for any other CV fields.
  7. Optional: Select a Product.
  8. Click Save to finish or click Save + Create to create additional constraints.

Download this CSV file to load our recommended constraints. You can also use it as a starting point when creating unique constraint records using Vault Loader.

Creating Document & Object Fields

You can apply controlled vocabularies to both document and object fields.

To apply controlled vocabularies to fields:

  1. Create a new document field or object field. Select Object as the Field Type and Controlled Vocabulary (controlled_vocabulary__v) as the Object.
  2. Click Save.
  3. Find and click on the new field name.
  4. Click Edit.
  5. Set up a reference constraint.
  6. Click Save.

The following table includes the relationship names for each CV field on the Constraint object:

Field Relatonship Name
CV1 constraints1__vr
CV2 constraints2__vr
CV3 constraints3__vr
CV4 constraints4__vr

By default, the Health Authority Submission and Health Authority Decision document fields include reference constraints. The Health Authority Decision field, for instance, includes the following reference constraint:

id IN (SELECT id FROM constraints2__vr WHERE cv1__v CONTAINS ), id IN (SELECT id FROM constraints2__vr WHERE country__v CONTAINS ), controlled_vocabulary_type__v = 'health_authority_decision__v', status__v != 'inactive__v'

Adding Fields to Workflow Prompts

When adding these document or object fields to workflow task prompts, you must include the fields on which the values are dependent. For example, if you add the Health Authority Submission document field to a task prompt, you must also add the Country field to the task prompt. This allows Vault to read the reference constraint, which contains a dependency on the Country.

If users cannot see available values when populating document or object fields referring to Controlled Vocabularies, ensure their permission set includes Read permissions for the Controlled Vocabulary and Constraint objects.

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

Type Permission Label Controls
Security Profile Objects: Constraint: Read, Create, Edit, Delete Grants ability to view, edit, and manage Constraint object records.
Security Profile Objects: Controlled Vocabulary: Read, Create, Edit, Delete Grants ability to view, edit, and manage Controlled Vocabulary object records.