Creating and Using Entities

Entity Widgets can be used in the following Page Construction-scoped forms:

  • Person Page (to be viewed on custom person tabs)
  • Application Page (for custom application tabs, as well as pages within the Slate-hosted application).
Create the Entity
  1. Click Database in the top navigation bar and select Entities.
  2. Click Insert.
  3. Name the Entity.

Once the Entity has been created, create entity-scoped fields:

  1. Click Database in the top navigation bar and select Fields.
  2. Click Insert.
  3. Specify the requisite information. Most importantly:
    • Scope - Entity
    • Entity - Select the appropriate entity
    • ID - Prefix with the name of the entity (e.g., "scholarship_amount").
    • Data Type - Set to whatever is appropriate for the field (e.g., "Text/Unspecified," "Real," etc.)

  Tips

Slate can relate Entities to a Dataset by using a field with the Data Type of "Related Dataset Row."

Create the Entity Widget

Widgets are the container for Entity object. Once configured, this widget can then be added to forms.

To create an entity-scoped widget:

  1. Select Database from the top navigation.
  2. From the Queries section, select Refresh the Configurable Joins Library.
  3. Select Forms from the top navigation. 
  4. Click New Form, then select Edit Form
  5. Select Edit Properties, and specify the following configurations:
    • Scope - Set to Entity Widget
    • Entity - Set this to the desired Entity
  6. Populate the form with the desired entity-scoped fields. These fields should represent the data that should be collected and stored for each entity entry. For example: Scholarship field, Scholarship account, Scholarship approved, and Scholarship amount.
  7. The Custom List Fields area within Edit Properties allows you to define exports (columns), filters, and sorts. This controls what values appear on Forms that leverage the widget. 
Collecting Entity Information on Forms

This Widget can now be used in Slate on form as a custom tab or inside the Slate application. To add the entity widget on a tab or an application page, take the following steps:

  1. Navigate to the desired custom tab form or application page form in the Forms tool
  2. Edit the form and drag in the "Widget Table" option for the Form Fields Palette
  3. Give the widget a label if desired, select the form that was just created under "Widget Form", and enter the text that should display when an entity record is added under "Add Text".
  4. Enter a limit for the number of table rows, if desired. When interacting with the widget on the form, if the number of rows reaches the specified limit, the "Add" feature is disabled.
  5. Adjust other settings as desired.
  6. This will display the entity widget on the tab or application page.

This data can also be collected on a form without the widget. To map entity-scoped information on a form:

  1. Navigate to the desired form.
  2. Add an object from the Form Palette Tool that correlates to the field that should be mapped (i.e. a prompt-driven field should be mapped with a "Select List" or "Option Buttons").
  3. Select the Entity in the first System Field drop-down.
  4. Select the entity-scoped field in the second System Field drop-down.
  5. Enter other requisite information.
Was this article helpful?
7 out of 32 found this helpful