Custom Fields¶
Custom fields extend the ValuePact data model to capture information unique to your organization. You define the field type, validation rules, and display logic.
Who this is for¶
Admin Analyst
Prerequisites¶
- Tenant Admin or Content Admin role
- Review of Configuration Overview
- Understanding of the entity you are extending (Initiative, Business Case, etc.)
Field types¶
| Type | Use case | Validation options |
|---|---|---|
| Text | Free-form names, descriptions | Min/max length, regex pattern |
| Number | Quantities, scores | Min/max value, decimal places |
| Date | Deadlines, milestones | Min/max date, business days only |
| Select | Categories, priorities | Single or multi-select, option list |
| User | Assignee, stakeholder | Restrict to role or group |
| Formula | Calculated values | Expression editor, output format |
Step-by-step: add a custom field¶
- Go to Admin > Configuration > Custom Fields.
- Select the Entity Type: Initiative, Business Case, or Stakeholder.
- Click Add Field.
- Enter a Field Label and API Key. Use
snake_casefor the key. - Choose a Field Type.
- Set Validation Rules.
- Configure Display Rules (when the field is visible or required).
- Click Save and Publish.
API key immutability
The API key cannot be changed after creation. Choose it carefully if you plan to use it in integrations or formulas.
Validation rules¶
Validation rules ensure data quality at entry time.
| Rule | Description | Example |
|---|---|---|
| Required | Field must be populated before saving | Budget is mandatory |
| Unique | Value must be unique across the tenant | Project code |
| Regex | Value must match a regular expression | SKU format |
| Range | Number or date must fall within bounds | Budget between 10k and 10M |
Display rules¶
Display rules control when a field appears or becomes required.
- Open the custom field editor.
- Click Display Rules.
- Add a condition:
When [Field] [Operator] [Value]. - Set the action: Show, Hide, Require, or Optional.
- Click Save.
Permissions required¶
| Role | Permission | Scope |
|---|---|---|
| Super Admin | Create, edit, delete custom fields | Organization |
| Tenant Admin | Create, edit, delete custom fields | Organization |
| Content Admin | Create, edit custom fields | Organization |
| Analyst | View and edit custom fields on assigned records | Assigned records |
| Viewer | View custom fields on assigned records | Assigned records |
Limits and guardrails¶
Limit Maximum 100 custom fields per entity type.
Limit API keys must be unique within the tenant and cannot exceed 40 characters.
Limit Formula fields can reference up to 10 other fields.
Limit Display rule conditions support up to 3 nested clauses.
Troubleshooting¶
Issue: custom field not visible on record
Cause: A display rule is hiding it, or the field was added to a different entity type. Resolution: Check the display rule conditions. Confirm the field belongs to the entity you are viewing.
Issue: validation error on a correct value
Cause: The regex or range was updated after existing records were created, or the rule contains a syntax error. Resolution: Review the validation rule in Custom Fields. Test the rule against the value in the preview panel.
Related pages¶
Escalation path¶
For custom field corruption or formula evaluation errors:
- Disable the field from the entity form to prevent further bad data.
- Review the formula or validation rule for syntax issues.
- File a support ticket with the field API key and an example record ID.
- Escalate to
#valuepact-opsif the field is used in a production workflow.