[]
        
(Showing Draft Content)

Add an Entity

An entity represents a data table that holds information within the data model. In Wyn Enterprise, you can easily add an entity by either binding to an existing data table or creating a new data table through the SQL query. This article describes the steps to add an entity to a data model and its important properties. For more information, refer to the following sections.

Add an Entity

  1. To add a new entity, click the Add Entity button on top of the model editor.


    Add Entity button


  2. In the Add Entity dialog box that appears, enter the name of the new entity. If the "Name" field is left empty when selecting a table with an alias, it will automatically be populated with the table's alias.


    Add Entity Properties


  3. If you are adding a new entity by binding, select the Table option from the Binding section, and then select a data table from the provided list as shown.


    Add an entity by a SQL query


    Or,


    If you want to add a new entity through a SQL query, select the SQL Query option from the Binding section and enter the SQL statement to define the new entity.


    Add an entity by a SQL query


  4. Click the Validate button to verify the data binding or SQL query.


    Add an entity by a SQL query


  5. Control the appearance of the new entity using the Is Hidden property.

  6. Finally, click the Add button to confirm.


    Add the entity


    A newly added entity will appear in the list of entities on the left. You can modify the properties of the new entity in the Properties panel that appears on the right.


    Newly added entity


Modify an Entity

In a Direct Query Model, entities added by SQL query can only be modified. To modify an entity, follow the below instructions,

  1. On the Data Model Designer page, hover on the entity under the Entities pane and click the edit icon that appears on hover.


    Edit Icon to Modify Entity


  2. Modify Entity popup will appear on your screen. Modify the query in the input box, click the Validate button to verify the modified query, and then click the Modify button to finish.


    Modify Entity Popup


    Note: If an entity is modified from an SQL Expression to a Table, the entity cannot be modified again.

Search Entity

Follow the below steps to search for an entity from a direct query model.

  1. Go to the Entities list and enter the name of the entity you want to search in the search bar above the entity list. The searched entity will be listed as shown below.


    Search Entity Gif


Important Properties

The following table describes the important properties of an entity that you can set in the Data Model Designer.

Property Name

Description

Name

The name of the entity.

Binding

The database object that the entity represents.

Is Hidden

Indicates whether the entity is hidden from end-users.

Security Filter

Allows you to use custom security providers to filter the data displayed for the entity.