Data for Road Safety Cookbook - Mobility-Data-Space/mobility-data-space GitHub Wiki

DFRS Cookbook for First Movers

The cookbook is intended as a guide for a standard implementation in accordance with the requirements of DFRS Tech Group. We are recommending to use a Connector-as-a-Service (CaaS) with frontend functionalities, Kafka streaming as data transfer mode and (for first movers) manual approval as restriction mechanism.

There are also other data sharing options available. The connector can be installed on-premise. You can use the CaaS API (so-called management API) directly without the CaaS frontend. You can choose other data transfer modes and other policies. For all these variations, see the section Useful Links. The MDS team will be happy to provide an individual support if needed.

For a compact view, we integrated image previews into the text. Please click on the preview to see the full image.

Prerequisites:

  1. Your organisation has signed the MDS participant agreement.
  2. (For Kafka approach) You have an up and running Kafka cluster which is accessible from the internet (for providers) or a Kafka client (for consumers).

Step 1: Portal Registration

If your organisation is DFRS participant, but not registered in the MDS Portal yet, please contact our Community Team and follow the registration process. Please do not use the self-registration option.

If your organisation is already registered in the MDS Portal, the Admin can register further users by inviting them. We recommend to grant your colleagues Admin or Key Users rights to allow to work with Connector-as-a-Service (CaaS).

Feel free to contact our Technik Team if something is not working properly during these or later steps.

Step 2: CaaS Ordering

The CaaS is the simplest way to receive a registered and compliant connector and is free of charge for MDS participants.

If you want to order a CaaS for your organisation, please contact our Technik Team.

After the deployment of your CaaS, you will get an email from our provider Think-It and find your newly registered CaaS in the connectors list.

Then you can access the CaaS frontend by clicking on the symbol in the column "Frontend".

Alternatively, you can deploy the connector yourself (on-premise). In this case, please follow this guide.

Step 3a: Provider Kafka Guide

As a provider, you can publish your data offer using the connector frontend.

  1. Please select Create Data Offer and fill in all relevant fields. The description of Kafka fields can be found here.

  1. Please fill in the general information (metadata) about your asset.

To use more metadata fields, please select Show advanced fields. We recommend to use as much optional attibutes for the offer description as possible to make it easier for data consumers to find your offer.

Explanations about the meaning of each metadata field can be found here.

Note: If you find typos in your metadata or would like to add some informations after the publishing, don't worry: assets are editable. However, the editing feature is not intended for complete changes of the data offer. If you want to change the data offer or essential parts of the data offer description, please create a new asset and delete the old one.

  1. For first movers we are strongly recommending to use an unrestricted policy and the manual approval feature.

In this way, providers always obtain a full control over the own data offers and can manually approve the requests from DFRS consumers.

As soon as the DFRS group within MDS is established, the connector restricted policy can be applied instead of manual approval.

  1. Select the tab Manual approvals to check whether you already have requests from the consumer.

Step 3b: Consumer Kafka Guide

Later you will be able to find all relevant offers in the catalog. As first mover, you need to know the provider's connector address. The MDS will provide this address to you as soon as the provider deploys the connector.

  1. At first you need to negotiate contract. Select the Catalog Browser tab and paste the provider connector address.

  1. Select a relevant asset and click on Negotiate. Please confirm that you agree with the provider's terms and conditions. Provider will now receive and approve your request. Please allow some time for this approval.

  2. After the approval by the provider, the contract is successfully negotiated.

  3. Go to the Contract Agreements tab. You are now able to see the negotiated contract.

  1. Select the negotiated contract.

  2. Click on the Transfer button.

  1. Select Kafka Streaming from the Type dropdown list.

  2. Provide a callback address to automatically connect with your client or use the information in the endpoint data reference to manually configure the transfer.

  1. The provided Kafka topic is now available in your client.

Useful Links