Skip to content

Consume data via Frontend

Igor Petrov edited this page Oct 23, 2024 · 4 revisions

Contract negotiation

When you have the Connector Endpoint of the providing Connector to crawl, click on the tab Catalog Browser and enter the endpoint URL into the "Connector Endpoint" search bar. Your Connector will automatically show you all available offerings of the other Connector, which this Connector is entitled to show by the offerings access policy.

consume1

You can also connect to multiple providing Connectors at once by entering multiple Connector endpoints and seperating them in the search bar via a comma.

The information symbol in the "Connector Endpoint"-search bar provides basic information on the status of the connection process to the entered providing Connectors as well as potential error messages.

It is also important to understand that the consumer sees the assets offered by the provider directly in their catalog browser and not the contract offers. The details of the contract offers for an asset and their policies attached become visible when clicking on an asset. This logic is exactly the opposite of the providing area, as the individual contract definitions are displayed in the Contract Definitions area at the provider directly.

Clicking on a data offer opens the detail window with more details about the offer. If there are several different Contract-Offers for the offered Asset which may have different policies attached, several Contract-Offers will be displayed in the detail-view. The appropriate data offering can then be selected based on the set policies.

Click Negotiate to start a contract negotiation for the desired data offer.

consume2

When clicking Negotiate You will see a prompt asking you to accept the standard license and policies that come with the contract offer.

consume3

If you haven’t done so already, take a moment to review the "Standard License" and "Policy" sections in the contract offer. Click anywhere on the screen to go back to the contract offer. Once you’ve reviewed everything, click on the checkbox that says "I agree to the Data Offer Terms & Conditions". After you’ve checked the box, click on the Confirm button.

As soon as the contract negotiation ends successfully with an agreement, the new contract will be visible in the Contracts tab.

Data transfer

To transfer the data to your desired data sink go to the Contracts page. On this page, all your contract agreements are displayed, consuming as well as providing contract agreements. You can quickly distinguish consuming and providing contracts with the arrow left to the Contract Agreement (Up = providing, Down = Consuming). You can inspect details on the contract agreements by clicking on a single contract agreement.

When clicking on a contract agreement a pop-up window will show up and display details on the contract agreement.

transfer

By pressing the Transfer button, the following pop-up window then appears.

transfer2

To transfer data to a REST API endpoint, you need to select the HTTP-method and provide the URL of your the data-sink.

If your data-sink is protected by, for example, required headers or authentification, these can also be added in here.

For test purposes and only for public data you can use services like Webhook, which show all information from incoming HTTP requests.

Transfer history

The Transfer History page provides a list of all incoming and outgoing data transfers that were started with this Connector.

transfer3

You can for example identify the date, the involved asset, the state, the counterpart MDS Connector ID, the involved connectors or look up further details with a click on Show details.

Consume data via Frontend using parametrization

Find and negotiate the contract offer as described above. Then Go to Contracts and press the button Transfer.

Enter a destination endpoint of your backend. In this example we will simulate the backend using a webhook endpoint.

Press Show Http Datasourse Parameterization Fields

Define the custom method (usually GET), subpath (as part of the URL between the first slash and the question mark) and query parameters. Then press Transfer.

You will see the results on the webhook site. Only messages with "zustandsklasse=dicht" should be transferred.

Clone this wiki locally