Structure Selection
The structure selection tab allows you to view a list of your repository structures and select which of those structures will be included when you generate code for your Harmony Core web service.
Structure Name
The first column of the structures list displays the structure name which is the actual name of the structure in the repository. The structure name will be used to determine part of the endpoint names that are used to access that data in your web service. For example, if the name of a structure is CUSTOMER then the default endpoint used to access that data would be something like this:
https://your.domain.com/odata/Customers
Structure Alias
The second column of the structures list shows any structure alias names that you might have previously assigned. Alias names are optional and allow you to effectively change the name of a structure for code generation purposes, in turn changing the name used to refer to the structure throughout your web service. So if you don't want to use the actual name of a structure for any reason then you can click into the alias name field and enter an alternate value.
Alias names should not contain any spaces, but if you want to refer to multiple words in a name then use an underscore (_) character to separate the words. In the resulting web service underscores in structure and alias names are converted to PascalCase. For example if a structure is aliased as ORDER_ITEMS its name will appear as OrderItems in your web service.
Processing Mode
The processing mode column contains a drop-down selection of processing modes for each of the structures. These processing modes determine what code is generated for each of your structures, and in turn how the structure is represented in your web service. The processing modes are as follows:
|
Processing Mode |
Description |
|
None
|
Select None to completely exclude a structure from all code generation processing. Structures marked None will not be exposed by your web service in any way.
|
|
Structure and File
|
Full code generation will take place for the structure and it will be possible for you to expose full web service functionality for the structure, depending on how the structure is configured and what Harmony Core options you select when generating code for your web service.
This is the normal processing mode that you should select if you want to include a structure in your web service. The only exception is in the case where you may have multiple structures assigned to a single file definition. In that case you should select Structure and File for ONE of the structures and select Structure Only for all remaining structures that are assigned to the same file.
|
|
Structure Only
|
As described above, the Structure Only processing mode is specifically used when multiple structures are assigned to a single file definition. In that case you should select Structure and File for ONE of the structures, and select Structure Only for all other structures that are assigned to the same file.
|
|
Custom Code Only
|
The custom only processing mode can be used when you wish to expose a structure via custom code endpoints only. doing so will result in model and metadata classes being generated for the structure, but no OData controller endpoints will be generated, and the no Entity Framework provider functionality will be generated for the structure.
|