Data Forms

Forms are user interface elements that allow you to interact with individual entity records. You can access the entity forms from the Data Forms section of the entity.

You can create up to 2 forms for the same entity, depending on the different contexts in which users interact with the entity. Some forms may allow users to add records to the entity, some only to edit existing records, some may be read-only, some may have multiple pages and advanced controls and validations, etc.

When you create an entity, a default form is created automatically which allows you to do basic record inserts and edits. The default form will be used to insert or edit records when an entity is exposed in the Digital Experience Portal or other front-ends without designating a custom form for inserts or edits. The automatically created default form uses the Auto Generate Template option (see below), but can be customized at any time. An entity can have only one default form for record inserts and one default form for record edits at a time.

System entities do not have default forms created automatically.

Create an Entity Form

1. Expand the Data Forms section of an entity and click Insert.
   
2. Fill in the form's general information.

   

   • Name - Name used to identify the entity's form. If the entity has another form defined (each entity can have up to two forms), this name has to be different from the other form's name.
   • Description - Optional description of the form's function to simplify development.
   • Show Tooltips - Select if form fields display tooltips on mouse hover. The default is to inherit the user setting.
   • Is Default - Check to make this the default form for inserting and editing entity records when displaying entity views in the user interface. You can have only one default form for an entity at a time.
   • Is Default for Edit - Check to make this the default form for editing entity records when displaying entity views in the user interface. You can have only one default edit form for an entity at a time.
   • Auto Generate Template - Check to automatically generate the form fields based on the entity's attributes using a 1, 2, 3, or 4 column layout. The template will include all entity attributes, except the primary key and system attributes.
   • Hide Business Workflow - Hides the entity record's state and state transition options in the end-user interface. For more information about business workflows, see the Business Workflows Processor documentation.
   • Read Only - Prevents end-users from making any changes to the displayed form fields.
   • Disable Save Keyboard Shortcut - Prevents end-users from saving and reloading the form by pressing the Ctrl+S keyboard shortcut.
3. Click Save and Close ().

Edit an Entity Form

To edit an entity form, expand the Data Forms section of an entity and double click the form. The form's settings are displayed.

General

In the General section you can edit any of the general information fields filled in at form creation.

UI

Use the UI designer to define the form's layout. It is possible to add entity extension child collection support. For details on how to use the UI designer, see UI Designer.

Steps

Use the Steps section to set up forms with multiple pages. For details on how to work with steps, see Add and Configure Steps.

Field Options

The Field Options section allows you to customize form fields based on how users have filled out other fields in the form: show field values, show or hide specific fields, etc. For details on how to work with field options, see Configure Field Options.

Filtered Fields

A filtered field restricts the values available in a form field based on entries in other fields. For details, see Defining Filtered Fields.

Advanced

The Advanced section allows you to write custom client-side JavaScript code that is executed before or after the form is rendered. For details on the embedded JavaScript extensions , see the Client SDK Reference Guide.

Security Roles

Use the Security Roles section to select the Security Roles required for users that can access the form.

To learn more, check our Academy Evolutive Data Core course - Entity Views module.