Connectors → Oracle Transportation and Global Trade Management
About Oracle OTM/GTM
Oracle Transportation and Global Trade Management (OTM/GTM) systems manage all transportation activity throughout your global supply chain and trading. It combines ease of use with industry-leading capabilities.
Oracle OTM/GTM Connector Updates
This section is to explore the updates in the newer versions of the Oracle OTM/GTM connector available on the Incorta connectors marketplace.
In order to get the newer version of the connector, please update the connector using the marketplace.
Version | Updates |
---|---|
2.0.1.0 | Support data extraction via Data Export API (in addition to the Business Object Resources API), allowing for extracting archived data along with current data |
2.0.2.0 | Support uploading an optional, user-defined, line-separated list of tables that can be discovered and extracted via the Oracle OTM/GTM connector. |
2.2.1.0 | Requires upgrading the cluster to release 2024.7.x or 2024.1.7. ● Support uploading an optional user-defined list of tables that can be discovered and extracted via the Oracle OTM/GTM connector. |
2.2.2.0 | Requires upgrading the cluster to release 2024.7.x or 2024.1.7. ● Support asynchronous export via the Data Export API ● Support extracting deleted Primary Keys (PKs) |
About the Oracle OTM/GTM Connector
With the Oracle OTM/GTM connector, you can get data from Oracle OTM/GTM inside Incorta. You can create dashboards and insights based on this data to help your organization make good decisions.
This connector fetches data from your Oracle OTM/GTM system using a set of REST APIs.
The Oracle OTM/GTM connector supports the following Incorta-specific functionality:
Feature | Supported |
---|---|
Chunking | ✔ (via Business Object Resources API only) |
Data Agent | |
Encryption at Ingest | |
Incremental Load | ✔ |
Multi-Source | ✔ |
OAuth | ✔ |
Performance Optimized | ✔ |
Remote | |
Single-Source | ✔ |
Spark Extraction | |
Webhook Callbacks |
Steps to connect Oracle OTM/GTM and Incorta
To connect Oracle OTM/GTM and Incorta, here are the high-level steps, tools, and procedures:
- Create an external data source
- Create a schema with the Schema Wizard
- or, Create a schema with the Schema Designer
- Load the schema
- Explore the schema
Create an external data source
Here are the steps to create an external data source with the Oracle OTM/GTM connector:
- Sign in to the Incorta Direct Data Platform™.
- In the Navigation bar, select Data.
- In the Action bar, select + New → Add Data Source.
- In the Choose a Data Source dialog, in Database, select Oracle OTM/GTM.
- In the New Data Source dialog, specify the applicable connector properties.
- To test, select Test Connection.
- Select Ok to save your changes.
Oracle OTM/GTM connector properties
Here are the properties for the Oracle OTM/GTM connector:
Property | Control | Description |
---|---|---|
Name Your Data Source | text box | Enter a name for your data source. |
Domain | text box | Enter the URL for your Oracle OTM/GTM System in the following format: https://<servicename>-<identity-domain-name>.otm.<data-center>.oraclecloud.com/ |
Username | text box | Enter your username. |
Password | text box | Enter your password. |
Max concurrent calls | text box | Enter the maximum number of concurrent calls that Incorta sends to Oracle OTM/GTM. The default is 5 calls. |
Timeout in seconds | text box | Enter the time in seconds to wait for a response from Oracle OTM/GTM. The default is 600 seconds. |
Extract Data Using REST APIs For | dropdown list | Select the API type you want to use for data extraction: ● Business Object Resources (default) ● Data Export |
Metadata cache time (hours) | text box | This option is available when you select the Business Object Resources API type. Specify the time to cache the JSON response for table and column discovery. Set to 0 for no caching. |
Execution Mode | dropdown list | This option is available when you select the Data Export API type. Select the extraction mode: ● Synchronous (default) ● Asynchronous Synchronous exports have volume limits. Use asynchronous mode for large datasets to avoid performance issues. |
External Storage Name | text box | This option is available when you select the Asynchronous extraction mode. Enter the Oracle Object Storage Incorta will use during the asynchronous extraction. |
Bucket Name | text box | This option is available when you select the Asynchronous extraction mode. Enter the bucket name. |
OCI Auth Configurations | text box | This option is available when you select the Asynchronous extraction mode. Enter the OCI authentication configurations |
OCI Private Key | button | This option is available when you select the Asynchronous extraction mode. Upload the OCI private key |
Include Archived Transactional Data | toggle | This option is available when you select the Data Export API type. Turn on this toggle to extract archived data along with current data. |
OTM Tables List | button | Optionally upload a text file that contains a line-separated list of tables to be discovered and extracted. These tables will be available in the Table Data Source dialog under the Others schema. The maximum file size is 4MB. |
Extra Options | text box | Enter supported extra options in the form of key=value . |
Before version 2.0.1.0, data extraction is available via Business Object Resources API only.
Create a schema with the Schema Wizard
Here are the steps to create an Oracle OTM/GTM schema with the Schema Wizard:
- Sign in to the Incorta Direct Data Platform.
- In the Navigation bar, select Schema.
- In the Schema Manager, in the Action bar, select + New → Schema Wizard.
- In (1) Choose a Source, specify the following:
- For Enter a name, enter the schema name.
- For Select a Datasource, select the Oracle OTM/GTM source.
- Optionally create a description.
- In the Schema Wizard footer, select Next.
- In (2) Manage Tables, in the Data Panel, first, select the name of the Data Source, and then check the Select All checkbox.
- In the Schema Wizard footer, select Next.
- In (3) Finalize, in the Schema Wizard footer, select Create Schema.
Create a schema with the Schema Designer
Here are the steps to create an Oracle OTM/GTM schema using the Schema Designer:
- Sign in to the Incorta Direct Data Platform.
- In the Navigation bar, select Schema.
- In the Action bar, select + New → Create Schema.
- In Name, specify the schema name, and select Save.
- In the Schema Designer, in the Action bar, select + New → Table.
- In the Table Data Source dialog, specify the table data source properties.
- Select Add.
- In the Table Editor, in the Table Summary section, enter the table name.
- To save your changes, select Done in the Action bar.
Oracle OTM/GTM table data source properties
For a schema table in Incorta, you can define the following Oracle OTM/GTM-specific data source properties as follows:
Property | Control | Description |
---|---|---|
Type | dropdown list | Specify the data source type. Select Oracle OTM/GTM |
Data Source | dropdown list | Select the Oracle OTM/GTM data source you want to use |
APIs Type | dropdown list | Select the API to use to extract data: ● Business Object Resources (default) ● Data Export This option won't be available starting the connector version 2.2.2.0, and the used API will be set only in the data source. |
Catalog | dropdown list | Select the Oracle OTM/GTM catalog |
Schema | dropdown list | Select the schema you want to extract data from. ● Business Objects ● Power Data ● Others (available only if you upload the list of tables when creating the data source) |
Table | dropdown list | Select the table to extract its data |
Selected Columns | text box | Enter a comma-separated (with no spaces) list of columns to retrieve. Leave it empty to include all columns in the source table. Column names are case-sensitive. |
Extract Deleted Primary Keys Only | toggle | Enable this option to extract deleted Primary Keys only. If the selected table does not include deleted records, validating the dataset throws and error. However, you can save the dataset without validation and the table extraction will return 0 records. You must specify a date range; at least, set the Extract Inserted and Updated Data After field. You must also leave the Selected Columns box empty. Deleted data is extracted from primary OTM data objects only even if the Include Archived Transactional Data is enabled in the data source. |
Fetch Size | text box | Specify the number of records to retrieve per page in the list request to the REST service. The maximum value is 1000. |
Extraction Filter | text box | Enter the filter to limit the records to extract. This option is available when you select the Business Object Resources API type. Example: (insertDate le 2019-10-30T02:19:06-07:00) and (not descriptionText pr) or ((revenue gt "300000 USD") and (weight ge"80 LB" and weight le "100 LB")) For details, refer to REST API for Business Object Resources > Manage Collections |
Extract Inserted and Updated Data After | text box | Optional. Specify the start date and time for the period during which updated or inserted data in the selected table will be included in the extraction. This option is available when you select the Data Export API type. |
Extract Inserted and Updated Data Before | text box | Optional. Specify the end date and time for the period during which updated or inserted data in the selected table will be included in the extraction. This option is available when you select the Data Export API type. |
Incremental | toggle | Turn on this toggle to enable incremental load |
Incremental Column | text box | Enter the source table column to be used for the incremental load filter. It must be a Date/Timestamp column. The default is updateDate. |
Chunking Method | dropdown list | Select the chunking method to initiate parallel extracts for large tables: ● No Chunking ● By Data/Timestamp This option, along with its related options, is supported in the Business Object Resources integration API only. |
Order Column [Date/Timestamp] | text box | This option is available when you enable chunking. Enter the source table column you want to order records by before chunking. It must be a Date/Timestamp column. The default is the insertDate. |
Order Column Type | dropdown list | Select the type of the chunking order column: ● Data ● Timestamp |
Chunk Period | dropdown list | Select the chunk period that will be used in dividing chunks: ● Daily ● Weekly (default) ● Monthly ● Yearly ● Custom |
Number of days | text box | Select Custom for the Chunk Period to set this property. Enter the chunking period in days. |
Lower Bound for Order Column | text box | Enter the minimum value for the order column. |
Upper Bound for Order Column | text box | Optional. Enter the maximum value for the order column. |
Callback | toggle | Enable post extraction callback, that is, enabling callback on the data source data set(s) by invoking a certain callback URL with parameters containing details about the load job |
Callback URL | text box | Enable Callback to configure this property. Specify the callback URL. |
View the schema diagram with the Schema Diagram Viewer
Here are the steps to view the schema diagram using the Schema Diagram Viewer:
- Sign in to the Incorta Direct Data Platform.
- In the Navigation bar, select Schema.
- In the list of schemas, select the Oracle OTM/GTM schema.
- In the Schema Designer, in the Action bar, select Diagram.
Load the schema
Here are the steps to perform a Full Load of the Oracle OTM/GTM schema using the Schema Designer:
- Sign in to the Incorta Direct Data Platform.
- In the Navigation bar, select Schema.
- In the list of schemas, select the Oracle OTM/GTM schema.
- In the Schema Designer, in the Action bar, select Load → Full Load.
- To review the load status, in Last Load Status, select the date.
Explore the schema
With the full load of the Oracle OTM/GTM schema complete, you can use the Analyzer to explore the schema, create your first insight, and save the insight to a new dashboard.
To open the Analyzer from the schema, follow these steps:
- In the Navigation bar, select Schema.
- In the Schema Manager, in the List view, select the Oracle OTM/GTM schema.
- In the Schema Designer, in the Action bar, select Explore Data.
Additional Considerations
In the case of Asynchronous extraction mode, the temp external storage might not be fully cleaned in the following situations:
- Restarting the cluster or the Loader Service while loading the table
- Stopping the schema load job