How To Add and Edit Entity Fields

This guide walks you through three key workflows:

✅ Update entity settings
✅ Manage existing fields
✅ Creating new custom fields

Update Entity Settings

The Entity Settings panel allows you to configure how each entity behaves and appears across your system. These settings influence the way records are created, searched, displayed, and accessed.  

Steps:

1. Navigate to
   Settings → Entity Settings → General Entities or System Entities.
   
   

2. Select the entity you want to edit (e.g., Stakeholders).

3. Update any of the following settings as needed:

   • Display Name: The singular name used throughout Consultation Manager to refer to this entity (e.g., “Stakeholder” or “Interaction”). This name will appear on buttons, record screens, and field labels. 

   • Plural Display Name: The plural form of the entity name (e.g., “Stakeholders” or “Interactions”) used in list views, section headers, and reports where multiple records are referenced.

   • Default Record Visibility: Set whether new records for this entity are visible Globally (across all projects) or Privately (only within the project they are created in). Choose Global if cross-project access is required, or Private for more controlled access. 

   • Require Projects: When enabled, this setting ensures that every record of this entity type must be linked to a project. This is useful if your organization wants to tightly control record context and ensure no orphan records exist.

   • Default Search Field: Defines the primary field used when searching or filtering records for this entity. Choose a field that best identifies the record (e.g., First Name or Event Type).

   • Entity Prompt: Controls whether a prompt appears after creating a record, guiding the user to link the new record to related records (like connecting a stakeholder to an interaction).

   • Mobile Visibility: Controls whether this entity type is visible and accessible on the mobile version of Consultation Manager. Turning this off hides the entity from mobile views, simplifying the interface for mobile users.

4. Once all necessary changes are made, click Save in the top-right corner to apply your updates. 

Manage Fields

The Field Settings tab allows you to reorder fields, edit their properties, and manage their visibility for each entity.

Steps:

1. In the Entity Settings area, switch to the Field Settings tab at the top of the screen.

2. You will see a list of all fields for the selected entity.
   
   

3. From here you can perform the following actions:

   • Reorder Fields: Use drag-and-drop via the left hand icon, to change the order fields appear across when adding a new entity and searching.

   • Edit Field Details: Click the pencil icon on the right of a field to update its display name, make it required or optional, adjust its searchability, or configure mobile visibility. 

   • Hide: Click the eye icon to hide a field from the interface. 
     
     Note: Some system fields are mandatory and cannot be hidden or edited. 
     

4. When you’re finished, click Save in the top right hand corner to apply updates.

Create a New Field

You can now create custom fields directly from the UI, without needing backend support.

Steps:

1. Scroll to the bottom of the Field Settings tab and click Add New Field.

   

2. Select the field type you want and click continue to edit the field details.

   

3. Complete the field details, please note these requirements will change based on the field type selected.

   

4. Click Add New Field to finalise creation.

Success!

You’ve now learned how to: 

• Adjust entity-level settings
• Reorder, edit, or hide existing fields 
• Create new custom fields with ease 

These tools give you full control over how your records are structured and displayed, helping you better align Consultation Manager with your organization's workflows.