Properties
A property is a type specific variable/field for a value or range. properties are organized into value properties and range properties.
Create properties
You can create a new property by using the Create property capability on the Properties tab of an integration namespace's Overview page.
They are defined by using the following master data:
- Local Identifier: Identifier of the property. this value must be unique within the namespace and cannot be changed afterwards. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming fields! Furthermore, identifiers may not begin with a digit (required)
- Type: Defines the type of the property to be created. Types could be primitive such as text, number etc. or references such as modelled Root Entities, Entities or External Entities (required)
- Label: Label of the property (optional)
- Short Label: Short label of the property (optional)
- Notes: Useful information regarding the property definition (optional)
If the entity you want to reference does not exist you can directly create it by using the inline "Create" action in the field Type.
Property types
The following property types are available:
| Name | Type | Remark |
|---|---|---|
| Text | Value | Text field for short, un-formatted texts |
| Text/E-mail | Value | Text field for MAIL content |
| Text/URL | Value | Text field for URL content |
| Integer | Value | Allows you to save a number without decimal places |
| Long | Value | Type definition for a 64 bit integer |
| Boolean | Value | Type definition for truth values with the "true" or "false" property |
| Currency | Value | Type definition for monetary amounts consisting of quantity and currency code |
| Selection Element | Value | Type definition of a property that can take only specific values. The Enumeration Elements define the available options. If no specific values are specified for a used Selection Element, a warning appears in the Problems section. In this case, the generated source code cannot be compiled. |
| Date | Value | Type definition for dates without time specification |
| Time | Value | Type definition for time without dates specification |
| Decimal | Value | Allows you to save a number with decimal places |
| Geo Point | Value | Type definition of a Geo Point with latitude and longitude (only available for MongoDB) |
| Localized Text | Value | Localizable text, consisting of locale and name, for shorter texts up to 200 characters (without formatting) |
| Timestamp | Value | Type definition for specifications with date and time |
| Reference | Range | A link to another entity. Can also be defined as an array |
To create a new property and immediately associate it to an entity, you must use the Add property capability within the entity's instance page and select the Create new property option. In order to add and associate an existing property to an entity, you must use the Add property capability within the entity's instance page and select the Add existing property option. In this case, you are able to select any property created in any namespace within the Domain and integration namespace of the project.
Edit properties
You can edit the master data of a property by clicking the Edit property details button in the Property Details section on the property's instance page. Alternatively, you can use the Edit capability of each table row on the Properties tab of a integration namespace's Overview page. It can also be accessed by using the capability within the Edit Property Association action.
If the Type of a property is changed, the type-specific values are deleted.
Delete properties
You can delete a property by clicking the Delete property button in the upper right corner of the property instance page. Alternatively, you can use the Delete capability of each table row on the Properties tab of a integration namespace's Overview page.
You will need to confirm the action before the selected property is permanently deleted.
When a property is used, an extended dialog appears. For control, all places where the property is used are displayed and then you are asked to confirm the deletion. When the deletion is confirmed, the selected property is permanently deleted, as well as in all places where it was used.