Proposed to be integrated in the EOSC Portal Profiles.
Data Model
Basic Information | ||||||||
|---|---|---|---|---|---|---|---|---|
| Code | Attribute Name | Human Readable Atribute Name | Description | Type | Multiplicity | Attribute Grouping | Required | Public |
| EIG.BAI.01 | EOSC Interoperability ID | EOSC Interoperability ID | (auto-assigned) | Integer Auto-assigned by database | 1 | N/A | Mandatory | No |
| EIG.BAI.02 | Identifier | Identifier | The 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” | 1 | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.03 | identifierType | Identifier Type | The type of Identifier. | Controlled List DOI URI | 1 | N/A | Mandatory | Yes: PP & MP |
| Code | Attribute Name | Human Readable Atribute Name | Description | Type | Multiplicity | Attribute Grouping | Required | Public |
| EIG.BAI.04 | ProviderID | Provider | 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. |
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) | 1Provider Information | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.27 | CatalogueID | Catalogue | 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) | 1 | N/A | Optional | Yes: PP & MP |
| EIG.BAI.05 | creatorName | Creator 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. | Multiple | Creators | Mandatory (at least one) | Yes: PP & MP |
| EIG.BAI.06 | nameType | Name Type | The type of name | Controlled List: Organizational | 1 | Mandatory | Yes: PP & MP | |
| EIG.BAI.07 | givenName | Given Name | The personal or first name of the creator Example: Antoine; Mae | String (100) | 1 | Optional | Yes: PP only | |
| EIG.BAI.08 | familyName | Family Name | The surname or last name of the creator Example: Charpy; Jemison | String (100) | 1 | Optional | Yes: PP only | |
| EIG.BAI.09 | nameIdentifier | Name 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”. | 1 | Optional | Yes: PP & MP | |
| EIG.BAI.10 | affiliation | Affiliation | 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) | 1 | Optional | Yes: PP & MP | |
| EIG.BAI.11 | affiliationIdentifier | Affiliation 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) | 1 | Optional | Yes: PP & MP | |
Detailed information | ||||||||
| Code | Attribute Name | Human Readable Atribute Name | Description | Type | Multiplicity | Attribute Grouping | Required | Public |
| EIG.BAI.12 | Title | Title | A 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) | 1 | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.13 | PublicationYear | Year 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 | 1 | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.14 | ResourceType | Resource Type Description | A description of the resource, for example API, metadata schema, specification, policy, framework, human-readable guideline, human readable guideline, configuration template | String (1000) | Multiple | Resource Types Info | Mandatory | Yes: PP & MP |
| EIG.BAI.15 | resourceTypeGeneral | Resource Type Category | The general type of a resource | Controlled List: Guideline | Multiple* (*additional values will be introduced in future releases) | Mandatory | Yes: PP & MP | |
| EIG.BAI.16 | Created | Created | Time/date the record was created. Auto-assigned by database | ISO8601 DateTime (2022-07-27) | 1 | N/A | Mandatory | Yes: PP only |
| EIG.BAI.17 | Updated | Updated | Time/date the record was last saved, with or without modifications. Auto-assigned by database | ISO8601 DateTime (2022-07-27) | 1 | N/A | Mandatory | Yes: PP only |
| EIG.BAI.18 | RelatedStandard | Related 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. | URL | Multiple | Related Standards | Optional | Yes: PP & MP |
| EIG.BAI.28 | RelatedStandardIdentifier | Related Standard Identifier | The name of the related standard. | String (250) | Multiple | Optional | Yes: PP & MP | |
| EIG.BAI.19 | Rights | Rights | 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. | String (500) | Multiple | Rights | Mandatory | Yes: PP & MP |
| EIG.BAI.20 | rightsURI | Rights URI | The URI of the license | URL | Multiple | Mandatory | Yes: PP & MP | |
| EIG.BAI.21 | rightsIdentifier | Rights 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) | Multiple | Mandatory | Yes: PP & MP | |
| EIG.BAI.22 | Description | Description | Provide 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) | 1 | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.23 | Status | Status | Status of the resource. | Controlled List: Candidate | 1 | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.24 | Domain | Domain | Intended Audience for the Guideline | Controlled List: EOSC Profile Domains | 1 | N/A | Optional | Yes: PP & MP |
| EIG.BAI.25 | EOSC Guideline Type | EOSC Guideline Type | The type of Interoperability Guideline according to the definitions at https://eosc-portal.eu/eosc-interoperability-framework | Controlled List: EOSC-Core Interoperability Guideline | 1 | N/A | Mandatory | Yes: PP & MP |
| EIG.BAI.26 | EOSC Integration Options | EOSC Integration Options | A short summary of any options to integrate this guideline (if applicable). | String (100) | Multiple | N/A | Optional | Yes: PP & MP |
Controlled Values
Status | Description | Next state/s |
|---|---|---|
| Candidate | Identified and registered, but no proposal has been submitted. | Proposed, on hold, abandoned, |
| Proposed | Proposed but consultation has not commenced | Consultation, on hold, abandoned, |
| Consultation | This would operated as 'Pending Approval' status (like 'patent pending') | Accepted, rejected, on hold, |
| On Hold | To be used in the event that further information is required before consultation can conclude | Consultation, abandoned, withdrawn, |
| Update Pending | To be used either:
|
|
| Accepted | To 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 |
| Withdrawn | An artifact that has been withdrawn from the proposal process by its Guardian or Proposer | n/a |
| Rejected | An artifact that was rejected at the proposal stage by the EOSC Interoperability Advisory Board | n/a |
| Change log | |
|---|---|
| 20230323 |
|
| 20230324 |
|
| 20230327 | Added examples to EIG.BAI.09 nameIdentifier |
| 20230328 |
|
| 20230424 |
|
| 20231024 | EIG.BAI.05/creatorName - now Mandatory to fix unintended behaviour where a record could be loaded with no CreatorName but mandatory nameType. |
1 Comment
PAOLO MANGHI
Suggestions:
"EOSC related standard" field: