Entities Editor (Magic xpi 4.7)
The Entities Editor is an entry point for defining the OData service structure with a set of configuration dialogs. The configuration is completed on pressing the Finish button and aborted on pressing the Cancel button.
Clicking the Entities button will open a screen with the following tabs:
-
Entities:
The Entities tab lets you view and configure the following parameters (Parameters in bold are mandatory):
|
Parameter Name
|
Description
|
|
Name
|
Enter a valid entity name.
|
|
Plural Name
|
Enter the entity name in plural form to be used by the Metadata.xml.
|
|
Properties
|
Click  to open the Modal window where you can define the entities properties. For more information, click here.
|
|
Keys
|
Click to open the Modal window where you can define multiple properties.
Add the properties from the drop-down list.
The Add button adds a new property line.
the Delete button deletes the highlighted property line.
|
The Add button adds a new entity line.
The Delete button deletes the highlighted entity line.
-
Complex:
The Complex tab lets you view and configure the following parameters (Parameters in bold are mandatory):
|
Parameter Name
|
Description
|
|
Name
|
Enter a valid complex name.
|
|
Properties
|
Click to open the Modal window where you can define the complex entities properties. For more information click, here.
|
The Add button adds a new entity line.
The Delete button deletes the highlighted entity line.
-
Enumerations:
The Enumerations tab lets you view and configure the following parameters (Parameters in bold are mandatory):
|
Parameter Name
|
Description
|
|
Name
|
Enter a valid enumerations name.
|
|
Member
|
Click to open the Modal window where you can define the enumerations value. For more information, click here.
|
The Add button adds a new enumeration line.
The Delete button deletes the highlighted enumeration line.
Clicking the Next button will open Navigation Properties.
The Navigation Properties tab lets you configure the following parameters (Parameters in bold are mandatory):
|
Parameter Name
|
Description
|
|
Entity 1
|
This combo-box is populated with the service's pre-defined entities.
Select the desired entities from the drop-down list.
|
|
Relationship
|
This is a combo-box populated with the supported relationships.
The possibe values are 1..1, 1..n, n..1, n..n
Select the relationship from the drop-down list.
|
|
Entity 2
|
This combo box is populated with the service's pre-defined entities.
Select the desired entities from the drop-down list.
|
The Add button adds a new navigation properties line.
The Delete button deletes the highlighted navigation properties line.
Clicking the Next button will open Entity Sets.
The Entity Sets tab lets you view and configure the following parameters (Parameters in bold are mandatory):
|
Parameter Name
|
Description
|
|
Entity Container Name
|
Enter a valid entity container name.
|
|
Name
|
Enter a valid entity set name.
|
|
Entity
|
This is a combo-box populated with service's pre-defined entities.
Select the desired entity from the drop-down list.
|
|
Methods
|
This is a multi-select grid field. Click to open the methods.
The supported methods are:
-
Get
-
Get (By Key)
-
Post
-
Put
-
Patch
-
Delete
|
|
Query Options
|
This is a multi-select grid field. Click to open the query options.
The supported query options are:
-
Filter
-
Order by
-
Expand
-
Select
-
Top
-
Skip
|
|
Expansions
|
This is a multi-select grid field. Click to open the Entity Set.
You can select the entity sets that are connected by Navigation Properties to the selected entity.
|
The Add button adds a new entity sets line.
The Delete button deletes the highlighted entity sets line.
Since version: 4.7
