Matchmaking Integration Guide

Matchmaking Service Integration Guide

If you want to integrate your platform to EFPF federated search and matchmaking service, to allow your company and catalogue data to be found by other EFPF users via federated search, you should read on to understand the steps required. If you only need to utilise the matchmaking service by searching data, you should refer to the tools and services consumer guide.

Currently the EFPF Matchmaking Service combines company and catalogue data from the following four platforms:

  • SMECluster
  • iQluster
  • COMPOSITION
  • NIMBLE

In order to add a new platform (aka. data source) to the Matchmaking Service, a new DS NiFi integration flow (iFlow) must be established in order to gather data from the new data source and make it available in the Federated Search after (refer to Matchmaking Architecture page to have a better understanding of the overall deployment architecture and data flow).

The following steps are needed to make your company/catalogue data available to Matchmaking service. Note: this is assumed your platform has already enabled SSO with EFPF. If SSO is not enabled yet, please follow the User Guide 101 for Platform Providers to enable it.

Step 1: Provide APIs for EFPF to retrieve your data

You (as a platform provider) need to provide APIs to allow EFPF to retrieve your Companies/Partners and/or Products/Services data. You also need to check if your API can be extended to provide the following details of the companies/products/services. If data model enrichment or transformation is needed, it can be performed by using iFlows in DS NiFi. For details, check the ‘Data Enrichment’ section in the User Guide 101 for Tool/Service/Data Providers.

Companies Products/Services

Unique id, Origin country, Brand name, Legal name, Activity sectors (e.g., furniture, aerospace, logistics, recycling ),Business Type (e.g., manufacturer, logistic provider),Certificate Type (any certificates relevant to the activity sector), Trust-score, Projects, Capabilities, Interests, Opportunities (project collaboration opportunities),Website URL / logo URL

Unique id, Name / label, Price, Currency, Manufacturer ID (the reference id of the company who manufactures the product), Warranty Period, Minimum Quantity, Transport Mode, Certificate Type, Supported Cargo Type, Package Unit, Package Amount, Total Capacity, Delivery Time, Delivery Time Unit, Image URL

Note:

  • A composite API is expected for getCompanies and getProducts respectively depending on what data your platform has and what you intend to integrate to EFPF matchmaking.
  • In order to use more attributes with the Matchmaking Service, for example to allow more search options, the respective Matchmaking Ontology classes may be modified. A complete redeployment of the matchmaking service will then create the new fields with the Apache Solr service. This is NOT in the scope of the Open Call experiments.

Step 2:Register your composite API in Service Registry

Once you created/enriched your APIs as mentioned in step 1, after testing and validating them, you are now ready to register your company/product APIs in the Data Spine Service Registry. You can refer Service Registry User Guide to register your API. If you need help with this step, you can send an email to the EFPF Support Team.

Step 3: Configure NiFi integration Flow

Note: This step will be performed by efpf side by the efpf admin

According to our Matchmaking Architecture, the data gathering is performed by iFlows in DS NiFi which performs the following steps for each connected portal/platform/data source (iQluster, COMPOSITION, SMECluster, NIMBLE)

  • contact the portals/services (dedicated API Calls) to collect the data
  • transform the collected data into the common data format (see Matchmaking Ontology) using JOLT transformations. For a complete understanding of how JOLT works, the JOLT Demonstrator may be used.
  • stores the transformed data in the index

Note: This step will be performed by efpf side by the efpf admin

After NiFi integration flow is created, new document for your platform will be added to the Solar index. Your product/service/company data will be available in the federated search.

Next