| | 35 | [[TicketQuery(status=accepted|assigned|new|reopened,component=Centre Registry,order=priority,format=table,col=summary|component|priority|owner|reporter)]] |
| | 36 | |
| | 37 | == The Center Registry before 2.0 == |
| | 38 | |
| | 39 | = Status = |
| | 40 | |
| | 41 | == Current Version == |
| | 42 | |
| | 43 | An alpha version is implemented at the RZG. |
| | 44 | |
| | 45 | read-only access: |
| | 46 | * https://centerregistry-clarin.esc.rzg.mpg.de/centers/ (HTML view of all centers) |
| | 47 | * https://centerregistry-clarin.esc.rzg.mpg.de/restxml/ (XML view of all centers) |
| | 48 | * https://centerregistry-clarin.esc.rzg.mpg.de/restxml/1/ (XML view of 1 specific center) |
| | 49 | |
| | 50 | write access: https://centerregistry-clarin.esc.rzg.mpg.de/CenterRegistryadmin/ |
| | 51 | |
| | 52 | == Log == |
| | 53 | * 2012-04-11: created ticket queue for Center registry and added some HTML improvements |
| | 54 | * 2012-03-14: feedback to RZG developers about XML export improvements |
| | 55 | |
| | 56 | == Open Tickets == |
| | 57 | |
| | 58 | [[TicketQuery(status=accepted|assigned|new|reopened,component=CenterRegistry,order=priority,format=table,col=summary|component|priority|owner|reporter)]] |
| | 59 | |
| | 60 | |
| | 61 | = Technical Specification = |
| | 62 | |
| | 63 | == Introduction == |
| | 64 | The centers form the backbone of the distributed CLARIN infrastructure. So far the administration of the center details has been done manually, noting down the entry points and contact information on a web site. In order to streamline the information gathering and to ensure machine accessibility of this data a center registry needs to be built. In this page we specify the requirements for such a registry, in accordance with the CLARIN-D AP3 guidelines. |
| | 65 | |
| | 66 | == Requirements == |
| | 67 | The center registry is a store for records with information about CLARIN centres. This document describes the data that it could contain (Data store), the web application for users to view and change the data (Web Interface) and the machine-accessible API (Web Service). |
| | 68 | |
| | 69 | == Example files == |
| | 70 | |
| | 71 | The CMDI files containing information about the CLARIN centers can be found in the SVN repository: |
| | 72 | |
| | 73 | http://trac.clarin.eu/browser/CenterRegistry/data/ |
| | 74 | |
| | 75 | === Data store === |
| | 76 | Each record has these fields: |
| | 77 | |
| | 78 | ''' Basic Information''' |
| | 79 | |
| | 80 | * name (string) |
| | 81 | * country (controlled vocabulary: subset of ISO 3166-2) |
| | 82 | * [http://www.clarin.eu/files/wg2-1-center-types-doc-v5.pdf center type] (controlled vocabulary: A, B, C or E) |
| | 83 | * center type status (0 or 1; string; to be used to describe the A/B/C/E center status) |
| | 84 | * core description (string; possible multiple lines containing general information on the center, e.g., the collection focus or policy) |
| | 85 | |
| | 86 | '''Extended Information''' |
| | 87 | |
| | 88 | * Long term archiving policy (string) |
| | 89 | * CLARIN infrastructure services (0 or 1; string; meaning: non-standard offers like OAI harvesting) |
| | 90 | * strict versioning (boolean; meaning: 1 PID always points to 1 version) |
| | 91 | * repository system (string) |
| | 92 | * PID status (string) |
| | 93 | * assessment status (string) |
| | 94 | * website (URI) |
| | 95 | * references (0 or more description+URI): |
| | 96 | * description |
| | 97 | * URI, e.g., to link to an assessment reports |
| | 98 | * metadata (1 or more): |
| | 99 | * OAI access point (URI) |
| | 100 | * Metadata scheme (1 or more; controlled vocabulary: OLAC or CMDI) |
| | 101 | * Web Services Set (0 or 1; string; the OAI-PMH set that contains the webservice metadata records) - if a Web Services set is specified, 1 or more Web Service Types must be defined, otherwise there is no Web Service Type at all |
| | 102 | * Web Service Type (0 or more; controlled vocabulary: SOAP, REST or WebLicht.) |
| | 103 | * AAI: |
| | 104 | * AAI status (string) |
| | 105 | * member of a national identity federation (0 or more; controlled vocabulary: subset of ISO 3166-2) |
| | 106 | * member of the CLARIN Service Provider Federation (boolean) |
| | 107 | * organisational information: |
| | 108 | * organisation details (see http://www.clarin.eu/organisations/3434 for an example) |
| | 109 | * contact information (name, email, phone) of a technical contact person |
| | 110 | * contact information (name, email, phone) of an administrative contact person |
| | 111 | * monitoring: |
| | 112 | * Service Provider test site (URI, link to the [http://clarin.ids-mannheim.de/shib_test.pl shib_test.pl] script) |
| | 113 | * (As the nagios probes will be configured at the monitoring computer center no further fields required) |
| | 114 | |
| | 115 | Empty values shouldn’t be allowed, e.g., if the Web Services Set field is left empty it isn’t instantiated and this is the same as an instance count of zero. It is very probable that new fields will be needed in the future, so the data model should be flexible. Also it should be easy to add new values to controlled vocabularies, e.g., to add a new allowed Web Service Type. |
| | 116 | |
| | 117 | === Web interface === |
| | 118 | * initial view: a table like http://www.clarin.eu/centers with a link to the center view for each center |
| | 119 | * center view: display all fields of a single center |
| | 120 | * center editing screen: a webform to changed the values of a center |
| | 121 | * authorization: SAML-based, initally via the eduPersonPrincipleName attribute as received from [http://idp.mpi.nl/metadata/homeless-clarin-metadata.xml the CLARIN IdP]: |
| | 122 | * everyone should have read access |
| | 123 | * a few administrators ({{{dietuyt@mpi.nl, menwin@mpi.nl, thomas.zastrow@uni-tuebingen.de}}}) have write access |
| | 124 | |
| | 125 | === Web service === |
| | 126 | A REST-webservice returns information from the registry as: |
| | 127 | * JSON |
| | 128 | * CMDI (=XML, for the details of this format see below) |
| | 129 | |
| | 130 | (Inspired by the [http://www.clarin.eu/node/3248 web service for the Component Registry]) |
| | 131 | |
| | 132 | As the public REST-webservice is read-only no authorization should be required. |
| | 133 | |
| | 134 | A CMDI profile has been created: |
| | 135 | * link to CMDI profile: http://catalog.clarin.eu/ds/ComponentRegistry?item=clarin.eu:cr1:p_1320657629667 |
| | 136 | * link to XSD: http://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/profiles/clarin.eu:cr1:p_1320657629667/xsd |
| | 137 | * example instance (.cmdi): http://trac.clarin.eu/attachment/wiki/CenterRegistry/http_www_mpi_nl.cmdi |
| | 138 | |
| | 139 | To start, the following functions should be available: |
| | 140 | |
| | 141 | * return a list of all centers (together with a unique center ID): http://foo.eu/rest/centerregistry/centers |
| | 142 | * optional parameters: /xml (default, ad hoc xml encoding) or /json |
| | 143 | * output: center ID, Basic information fields, if there is at least 1 OAI access point, providing metadata about web services |
| | 144 | * return all information about 1 center: http://foo.eu/rest/registry/centers/{centerid} |
| | 145 | * optional parameters: /cmdi (default) or /json |
| | 146 | * output: all fields in the center record |
| | 147 | |
| | 148 | Documentation about the webservice: |
| | 149 | * as HTML |
| | 150 | * as a WADL file (like eg: http://catalog.clarin.eu/ds/ComponentRegistry/rest/application.wadl) |
| | 151 | |
