Add or Edit a Field Display Policy¶

This procedure adds and edits a field display policy (FDP).

Note

To modify the default form available for an item, a field display policy can be added to Data models, Relations, and Views.

Perform the following steps:

Login as provider administrator or higher.
Choose the relevant hierarchy.
Go to (default menus) Customizations > Field Display Policies to open the list of existing field display policies.
To edit an existing field display policy, click on the relevant field display policy and update the configuration, as required.
To add a new field display policy, click Add on the toolbar, and configure the following:
1. In the Name field, enter a name for the new field display policy.
  - If the name is default, the field display policy is applied to the target model type by default.
  - Each field display policy at the same hierarchy level must have a unique name. Field display policies at different hierarchies can share the same name.
2. Optionally, enter a description.
3. At Target Model Type, choose a model reference.
  
  The target model type defines the fields available for use in the field display policy.
4. At Groups, click the plus icon (+), then configure the following:
  
  All fields in the field display policy must belong to a group.

Component	Description
Title	Mandatory. Enter the label text to display for the attribute on the new tab. If a group displays as a tab in the Admin Portal, the value defined for Title displays as the title of the tab.
Display as Fieldset	Select this check box to display the group header and fields as a fieldset on the same page in the Admin Portal (not on a separate tab). Alternatively, if two or more groups have this checkbox enabled, the group title displays on a tab called Base.
Number of Columns	Enter a numeric value to define the number of columns. The default is a single column. Fields in the Selected transfer box display in these columns.
Fields	Choose fields to add. Select fields from the Available box and add them to the Selected box. The target model type you choose defines the available fields. Use the Move Up/Move Down buttons to adjust the position of any field.

At Field Overrides, click the plus icon (+), then configure the following:

This step configures fields added to the Selected transfer box.

Component	Description
Field	Select the field.
Title	Define the label text. If the field display policy is called `default` at a hierarchy, the list view column header also displays this title if the field belongs to the list of summary attributes.
Help Text	Enter the text to display as the field online help and form tooltip. Alternatively, leave the field blank to use the model attribute description.
Disabled	Select this check box to display the field as disabled (unavailable).
Input Type	Select an option to choose how the input field displays.

Click Save.

If you’re editing an existing field display policy, your changes are saved.

If you’re adding a new field display policy, the policy is created and is available for applying to the item by selecting it in a menu layout available to a role.

Field Display Policy Field Reference¶

Title	Field Name	Description
Name *	name	The name that is given to the Field Display Policy.
Description	description	A description for the Field Display Policy.
Target Type Model *	target_type_model	The target model type to which the Field Display Policy applies.
Groups	groups.[n]	The groups that describe groupings of attributes that are displayed together on the user interfcae.
Title *	title	The name of a specific group of attributes.
Display as Fieldset	display_as_fieldset	Render this group as a fieldset in the form.
Number of Columns	num_cols	The number of columns of fields.
Fields	fields.[n[]	Model fields that will form part of the particular group.
Field Overrides	field_overrides.[n]	Field display policy overrides to apply to a model fields.
Field *	field	Name of the model field to override.
Title	title	New title to display for field.
Help Text	help_text	New help text to display for field.
Disabled	disabled	Will set the field to read-only if checked.
Input Type	input_type	Overrides the input type of the field.