Requirement Set Template
Table of Contents
Requirement Set Template
(Note: This is one of the objects related to Application Requirements and Checklist. For a use case and example, see here.)
Introduced in v3.11, this object is used as a template for Requirement Set, which are a grouped set of Requirements that users need to perform for a process.
- Requirement Set Template ---> Requirement Set.
When the criteria field on a target object returns the expected value, this Requirement Set Template (and its underlying Requirement Templates) will be cloned as a Requirement Set (and its underlying Requirements) on the target object.
For example, this Requirement Set Template is created for the Program Application process.
The Object field should be the API name of the target object (which in this case, is the Program Application).
The Object Lookup field should be the API name of the field on the Requirement Set that looks up to the target object.
By default, the Requirement Set already has lookup fields to Program Application and EDA Application.
If you want to use a different target object, you will need to create a new lookup field on the Requirement Set, and use its API name for the Requirement Set Template's 'Object Lookup Field'.
Once the Criteria Field (e.g. 'Status' field) on the Program Application returns a 'Submitted' value, this Requirement Set Template will be cloned as a Requirement Set on the Program Application.
Note: The configuration section only allows for one Criteria Field. If you need multiple Criteria Fields to trigger the creation of Requirement Sets, you can create a custom formula field to reference those other fields. That custom formula field can then be your Criteria Field.
See here for use case.
Fields
Field name | Description |
Requirement Set Template Name | Name for this record. |
Requirement Set Code |
Used for filtering previously created requirement sets. A unique value must be populated, in order for this to be displayed on the checklist (if there are multiple other Requirement Set Templates). |
Active | If checked, and when the criteria field is populated with the expected value, the requirements here will be active (users will need to perform them). |
Requirement Set Description | Text field to add descriptions (if any). |
Object | API name of the target object. |
Object Lookup Field |
API Name of the object lookup field created on the Requirement Set object. The Requirement Set has lookup fields to Program Application and EDA Application by default. For example, if the target object is Program Application, then you will need to use the API name of the Requirement Set's 'Program Application' lookup field. If a different target object is used, you will need to create a new lookup field on the Requirement Set that looks up to that target object. |
Criteria Field |
API name of the field on the target object that holds the criteria value. If the criteria field is populated with the expected value, the requirements will be triggered (if active). Note: If you need to refer to more than 1 field, you can create a custom formula field on the target object that references other multiple fields. This custom formula field can be used as your criteria field. See here for example. |
Expected Value |
The value that the criteria field should return, in order to trigger the creation of Requirements. Once the criteria field returns a similar value, the Requirement Set Template (and its underlying Requirement Templates) will be cloned as Requirement Set (and its underlying Requirements) on the target object. |
Contact Field | API name of the Community user contact field on the the Object, so we can set it for community sharing with sharing sets. |