NVO Portal and Portal Applications
Portal Applications
- The NVO Home Page in the Portal? (?)
- The NVO Registry in the Portal (Greene)
- Inventory Services in the Portal? (Good)
- Handling non-VOTable source lists? (Good)
- DataScope in the Portal (McGlynn)
- Simple Queries in the Portal (McGlynn)
- Vim in the Portal (Williams)
- VOClient access? (Fitzpatrick)
Testing
See Bob and Tom's Adventures in Portalland
Requirements
See User Requirements Document (9/2007)
Common CGI Arguments
All portal services should handle each of the following inputs. Normally if a service does not itself use an element, e.g., the registry will not use the source inputs and the simple query service will not use the resource list, then they should pass these arguments through to any portal services that are invoked from them.
- sources: A VOTable containing a list of sources to be queried (see below).
- sourcesURL: A URL linking to a VOTable as above.
- resources: A VOTable containing a list of resources. (see note below)
- resourcesURL: A URL referencing a VOTable containing a list of resources. (see note below)
- RunID: An ID used to establish a common identifier for the current request/session.
- referralURL: A URL containing the baseURL plus associated non portal standard parameters that preserve the initial calling application referring url.
Definition of sourceVOTable
A source VOTable must contain three special FIELDs whose UCDs have the following properties:
- A FIELD whose UCD contains the string "POS_EQ_RA" or "pos.eq.ra"
- A FIELD whose UCD contains the string "POS_EQ_DEC" or "pos.eq.dec"
- A FIELD whose UCD contains the string "ID_MAIN" or "meta.id"
Notes:
- FIELDs can appear in any order
- The ID FIELD must have datatype="char" and arraysize="*"
- The RA and Dec fields must have datatype="float" or datatype="double"
- Other FIELDs can also appear in the table
Definition of resourceVOTable
A resource VOTable must have all the following FIELDs with the given name attribute:
- title: A few words that describe the service, for example 'BAX X-Ray Galaxy Clusters and Groups Catalog'.
- identifier: The IVORN of the resource in the VO registry, for example: 'ivo://nasa.heasarc/baxgalclus'
- accessURL: A service endpoint, for example 'http://heasarc.gsfc.nasa.gov/cgi-bin/vo/cone/coneGet.pl?table=baxgalclus&'
- capabilityClass: The service type, for example 'ConeSearch', 'SimpleImageAccess', 'SimpleSpectralAccess', etc
The table may have the following named FIELDs for the associated content. If that content is present, it should have that name attribute, and if that name is present, it should resolve to that content.
- shortName: A few characters that describe the resource for example 'BAX GalClus'.
- description: A paragraph-sized description of the resource.
- referenceURL: A URL to find out more, for example: 'http://heasarc.gsfc.nasa.gov/W3Browse/galaxy-catalog/baxgalclus.html'
Notes:
- FIELDs can appear in any order
- The ID attribute is not used in this definition
- All required and optional FIELDs must have datatype="char" and arraysize="*"
- Other FIELDs can also appear in the table
Portal Components
| Element | URL | Status | for Developers |
| Home page | HEASARCNOAO | Prototypes | |
| Registry | Link | Released | |
| SimpleQuery? | Link | Released | |
| DataScope? | Old Link | New version in testing | |
| Source List Converter | IRSACACR | IRSA: released; CACR: Alpha test | |
| Inventory | Link | Released | |
| Vim | Vim front page | Initial release | Test Page |
| VOClient | VO-CLI Project Page | Released |
"Portal linking"
This table suggests when we link from one system to another.
It indicates what the From link adds to the current user state
before going to the next link.
| To: | Registry | SimpleQuery? | Inventory | DataScope? | Translator | VIM | |
| From: | |||||||
| Portal: | Keywords | VOTable List of targets | Single target | Non-VOTable list | VOTable list of targets | ||
| Registry | Table query | List of services | List of services | List of services | |||
| SimpleQuery? | List of targets | Top target | List of targets | ||||
| Inventory | --find registry entires-- | Table to query | List of services | List of services | |||
| DataScope? | --find registry entries-- | List of targets and/or services | List of targets and/or services | ||||
| Translator | Table to display? | List of targets | Top target | List of targets | |||
| VIM | --find registry entries-- | Table/target[s] to query | List of targets |
Attachments
- Portalland.doc (46.0 kB) - added by tam on 02/08/08 09:35:40.
- SearchReq.doc (42.5 kB) -
Requirements document (from late 2007)
, added by tam on 04/15/08 06:30:35.