IESR: WebCGI Service Input Templates


Note that these templates are obsolete and their use is no longer supported.

dc:title JISC Information Environment Service Registry (IESR) WebCGI Service Input Templates
dc:creator Ann Apps, University of Manchester, UK.
dc:date 2004-06-11
dc:identifier http://www.mimas.ac.uk/iesr/metadata/templates/svcwebcgi-template.html
dc:description Templates for submission of WebCGI Service Descriptions to IESR.
dc:rights Creative Commons License This work is licensed under a Creative Commons Licence: Attribution Required; Non-Commercial; Share-Alike.
version 2.0

Change History
v2.0, 2004-06-11 dc:description changed to dcterms:abstract
Added iesr:logo
v1.1, 2003-11-17 Removed 'publisher'
v1.0, 2003-07-16 First version


During the initial phase of the IESR project descriptions of services will be created using templates, either Excel or XML, by the identified initial contributors. Eventually there will be a Web form for input and editing of data.

Rights. All metadata records in the IESR will be freely available and licensed under a Creative Commons Licence: Attribution Required; Non-Commercial; Share-Alike. When you submit data to the IESR you are agreeing to this licence on your metadata records.

Identifiers. Identifiers for collections, services and agents will be allocated on registration with IESR. For initial submisssion of data please construct simple identifiers to enable correlation by the IESR project team between the collection and its associated services (hasService) and agents (owner, administrator).

Repeated and Optional properties. When properties are repeated please repeat elements in the XML or lines in the Excel spreadsheet. Where optional properties are not included please delete the elements from the XML or the lines from the Excel spreadsheet. Fixed value properties are not included in the data submission templates.

Version 2. Following a review of the IESR metadata early in Phase 2 of the project several changes were made to the metadata available as output from the IESR. These changes are listed at the beginning of the review document. The Excel templates for data supply will not be changed. The XML templates for data supply and the tables below have been updated, but data encoded according to version 1 XML templates will still be accepted.

For help and further information please contact the IESR project team iesr@mimas.ac.uk


WebCGI Service Templates

Note that these templates are obsolete and their use is no longer supported.


CGI Arguments

Arguments required when calling the WebCGI script via URL are specified as a list of key names along with associated fixed values where appropriate and optional descriptions. For example a webcgi service:
http://www.example.org/mycgi?db=abc&id=123 (where 'abc' id a fixed value and '123' is a variable)
has arguments:

A WebCGI script may have several possible sets of arguments providing different functions, ie. several inputs. In the templates each set of arguments is introduced by by an 'input' Name with no Value in Excel, or nested within an <input> tag in XML. Items in the Excel tabular templates are assumed to be processed sequentially so fixed values and descriptions must immediately follow their keys.


WebCGI Service Description Tabular Form

Name EncodingScheme/Language Value
title Language. Optional Name of the service. Required Not Repeatable
identifier   Data provider's identifier of the metadata record of this service. Required Not Repeatable
abstract Language. Optional A free text summary description of the service. A service description should be provided only for a transactional service (not associated with a collection). Optional. Not Repeatable
locator   The URI of the access point for the service. Required. Not Repeatable
accessType AccMthdList webcgi
serviceType SvcTypeList Type of the service. Optional. Repeatable
output   Output format available from the service. Optional. Repeatable
accessRights AuthList Access control for the service. Required. Repeatable
accessDomain DNSDomain Domain where service is available. Optional. Repeatable
seeAlso   The global identifier of a document that provides more information about using the service. Optional. Repeatable
logo   URL of a logo for the service. Optional. Not Repeatable
administrator   Data provider's identifier of the metadata record for the agent that has responsibility for the electronic environment in which the collection is held. Required. Repeatable
creator   Person or organisation who created the metadata record. Optional. Repeatable
contributor   Person or organisation who modified the metadata record. Optional. Repeatable
created W3CDTF Date when metadata record was created (or manually updated). Optional. Repeatable
metaLanguage RFC3066 Language of the metadata record. Optional. Not Repeatable
source   URL of source record from which this metadata record was derived. Optional. Repeatable
input   Introduces a set of CGI arguments. Required. Repeatable
keyName   CGI argument label. Required
keyValue   Fixed value for a CGI argument. Optional
keyDescription   Description of a CGI argument. Optional


WebCGI Service Description Example Tabular Form

Note that this example does not include the following optional webcgi service properties: abstract; serviceType; accessDomain; contributor; logo; adminmeta-language; source

Name Scheme Value
title   zetoc
identifier   mimas-ze-svc02
locator   http://zetoc.mimas.ac.uk/zetoc/wzgw
accessType AccMthdList webcgi
output   text/html
accessRights AuthList ip
accessRights AuthList athens
seeAlso   http://zetoc.mimas.ac.uk/faq.html
administrator   mimas-agt-mimas
creator   Apps, Ann
created W3CDTF 2003-07-16
input    
keyName   db
keyValue   etoc
keyDescription   Database
keyName   fs
keyValue   Search
keyName   buttons
keyValue   1
keyDescription   Show buttons
keyName   form
keyValue   general
keyDescription   General search form
keyName   isn
keyDescription   ISBN/ISSN
input    
keyName   db
keyValue   etoc
keyDescription   Database
keyName   fs
keyValue   Search
keyName   buttons
keyValue   1
keyDescription   Show buttons
keyName   form
keyValue   journal
keyDescription   Journal search form
keyName   stype
keyValue   S
keyDescription   Journal search
keyName   issn
keyName   vol
keyDescription   Volume/issue
keyName   tij
keyDescription   Journal title
keyName   date
keyDescription   Publication year
keyName   tia
keyDescription   Article title
keyName   au
keyDescription   Author
keyName   page
keyDescription   Start or End page
input    
keyName   db
keyValue   etoc
keyDescription   Database
keyName   fs
keyValue   Search
keyName   buttons
keyValue   1
keyDescription   Show buttons
keyName   form
keyValue   conference
keyDescription   Conference search form
keyName   ctype
keyValue   C
keyDescription   Conference search
keyName   isbn
keyName   conf
keyDescription   Conference title
keyName   tip
keyDescription   Paper title
keyName   au
keyDescription   Author


3 February 2005

[Valid XHTML 1.0!]