Customization sets

How to use

In order to create a Customization Set, in the Develop app, from the menu the main menu select Customization sets.. In the page that opens click the Add button and follow the next workflow:

flowchart LR
    A((Start))
    B[Create the customization set]
    C[Create the entities]
    D[Create the properties]
    E[Create the relationships]
    F[Publish]
    G((End))

    A-->B
    B-->C
    C-.->D
    C-.->E
    D-.->F
    E-.->F
    F-->G

When modifying a Customization Set there are two possible situations, first when you need to add new entities, properties or relationships and the second is when you want to change existing (and published) entities, properties or relationships.

To do that, in the Develop app, from the menu the main menu select Customization sets. In the page that opens select the Customization set to update.

For adding new entities, properties and relationships follow the workflow below:

flowchart LR
    A((Start))
    B[Add new entities]
    C[Add new properties]
    D[Add new relationships]
    E[Publish]
    F((End))

    A-->B
    B-.->C
    B-.->D
    D-.->E
    C-.->E
    E-->F

Changing existing (and published) entities, properties or relationships requires deleting the existing customizations and creating new ones.

If you want to delete published entities, properties or relationships follow the workflow below:

flowchart LR
    A((Start))
    B[Click the HISTORY tab]
    C[Select the published version]
    D[Unpublish]
    F((End))

    A-->B
    B-->C
    C-->D
    D-->F

Designer

Fields in the sidebar:

  1. Name - Is the name of the customization set.
  2. Module - Specify if the entity is contained in a module.
  3. UUID - Is the unique identifier of the row in the table (read-only).
The following diagram describes the entity used by this designer:
erDiagram
    ui_cs {
        string name "Name"
        string uuid "UUID"
    }
    ui_cs_history {
      string customization_set_name "Customization set name"
      string log "Log"
      integer ui_cs FK
    }
    ui_cs one--many ui_cs_history : ui_cs_history_ui_cs

ENTITIES tab

To add an entity you will have to click the Add button and fill in the Entity name field. Usually here you will add only one entity. There are only two cases when you will add more then one entity:

  1. If the already created entity will have a parent-child relationship with other entities. Those entities will be added also in this tab and their properties will be put in the properties tab. The idea is to have the entities that are in a parent-child/child-parent relationship in the same customization set.
  2. If the created entity will have relationships with entities from other customization sets. Those entities will be added in this tab without setting their properties in the properties tab.

The name of the entity cannot be in Cammel Case and it should be a singular noun.

Click the Add button to add entities and the Delete button to remove entities.

Fields for entities:

  1. Name - The name of the entity, can only contain lower case letters [a-z], numbers [0-9] and the character _ and cannot start with a number.

The following diagram describes the entities used by this tab:

erDiagram
    ui_cs_entity {
      string name "Name"
      string uuid ""
      integer ui_cs FK ""
    }
    ui_cs_entity many--one ui_cs : ui_cs_ui_cs_entity

PROPERTIES tab

Click the Add button to add properties and the Delete button to remove properties.

Fields for properties:

  1. Entity name - The name of the entity.
  2. Property name - The name of the property, can only contain lower case letters [a-z], numbers [0-9] and the character _ and cannot start with a number or with the id_ prefix.
  3. Property type field.
  4. Is required - Check the box if that property is mandatory to be set.
  5. Default value - The default value for the corresponding property.

The following diagram describes the entities used by this tab:

erDiagram
    ui_cs_property {
      string entity_name "Entity name"
      string property_name "Property name"
      string uuid "UUID"
      integer is_required "Is required"
      integer ui_cs FK ""
      integer ui_cs_property_type FK "Property type"
    }
    ui_cs_property_type {
      string name ""
      string uuid "UUID"
    }
    ui_cs_property many--one ui_cs : ui_cs_property_ui_cs
    ui_cs_property many--one ui_cs_property_type : ui_cs_property_ui_cs_property_type

RELATIONSHIPS tab

Click the Add button to add relationships and the Delete button to remove relationships.

Fields for relationships:

  1. Relationship name -  The name of the relationship. Relationship names are case sensitive and usually they should be composed by putting together the names of the entities that form the relation. This is optional. The system will set the name for you if don’t set it.
  2. Entity name - The entity on the left-side of the relationship.
  3. Type name - The type of the relationship. There are four types of relationships: One-To-Many(1:n), Many-To-One(n:1), Parent-Child(p:c) and Child-Parent(c:p). From structural point of view the Parent-Child and Child-Parent relationships are identical with One-To-Many and Many-To-One relationships. The difference resides in the fact that they are managed in the same life cycle and not separately. This means that child entities are not saved or updated separately but within parent entity.
  4. Property name -  The property for the key of entity on the right-side on the entity on the left-side of the relationship. This field is optional, if not set then the key parameter of entities it will be used.
  5. Foreign entity name - The entity on the right-side of the relationship.
  6. Foreign property name - The property for the foreign key. This field is optional.
  7. Is required - Check this if you want the relation to be mandatory.
  8. Sort property - Only for parent-child relationships. The property on the child if the children are to be sorted when the parent entity is read. ???
  9. Sort asc - Check this if you want to sort children in an ascending order.

The following diagram describes the entities used by this tab:

erDiagram
    ui_cs_relationship {
      string name "Relationship name"
      string entity_name "Entity name"
      string property_name "Property name"
      string uuid ""
      integer is_required "Is Required"
      string foreign_entity_name "Foreign entity name"
      string foreign_property_name "Foreign property name"
      string sort_property "Sort property (P:C, C:P only)"
      integer sort_asc "Sort asc"
      integer ui_cs FK
      integer ui_cs_relationship_type FK "Type name"
    }
    ui_cs_relationship many--one ui_cs : ui_cs_relationship_ui_cs
    ui_cs_relationship many--one ui_cs_relationship_type : ui_cs_relationship_ui_cs_relationship_type
    ui_cs_relationship_type {
        string name
        string uuid
    }
← Catalogs
Edit Views →