Interacting with an Entity editor Object
  • 13 Jun 2024
  • 3 Minutes to read
  • Contributors
  • Dark
    Light

Interacting with an Entity editor Object

  • Dark
    Light

Article summary

The following image shows a full-featured Entity editor associated with an Entity and its interactive elements:

contents/assets/images/assets/images/entity-editor-interactive-elements.png

Depending on its configuration, the Entity editor may offer the following options:

  • The Code field and the Description field allow you to select existing Entity members. Click on the down-facing arrows to open the list of members codes or the list of members descriptions

  • Filter contents/assets/images/assets/images/filterk.png. Allows you to make a selection on a parent Entity in order to reduce the amount of members displayed in the Code and the Description fields

  • Reset selection contents/assets/images/assets/images/refresh.png. Clears the current selection

  • Insert new member contents/assets/images/assets/images/add.png. Allows you to create a new Entity member. See How to create a new Entity member for more details

  • Edit existing member contents/assets/images/assets/images/edit.png. Allows you to modify the relationships and the description of an existing Entity member. See How to edit an existing Entity member for more details

  • Edit member's description contents/assets/images/assets/images/edit-desc.png. Allows you to modify the description of an existing Entity member. See How to edit the description of an existing Entity member for more details

If there are other Objects in the same Screen, the Entity editor acts as a Pager and filters all data displayed on the Screen as a member is selected or created. Other Objects in the Screen will only show data once a selection on all available Entity editors has been made. Any custom filter applied using an Entity editor will be lost if you leave the Screen or update it. New Entity members or changes made to existing ones will be retained.

How to create a new Entity member

To create a new Entity member using the Entity editor Object, proceed as follows:

  1. Click on the "Add new member" icon contents/assets/images/assets/images/add.png to open the member creation window shown below:
    contents/assets/images/entity.editor.add.members.png
    contents/assets/images/entity.editor.member.creation.window.png

  2. Enter a Code for the new member (if the option is available) and a Description

  3. Define the Relationships between the new member and its parent Entities from the dropdown menus available

  4. (Optional) If the option is enabled for parent Entities, from the member creation window you can also create new members at higher levels of the hierarchy using the "+" buttons next to each dropdown menu
     contents/assets/images/entity.editor.add.member.add.parent.png
     contents/assets/images/entity.editor.add.parent.member.png

  5. Click on SUBMIT to save the new Entity member.

The new member is immediately added to the associated Entity and will appear as selected in the Entity editor Object.

To see the newly created member in other Objects on the Screen, refresh all Screen Objects using the Refresh option in the Top menu of the Capsule workspace.

How to edit an existing Entity member

To edit a new Entity member using the Entity editor Object, proceed as follows:

  1. Click on the down-facing arrow next to the Code or the Description fields to open the list of members codes or the list of members descriptions

  2. Select an existing Entity member.

    You can also make a selection by clicking on the Code or the Description field and typing the desired member code or description: search results will automatically appear below as you type, as shown in the following image
     contents/assets/images/assets/images/search.png

  3. Click on the "Edit existing member" icon contents/assets/images/assets/images/edit.png to open the member editing window shown below
     contents/assets/images/entity.editor.edit.members.png
     contents/assets/images/entity.editor.edit.window.png

  4. Edit the description and/or the relationships between the Entity member and its parent Entities as needed by clicking on the pencil icon  contents/assets/images/pencil.edit.png
     contents/assets/images/entity.editor.edit.icon.png
     contents/assets/images/entity.editor.editing.png

    It is not possible to change the code of an existing Entity member.

  5. (Optional) If the option is enabled on parent Entities, you can also create new members at higher levels of the hierarchy using the "+" buttons next to each dropdown menu from the member editing window
     contents/assets/images/entity.editor.edit.add.parent.png
     contents/assets/images/entity.editor.add.member in edit.png

  6. Click SUBMIT to save the modified Entity member.

How to edit the description of an existing Entity member

To edit the description of an existing Entity member using the Entity editor Object, proceed as follows:

  1. Click on the down-facing arrow next to the Code or the Description fields to open the list of members codes or the list of members descriptions

  2. Select an existing Entity member.

    You can also make a selection by clicking on the Code or the Description field and typing the desired member code or description: search results will automatically appear below as you type, as shown in the following image

  3. Click on the Edit member's description iconto open the description editing window shown below:

  4. Edit the description as needed

  5. Click on the UPDATE button to save the new description.


Was this article helpful?