Configure the Web API Reader functionality - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The Web API Reader functionality allows you to transfer data from any third-party application into SDx if the application has exposed its data using RESTful web APIs.

Using Data Validator Administration, data is imported using a web API import definition. The Web API that you connect to and the URL suffix that you use to fetch data from the third party source is specified in the import definition. The data is mapped to the target system using existing class definitions, property definitions, and relationship definitions. The imported data is validated against defined validation rule sets that can use the target system as their basis, and the export mapping ensures that the data is mapped correctly into the target system format.

Job definitions combine all these components into one set of steps. You can create a Web API job definition and use it to process a load job which transfers the data to the target system. Before running the load job, you must create a load job method for the particular classification that you are importing from the third party application. You can also process the job using a HTTP client like Postman.

Prerequisites

Before you can connect to another third-party data source, you must set up an authorization server to authorize requests for the data to a data source. You also must create a Web API to request the data from the data sources. The Web API contains the base URL that can be used by import definitions to build their URLs to connect to the third party application and fetch data for the import.

For more information, see Create an authorization server and Create a Web API.

The following work process diagram illustrates the steps involved in the export of data and documents from a third-party application to an SDx staging system and the subsequent validation and export of these files to a target system using Data Validator.

Page-1 Run a load job Create a Web API Create a load job method Create a job details object Create a Web API job definition Create a Web API import definition Create a job details item Load XML file for Web API Reader sub-classifications Create an authorization server

SHARED Tip Click a box in the diagram to go to the associated procedure.