Welcome to this Provider guide on how to onboard Training Resources into the EOSC Marketplace.
Table of contents
Preliminary notes
To onboard a training resource into the EOSC Marketplace, the organisation that manages or delivers the resource must be registered as an EOSC Provider in the EOSC portal.
If your organisation is not yet onboarded as a Provider in the EOSC portal, please find the detailed information on how to become an EOSC Provider at and become a Provider at https://providers.eosc-portal.eu/becomeAProvider.
The training resources onboarding process requires a Provider Representative [1] to submit information about the training resources they want to include in the EOSC Marketplace. This specific required or optional information (metadata) is specified in the “EOSC Training Resource Profile”.
[1] Onboarding should be performed by an appropriate representative of each Provider, referred to as the “Provider’s Representative”, who is authorised to provide correct information about the Resources that are being onboarded.
Inclusion criteria to onboard Training Resources
Only onboarded Providers will be able to onboard different types of resources to EOSC. This section describes general requirements for all EOSC resource types, being complemented by specific requirements for training resources to be onboarded to EOSC.
a) Common inclusion criteria
Providers must first be onboarded as an EOSC Provider before being able to onboard resources.
The resource to be onboarded is targeted to EOSC and EOSC communities, or built on or that leverage EOSC capabilities to serve some other community.
Examples of training resources targeted at EOSC and EOSC communities are the ones related to open science, research data management, and how to use EOSC resources.
For federated or jointly provided resources, the resource onboarding must be done by the coordinating or lead provider (i.e. the coordinating or lead provider is the “Resource organisation” in the resource profile). Other providers may also onboard as EOSC Resource Providers if they wish to appear as supplementary or supporting providers. Such providers will be listed as “Resource providers” in the resource profile.
The resource provider commits to maintain resource descriptions up-to-date, this includes removing resources that are no longer operational or available.
Resource profile information must be provided in English.
b) Additional inclusion criteria to onboard a training resource
In addition to meeting the common inclusion criteria to onboard all resource types, these criteria must be met to onboard training resources:
Provide metadata in English when filling-in the EOSC Training Resource profile.
Specify the learning outcomes, resource type (e.g. recorded lesson, textbook, activity plan, etc.), content resource type (e.g. video, slides, audio, etc.), and estimated duration (e.g. estimated work hours).
Be in one of the European language(s) (view)
Incorporate information about the expected level of training and expertise to be achieved (beginner, intermediate, advanced, all) and required qualifications to access the training resource.
Comply with the FAIR principles, open and reproducible science practices, and have a defined approach to adherence to them. The provider also ensures file technical integrity (completeness of metadata to facilitate discovery and reuse, PIDs, etc.). In addition to ensuring the technical integrity of files, the provider should provide the most accurate metadata possible: all mandatory metadata is provided; all copyright, usage conditions, access constraints, licensing are declared; and all sources are credited when pre-existing resources are reused.
Provide information about the resource's provenance.
Be periodically updated and include the date of the last update to prevent outdated content. In the event that a training resource is not well maintained but is still useful, the provider must include a note that maintenance has been discontinued.
Ensure preservation (e.g. resources are deposited in a repository/platform that can ensure that they are accessible for a reasonable (3-5 years) period of time, preferably in trusted repositories with a long-term preservation policy). EOSC does not offer long-term preservation.
Step-by-step guidance to onboard Training Resources
Onboarding a new Training Resource in the Providers Dashboard operates similarly to onboarding a regular resource (see the Basic Onboarding Process).
The Provider’s Representative is offered two options to onboard Training Resources:
a) via a web interface for each Resource individually, or
b) via the Portal Application Programming Interface (API) (onboarding a catalogue still under development).
Notes:
The first resource of the Provider must be entered using the web interface.
Onboard the first resource via the API and wait for the approval of the EPOT. Once the resource is approved, continue onboarding other resources via the API.
a) Onboarding procedure via a web interface for each Resource individually
1) Access to the EOSC Providers Portal at https://providers.eosc-portal.eu/home and login.
2) Access the Providers Dashboard by selecting the menu “Providers Dashboard” (1) or the button “Learn more” (2) in the box “Provider Dashboard”.
Figure 1: EOSC Providers Portal
2.1) Then, click on the Provider’s name (1) or select the option “More” (2.1) and “Go to Dashboard” (2.2).
Figure 2: Providers Dashboard
3) Once in the Provider Dashboard, go to the left side menu, and select the option “Add new Training Resource” in the “Actions” section.
Figure 3: Action “Add new Training Resource”
4) Then a set of metadata fields needs to be filled in to complete the Training Resource Profile, which includes the following metadata sections:
Basic Information
Detailed & access Information
Learning Information
Geographical and Language Availability Information
Classification Information
Contact Information
Figure 4: Training Resource registration form
Full metadata fields:
The full description of the Training Resource Profile - including the metadata types, controlled vocabularies and multiplicity - is available at https://wiki.eoscfuture.eu/display/PUBLIC/F.+EOSC+Training+Resource+Profile#F.EOSCTrainingResourceProfile.
1. Basic Information | ||
Attribute Name | Definition | Required |
ID | A persistent identifier, a unique reference to the Resource. | Mandatory |
Title | The human readable name of the learning resource. | Mandatory |
Resource Organisation | The name of the organisation that manages or delivers the resource, or that coordinates the Resource delivery in a federated scenario. | Mandatory |
Resource Providers | The name(s) of (all) the Provider(s) that manage or deliver the Resource in federated scenarios. | Optional |
Authors | The name of entity(ies) authoring the resource. | Mandatory |
URL to resource | The URL that resolves to the training resource or to a "landing page" for the resource that contains important contextual information including the direct resolvable link to the resource, if applicable. | Mandatory |
Resource URL type | The designation of identifier scheme used for the resource URL. It represents the type of the URL of the resource, that is the used scheme (e.g., Web Address URL, DOI, ARK, etc.). | Optional |
EOSC related Resource | The name(s) of (all) the EOSC Catalogue/Marketplace registered Resource(s) for which this training resource is referring to (Refer to the EOSC Resource ID when applicable). | Optional |
2. Detailed & access Information | ||
Description | A brief synopsis about or description of the training resource. | Recommended |
Keywords | The keyword(s) or tag(s) used to describe the resource. | Recommended |
License | A license document that applies to this content, typically indicated by URL. | Mandatory |
Access Rights | The access status of a resource (open, restricted, paid). | Mandatory |
Version Date(s) | The version date for the most recently published or broadcast resource. | Mandatory |
3. Learning Information | ||
Target Group (Audience) | The principal users(s) for which the training resource was designed | Mandatory |
Learning Resource Type | The predominant type or kind that characterises the training resource. | Recommended |
Learning Outcome(s) | The descriptions of what knowledge, skills or abilities students should acquire on completion of the resource. | Mandatory |
Expertise Level | Target skill level in the topic being taught. | Mandatory |
Content resource type | The predominant content type of the training resource (video, game, diagram, slides, etc.). | Recommended |
Qualification | Identification of certification, accreditation or badge obtained with course or learning resource. | Recommended |
Duration | Approximate or typical time it takes to work with or through the training resource for the typical intended target audience. | Recommended |
4. Geographical and Language Availability Information | ||
Language | The language in which the resource was originally published or made available. | Mandatory |
Geographical Availability | Locations where the Resource is offered. | Mandatory |
5. Classification Information | ||
Scientific Domain | The branch of science, scientific discipline that is related to the Resource. | Mandatory |
Scientific Subdomain | The subbranch of science, scientific subdiscipline that is related to the Resource. | Mandatory |
Category | A EOSC named group of Resources that offer access to the same type of Resources. | Recommended |
Subcategory | A EOSC named group of Resources that offer access to the same type of Resources, within the defined Resource category. | Recommended |
6. Contact Information | ||
First Name | First Name of the Resource's main contact person/Resource manager. | Mandatory |
Last Name | Last Name of the Resource's main contact person/Resource manager. | Mandatory |
Email of the Resource's main contact person/Resource manager. | Mandatory | |
Phone | Telephone of the Resource's main contact person/Resource manager. | Optional |
Position | Position of the Resource's main contact person/Resource manager. | Optional |
Organisation | The organisation to which the Resource's main contact person/Resource manager is affiliated. | Optional |
Once the form is completed (1) and passes all automatic checks (2), it can be submitted (3).
Figure 4: Completion of the Training Resource registration
When the form is submitted, you will be asked if additional Resources will be onboarded. If yes, repeat the steps 3 and 4, otherwise the process is concluded.
Additional information:
Automated mechanisms are used to the fullest extent possible to ensure that all required information is included and that the information is of the correct type, size, etc.
In case any difficulties arise during the application, you may communicate issues (by email to onboarding@eosc-portal.eu) and depending on the issue, the (EOSC Portal Onboarding Team) EPOT will support them.
b) Onboarding procedure via the Portal API
Follow this procedure to onboard training resources using the EOSC Portal API. In this scenario, you will use command line or other HTTP request generation tools to interact with the EOSC Portal programmatically.
You may apply for the onboarding of Resources by using the Portal Open API.
In brief, the Provider needs to use the AAI of the Portal to retrieve a new API token. Then, the Provider prepares the Resource description, according to the EOSC Training Resource Profile by calling the API’s POST/Resource/validate method.
Upon successful validation, the Provider calls the POST/Resource method to add the new Resources in the catalogue. Upon success, the Provider receives a new set of Resource IDs and the new Resources are onboarded in the Portal.
A detailed description of the Portal Open API is available at https://providers.eosc-portal.eu/openapi.
Additional support resource
EOSC course on how to onboard services and resources to the EOSC Marketplace via the EOSC Portal open API: https://openplato.eu/course/view.php?id=61
In case any difficulties arise during the employment of the API, you may communicate issues to the EPOT by email to onboarding@eosc-portal.eu, who will support them.
Revision and publication of the new onboarded Resources
The first newly onboarded Resource by each provider is reviewed by the onboarding team.
Subsequent resources are automatically published.
The onboarding team examines the quality of the metadata, specifically if they follow the general recommendations and guidance of the Resource Profile, spelling, accuracy, composition and URLs.
If the Resource description does not comply with the inclusion criteria (presented above) and the rules and criteria based on the current Rules of Participation(RoP) and the typology of the Resource Profile, the PR will be asked to take an action (e.g. amend the description and resubmit, etc.).
To facilitate the amendment, the EPOT provides recommendations, taking into account potential Provider's nuances, and reviews the Provider’s website, their catalogue and provided URLs, and proposes alternatives for the description of the Resource’s metadata and provides best practice examples from other Providers.
If the Provider fails to update the Resource accordingly, the Resource may be rejected. In this case, the Provider is sent a notification of the definitive Resource Onboarding rejection and possibly a Provider suspension.
Otherwise, you will be notified of the approval and the Provider, as well as the Resource, are published on the Portal. The EPOT may also perform small corrections on the Resource descriptions and ask for the consent of the Provider before publishing.