Some RegulatoryOne Registration & Dossier Management features require you to create components for specific component types as part of the configuration process. Component types are the configuration elements of a Vault that extend its functional behavior. Components are instances of component types that contain specific configuration details. Some components store additional data in subcomponents. Components have a parent-child relationship with their subcomponents, meaning that a subcomponent always belongs to a parent component.

You can view, create, and edit some components in your Registration & Dossier Management Vault; however, some components can only be accessed in MDL. You must use MDL to inactivate, reactivate, and delete any of the component types included in this article. See About Vault Components for more details about how to access, create, and alter components in MDL.

Component Types

The following component types are available in Registration & Dossier Management Vaults:

Label API Name Details Accessibility
Object Mapping Objectmapping Maps a source and target object. Accessible in Vault and MDL.
Field Mapping Fieldmapping This subcomponent of Object Mapping maps two (2) fields on the objects defined in the associated Object Mapping. Accessible in Vault and MDL.
Relational Token Relationaltoken Identifies how Vault creates or populates object records when supported actions run. Partially accessible in Vault with some functionality only accessible in MDL.
Relational Token Setting Relationatokensetting Defines the root Relational Token for supported actions. Only accessible in MDL.
Registration Attribute Registrationattribute Identifies how Vault matches Registrations to source Registration Items for local impact assessments. Only accessible in MDL.

Defining Object Mappings & Field Mappings

Object Mapping components define a source object and target object. Field Mappings are subcomponents of Object Mappings that map fields between the source and target objects defined in the associated Object Mapping. You must first create an Object Mapping, then add Field Mapping subcomponents to that Object Mapping.

You can access, create, and alter Object Mappings and Field Mappings in your Registration & Dossier Management Vault and in MDL. You must use MDL to delete or inactivate Object Mappings and Field Mappings. See Defining Object Mappings & Field Mappings for details about how to create Object Mappings with Field Mappings in your Vault.

Defining Relational Tokens

Relational Token components leverage hierarchical relationships between objects so that users can automatically generate and populate records based on token resolution when supported actions run. When you create recursive Relational Tokens, Vault applies the token to all generated records created as the token resolves through the hierarchy for the specified object until no more additional records can be created. You can also specify if any VQL Criteria on the Relational Token is applied as new records are created or after recursive record creation.

You can create non-recursive Relational Tokens in your Registration & Dossier Management Vault. You can also create Relational Tokens in MDL. You must use MDL to access and alter Relational Tokens after creation and to create recursive Relational Tokens. See Defining Relational Tokens for details about how to create non-recursive Relational Tokens in your Vault.

Relational Token Component Attributes

Relational Token components include the following attributes:

Attribute API Name Field Type Description
Name name String (Maximum length 128) API Name.
Token Label label String (Maximum length 60) UI-friendly string.
Active active Boolean Indicates if the component is active.
Description description String (Maximum length 1500) Optional description of this token.
Object object Object API Name of the object that this token refers.
Field Label field_label Object.field API Name of the object field used as a label for the token when it resolves. This field is only referenced when users run the Generate Requirements action.
VQL Criteria vql_criteria String (Maximum length 1500) Optional VQL Criteria to apply to object records when this token resolves.
Parent Token Reference Field Type parent_token_object Enum Determines how the Parent Token is processed relative to this token:
  • self: The Parent Token Reference Field is on the same Object of this token.
  • parent: The Parent Token Reference Field is on the Parent Token’s Object.
  • composition: The Parent Token Reference Field is on a join or composition object that has a relationship to this token’s Object.
  • none: This token has no parent, and the Parent Token Reference Field is "ID".
Parent Token parent_token Relationaltoken Token Label of the Parent Token. Leave this field blank for self types of Parent Token Reference Field Types.
Parent Token Reference Field parent_token_reference_field Object.field Field Label of the Parent Token.
Parent Token Object parent_token_object Object API Name of the Parent Token’s Object.
Parent Token Child Field parent_token_child_field Object.field API Name of the Parent Token’s Field Label.
Request Requirement Object Mapping request_requirement_object_mapping Objectmapping The selected Object Mapping targets the request_requirement__v object.
EDL Object Mapping edl_object_mapping Objectmapping The selected Object Mapping targets the edl__v object.
EDL Item Object Mapping edl_item_object_mapping Objectmapping The selected Object Mapping targets the edl_item__v object.
Request Object Mapping request_object_mapping Objectmapping The selected Object Mapping targets the request__v object.
Recursion Type recursion_type Enum Specifies the type of recursion to apply to this Relational Token:
  • self: The Recursion Reference Field is on this token’s Object.
  • composition: The Recursion Reference Field is on a join or composition object related to this token’s Object.
Recursion Object recursion_object Object API Name of the inbound object. For Composition recursion type, this specifies the object of this token’s inbound relationship.
Recursion Reference Field recursion_reference_field Object.field API Name of the field on which recursion is applied.
Recursion Child Field recursion_child_field Object.field API Name of the inbound object field. For Composition recursion type, this specifies the object field of this token’s inbound relationship.
Use VQL Criteria Post Recursion use_vql_criteria_post_recursion Boolean Specifies whether VQL Criteria is applied post record creation or at the time of record creation.

Defining Relational Token Settings

The Relational Token Setting component type defines settings for object actions that support Relational Tokens. You must link each supported action to the appropriate root Relational Token to specify which root token each action references when resolving Relational Tokens. This allows you to define Relational Tokens that indirectly reference objects. Relational Tokens referenced in Relational Token Setting components can also be used as needed for other purposes.

You must use MDL to access, create, and alter Relational Token Settings.

We recommend using the following two (2) Relational Token components (a parent and a child) to use as root tokens to link to supported actions. You may need to create these components if they are not already in your Vault:

Attribute Parent Token Child Token
Token Label registration_objective__c registration_item__c
API Name registration_objective__c registration_item__c
Object registration__v request__v
Parent Token Reference Field Type none self
Parent Token Reference Field id__v registration_objctive__v
Parent Token null registration_objective__c

Relational Token Setting Component Attributes

Relational Token Setting components include the following attributes:

Attribute API Name Field Type Description
Name name String (Maximum length 128) API Name.
Label label String (Maximum length 60) UI-friendly string.
Active active Boolean Indicates if the component is active.
Action action Enum The supported action to which this setting applies:
  • GENERATE_REQUIREMENT
  • GENERATE_REQUIREMENT_FOR_RO
  • SPLIT_REGISTRATION
Root Token root_token Relationaltoken The root Relational Token for specified Action.

Linking Actions to Root Tokens

You must create Relational Token Settings and set the Action (action) and Root Token (root_token) fields for the following supported actions:

  • Generate Requirements for Registration Item (GENERATE_REQUIREMENT): The Generate Requirement action on the Registration Item (request__v) object. The Root Token (such as registration_item__c) must reference the request__v object.
  • Generate Requirements for Registration Objective (GENERATE_REQUIREMENT_FOR_RO): The Generate Requirement action on the Registration (registration__v) object record. The Root Token (such as registration_objective__c) must reference the registration__v object.
  • Split Registration Item (SPLIT_REGISTRATION): The Split Registration Item action on the Registration Item (request__v) object. The Root Token (such as registration_item__c) must reference the request__v object.

If you are using the recommended Relational Tokens (registration_objective__c and registration_item__c), we recommend also using the following Relational Token Setting components to link supported actions to root tokens. You may need to create these components if they are not already in your Vault:

Attribute Generate Requirements for Registration Item Generate Requirements for Registration Objective Split Registration Item
Label generate_requirement generate_requirement_for_ro split_registration
Name generate_requirement__c generate_requirement_for_ro__c split_registration__c
Action GENERATE_REQUIREMENT GENERATE_REQUIREMENT_FOR_RO SPLIT_REGISTRATION
Root Token registration_item__c registration_objective__c registration_item__c

Any objects referenced in Relational Tokens must be directly or indirectly related to the object defined by the root Relational Token for the supported action in order for the Relational Token to resolve when that action runs. For example, when the Generate Requirement action runs on a Registration Item record and a related Requirement uses the packaging__c Relational Token in the Name field, the packaging__c Relational Token must be a direct or indirect child of the registration_item__c Relational Token.

Defining Registration Attributes

The Registration Attribute component type defines Registration Item field attributes and an optional Relational Token with linked Object Mapping that determines how Vault populates the specified field on Registration Items. You must create Registration Attributes components and link them to Regulated Category Attribute Impacts, which determine how Vault identifies Registration and Registration Objective matches when the Local Impact Assessment action runs. If you link a Registration Attribute to a Relational Token, Vault automatically populates the specified field on the source Registration Item record when the Generate Registration Data action runs based on the Object Mapping the Relational Token is linked to.

You can create only one (1) Registration Attribute component for each Registration Item field.

Registration Attribute Component Attributes

Registration Attribute components include the following attributes:

Attribute API Name Field Type Description
Name name String (Maximum length 128) API Name.
Label label String (Maximum length 60) UI-friendly string.
Active active Boolean Indicates if the component is active.
Field field object.field The field on the Registration Item object used as an attribute. This field only supports certain field types. If you enter a lookup field, you must leave the Relational Token field blank.
Relational Token relational_token object.field An active Relational Token that determines which Field Mapping is utilized to populate the specified field on a Registration Item record when the Relational Token resolves. This field is optional. Ensure that the Request Object Mapping field on the Relational Token is populated with a valid Object Mapping. The Object Mapping determines what value the specified field on a Registration Item record is populated with based on how the specified Relational Token resolves when users trigger the Generate Registration Data action.

Supported Field Types

Vault supports the following types of object fields for Registration Attributes:

  • Date
  • Number
  • Object (excluding references to the User object)
  • Picklist
  • Text (including long text and rich text)
  • Lookup (so long as the type is a supported type listed above)