1. Attributes

1. Basic Attributes

If you select a Property, the following Attributes can be configured:

BaseEntity Property: Attributes

Name

The Name field contains the name of the Property. By default it is the same as the Domain Topic Property from which it was created. You can change the name of a BaseEntity Property while the BaseEntity is not used in any BusinessEntity. Preferably, always configure the BaseEntity Properties first, before using it in a BusinessEntity. 

Also, try to change any abstract column names from the database to a logical and understandable name for the BaseEntity. This is not a mandatory step, but it will make your configuration much easier to maintain if it is easier to read and understand.

DataType

The DataType specifies what kind of data this Property contains. Usually this attribute is set correct upon adding the Property from the Domain Topic. However, sometimes you might want to change this. The following list describes the various DataTypes and how changing it will affect your configuration.

DataType: String
This is commonly used for alphanumeric values. In other words, plain text which can contain virtually any character. Properties that are of this DataType will show up as regular Text inputs in the User Interface of the Silver Essence Portal. Specific behavior of that Text input can be maintained from the Input Panel.

DataType: Integer
This is commonly used for numeric values. In other words, numbers without decimal positions. Properties that are of this DataType will show up as regular Text inputs in the User Interface of the Silver Essence Portal, but only numeric values are allowed. Further behavior of that Text input can be maintained from the Input Panel.

DataType: Boolean
This is commonly used for True/False or Yes/No values. If a Property is of this DataType and it is to be shown in the User Interface of the Silver Essence Portal, be sure to configure it to be treated as a Boolean too. This is done by checking the Treat as Boolean Checkbox, after which 2 additional fields will be shown for configuration:

BaseEntity Property: Treat as Boolean

After you checked the Treat as Boolean Checkbox, you can enter the values for both True and False. Please check your database or webservice documentation for specific values.

DataType: Float
This is commonly used for numeric values that also contains decimal positions. In other words, numbers like 1.5 or 2.75 that might contain prices or amounts. Properties that are of this DataType will show up as regular Text inputs in the User Interface of the Silver Essence Portal, but only numeric values and the decimal separator are allowed. By default, Floats will show 2 decimals. Further behavior of the Text input can be maintained from the Input Panel.

DataType: DateTime
This is commonly used to store values that contain both a date and a time. These Properties often need manual configuration because in many databases the DateTime DataType is also used for values of which only the date is used. If this is the case, you might want to set the DataType to Date, so the time part is not shown in the User Interface of the Silver Essence Portal. If a Property is of the DateTime DataType, it will show up as a regular Text input, and beside it both a Calendar and a Clock Icon are shown. Since this might lead to confusion with the users of your solution, always make sure you check for redundant icons.

DataType: Date
This is commonly used to store values that contain just a date but no specific time. If a Property is of the Date DataType, it will show up as a regular Text input, and beside it a Calendar Icon is shown.

DataType: Time
This is commonly used to store values that contain just a time but no specific date. If a Property is of the Date DataType, it will show up as a regular Text input, and beside it a Clock Icon is shown.

DataType: GUID
This is commonly used to store values that contain a so called Global Unique Identifier. This is a unique key which consists of 32 characters (alphanumeric) and 4 dashes at random positions. Example: 7673FB3A-30EC-4EBA-B70E-1E54C3EC70A2. If you specify this DataType, additional validation will be done to ensure that the value is formatted accordingly.

Specifying this DataType has also impact on how this Property is shown in the User Interface of the Silver Essence Portal. By default, these Properties are hidden since they do not contain a value that is readable by the user. Since these Properties often refer to data from other tables, you can specify where that data should be coming from. This is done through the Label panel (configure a LookUp Label) and the Input panel (configure a LookUp Browser or Selection List) for this BaseEntity Property.

DataType: OleDBImage
This is commonly used to store values that contain binary data. In other words, these Properties contain a single file as an attachment that is stored in the database. These Properties are always used in conjuction with another Property that contains the FileName. For more information, check out the Special Cases section of this chapter.

Primary Key

One of the properties should be marked as the Primary Key through which the data can be retrieved. Currently we do not support multiple Primary Keys and it is not planned to be supported in the near future.

Required

A Property can be set to Required, to enforce the user has to enter an allowed value. If a Property is configured to be required, an exclamation mark will be shown in the User Interface of the Silver Essence Portal so the user will know which fields should be filled. 

Do note, if a field is not required in the database table or webservice topic, you can configure it to be required in your solution. Opposite, if it is required in the database table or webservice topic, you should not uncheck this in the configuration. The data logic from the database or webservice wil always prevail the configuration. In other words, you can make the data logic more tight in your solution, but you can never overrule the data logic.

Format

You can configure the Property so it will show in the User Interface of the Silver Essence Portal in a specific format. This is especially useful for numbers to make them more easily readable. For example, you could specify a Format like '000.000.000' and the number 1234 wil be shown as 000.001.234.