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:
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:
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:
Designer
Fields in the sidebar:
- Name - Is the name of the customization set.
- Module - Specify if the entity is contained in a module.
- UUID - Is the unique identifier of the row in the table (read-only).
Entity diagram:
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:
- 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.
- 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 Camel Case and it should be a singular noun.
Fields in the entities table:
- 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.
Fields in the properties table:
- Entity name - The name of the entity.
- 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 theid_prefix. - Property type field.
- Is required - Check the box if that property is mandatory to be set.
- Default value - The default value for the corresponding property.
Fields in the relationships table:
- 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.
- Entity name - The entity on the left-side of the relationship.
- 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.
- 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.
- Foreign entity name - The entity on the right-side of the relationship.
- Foreign property name - The property for the foreign key. This field is optional.
- Is required - Check this if you want the relation to be mandatory.
- 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.
- Sort asc - Check this if you want to sort children in an ascending order.
Catalogs
A catalog is a type of entity that can be related to another entity and it defines a set of options. When a catalog is displayed in an edit-view it uses a drop-down list control. Sometimes catalogs are called picklists by developers.
Edit Views
The edit view displays one entity in a form, allowing the user to view or change the properties.