The next table presents the properties of the entity element.

Property

Description

Optionality

Default value

Obs.

Name

Name of the entity.

Mandatory

 

See rules for naming elements.

Physical Table Name

Physical table name. The name you specify for this field depends on the database you are connecting to.

Mandatory

 

In a SQL Server, the full physical table name is:

[<server>].[<catalog>].

[<owner>].<table>

In Oracle, the full physical name is:

[<owner>].<table>@[<server>]

Logical Database

The logical name that represents the external database. In Service Center of each environment map the Database Connection to this Logical Database name. This is especially useful when staging between environments, allowing to dynamically change the entity's external database.

Optional

 

This field is used only for entities imported using Database Connections.

Identifier

Attribute that uniquely identifies the entity rows.

Optional

 

In database terminology, the Identifier is called the Primary Key.

Description

Free text that describes the action.

Optional

 

Useful for documentation and knowledge transfer purposes.

The maximum size of this property is 255 characters.

Default Value behavior

Indicates how the default values of the entity's attributes are stored in the database and retrieved from the database:

No conversion to/from Database: all the entity's attributes that have the default value set are stored in and retrieved from the database without any conversion, i.e., it is the default value that is stored in and retrieved from the database.

Convert to/from Null value in Database: all the entity's attributes that have the default value set are stored in the database with the null value. When retrieving data from the database, the null value is converted to the attribute's default value. If no default value is defined for the attribute,  the null value is then converted to the Platform default value for the data type.

Mandatory

No conversion to/from Database

Only optional attributes are converted. The mandatory attributes cannot be empty so no conversion occurs.

Check also the list of default values at runtime and in the database for further information.

See Also

Define Extension Entities | Entity Editor | Default Values in Database | Available Data Types