Discoverability and Harvesting#

Colectica Portal supports the Sitemap protocol and OAI-PMH.

Sitemap#

Sitemaps are a way to inform search engines which pages on a web site are available for indexing. Colectica Portal may contain a large number of pages: one for every study, question, and variable in your repository. Providing a sitemap can be a useful way to increase the discoverability of your information.

The sitemap index is available at https://{example.org}/sitemap_index.xml. It lists a sitemap for the portal’s static pages and custom pages, and one or more compressed sitemaps for each of the following item types: series, studies, data files, questionnaires, variables, questions, question grids, and question blocks. Each sitemap contains at most 45,000 URLs. The sitemaps are regenerated when items are registered with the repository.

OAI-PMH#

The Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH) allows data providers to expose structured metadata that can be gathered by service providers.

Colectica Portal provides an OAI-PMH endpoint at https://{example.org}/oai/request. Visiting https://{example.org}/oai performs an Identify request.

Verbs: Identify, ListMetadataFormats, ListSets, ListIdentifiers, ListRecords, and GetRecord.
Metadata formats: oai_dc (Dublin Core) and oai_ddi33 (DDI Lifecycle 3.3).
Sets: Each item type configured by the administrator is exposed as a set. The set specification is the item type identifier listed in Item Type Identifiers.
Identifiers: Records are identified by DDI URNs, such as urn:ddi:example.org:e9d35174-dea3-4629-afef-770220b4cbc4:1.

Lists return 100 records at a time, with a resumption token for the next page.

Administrators can disable the endpoint, require authentication, choose whether only the latest version of each item is listed, include deprecated items, and choose the item types exposed as sets. See the OAI-PMH section of Site Information.