Entities Editor (Magic xpi 4.9)
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:
-
The Entities tab lets the user view and configure the following parameters (Parameters in bold are mandatory):
|
|
|
|
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. Here the user can define the entities properties. For more information, click here.
|
|
Keys
|
Click to open the Modal window. Here the user 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.
-
The Complex tab lets the user view and configure the following parameters (Parameters in bold are mandatory):
|
|
|
|
Name
|
Enter a valid complex name.
|
|
Properties
|
Click to open the Modal window. Here the user 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.
-
The Enumerations tab lets the user view and configure the following parameters (Parameters in bold are mandatory):
|
|
|
|
Name
|
Enter a valid enumerations name.
|
|
Member
|
Click to open the Modal window. Here the user 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 the user configure the following parameters (Parameters in bold are mandatory):
|
|
|
|
Entity
|
This combo-box is populated with the service's pre-defined entities.
Select the desired entities from the drop-down list.
|
|
Related Entity
|
This combo box is populated with the service's pre-defined entities.
Select the desired entities from the drop-down list.
|
|
Collection
|
This is a check-box. By default it is un-checked. Selecting this check-box can denote One-to-many (1..n) relationship, while deselecting denotes one-to-one(1..1) relationship of Entity with its Related Entity.
|
|
Property Name
|
This is the name of the navigation property. This field is editable. The user can enter the name manually or generate it by clicking the Default Name button.
The Property Name must be unique for the Entity and its Related Entity.
|
The Default Name button generates the Property Name. This button is available on each navigation property line and is viewed when both the Entity and Related Entity fields are filled.
|
|
-
If Related Entity is participating in a collection then the Plural Name of that entity, if defined, will be used as the Property Name.
-
If Related Entity is not participating in a collection then the Name of that entity will be used as the Property Name.
-
If Plural Name for corresponding Related Entity is not defined then the Name of that entity will be used as the Property Name.
|
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 the user view and configure the following parameters (Parameters in bold are mandatory):
|
|
|
|
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
-
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.
The user 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.
|
|
If the user makes any changes to the OData Entities for the existing OData Service, a warning message will pop-up, asking the user to reconfigure the trigger(s). When the trigger is reconfigured, the OData provider will generate/modify the existing schema internally. This schema will be useful for mappings on the OData connector step.
|
