Attributes are characteristics that describe and/or identify the entity. For example, a Customer entity typically has attributes for the name of the customer, an e-mail address and other personal information.
The domain model editor uses the following symbols for visualization of attribute properties:
|This attribute has one or more validation rules.|
|This attribute has a microflow that calculates the value of the attribute.|
The name property defines the name of the attribute. This name is used to refer to the attribute from forms, microflows, queries, constraints etcetera.
If you delete an attribute in your entity and then create a new attribute with the same name, Mendix will consider it a new and different attribute. This means that upon deployment the old column will be dropped, including its data. Then a new, empty, column with the same name will be created.
The type property defines the type of data that can be stored in the attribute. An attribute has one of the following types:
|AutoNumber||A positive or negative whole number. AutoNumber attributes are automatically generated numbers. The default value of the attribute determines the first number that will be generated. Each created object will have an AutoNumber that is one greater than the previous one. AutoNumbers can only be used for persistable entities as the AutoNumber value is computed in the database.|
|Binary||Binary data. Can only be used for persistable entities as the data is stored in the database. For example an entire file. In most cases you want to use an association to a FileDocument or Image to store file contents.|
|Boolean||True or false.|
|Currency||The Currency type is deprecated. Use the high-precision Decimal type instead. The currency type is a synonym for the Float type, as in, it represents a positive or negative number that can have digits after the decimal point. It was introduced in Mendix to make it clear what type should be used when representing amounts of money. However, given the finite precision of the Float type, performing calculations with very large numbers may yield incorrect results due to rounding errors. Because of this, it is recommended to use the high-precision Decimal type for these (financial) calculations.|
|Date and time||A point in time consisting of a date and a time component accurate up to milliseconds.|
|Decimal||A positive or negative number that can have digits after the decimal point. The Decimal type can be used for high-precision calculations. Use this type to represent amounts of money for example. When a Decimal type attribute is persisted in the database its value is validated against 2 conditions. In case the number of digits of the integral part (before the decimal separator) is more than 20, an exception is thrown. In case the number of digits of the fractional part (after the decimal separator) is more than 8, the fractional value is automatically rounded according to the round half to even rule (also known as bankers’ rounding). Therefore the the maximum allowable value for the Decimal type is 99999999999999999999.99999999.|
|Enumeration||One of the values of the given enumeration.|
|Float||The Float type is deprecated. Use the high-precision Decimal type instead. A positive or negative number. The number can have digits after the decimal point.|
|Hashed string||The hash value of a String or set of characters. It can among others contain letters, spaces and/or numbers. This type can for example be used to store a password. Hash values are generated using the hash algorithm that is chosen in the Project Settings.|
|Integer||A whole number that can be positive (maximum 231-1, thus 2147483647), negative (minimum -231, thus -2147483648), or zero.|
|Long||A whole number that can be positive (maximum 263-1), negative (minimum -263), or zero.|
|String||A text containing letters, spaces, numbers and other characters.|
The maximum size that can approximately be stored in an attribute of type binary depends on the database:
|1 MB||1 GB||2 GB||128 TB or limited by hard disk of server|
Default value: String
In a web shop, you want to store the id, profile photo, level (for service quality), user name, password, activity, total of minutes spent online, year of subscription, date of birth, total amount of expenses and the standard amount of discount for a customer.
The ID should be unique for every customer, so this attribute has type AutoNumber.
The photo will be represented by an association to an entity that specializes Image. You do not use a Binary attribute for this purpose.
Level has three possible values: High, Medium and Low. This is stored in an attribute of type Enum.
The password itself should not be stored, but only its hash value, thus it is stored in an attribute of type HashString.
A customer can be active or inactive, which is stored in an attribute named ‘Active’ of type Boolean.
Localize (Only for the Date and Time Attribute Type)
This property indicates whether the date and time should be localized. By default localization is enabled. If you are not interested in the time component of a date (e.g. a birthday), you should set this property to ‘No’. Otherwise, the date can change because of time zone differences: a date and time early in the morning on April 2nd in Europe will be on April 1st in the U.S.A.
In technical terms, this property indicates whether the client assumes that the date and time are in a local time zone (Yes) or in UTC (No). In the former case, the date is first converted to UTC before being sent to the server and converted from UTC before being displayed.
Default value: Yes
Enumeration (Only for the Enumeration Attribute Type)
The enumeration property indicates which enumeration defines the possible values for this attribute.
Length (Only for the String Attribute Type)
This property specifies whether the length of a String is limited to a maximum or unlimited. In the case of a limited length, the ‘Max length’ property specifies the maximum (see below).
Default value: Limited
Max Length (Only for the String Attribute Type)
The ‘Max length’ property specifies the number of characters that can be stored in the attribute.
Default value: 200
The Value determines whether the value of the attribute is Calculated by a microflow or Stored in the database.
Take note of the following things when using Calculated attributes:
- Each time an object with a calculated attribute is retrieved, the attribute is calculated. Depending on the complexity of the microflow and the number of objects you retrieve this can have impact on performance.
- Attributes that are calculated by a microflow are not stored in the database.
- It is not possible to sort on an attribute for which this property is used, because sorting is done by the database engine.
- Uncommitted associated objects cannot be retrieved in calculated attributes.
Microflow (If Value Is Calculated with Microflow)
If the value is a computation, the Microflow property defines which microflow defines this computation to calculate the value of the attribute when the object is retrieved. The microflow should have a parameter of the type of the entity of the attribute and it should return a value with the same type as the attribute.
In a webshop, you want to show the total expenses for each customer. These are calculated by retrieving all orders associated with the customer and adding their totals.
Default Value (If Value Is Stored)
The Default value property defines the value of this attribute when an object is created. The default value should be compatible with the type of the attribute.
|Type of Attribute||Default Value Property||Additional Comments|
|AutoNumber||1||Starting value of the increment. If there are already rows in the table, the AutoNumber values will be based on the right 32 bits of the id column value. This can cause gaps in the AutoNumber ranges with jumps of 100, because id values are reserved by the Runtime in blocks of 100.|
|DateTime||(empty)||The default value should either comply with the format year-month-day (eventually postfixed by hour:minute, eventually postfixed by :second), or be
Effects of Data Type Changes on Existing Attributes
For more information, see Attributes Type Migration.