Welcome to the EOSC Future wiki!

IMPORTANT: Please be aware that this Wiki space is no longer actively maintained. The information in it applies to the discontinued EOSC Marketplace and Provider Portal, which have been replaced by the EOSC EU Node.
Information related to the EOSC EU Node is available via the official page <here>

Proposed to be integrated in the EOSC Portal Profiles.

Data Model

Basic Information

CodeAttribute NameHuman Readable Atribute NameDescriptionTypeMultiplicityAttribute GroupingRequiredPublic
EIG.BAI.01EOSC Interoperability IDEOSC Interoperability ID(auto-assigned)

Integer

Auto-assigned by database

1N/AMandatoryNo
EIG.BAI.02IdentifierIdentifierThe Identifier is a unique string that identifies a resource. For software, determine whether the identifier is for a specific version of a piece of software, (per the Force11 Software Citation Principles), or for all versions.

The record's primary key for locating it in the EOSC-IF database.

String

DOI (Digital Object Identifier) registered by a DataCite member. Format should be “10.1234/foo”

1N/AMandatory

Yes:

PP & MP

EIG.BAI.03identifierTypeIdentifier TypeThe type of Identifier.

Controlled List

DOI

URI

1N/AMandatoryYes:

PP & MP


CodeAttribute NameHuman Readable Atribute NameDescriptionTypeMultiplicityAttribute GroupingRequiredPublic
EIG.BAI.04ProviderIDProvider

The Provider of the Guideline.

Individual Creators may be added to the record if required to cite contributors and/or authors of the the guideline. 



Controlled List: Providers

Auto-assigned by database

(Provider is logged in when onboarding a new Guideline; ID defaults to ProviderID of Provider that the user has logged into)

1

Provider Information

N/AMandatoryYes:

PP & MP

EIG.BAI.27CatalogueIDCatalogue

The ID of the Catalogue this Resource is originally registered at.

(Catalogue Provider is logged in when onboarding a new Guideline)

Auto-assigned by database

(catalogueID)

1N/AOptionalYes:

PP & MP

EIG.BAI.05creatorNameCreator Name

The full name of the creator, if necessary to include individual contributors or creators.

May be a corporate/institutional or personal name. 



String (100)

Examples: Charpy, Antoine; Jemison, Mae; Foo Data Center Note that the personal name, format should be: family, given. Names in non-roman scripts may be transliterated according to the ALA-LC tables.

MultipleCreatorsMandatory (at least one)Yes:

PP & MP

EIG.BAI.06nameTypeName TypeThe type of name

Controlled List:

Organizational
Personal

1MandatoryYes:

PP & MP

EIG.BAI.07givenNameGiven Name

The personal or first name of the creator

Example: Antoine; Mae

String (100)1OptionalYes:

PP only

EIG.BAI.08familyNameFamily Name

The surname or last name of the creator

Example: Charpy; Jemison

String (100)1OptionalYes:

PP only

EIG.BAI.09nameIdentifierName Identifier

Uniquely identifies an individual or legal entity, according to various schemes.

The format is dependent upon scheme utilised.

String (100)

Examples:   0000-000n-nnnn-nnnn (ORCID), or ISNI (16 digits, the last character being a check character. The check character may be either a decimal digit or the character “X”.

1OptionalYes:

PP & MP

EIG.BAI.10affiliationAffiliation

The organizational or institutional affiliation of the creator

The creator’s nameType may be Organizational or Personal. In the case of an organizational creator, e.g., a research group, this will often be the name of the institution to which that organization belongs.

String (250)1OptionalYes:

PP & MP

EIG.BAI.11affiliationIdentifierAffiliation Identifier

Uniquely identifies the organizational affiliation of the creator.

The format is dependent upon scheme. Examples : https://ror.org/04aj4c181 grid.461819.3

String (250)1OptionalYes:

PP & MP

Detailed information

CodeAttribute NameHuman Readable Atribute NameDescriptionTypeMultiplicityAttribute GroupingRequiredPublic
EIG.BAI.12TitleTitleA name or title by which a resource is known. May be the title of a dataset or the name of a piece of software.String (250)1N/AMandatoryYes:

PP & MP

EIG.BAI.13PublicationYearYear of Publication

The year when the guideline was or will be made publicly available. 

If an embargo period has been in effect, use the date when the embargo period ends. In the case of datasets, "publish" is understood to mean making the data available on a specific date to the community of researchers. If there is no standard publication year value, use the date that would be preferred from a citation perspective.


Integer

YYYY

1N/AMandatoryYes:

PP & MP

EIG.BAI.14ResourceTypeResource Type DescriptionA description of the resource, for example API, metadata schema, specification, policy, framework, human-readable guideline, human readable guideline, configuration templateString (1000)Multiple

Resource Types Info

MandatoryYes:

PP & MP

EIG.BAI.15resourceTypeGeneralResource Type CategoryThe general type of a resource

Controlled List:

Guideline

Multiple*

(*additional values will be introduced in future releases)

MandatoryYes:

PP & MP

EIG.BAI.16CreatedCreated

Time/date the record was created.

Auto-assigned by database

ISO8601 DateTime (2022-07-27)1N/AMandatoryYes: PP only
EIG.BAI.17UpdatedUpdated

Time/date the record was last saved, with or without modifications.

Auto-assigned by database

ISO8601 DateTime (2022-07-27)1N/AMandatoryYes: PP only
EIG.BAI.18RelatedStandardRelated Standard URI

Standards related to the guideline

This should point out to related standards only when it is a prerequisitite/depenendency, and likely to influence a Provider's design towards interoperability based on the guideline.

URLMultipleRelated StandardsOptionalYes:

PP & MP

EIG.BAI.28RelatedStandardIdentifierRelated Standard Identifier

The name of the related standard.

String (250)MultipleOptionalYes:

PP & MP

EIG.BAI.19RightsRights

Any rights information for this resource.

Provide a rights management statement for the resource or reference a service providing such information. Include embargo information if applicable.
Use the complete title of a license and include version information if applicable.
May be used for software licenses.
Examples:
Creative Commons Attribution 3.0 Germany License Apache License, Version 2.026

String (500)MultipleRightsMandatoryYes:

PP & MP

EIG.BAI.20rightsURIRights URI

The URI of the license

Example: https://creativecommons.org/licenses/by/3.0/de/

URLMultipleMandatoryYes:

PP & MP

EIG.BAI.21rightsIdentifierRights Identifier

A short, standardized version of the license name

Example: CC-BY-3.0 A list of identifiers for commonly-used licenses may be found here: (https://spdx.org/licenses/).

String (250)MultipleMandatoryYes:

PP & MP

EIG.BAI.22DescriptionDescriptionProvide an abstract or summary of the guideline. Description can include additional information that does not fit in any of the other categories. May be used for technical information.String (1000)1N/AMandatoryYes:

PP & MP

EIG.BAI.23StatusStatusStatus of the resource.

Controlled List:

Candidate
Proposed
Consultation
On Hold
Update Pending
Accepted
Operating
Deprecated
Abandoned
Withdrawn
Rejected


1

N/AMandatoryYes:

PP & MP

EIG.BAI.24DomainDomainIntended Audience for the Guideline


Controlled List:

EOSC Profile Domains

1N/AOptionalYes:

PP & MP

EIG.BAI.25EOSC Guideline TypeEOSC Guideline TypeThe type of Interoperability Guideline according to the definitions at https://eosc-portal.eu/eosc-interoperability-framework

Controlled List:

EOSC-Core Interoperability Guideline
EOSC-Exchange Interoperability Guideline (Thematic)
EOSC-Exchange Interoperability Guideline (Horizontal)

1

N/AMandatoryYes:

PP & MP

EIG.BAI.26EOSC Integration OptionsEOSC Integration OptionsA short summary of any options to integrate this guideline (if applicable). String (100)MultipleN/AOptionalYes:

PP & MP


Controlled Values

Status

DescriptionNext state/s
Candidate

Identified and registered, but no proposal has been submitted.

Proposed, on hold, abandoned,
withdrawn, rejected

ProposedProposed but consultation has not commenced

Consultation, on hold, abandoned,
withdrawn, rejected

ConsultationThis would operated as 'Pending Approval' status (like 'patent pending')

Accepted, rejected, on hold,
withdrawn, abandoned

On HoldTo be used in the event that further information is required before consultation can conclude

Consultation, abandoned, withdrawn,
rejected

Update Pending

To be used either:

  1. During the proposal process to indicate that a new version is to be considered before the proposed version is accepted. OR
  2. During the operating phase to indicate that a new version will be published shortly.
  1. Proposed, consultation, on hold, accepted
  2. Deprecated, abandoned, withdrawn, rejected
AcceptedTo identify Artifacts that have been accepted byt the EOSC Interoperability Advisory Board but have not yet been announced as operational.

Operating, deprecated, withdrawn

Operating

To identify Artifacts that have been accepted by the EOSC Interoperability Advisory Board and have been announced as operational.

Deprecated, withdrawn

Deprecated

Artifacts that have been superseded or replaced by new versions but are to be retained in the Registry.

n/a
Abandoned

An artifact that was proposed but its Guardian and/or Proposer is unresponsive to requests from the [role]

n/a
WithdrawnAn artifact that has been withdrawn from the proposal process by its Guardian or Proposern/a
Rejected

An artifact that was rejected at the proposal stage by the EOSC Interoperability Advisory Board

n/a
Change log
20230323
  • EIG.BAI.01 – made public = No
  • Added ProviderID
  • Added CatalogueID
20230324
  • Combined ProviderID into EIG.BAI.01 
  • Changed human-readable CatalogueID to 'Catalogue'.
  • Assigned EIG.BAI.27 to CatalogueID
  • Specified 'Public' in terms of public to Provider Portal (PP) or Marketplace (MP).
20230327Added examples to EIG.BAI.09 nameIdentifier
20230328
  • EIG.BAI.07 - public visibility changed to PP only
  • EIG.BAI.08 - public visibility changed to PP only
20230424
  • Renamed EIG.BAI.18:
    • from "EOSC Related Standard" to "RelatedStandard"
    • from "EOSC Related Standard" to "Related Standard URI"
  • Added EIG.BAI.28:
    • Attribute name = RelatedStandardIdentifier
    • Human readable attribute name = Related Standard Identifier
    • Description = The name of the related standard.
    • Type = String (250)
    • Multiplicity = Multiple
    • Optional
    • Public = Yes:PP & MP
  • Added Attribute Grouping column to ensure that where attributes can be multiple, they are treated as 'key-value relations'.
  • Aligned documentation to change requested 24.03.2023 via Jira and Skype (to add URI to Controlled List for EIG.BAI.03 Identifier Type.
20231024EIG.BAI.05/creatorName - now Mandatory to fix unintended behaviour where a record could be loaded with no CreatorName but mandatory nameType.
  • No labels

1 Comment

  1. PAOLO MANGHI

    Apr 12, 2023

    Suggestions:

    "EOSC related standard" field:

    • could be renamed "Related Standard"
    • should have structure (sub-fields) for "name of the standard" and "URL" (as is, it is not human readable)

Privacy Policy