Editing the Participant Fields, Household Fields, Organization Fields, or Anonymous Fields
Manage Entity Fields is where administrators can review all of the active entity forms in their instance, such as the Participant Form, and make changes to the forms as needed. This includes adding fields, editing field options, adjusting duplicate check, and changing where users go after saving a form.
What is an Entity?
Compyle includes four types of entities, which each have their own profile form, document folder, and survey/note forms. Each of these has their own set of standard, built-in fields, and administrators can add custom fields.
- Participants: individual service recipients who may be engaged in a program, class, or group
- Households: a linked set of participants, like a family, who share resources and may live together
- Organizations: agencies, programs, sites, departments, teams, or community partners
- Anonymous: intentionally unidentifiable survey respondents
For more information about the different entity types, see What are Participants, Households, Organizations, and Anonymous...
Manage Entity Fields Overview
You can find the Manage Entity Fields resource in the Admin section of the left sidebar menu.
When Manage Entity Fields opens, you will see a list of all of the currently active Entity types for your Compyle site and information about each form.
To edit an entity form, select its name or click the edit icon on the right.
- Custom Fields: Count of fields added to each form by your organization
- Public Forms: Number of Public Forms, or customized versions of the entity form, created as standalone forms or for use with surveys or notes.
- Duplicate Check: Whether duplicate check is applied to the form settings (yes, no, NA)
- Save Action settings: Where users go after saving this form (open folder, return to search, reopen entity record)
- Auto Accept settings: Whether new records from survey responses and public forms will start out with pending status or automatically become active records
Editing the Entity Profile Forms
To review and edit the active Entity forms in your Compyle site:
1. Expand the = left sidebar menu
2. Open the Admin section
3. Select Manage Entity Fields
4. Select the name of the form to edit
5. The Edit [Entity] Fields page will open.
Navigation Shortcuts to Related Areas
From the Manage Entity Fields form list, there are quick links to other related areas.
Instance Settings
- Opens: Admin > Instance Settings
- Purpose: Add or Remove Entity Types in Compyle Instance Settings, which updates the list of forms in Manage Entity Fields
- Example: Adding a new Entity type
- Use Case: If you would like to add an Entity type, like Households, you can use the Instance Settings button to open the Admin > Instance Settings so that you can adjust the Profile Form Types setting.
Note Forms
- Opens: Data Collection > Note Types
- Purpose: Add/Edit Note Forms, which are the supporting forms created on the Notes tab in the Entity folder
- Example: Your organization is trying out the AI summary option for your online meeting software, and you need to add a field to the Client Encounter note form to track whether or not staff used the AI summary as a starting point for the case notes. The Client Encounter note form is found on the Notes tab in the Participant folder.
Survey Forms
- Opens: Data Collection > All list of Survey Form categories
- Purpose: Add/Edit Survey Forms, which are the supporting forms connected to specific time periods, or survey instances, and which appear on the Survey Forms - Collected Data tab in the Entity Folder
- Example: Your organization has a new performance measure related to health and movement, so you need to add some new questions to your Monthly Wellness Survey.