Creating Nested Object

Data model section. Data administrator interface

Description

A nested object is a set of nested attributes that is added to a complex attribute. The complex attribute is displayed in the record card as a catalog of nested attributes.

Instructions

To create a nested object:

  1. Make sure that draft mode is enabled and a draft is selected.
  2. Switch to the “Nested objects” tab in the “Data Model” section.
  3. Click the “Create nested object” button at the bottom of the “Data model” list.
  4. From the menu that appears above the button, select “Nested object”.
  5. The action will create a nested object. It will open on the right side of the screen (in the general area of the section). The nested object contains the “Settings” and “Attributes” tabs.
  6. Fill in the required fields in the “Settings” tab:
    • “Name”: the system name of the nested object. The name can only contain Latin characters. Cannot be edited after saving.
    • “Display name”: name of the nested object that will be displayed to all users. The display name can consist of both Latin and Cyrillic letters, as well as spaces. It is recommended to use a human-identifiable name. Can be edited after saving.
    • “Description”: any additional information that is displayed only for administrators.
    • “Custom properties”. A list of parameters (the “name” – “value” pair) that contain additional text information. Parameters can be referenced by custom extensions, and parameters can also contain non-standard information from external systems.
  7. Switch to the “Attributes” tab and create at least 1 attribute. The added attributes will represent the contents of the nested object.
  8. Save the changes. Click “Save” in the upper-right corner of the screen. If some errors are detected during saving, a corresponding message will be displayed on the screen.
  9. Publish the draft when all necessary changes are made.
Attributes of nested objects have the same characteristics as attributes of entities/lookup entities with the only exception that attributes of nested objects do not use the “Displayable” and “Main displayable” properties.

To copy a nested object:

  1. Click the “Create nested object” button at the bottom of the “Data model” list.
  2. From the menu that appears above the button, select “Copy from…”.
  3. This will open a pop-up with a list of existing nested objects.
  4. Select the required one and click “Continue” in the lower right corner of the window.
  5. Enter a name for the new object, make additional changes if necessary, and click “Save” in the upper right corner.
Copying includes all simple, complex, and array-attributes.

To delete a nested object:

  1. Make sure that the “Nested objects” tab is active in the “Data Model” section.
  2. Make sure that the nested object is not used in the data model through complex attributes. To do this, check the “Attributes” tab in entities/lookup entities.
  3. If the nested object is in use, change it in a complex attribute, or delete the complex attribute.
  4. Go to the “Nested objects” tab of the “Data model” section.
  5. Select the required object from the list.
  6. Click the “Delete” button located in the upper right corner of the screen and confirm the action.

Create nested object

Figure 1. Create nested object

Main Features

  • Single nested object can be used in multiple complex attributes of one or more entities at once. Example: The nested “Contacts” object will contain the following attributes: phone number, email, address, etc.
  • If a nested object has been edited, the changes will be applied to every complex attribute where the object is used.
  • Nested object can contain complex attributes that refer to other nested objects. A nested object cannot refer to itself.
  • Nested object can only be deleted if it's not used in the data model.