Defining attributes: The Field Configuration

Who can use this feature?

Only the Application Owner role can use this feature.

What is it? 

Within your application, you have the possibility to design your own templates. Such templates are called entities, and each entity consists of different fields, rating criteria, modules/visualizations, and has distinct permissions.

Via fields, you have the option to structure and compare the content of the entities. Fields also allow you to filter and analyze your content according to your specific needs.

Fields differ from rating criteria because rating criteria can aggregate evaluations from numerous people. 

1. Navigate to the field manager

2. Edit an existing field

3. Create a new field

4. Add the new field to the element create/edit form

5. Add the new field to the element view

 

How does it work?

1. Navigate to the Field Manager

To configure fields, go to the Settings Wheel > Entity Configuration > Entity Configuration.

From here, you have two options to add, edit, disable, and delete fields. You can either navigate to the global Field Manager or you can choose an entity and click on the Manage Field icon (indicated by the arrow in the picture below).

Field_ccnfig.png

The difference between the global and local field manager is that fields created globally can be used in the same way across different entities. This will reduce the effort of creating the same field multiple times for each entity specifically. It also means that changes in a global field's configuration will take effect for all entities where this field is used. This also means that if you delete a global field, it will be deleted on all entities. Better use the option to deactivate a field.

In contrast, local, better said entity-specific, fields can only be used on the specific entity. Changes to the configuration will only affect the specific field and the specific entity.

2. Edit an existing field

To edit a certain field, click on the Pen Icon next to it.

Edit_field.png

3. Create a new field

To add a new field to your entity, stay on the Manage Field page and scroll down to the Add a new field box.

Add_a_new_field.png

  • Add a field label (1)
  • Define Field Type (2): Choose a Field Type from the drop-down menu. You can choose between several options that let you adjust the field type to your data (for example, when you’re adding a Start Date field, you should select a Date Picker field type).
  • Save (3)

After you clicked on Save the new entity settings form opens in a new tab. In the example below, we added the new field "Strategic focus".

entity_field_settings.png

In the form, you can:

  • change the previously defined Label,
  • add a Tooltip which will be displayed via a small icon next to the attribute,
  • add the Help Text which will be displayed in line of a text field, and
  • decide whether this field is mandatory by checking the box in the form

When ready, click the Save button. You will automatically land on the Manage Field page and see a message on top indicating that the field was saved successfully.

4. Add the new field to the element create/edit form

To make use of your new attribute in your entity, go to the Form Configuration and drag and drop the new field to the left side to place it in the form, in your preferred place.Field_form.png

When you want to create a new or edit an existing element, you will see your new field in that form.

New_field_form.png

5. Add the new field to the element view

After adding the field to the edit/create form, decide where to place it on the element detail page. Go to the View Configuration tab and drag and drop the new field to the respective column on the left side.

view_config_field.png

When ready, click the Save button. You can check the element detail page and adjust it again if you prefer a different placement.

Was this article helpful?
1 out of 1 found this helpful