skip to main content
Using DataDirect Hybrid Data Pipeline : Enabling OData and working with Data Source groups : Using the Configure Schema editor
  

Try Now

Using the Configure Schema editor

The OData tab of a Data Source definition allows you to enable OData access. Progress DataDirect Hybrid Data Pipeline requires a schema map to translate the OData requests to the data model used by the underlying data source. From the OData tab, you launch the Configure Schema editor to choose the tables and columns to expose through OData. When you save, Hybrid Data Pipeline generates the schema map as a JSON string. If the underlying data source changes, or you want to expose a different set of tables and columns, you need to edit the schema map. A schema map can only enable OData access to tables in one schema per Data Source definition. To expose tables in multiple schemas, use Data Source groups as described in Creating a Data Source Group
The following steps describe how to create or edit a Data Source definition, enable OData and use the Configure Schema editor to create a schema map.
1. In the navigation pane, click Data Sources to open the Data Sources view.
*To create a new Data Source definition, click New Data Source, choose your data store type, and enter the appropriate information on the General tab. If you need help with the fields, see the documentation specific to your data store type, Creating a Data Source definition.
*To enable OData for an existing Data Source, click the Data Source Name of the definition to edit.
The Edit Data Source screen opens.
2. Select the OData tab.
Click the thumbnail to see an example OData tab for a Salesforce Data Source. DDC - OData tab before schema map has been createdDDC - OData tab before schema map has been created
3. In the OData Version field, select the version to be used by your data source. This value determines the format of your schema map. If this data source is part of a data source group, the version specified must match that of the other members.
Note: To change the OData Version after creating the schema map, you will need to reconfigure your map using the instructions provided in steps 3 through 9.
4. Click Configure Schema.
The Configure Schema wizard opens.
5. From the Select Schema pull-down list, select the schema that contains the tables to expose through OData.
The Configure Schema editor opens.
6. Select the tables and columns to expose to OData clients:
*Tables that have a primary key assigned in the underlying data store have a gold key icon next to the key column(s). You cannot change a key assigned by the data source. If a table does not have a primary key, select one or more columns as the primary key by clicking the key icon.
*Optionally, specify singular and plural names for the table by expanding the table node and select the Settings tab. In the schema map, DataDirect Cloud pluralizes the table name automatically. You use the plural entity name in OData requests. If the table name is plural already, the plural entity name will have an additional S, for example ACCOUNTSES. You can enter a plural name in this field to make entity addressing more intuitive.
7. Optionally, complete the following steps to enable text search for individual tables and specific text-based columns using the $search system query option (for OData version 4) or the ddsearch custom query parameter (for OData version 2). For the data store types that support indexing, make sure that your underlying data store contains the appropriate indices and that they are up to date.
a. Select Advanced Settings to enable search configuration.
b. Select a table and expand its details, select the Settings tab and select a search option: Substring enables searches for the string anywhere in the search-enabled fields; Begins restricts the search to the text at the beginning of a field; and Full Text, which is only available for data store types that support indexing and full text search. DDC - Configure Schema editor enable SearchDDC - Configure Schema editor enable Search
c. Select the table's Columns tab and click the search icon next to the text-based column(s) where you want to enable search. For data stores such as Oracle, that can expose multiple indices, when you click the search icon you can also select the index to submit $search or ddsearch queries against. Note: If the data store index has not been properly configured and you select Full Text, queries using $search or ddsearch will return errors.
The search icon for that column changes color as shown in the example.DDC - Configure column to enable searchDDC - Configure column to enable search
8. Optionally, click the editor's View Code button to see the JSON schema.
DDC - View Code button in the Configure Schema editorDDC - View Code button in the Configure Schema editor
9. Click Save & Close to save your selections.
If you select a table that does not have a primary key and try to save, a message alerts you to select columns for the primary key:
The Schema Map field in the OData tab displays the schema map as a JSON string.
After you create an OData-enabled data source, you can view the status of the schema map generation on the Data Sources tab. The icon besides the OData-enabled data source indicates the status of the schema map generation. The following table provides details of the icons:
Icon
Description
Schema Synch in progress
The synchronization of the schema map is in progress. The number denotes the percentage of synchronization completed.
Sync completed successfully
The schema map was synchronized successfully.
Sync completed successfully, with warning messages
The schema map was synchronized successfully, but there are some table/column warnings. Hybrid Data Pipeline allows users to know the details of the tables and/or columns that were dropped while generating the OData Model for a given schema map of a Data Source. The number of warnings shown is limited to 100. If there are more than 100 errors/warnings, you can get the complete list of warnings via the GET API.
Errors when synching a schema map
Errors occurred while synchronizing the schema map. You must address the errors and synchronize the schema map again. Hybrid Data Pipeline allows users to know the details of the tables and/or columns that were dropped while generating the OData Model for a given schema map of a Data Source. The number of errors/warnings shown is limited to 100. If there are more than 100 errors/warnings, you can get the complete list of warnings via the GET API.
Schema map resynch needed
You must synchronize the schema map again.