[DRAFT]

This is a draft version of the document, remind that information could change frequently.

Preface

This page contains the information model for the RoR.

Registry

The main container of all the elements is the Registry. Each registry makes reference to some specific organization (like a member state or an European organization). The registry is an information system on which a register is mantained (eg. the German theme register is registered in the federation under the  "German INSPIRE registry" registry).

Table name: registry

Field name Field type Required Foreign key Description
uuid string (tick)    
label string (tick)  

The name of the organization

description string     A short description of the organization
contactpoint string (tick)   The email of the contact point for this organization
manager string (tick)   Automatically filled with the requesting user ECAS id
uri string     The link to a web page related to the organization
status string (tick) status [uuid] The status of the registry
creationdate date (tick)   The creation date
lasteditdate date     The date of last modification

Example

uuid label description contactpoint manager uri status crerationdate lasteditdate

d41d8cd98f00b204e9800998ecf8427e

European Commission Description here some-mail@inspire.ec.europa.eu francdb http://inspire.ec.europa.eu c81e728d9d4c2f636f067f89cc14862c 2015-08-07  

b53b3a3d6ab90ce0268229151c9bde11

Italian office for SDI Description here some-mail@example.it francdb http://sdi.example.it c81e728d9d4c2f636f067f89cc14862c 2015-08-07  

 

Register

The register is an element in the federation. For example it could be a Register or a Hierarchical Register

Table name: register

Field name Field type Required Foreign key Description
uuid string (tick)    
uri string (tick)  

The name of the organization

registry string (tick) registry [uuid] The registry containing this register
searchable boolean     Specify if this register is searchable in the federation
search-index-update-file-url URL     The url of the file (in the agreed format) for the search index automatic update
search-index-update-method string     push | pull - Specify if the remote register is going to send the file to the RoR or if the RoR has to read the file from the specified url (search-index-update-file-url)
extension boolean     Specify if this register can extend other registers (a register could be inserted in the federation also to be part only of the federated search interface)
extension-update-file-url URL     The url of the file (in the agreed format) for the extension information automatic update
extension-update-method string     push | pull - Specify if the remote register is going to send the file to the RoR or if the RoR has to read the file from the specified url (extension-update-file-url)
creationdate date (tick)   The creation date
lasteditdate date     The date of last modification

Example

uuid URI registry searchable search-index-update-file-url search-index-update-method extension extension-update-file-url extension-update-method crerationdate lasteditdate

e4da3b7fbbce2345d7772b0674a318d5

http://inspire.ec.europa.eu/theme d41d8cd98f00b204e9800998ecf8427e true http://inspire.ec.europa.eu/search-updater.json pull false     2015-08-07  

15de21c670ae7c3f6f3f1f37029303c9

http://example.it/theme b53b3a3d6ab90ce0268229151c9bde11 true http://example.it/search-updater.json pull true   push 2015-08-07  

 

Relation

The relation table contains the relations of different types between registers.

Table name: relation

Field name Field type Required Foreign key Description
uuid string (tick)    
sourceregister string (tick) register [uuid]

The URI of the main register

relatedregister string (tick) register [uuid] The URI of the related register
relationtype string (tick)   The type of the relation
status string (tick) status [uuid] The status of the relation
creationdate date (tick)   The creation date
lasteditdate date     The date of last modification

Example

uuid sourceregister relatedregister relationtype status crerationdate lasteditdate
6a83a2a468c4c36164924a51149374e2 15de21c670ae7c3f6f3f1f37029303c9 e4da3b7fbbce2345d7772b0674a318d5 subset c81e728d9d4c2f636f067f89cc14862c 2015-08-07  

 

Status

The status of the elements in the database

Table name: status

Field name Field type Required Foreign key Description
uuid string (tick)    
label string (tick)   The label of the status
description string (tick)  

The description of the status

creationdate date (tick)   The creation date
lasteditdate date     The date of last modification

Example

uuid lable description crerationdate lasteditdate

c81e728d9d4c2f636f067f89cc14862c

Valid Description here

2015-08-07

 
eccbc87e4b5ce2fe28308fd9f2a7baf3 Proposed Description here 2015-08-07