Entity Previews - Rules, Settings, and Tips

Content
1

At General Availability on April 14, 2021, the Customizable Entity Previews feature was made available to customers. Here are some rules, available settings, and tips to keep in mind when configuring entity previews.

Rules
There are certain rules users should keep in mind when configuring entity previews for their entity types:

  1. For the purposes of Entity Previews, subfields of struct-like fields are treated as individual & separate fields within the preview. The only exceptions are for Address and Hours (and Daily Times type fields) subfields, where we render those all together.
  2. We do not allow more than one photo field to be a part of the preview. If a user has more than one photo field selected, they will be presented with a warning within the configuration canvas, and will not be able to save their preview.
  3. We support a maximum of 7 fields (or struct subfields) within a preview. If a user has more than 7 fields selected, they will be presented with a warning within the configuration canvas, and will not be able to save their preview.

Field-Type Specific Settings
For settings, we classified all the existing field types into 4 main categories: String-like, Image-like, List-like, and Entity Reference field types. Each category of field type has a specific set of settings:

  • String-like field types - Single-line text, Multi-line Text, Number, Single-option select, Rich Text, URL, Date, Yes/No
    • Show Name
    • Field Name Alias (when Show Name is toggled on)
    • Line Height
  • Image-like - Photo, Photo Gallery, Video, Video Gallery, Complex Photo, Complex Photo Gallery, Complex Video, Complex Video Gallery
    • Show Name
    • Image Preview (Fill or Fit)
  • List-like - Multi-option Select, Text Lists,
    • Show Name
    • Field Name Alias (when Show Name is toggled on)
    • Line Height
    • Show List Count
    • Show List Value
  • Entity Reference - Entity Reference, Entity List
    • Show Name
    • Field Name Alias (when Show Name is toggled on)
    • Line Height
    • Show Entity Count
    • Show Entity Name
    • Show Entity ID

Tips

  • Use Field Name Aliases when your field names are too long for your Preview, or if you are adding a subfield of a main field to your Preview
  • Choose fields for your preview that will highlight important information about entities of a given type to your field users
2 Likes
2

Is there a way to set a default number of Entities that should show in the Entity Preview? For example, if I have 71 Entities, can I set the Preview to show all 71? Currently, I have to choose that each time I open Knowledge Graph.

3

Hi Janelle,

Correct me if I am wrong, but it sounds like you are referring to the number of entities shown in the table in the Entity Search page.

Right now, by default, the screen shows 25 entities, and you can can change that to view either 25, 50, or 100 entities in the list upon entering the page. However, we do not support changing the 25 entity default setting or maintaining the selected preferred view at this time.

That being said, this is something that we plan to update in the near future, so stay tuned!

Best,
Fed

1 Like