PartnerWizard

The PartnerWizard allows you to integrate new partner systems using this web app. A partner system is a content provider which is used by the federated recommender to generate recommendations. So without coding you can integrate most search APIs. For more general information about the EEXCESS project please visit:http://eexcess.eu/ or https://github.com/EEXCESS.

For more Information about this web app please visit:https://github.com/EEXCESS/PartnerWizard

General Settings

Partner Information

your username

e-mail

To generate a PartnerRecommender you need to agree to the EEXCESS Data Access Agreement.

Parameter

id used in the Maven-Repository (e.g eu.eexcess)

id used in the Maven-Repository (e.g MyPR)

version used in the Maven-Repository (e.g 1.0)

java package, can be the same as the groupId (e.g eu.eexcess)

Name of the Partner - we will show this information as origin of the metadata

URL of the Partner - used in EEXCESS

URL of the FavIcon of the Partner - used in EEXCESS

prefix for the URI to the objects

prefix for access to images

License of the meta data

select the format which your API returns

configure Search API

The API configured in the sections below, need to return the data in XML-format. EEXCESS uses XPath to determine the metadata from the objects. If you need more info about XML and XPath we recommend to visit:

configure Search API
configure Search API
Partner API search

URL for API
mandatory place holder:
$ {query} - here we insert the search term
possible place holder:
$ {numResults} - here we insert the number of objects returned

search term

API Response

Mapping to EEXCESS fields

XPath which points to the list of objects

EEXCESS Fields

Here you need to define the mapping from your metadata to our EEXCESS metadata fields.

name description xpath value
ID identifier
URI URI of the object
Title title
Description description of the item
previewImage URL of the preview image

configure Detail API

configure Detail API
configure Detail API
Partner API detail

URL for API
mandatory place holder:
$ {detailQuery} - here we insert the identifier

search term

API Response

Mapping to EEXCESS fields

XPath which points to the list of objects

EEXCESS Fields

Here you need to define the mapping from your metadata to our EEXCESS metadata fields.

name description xpath value
ID identifier
URI URI of the object
Title title
Description description of the item
previewImage URL of the preview image
collectionName name of the collection
date date of the object
subject subject of the object
language language of the object

Create PartnerRecommender/project

mvn command used to generate the PartnerRecommender:

Result:

Download PartnerRecommender as WAR

Download the generated sources of the PartnerRecommender

Deployment to our Development-Server

With this button we deploy the generated PartnerRecommender to our Development-Server. With our Chrome-Extension you should become recommendations also from your new PartnerRecommender.