RegUpgradeToV10 < IVOA

IVOA Web>IvoaResReg>RegistryImplmentation>RegUpgradeToV10 (2008-01-18, RayPlante) (raw view)

<small>Jumps:  [[http://www.ivoa.net/forum/registry/][reg-dm mail archive]] :: ResourceMetadata :: RegistryInterface :: VOResourceV10 :: RegDMServices :: RegUpgradeSummer2006
<br/> Meetings: InterOpMay2006ResReg :: InterOpSep2006ResReg</small>

---+!! Upgrade to Registry Interface v1.0 (Spring 2007)

This page will provide useful information for registry providers regarding the upgrade schedule, upgrade requirements, links to schemas and tools, etc.

__Contents__
%TOC%
---

---++ News

   $ *2007 Dec 20*: The Registry of Registries is now available for [[http://rofr.ivoa.net:8080/vovalidation/regvalidate.html][validating and registering your registry]].  You can also [[http://rofr.ivoa.net/cgi-bin/rofr/rofrhello.py][view the currently registered registries]].  See the [[#Software_Tools_and_Testers][Software Tools and Testers section]] below for more information.  

---++ Roadmap

Please update this schedule as necessary.  The initial dates have been taken from the roadmap described in InterOpMay2006ResReg and are subject to change pending discussion by the WG.

| *Action* | *When* | *Comments* |
| updated versions schemas | done | see schema section below |
| updated draft of RI spec | done | see attachments at RegistryInterface |
| conversion stylesheet available | done | see below |
| Registry of Registries ready | 06-Apr-2007 | (Ray) |
| complete implementations of RI v1.0 | 30-Apr-2007 | |
| general testing period begins | 01-May-2007 | |
| discuss remaining interoperability issues at IVOA mtg. | 14-May-2007 | |
| new registries "turned on" | 01-Jun-2007 | |
| achieve stability | 15-Jun-2007 | |

We are strongly encouraging registry providers to maintain the old registry interfaces beyond the "change-over" date to support existing applications.  Note, however, that after the switch, the old interfaces may not continue to be updated.  

---++ Meetings and Discussion

   * Registry Provider Telecon, 14 June 2006:  [[%PUBURL%/%WEB%/RegUpgradeSummer2006/upgrade-telecon-notes.txt][Minutes]]
   * Moscow Interop Meeting: InterOpSep2006ResReg

---++ Standard Schemas and WSDLs

---+++ VOResource Schemas and Example Instances (Release Candidate 11 2006-11-07)

The VOResource core schema is documented in the Working Draft, _VOResource: an XML Encoding Schema for Resource Metadata_.  The current version under review is [[http://www.ivoa.net/Documents/latest/VOResource.html][VOResource-20061107]]; the associated Schema files is available at both at http://www.ivoa.net/xml/ and below.  

All of the schemas and examples can be downloaded together: [[%ATTACHURL%/VOResource-v1.0.tar.gz][VOResource-v1.0.tar.gz]],
[[%ATTACHURL%/VOResource-v1.0.zip][VOResource-v1.0.zip]].

Individual examples:
| Schema | Sample instances | 
| [[%ATTACHURL%/VOResource-v1.0.xsd][VOResource-v1.0.xsd]] |   [[%ATTACHURL%/organisation.xml][organisation.xml]] <br>  [[%ATTACHURL%/webform.xml][webform.xml]] <br>  [[%ATTACHURL%/webservice.xml][webservice.xml]] | 
| [[%ATTACHURL%/VODataService-v1.0.xsd][VODataService-v1.0.xsd]] |  [[%ATTACHURL%/collection.xml][collection.xml]] <br> [[%ATTACHURL%/catalog.xml][catalog.xml]] <br> [[%ATTACHURL%/stc.xml][stc.xml]] | 
| [[%ATTACHURL%/ConeSearch-v1.0.xsd][ConeSearch-v1.0.xsd]] |  [[%ATTACHURL%/conesearch.xml][conesearch.xml]] |
| [[%ATTACHURL%/SIA-v1.0.xsd][SIA-v1.0.xsd]] |  [[%ATTACHURL%/sia.xml][sia.xml]] <br> [[%ATTACHURL%/sia2ver.xml][sia2ver.xml]]| 
| [[%ATTACHURL%/VORegistry-v1.0.xsd][VORegistry-v1.0.xsd]] |  [[%ATTACHURL%/registry.xml][registry.xml]] | 
|[[%ATTACHURL%/VOStandard-v0.1.xsd][VOStandard-v0.1.xsd]] |  [[%ATTACHURL%/siastd.xml][siastd.xml]] | 
|[[%ATTACHURL%/SkyNode-v0.2.xsd][OpenSkyNode-v0.2.xsd]] |  skynode.xml | 

Several of the examples use [[http://www.ivoa.net/Documents/latest/STC.html][STC]] which requires [[http://www.ivoa.net/xml/STC/stc-v1.30.xsd][stc-v1.30.xsd]] and [[http://www.ivoa.net/xml/Xlink/xlink.xsd][xlink.xsd]].

*Note*: The samples above were created to be compliant only with the VOResource schema and the above extensions.  These would have a different wrapping or "root" element (namely, the =&lt;ri:Resource&gt;= element) when used as part of a Registry service, the details depending on the type of message; see the [[http://www.ivoa.net/Documents/latest/RegistryInterfaces.html][RI spec]] for specifics.  _(I'll try to update these with Registry-specific versions to avoid confusion --rp)_

*Note*: Prior to 26 June, several of the schemas had versions set to 0.9; they have now been elevated to v1.0.

-- IVOA.RayPlante - 5 April 2007

---+++ Interface WSDLs

A version 1.0 of the RI spec has been submitted to the [[http://www.ivoa.net/Documents/latest/RegistryInterface][IVOA document repository]].  There is a [[RegistryInterface#IVOA_Standard_Specification][small errata]] plus an internal WD waiting in the wings on the RegistryInterface twiki page.  Consult this document for examples of how to include <nop>VOResource metadata within the interface messages.

The RI specification defines 2 WSDL files--one for the search interface and one for the harvest interface. Both import a common <nop>RegistryInterface schema. These are available here:

   * [[http://www.ivoa.net/wsdl/RegistrySearch/RegistrySearch-v1.0.wsdl][RegistrySearch-v1.0.wsdl]]
   * [[http://www.ivoa.net/wsdl/RegistryHarvest/RegistryHarvest-v1.0.wsdl][RegistryHarvest-v1.0.wsdl]]
   * [[http://www.ivoa.net/xml/RegistryInterface/RegistryInterface-v1.0.xsd][RegistryInterface-v1.0.xsd]]

More info about the RI spec, including getting Kevin's last bundle of WSDLs and Schemas, conult the RegistryInterface page.  

*Remember:*  The WSDL/SOAP-based Harvesting interface is optional; if your registry is harvestable, the standard GET-based version of OAI is required.  

---++ XSL conversion stylesheets

---+++ For v1.02 (Release Cand. 11):

   $ [[%ATTACHURL%/VOResource-v0.10-v1.0.xsl2][VOResource-v0.10-v1.0.xsl2]]: XSL stylesheet for converting v0.10 to v1.0 records.  (Updated 5 April 2007)

This stylesheet requires an XSLT 2.0 processor, such as the Saxon engine, available in [[%PUBURL%/%WEB%/RegUpgradeSummer2006/saxon8.jar][saxon8.jar]].  To run, type:

<verbatim>java -jar saxon8.jar resource-v0.10.xml VOResource-v0.10-v1.0.xsl2 > resource-v1.0.xml</verbatim>

where <code>resource-v0.10.xml</code> is the v0.10 resource record to convert. 

See VoResourceConversionXSL for more info, including Caveats, available input parameters, and a list of recent changes. 

--IVOA.RayPlante - 17 April 2007

---++ Software Tools and Testers

   * *ivoaregistry*:  _a registry search Java library and tester._ 
      *  Download as a zip file: [[%PUBURL%/%WEB%/RegUpgradeSummer2006/ireg-linux.zip][ireg-linux.zip]]
         *  "linux" means the command line wrapper script is for *nix OSes; the Windows version is not yet included.
         *  It is pre-built, but can be re-built with ant
         *  Requires at least Java 1.5
      *  The <nop>net.ivoa.registry.search.RegistrySearchClient class provides a Java API to the standard IVOA Registry Search Interface.  
      *  The *regsearch* command line tool can be used to test the interface
         *  to install, first run "bin/install_tools"
         *  see top section of bin/regsearch for usage details
         *  it's still a little clunky for using in scripts. 

   *  Registry in a Box, v2.0:  [[%ATTACHURL%/riabox-2.0rc2.tar.gz][riabox-2.0rc2.tar.gz]]
      *  Enhancements on the commonly used OAI libraries from Virginia Tech that understands the RI profile on OAI.  
      *  Allows configuration for compliant OAI responses:
         * returning the Registry VOResource record in Identify response
         * define, document, and configure sets
         * show support for ivo_vor metadata prefix
         * support required oai_dc format with stylesheet from VOResource format.

   *  Registry of Registries: 
      *  Documentation: [[%ATTACHURL%/RofR-20070601.html][IVOA Note]]
      *  OAI interface at [[http://nvo.ncsa.uiuc.edu/cgi-bin/rofr/oai.pl]]
         * implemented using Registry-in-a-box above.
      *  Fully v1.0 compliant
      *  can be used to test Harvesting
      *  validate and register your registry at [[http://rofr.ivoa.net:8080/vovalidation/regvalidate.html]]
      *  view [[http://rofr.ivoa.net/cgi-bin/rofr/rofrhello.py][currently registered Registries]]

   *  VOResource validating stylesheet: [[%ATTACHURL%/validateVOResource.xsl][validateVOResource.xsl]]
      *  this style sheet will run VOResource compliance checks that are not covered by the VOResource schemas
      *  understands extension types defined in these extension schemas
         * <nop>VORegistry
         * <nop>VODataService
         * <nop>ConeSearch
         * <nop>SIA
         * <nop>SkyNode
      *  By default it will only report on problems found with a text output.
      *  Useful optional input parameters include (see in-line documentation for more detail):
         *  =requireRI=:  set to 1 if you want to ensure that the VOResource records is wrapped in the &lt;ri:Resource&gt; element as required by the RI standard.
         *  =rightnow=:  set to the current date and time (in ISO format) to ensure that all dates are in the past.
         *  =showStatus=:  set to "fail warn rec pass" to include reports on passed tests; the default is only to report failures, warnings and recommendations.  
<br/>


<br/>
<!--
      * Set ALLOWTOPICRENAME = IVOA.TWikiAdminGroup
-->

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
xsd	ConeSearch-v1.0.xsd	r1	manage	7.4 K	2007-04-05 - 10:32	RayPlante	release candidate v1.02R1
html	RofR-20070601.html	r3 r2 r1	manage	27.5 K	2007-06-01 - 08:20	RayPlante
xsd	SIA-v1.0.xsd	r1	manage	13.9 K	2007-04-05 - 10:37	RayPlante	release candidate v1.02R1
xsd	SkyNode-v0.2.xsd	r1	manage	7.0 K	2007-04-05 - 10:38	RayPlante	release candidate v1.02R1
xsd	VODataService-v1.0.xsd	r1	manage	34.2 K	2007-04-05 - 10:39	RayPlante	release candidate v1.02R1
xsd	VORegistry-v1.0.xsd	r1	manage	11.1 K	2007-04-05 - 10:40	RayPlante	release candidate v1.02R1
xsl2	VOResource-v0.10-v1.0.xsl2	r5 r4 r3 r2 r1	manage	111.1 K	2008-01-18 - 10:21	RayPlante	release candidate v1.02R1 (with bug fixes)
gz	VOResource-v1.0.tar.gz	r1	manage	51.1 K	2007-04-05 - 10:31	RayPlante	release candidate v1.02R1
xsd	VOResource-v1.0.xsd	r1	manage	53.1 K	2007-04-05 - 10:40	RayPlante	release candidate v1.02R1
zip	VOResource-v1.0.zip	r1	manage	64.7 K	2007-04-05 - 10:55	RayPlante	release candidate v1.02R1
xsd	VOStandard-v0.1.xsd	r1	manage	5.8 K	2007-04-05 - 10:40	RayPlante	release candidate v1.02R1
xml	catalog.xml	r1	manage	7.9 K	2007-04-05 - 10:32	RayPlante	release candidate v1.02R1
xml	collection.xml	r1	manage	4.9 K	2007-04-05 - 10:32	RayPlante	release candidate v1.02R1
xml	conesearch.xml	r1	manage	3.5 K	2007-04-05 - 10:33	RayPlante	release candidate v1.02R1
xml	ivoa-auth.xml	r1	manage	1.5 K	2007-04-05 - 10:33	RayPlante	release candidate v1.02R1
xml	ivoa.xml	r1	manage	3.3 K	2007-04-05 - 10:35	RayPlante	release candidate v1.02R1
xml	organisation.xml	r1	manage	1.9 K	2007-04-05 - 10:35	RayPlante	release candidate v1.02R1
xml	registry.xml	r1	manage	3.1 K	2007-04-05 - 10:36	RayPlante	release candidate v1.02R1
gz	riabox-2.0rc2.tar.gz	r1	manage	27.5 K	2007-04-30 - 09:56	RayPlante
xml	rofr.xml	r1	manage	2.5 K	2007-04-05 - 10:36	RayPlante	release candidate v1.02R1
xml	sia.xml	r1	manage	7.8 K	2007-04-05 - 10:38	RayPlante	release candidate v1.02R1
xml	sia2ver.xml	r1	manage	4.1 K	2007-04-05 - 10:37	RayPlante	release candidate v1.02R1
xml	siastd.xml	r1	manage	6.1 K	2007-04-05 - 10:37	RayPlante	release candidate v1.02R1
xsd	stc-v1.30.xsd	r1	manage	160.7 K	2007-04-05 - 10:38	RayPlante	release candidate v1.02R1
xml	stc.xml	r1	manage	2.5 K	2007-04-05 - 10:39	RayPlante	release candidate v1.02R1
xsl	validateVOResource.xsl	r1	manage	30.4 K	2007-04-26 - 09:04	RayPlante	makes compliance checks not covered by XML Schema
xml	webform.xml	r1	manage	1.9 K	2007-04-05 - 10:41	RayPlante	release candidate v1.02R1
xml	webservice.xml	r1	manage	2.5 K	2007-04-05 - 10:41	RayPlante	release candidate v1.02R1