The field configuration controls which fields appear for a given entity type on the Entity Edit screen. You can specify which fields are required for entities of a certain type, which fields are visible when adding new entities, and which sections and fields will display for each entity type.
Note: Making changes to the field configuration will modify the default field presentation. This can impact automatically translated content or prevent your account from receiving automatic updates that Yext makes to default field presentations in the future. For more information, see the Default Field Presentation reference on Hitchhikers.
View and Edit Field Configuration
- Navigate to Knowledge Graph > Configuration and click the Entity Types tile. Then, click Edit Fields on your chosen entity type.
- Select the Fields tab.
- From this view you have the ability to:
Add a Field Section
Field section names must be fewer than 255 characters and must be unique within a given entity type (e.g., you can't have two sections named "Business Details" on the Location entity type). When adding a section, you can either:
- Create a new field section
- Copy an existing field section from another entity type.
Create a New Field Section
- Click the Add dropdown wherever you would like to add a new section and select Add Section.
- You can also access this option in the left sidebar that lists your field sections. Find the place where you would like to add a new section and hover over it.
- Click the plus sign that appears and select Add Section.
- Enter the information for your new section and click Save.
- (Optional) To add a translation for your section name, click Add translation. Select the desired language from the dropdown menu and enter the translated field section name.
Copy a Section from Another Entity Type
- Click the More Actions dropdown at the top right of the page and select Add Section from Existing Entity Type.
- Click Select Entity Type and choose the entity type you want to copy a section from.
- Select the checkbox next to the desired sections and click Add Sections. This will also copy the fields in the sections.
Modify a Field Section
- Locate the section you want to modify. Use the tools at the top of the section.
- Click the Collapse by default toggle to collapse this section. When you go to Entity Edit on an entity of this type, this field section will display as collapsed until a user expands it.
- Click the pencil icon to rename the section and/or modify translations for the section name. You can also do this by hovering over the section in the left sidebar.
- To move a field section to a different position, hover over the desired section in the left sidebar. Click and drag to the desired position.
Delete a Field Section
- Locate the section you want to modify. Use the tools at the top of the section, or hover over the section in the left sidebar and click the trash can icon.
- Select how you want to manage the fields in the section:
- Delete section & move all fields. Move the fields in the deleted section to a different section. Select the new section from the dropdown menu.
- Delete section, delete fields that can be deleted, & move fields that cannot be deleted. Use this option to remove fields from the entity type entirely. Any fields that are required for the entity type will be moved to a different section. Select the new section from the dropdown menu.
- Delete section & remove fields from entity type. This option only appears if all fields in the section can be removed from the entity type.
- Click Confirm.
Note: If the last section is removed from an entity type, fields that cannot be removed will be moved to the Other Fields section. Fields that can be removed from the entity type can either be moved to Other Fields or removed entirely.
Add a Section Divider
Section dividers appear on the left sidebar in Entity Edit to group similar field sections.
To add a section divider:
- In the left sidebar that lists your sections, hover between sections and click on the plus sign that appears. Click Add Section Divider.
- Enter the information for your divider and click Save.
- (Optional) To add a translation for your divider name, click Add translation. Select the desired language from the dropdown menu and enter the translated field section name.
The Other Fields Section
The Other Fields section is a catch-all for fields that aren't organized into a different section. Usually, this is because they were added to an entity type outside of the Field Configuration screen:
- On the Field Settings screen (Knowledge Graph > Configuration > Fields)
- Via Config as Code or API
The Other Fields section will always appear at the bottom of Entity Edit.
Save Section Changes
To apply your changes to your entity type, click Save in the bottom right of the screen.
Add Fields to a Section
-
Click the Add dropdown at the bottom of the section you want to add the field to and select Add Field.
-
Select the checkbox next to the desired fields and click Add Field.
-
To create a new custom field for this entity type, click Create Custom Field. For more information, see Create a Custom Field.
-
To create a new custom field for this entity type, click Create Custom Field. For more information, see Create a Custom Field.
Remove a Field from a Section
-
Hover over the desired field and click the trash can icon.
- If the field is required for the entity type and cannot be removed, this icon will be grayed out.
-
Removing a field from a section will not delete the field from the Knowledge Graph for other entity types.
Move a field
- To move a field within a section, hover over the field. Click and drag to the desired position.
-
To move a field to a new section, hover over the field and click the Move To dropdown. Choose the desired section.
Rename or Edit a Field
-
Hover over the desired field and click the pencil icon.
-
You will be brought to the field settings screen for that field. Make any changes to the field settings and save.
- Settings on built-in fields cannot be modified and will be grayed out.
- For more on modifying field settings, see Manage Field Settings.
Hide a Field
Hiding a field on an entity type removes the field from Entity Edit when users view entities of that type. Hiding a field on an entity type hides the field for all users on the Yext account.
-
Hover over the desired field and click the eye icon to hide it.
-
When a field is hidden, it will be moved to the Hidden Fields section at the bottom of the screen.
-
To unhide the field, move it to a different section.
Enable Required Fields and Fields Shown on Entity Creation
You can choose how a field on an entity type should be used when creating new entities of that type.
Checking Required on a field means that new entities of this type cannot be created unless that field is filled in.
Checking Show on Entity Creation means that when a user creates an entity of this type manually, that field will be visible in the Quick Add options.
-
Note: Fields in the Other Fields section cannot be made required or shown on entity creation. To modify these settings on fields in the Other Fields section, move them to a different section.