Embedded Fields
In a Configuartion Design, an Embedded Field establishes a relationship between this configuration design and an embedded design. The cardinality can only be one-to-one.
Since multiple designs may use the same embedded design as an embedded field, data model re-use can be achieved. By changing the data model of the embedded design in one place, all other designs that use the embedded design as an embedded field are automatically updated. This can save time and is a good data modeling practice.
Embedded objects can only be transported through the API within their parent objects. They can't be transported on their own.
Embedded types may be used to group a set of related settings together.
 |
| Field Name Name of the relationship field. This will appear as a section heading for the embedded field to the runtime end user. It is best practice to follow camel case for the naming convention. (Camel case is when all spaces are removed and the first letter of the first word is lowercase and the first letter of each subsequent word is capitalized, e.g. postsAboutThisSubject) |
| Target Design [drop down] Dropdown of designs in the current module. This field establishes a relationship between current design and the target design defined in the module. |
| Render On Screen [drop down of Normal, Read Only, and Hidden] The Render On Screen field determines how the embedded field section is rendered on the screen. A field can be rendered on screen as Normal, Read Only or Hidden. The Render On Screen setting behaves the same way for embedded fields as it does for standard fields. If Hidden is selected, the entire section is hidden; you will not see the section header label. |
| Position This determines the order in which the embedded field (which is rendered as a section) will be placed on the UI page. The field with the lowest position number is given the first position on the UI (following the standard fields). Best Practice: Number the Position values in increments of 10 in case you need to add a new field in between two existing fields at a later date. For example, if Field A has a position of 10 and Field B has a position of 20, you can add a new field between the two by giving it a position of 15. |
| Link OQL The Link OQL allows the developer to filter the data in the embedded field section using OQL. |
| Description The Description field is a free text field used to describe the embedded field. |