Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Populating RVA portal metadata fields

CSS Stylesheet
h1:not(#title-text)::before, h2::before, h3::before {
  display: block;
  content: " ";
  margin-top: -150px;
  height: 150px;
  visibility: hidden;
  pointer-events: none;
}

Some of the metadata that you capture about your vocabulary in PoolParty can be pulled from PoolParty into the  Research Vocabularies Australia portal . Here we provide guidance for capturing rich descriptions of your vocabulary for use in the RVA portal. 

The PoolParty tool allows for the creation of multiple vocabulary ‘projects’ to be created. When ANDS ARDC creates your vocabulary management space in PoolParty, we will set up a project workspace in which you may create or manage your vocabulary as a ‘concept scheme.’

 

Vocabulary metadata


Advanced Tables - Table Plus
highlightColorwhite
heading0
multiplefalse
width100%
enableHeadingAttributesfalse
columnAttributesstyle="border:0;",style="border:0;",style="border:0;"
enableSortingfalse
enableHighlightingfalse


Versions metadata

Related metadata

 



Vocabulary metadata

 

A title is a human-readable identifying label for a vocabulary. Titles are displayed in RVA and are searchable. A length limit of 80 characters (including spaces) is recommended for compatibility with discovery services, which will often truncate names or collection titles longer than this.

 

 

An acronym is an abbreviation formed from the initial components in the title of the vocabulary. 

For example:

Image Modified

 



Anchor

 

Vocabulary Description
Vocabulary Description

Good quality vocabulary descriptions will increase the chances of a vocabulary being discoverable through RVA and other search engines, as well as helping researchers decide if the vocabulary is likely to be useful for them. The following principles are recommended:

  • Write the description for a reader who has general familiarity with a research area but is not a specialist—this will make vocabulary more accessible for cross-disciplinary use.
  • Don't use specialist acronyms or obscure jargon.
  • Don't assume a reader has specialist knowledge.
  • Include important keywords within the text—this makes them accessible for search engines. Inclusion of a paragraph beginning with Keywords: and followed by a list of keywords is acceptable. However, best practice would be to include the keywords as subjects.

 

Anchor
Vocabulary Licence
Vocabulary Licence


Open Links in New Window
The Licence field allows for capture of information about the text of a legal document giving official permission to do something with a vocabulary.  The types of licences are sourced from th licence types used in Research Data Australia. More information about licences in RDA is available here. Research Vocabularies Australia will use Licence information to provide a faceted search option based on licences.
 



Anchor

 

Vocabulary Creation Date
Vocabulary Creation Date

The date of creation of the original version of the vocabulary. Please provide the Creation Date in one of the following formatformats:

DDYYYY-MM-DD,  YYYY

For example:

Image Removed

 

-MM,  YYYY


Anchor
Revision Cycle
Revision Cycle

Revision Cycle refers to information about a regular revision cycle under which the vocabulary develops. This may be provided in definite frequency (i.e. Biannually, Yearly, Monthly, etc.).

 

Anchor

 

Note
Note

Notes provide additional information about the vocabulary being described.

 

Anchor

 

Owner
Owner

(needs info about how to select & that you have to set the Owner field to the right org role when you create the vocab & if you leave it blank, the vocab is "private")

 

Owner refers to the individual or organisation that owns the particular record in the RVA portal. Note: Once set, the owner field is read-only and cannot be changed via the interface.

Image Added


Anchor
Top Concepts
Top Concepts

You may provide top concepts that appear in the vocabulary. You may provide more than one top concept for your vocabulary.

For example:

Image RemovedImage Added


 

Anchor
Languages
Languages

A natural language in which the vocabulary is available. You may provide more than one language for your vocabulary; if you do so, the first language in the list is treated as the primary language. The primary language determines the selection of labels, definitions, etc. shown in the browse visualisation.You may enter languages not already shown in the list, by entering a value drawn from BCP 47. For more information, see Vocabulary language metadata.

For example: 

[UI needs to be stable before example can be provided]

Image Added 


 

Anchor
Subjects
Subjects

A subject is a term, keyword, classification code or phrase representing the primary topic or topics covered by a vocabulary. You may provide natural language keywords by selecting a Subject Source of "local", Australian and New Zealand Standard Research Classification Field of Research  (ANZSRC-FOR) subjects by selecting a Subject Source of "ANZSRC-FOR" or subjects from a vocabulary of your choice by providing the name of the vocabulary in the "Subject Source" field.

For example:

Image RemovedImage Added 

ANDS ARDC requires the application of at least one ANZSRC-FOR code to each vocabulary published via Research Vocabularies Australia. The ANZSRC-FOR codes can be found here .

 


Versions metadata

 

Anchor

 

Status
Status

Information about the publication status of the vocabulary version. Choose one of the following options:

  • Current: This is the current version.
  • Superseded: This version has been replaced or supplanted by an updated version.



 

Anchor
Version Title
Version Title

A title is a human-readable identifying label for a vocabulary. A length limit of 80 characters (including spaces) is recommended for compatibility with discovery services, which will often truncate titles longer than this. 


Anchor

 

Release Date
Release Date

The date of release of the version of the vocabulary. Please provide the Release Date in the following format:

DDYYYY-MM-YYYYDD 


Anchor

 

Notes
Notes

Information about changes made from the previous version of the vocabulary. 


Anchor
Access Points
Access Points

 

A digital access point for human or machine consumers of a vocabulary version.

Access Point Type

The : the type of access point.

Access Point Format

The format in which the access point is available for download.

[UI needs to be stable before example can be provided]

Related metadata

 

Image Added

 


Anchor
SKOS Concept Schemes and Collections
SKOS Concept Schemes and Collections

These settings determine whether SKOS concept schemes and collections defined in the vocabulary data are displayed as nodes in the browse visualisation.

 


Anchor
Hyperlinked URLs
Hyperlinked URLs

Users of the browse visualisation can hover over a resource node to view a tooltip that contains details of the resource, including the resource's IRI. This setting determines whether the resource IRIs shown in tooltips are displayed as clickable, hyperlinked URLs.

You should only enable this setting if every resource IRI in the data represents a URL that resolves, e.g., to a web page describing the resource. No link checking is performed; if this setting is enabled, all IRIs will be displayed as hyperlinks whether they resolve or not.

Note: if an IRI contains any character that is not valid according to the syntax rules for URLs, the displayed link text will be the IRI, but the link will point to the URL obtained by applying the normalisation process described in RFC 3987, Section 3.1.


Anchor
Notation
Notation

Information about the SKOS notation values for concepts in the vocabulary data.

First, indicate if the vocabulary data contains SKOS notation values, and, if so, what their format is. Choose from one of these formats:

  • Numeric, multi-level hierarchical values, e.g., 2.4.1, 2.20. When sorting by notation, each component of the value is treated as an integer value. So, for example, 2.4 comes before 2.20.
  • Numeric, either integer or floating-point numbers, e.g., 2, 2.4. When sorting by notation, each value is treated as a real number. So, for example, 2.20 comes before 2.4.
  • Alphanumeric, e.g., A0932, 0634, fish. When sorting by notation, the values are sorted "lexicographically" as Unicode strings. For example, 0634 comes before A0932, which comes before fish.

Then, use the dropdown to indicate whether or not the browse visualisation on the vocabulary's view page should default to showing the vocabulary data sorted by notation values. (The vocabulary's view page will offer a dropdown to switch between sorting by preferred label and notation.)

The vocabulary's view page will offer a switch to display or hide notation values within node labels. You can set the default value of the view page's switch by setting the "Display notations on page load" switch.


Anchor
Harvest from PoolParty
Harvest from PoolParty

If this setting is enabled, vocabulary data will be harvested from the linked PoolParty project.

(This setting is only available for vocabularies that were linked to a PoolParty project at the time of creation.)

Note: To prevent the vocabulary data being overwritten by changes in the PoolParty project each time the vocabulary is re-published, the harvesting from PoolParty is only performed the first time this setting is processed. If you need to re-harvest the vocabulary data from PoolParty, leave this setting enabled, and enable the “Reapply settings on publish“ setting. (The “Reapply settings on publish“ setting is reset after re-publication.)

To provide access to the harvested vocabulary data, each harvest is stored in the Vocabulary Repository. If this setting is enabled, the “Import version into the ARDC Vocabulary Repository” setting will also be enabled, if it has not already been. When making changes to settings for a version that has already been published, if you reset this setting to “No”, the other setting will also be set to "No".


Anchor
Import version
Import version

If this setting is enabled, vocabulary data will be imported into the Vocabulary Repository. The vocabulary's view page will offer download links in a variety of RDF formats, and access to the vocabulary through a SPARQL 1.1 Query endpoint .

This setting is only available if the version contains RDF data, either by direct file upload, or by harvest from PoolParty.

Changing this setting to “No” for a version with previously-imported data will remove the vocabulary data from the Repository.

Note: Vocabulary data must be present in the Repository for it to be made available via the Linked Data API. If you change this setting to “No”, the “Make version available via the ARDC Linked Data API” setting will also be set to "No", if it was enabled.


Anchor
Make version available LDA
Make version available LDA

If this setting is enabled, the vocabulary data will be made available via the Linked Data API, also known as SISSVoc.

The Linked Data API has been configured especially for SKOS vocabularies, and provides web pages for human-readable views, and machine-readable resources for client applications, in RDF, JSON, and XML formats.

This setting works for all vocabulary data encoded as RDF, but works best for vocabularies encoded using the SKOS classes.

Changing this setting to “No” for a version that was previously published with the setting "Yes" will remove the linked data endpoints. However, it will not also remove the version from the Vocabulary Repository.

Note: Vocabulary data must be imported into the Vocabulary Repository before it can be made available via the Linked Data API. When enabling this setting, the “Import version into the ARDC Vocabulary Repository” setting will be set to "Yes", if it is not already.


Anchor
Reapply settings
Reapply settings

If you enable this setting and publish the vocabulary, this version's data will be reprocessed. Unlike the other settings on this dialog, this setting resets automatically to "No" when you publish the vocabulary.

This setting is primarily used as a way to request a re-harvest of vocabulary data from PoolParty, and to apply updates made by system administrators.

Note: It is not necessary to enable this setting when changing a version's metadata or settings. Changes will automatically be identified, and the necessary re-processing will be applied at publication time. 

Anchor
Related Metadata
Related Metadata

Related metadata


You may provide information about entities related to your vocabulary, including parties, services and other vocabularies.
  • PartyAn individual or organisation related to the vocabulary. Note Note: At least one party of type "Publisher" is required.
  • Service A database or collection of resources which may use or reference the vocabulary.
  • Internal Vocabulary A vocabulary which is published within RVA that is related to the vocabulary. Note: You will only be able to describe the relationships to an internal vocabulary. You will not be able to edit the metadata as this is taken directly from the internal vocabulary's metadata record.
  • External Vocabulary: A vocabulary not published within RVA that is related to the vocabulary. 

 

Each related entity is "owned" by a particular owner. You may only alter related entities that you own. However, you may copy an existing related entity owned by a different owner, in which case, you then own the copy, and you can make changes.

Related entities are first class objects and may be shared across multiple vocabularies; changing the details of a related entity within one vocabulary affects the view page of all vocabularies that are related to it.

Once you have chosen a related entity type, RVA will automatically allow you to search/browse for and select any entity that has previously been captured via a type-ahead toolpublished in RVA:

 

Image Removed

Image Added 

If you do not own the selected related entity you will be presented with a locked related entity metadata form. You are still able to define the relationships to the entity but you will not be able to edit the entity's metadata. If you would like to change the metadata you can choose to make a copy of the entity's record by clicking the padlock icon.

Image Added 

If your related entity has not previously been captured in RVA, you may add the relevant metadata at this time.


 

Anchor
Related Title
Related Title

A title is a human-readable identifying label for a related party, service or vocabulary.

In the case of a related party, please provide a given name and a family name and relevant titles or suffixes:

...or provide an official organisational title:


In the case of a related service, please provide an official name:

In the case of a related vocabulary, please  provide an official title:

 



Anchor

 

Email
Email

The email address of the related party, service or vocabulary. For example:


 

Anchor

 

Phone
Phone

The phone number of the related party, service or vocabulary.

No format is specified. Vocabulary providers may follow AS 4590:2006 Interchange of client information or use custom formats for telephone numbers. Spaces, hyphens, parentheses or the form +61 for Australian country code are permitted.

The ANDS ARDC Research Vocabularies Australia portal is available worldwide. Accordingly, inclusion of the international dialling code (61) with all telephone and fax numbers is recommended to support international collaboration.

Formatting examples (not a complete list of possibilities):

Telephone or fax number with country code
61 453276731
+61 4 5327 6731

Telephone or fax number with area code
(04) 5327 6731
04 5327 6731
0453276731

Mobile telephone number
0416 345 678
0416345678 


Anchor

 

Relation

 

Relation

Related type of "Party"

  • Publisher

    • An individual or organisation responsible for making the vocabulary available.

  • Author

    • An individual or organisation responsible for developing the vocabulary.

  • Contributor

    • An individual or organisation responsible for making contributions to the vocabulary.

  • Point of contact

    • An individual or organisation responsible for coordinating communication concerning the vocabulary.

  • Implementor

    • An individual or organisation that has made use of the vocabulary.

  • Consumer

    • An individual or organisation for whom the vocabulary is intended or is useful.

Related type of "Service"

Related type of "Vocabulary"

 

Anchor

 

Identifiers

 

Identifiers

A unique ID for the related party, service or vocabulary. An identifier is a sequence of characters or words that uniquely identify an object within a particular context or the domain of a specified authority. It may be globally unique if the specified authority has a global domain. Identifiers that are useful for discovery, linking of metadata records,  reuse, or to support the functions of the metadata provider, can be recorded, even if they are not unique or persistent.

 If there is a public identifier for an entity, ANDS ARDC strongly recommends providing that identifier as a party identifier. This may be a local username or staff ID, ORCID, NLA Party Identifier (Persistent identifier), Scopus Author Identifier, or ThomsonReuters ResearcherID. Please include all relevant identifiers, as this helps in the disambiguation of entities with similar names.

When entering identifiers, you must specify the type of the identifier by making a selection from a dropdown. The value field gives advice about the expected format for the selected type, and any value entered is validated accordingly.

How do I find identifiers?

For example:

Image RemovedImage Added

 

Anchor

 

Websites
Websites

The URL of the entity's web page. For example: 

Image RemovedImage Added 

 

Page Turner
button-linkstrue