purx Proxy Registry purx lets you register your services without having to run a full OAI-PMH endpoint, but still letting you programmatically control the VOResrouce XML. 2017-03-27T11:08:00Z 500 virtual-observatories Demleitner, M. Research Registry /getRR// (as in ``.../getRR/__system__/tap/run`` for the TAP service); you can also see a link to that way down on service info pages under “VOResource XML”. * Other toolkits: Perhaps your toolkit can produce VOResource already; in particular if you're publishing through TAP, you already have the difficult pieces capabilities and tables, as they are available on their VOSI endpoints (for TAP 1.0, that's the ``.../capabilities`` and ``.../tables`` children of your access URL). You can simply include that XML into the registry records as described below, adjusting the root elements (which can safely be done using regular expression). Toolkit authors: Let us know what to write here. * `Write registry records from scratch`_ Unless your toolkit already gives you a URL, make the registry record built in this way available under an http(s) URL (http is preferred because there's less that can fail). It is highly recommended to make sure the file is being served with last-modified headers and support for HTTP if-modified-since (that's the case if you use a plain file on a capable web server like apache). That way, our checks for updates (which we do every 80 ks) will consume almost no resources at all. The system will work even without last-modified. You *must*, however, manage the updated attribute on your `ri:Resource`, element. purx will not update the record unless that date is updated. Then submit the URL to the `purx enrollment service`_. This will validate your resource record and generate an IVOA identifier for it if all checks out. It will then send a mail to the address given as contact in the resource record with something like an activation URL (which is valid for at least 150 ks). Once that URL is retrieved, you should see your record in the common registries within a day or so (these first need to hit purx's OAI-PMH face; the Registry is pull in this way rather than push). You can always check the idea purx has of your service by entering your access URL at the `purx status service`_. .. _purx enrollment service: /purx/q/enroll/custom .. _purx status service: /purx/q/urlstatus/form What Identifier Will I Get? =========================== One of the big advantages of purx is that you don't have to think of an authority and claim it. The downside is that we will assign the identifier. We're trying to be accomodating, though. Just set the identifier element with an arbitrary (ignored by us) authority – ``ivo://ignored/generic/service``, say. We will then take the path part (``generic/service`` in this case; obviously, you should pick something descriptive here) and glue that together with the authority. That gives ``ivo://purx/generic/service``, which would be your identifier. If that identifier is already taken by someone else, we take the longest element of the host part of the URL we got the XML from, and stick that right behind the authority. For instance, if we got the document from ``http://ari.uni-heidelberg.de/doc.xml``, the resulting identifier would be ``ivo://purx/uni-heidelberg/generic/service``. If that still clashes, we try to disambiguate by appending numbers, but I'd suspect somebody is trolling us if that happens. Also note that the URL-ivoid relationship is fixed once the identifier is minted. Even if you change the identifier at your end, the identifier assigned by purx will remain. Getting Out of purx =================== Purx will regularly re-retrieve your file. If that fails or if the document becomes invalid, purx will, after a couple of weeks, drop your service record (technically, it will henceforth publish a „deleted record” for it). It will send two mails explaining the situation to the contact person given in the record that it last saw. If you want to immediately get rid of the record, just arrange for your webserver to return a 403 Forbidden HTTP status code to purx. You can always resuscitate your record by resubmitting it to the `purx enrollment service`_ again. It will receive the ivoid it had before. Write Registry Records from Scratch =================================== That's a bit of work, in particular if you want to provide table metadata (which is highly recommended). Before starting you should have the following specs handy (in the sense of: searchable; don't even try to actually read them): * `VOResource`_ (basic definitions) * `VODataService`_ (definitions of services and table metadata elements) * `SimpleDALRegExt`_ (metadata for cone search and S*AP; the equivalent for TAP is TAPRegExt, but you don't need that because your TAP server already spits out ready-made content for that from capabilities). You can use these to look up explanations for elements you don't understand in the sample records. There's also http://docs.g-vo.org/schemadoc/, giving a javadoc-like reference for the schema files used in the VO. Now figure out which kind of service (Browser, SCS, TAP, SIAP...) you'd like to publish and grab a matching sample record below. Format it with whatever tool you prefer (our recommendation: xmlstarlet) and then just edit it, replacing content as appropriate. Quite a few elements can also be deleted if you absolutely cannot find something to put in there. Plan for a couple of rounds of validation (any XSD validator should do, or just use purx, though we're not putting any effort in the nice presentation of the diagnostics yet). Oh, don't sweat the VOSI interfaces that you'll see in the sample records. If you don't have them, just remove the corresponding capabilities; most of the records below also have „auxiliary” capabilities (the ``standardID`` attribute has an ``aux`` in the fragment part). Unless you know that you want such capability declaration, just remove them. Here are links to some sample records: * A simple browser service: http://dc.zah.uni-heidelberg.de/getRR/dexter/ui/ui * A browser service with metadata for the underlying table: http://dc.zah.uni-heidelberg.de/getRR/ucds/ui/ui * A standard cone search (SCS) service with a custom browser service: http://dc.zah.uni-heidelberg.de/getRR/amanda/q/cone * An image (SIAP) service with a custom browser service: http://dc.zah.uni-heidelberg.de/getRR/lswscans/res/positions/siap * A spectral (SSAP) service: http://dc.zah.uni-heidelberg.de/getRR/flashheros/q/ssa * A spectral line (SLAP) service: http://dc.zah.uni-heidelberg.de/getRR/toss/q/q * A TAP service (but again, don't write capability and tableset by hand, your toolkit can already build these): http://gavo.aip.de/getRR/__system__/tap/run * A record for a tutorial (or some other piece of documentation that should be listed on VOTT_: http://dc.zah.uni-heidelberg.de/getRR/tutreg/gavo_addpms/gavo_addpms .. _VOResource: http://ivoa.net/Documents/VOResource/ .. _VODataService: http://ivoa.net/Documents/VODataService/ .. _SimpleDALRegExt: http://ivoa.net/Documents/SimpleDALRegExt/ .. _VOTT: https://dc.g-vo.org/VOTT ]]> enrollment, _ = loadPythonModule(rd.getAbsPath("res/enrollment")) enrollment.updateAll() enrollment, _ = loadPythonModule(rd.getAbsPath("res/enrollment")) enrollment.dumpIfChanges() A table of source URLs and their metadata. VOResource XML PENDING OK FAIL1 FAIL2 FAIL3 FAIL4 FAIL5 DELETED The columns of the sources table suitable for public consumption" CREATE VIEW \curtable AS ( SELECT \colNames FROM \schema.sources) purx OAI Web service to enroll plain HTTP-published VOResource records with purx static \internallink{purx/q/urlstatus/form} purx enrolling purx Enrollment Web Service purx URL Status Use this service to inspect what purx thinks of a record. \internallink{purx/q/enroll/custom} source_url return T.a(href=base.makeSitePath( "/purx/q/urlstatus/qp/"+urllib.parse.quote(data)))["purx Info"] purx Publishing Registry Proxy purx OAI-PMH This is the OAI-PMH endpoint of the purx publishing registry proxy. purx lets you publish VOResource records by just putting XML into a web browser. For details, see http://dc.g-vo.org/PURX. registry 1000 false purx ivo://purx/registry 2019-09-24T09:00:00 resType: authority identifier: ivo://purx creationDate: 2017-08-28T09:00:00Z datetimeUpdated:2018-06-01T02:10:00 title:purx Proxy Authority creator: Demleitner, M. managingOrg: ivo://org.gavo.dc/org subject:virtual-observatories referenceURL:http://dc.g-vo.org/PURX sets:ivo_managed contentLevel: Research This authority is used by the purx publishing registry proxy and hence contains records from (potentially) a multitude of publishers that just put their registry records on a common web server. Problems with actual records served here should be reported to the resources' contact addresses first. Non-responsive contacts should be reported to the contact persons of this authority. pmh/pubreg.xml identifiers = set(e.text for e in self.getXpath("//o:identifier")) self.assertTrue("ivo://purx" in identifiers) self.assertTrue("ivo://purx/registry" in identifiers) pmh/pubreg.xml self.XPATH_NAMESPACE_MAP["vr" ] = "http://www.ivoa.net/xml/VOResource/v1.0" self.assertXpath("o:Identify/o:description/*/capability[" "@standardID='ivo://ivoa.net/std/registry']/interface", { "{http://www.w3.org/2001/XMLSchema-instance}type": "vg:OAIHTTP", "role": "std"}) self.assertXpath("o:Identify/o:description/*/identifier", { None: "ivo://purx/registry"}) self.assertXpath("o:Identify/o:description/*/managedAuthority", { None: "purx"}) pmh/pubreg.xml self.assertValidatesXSD() enroll/custom # can we figure out a stronger test? self.assertHasStrings("The URL at which to retrieve") enroll/custom/confirm/junk-code self.assertHasStrings("no open transaction was found")