| 1 | This collection talks to the iVia installation at INFOMINE, Riverside,
|
|---|
| 2 | California. The software should work with any iVia installation.
|
|---|
| 3 |
|
|---|
| 4 | Cgi scripts are called to do searching of and retrieval from the database.
|
|---|
| 5 | All three are fairly generic CGI scripts; iVia's "theming" ability is used to
|
|---|
| 6 | get the data back in the format we want-- there is a gsdl3 theme.
|
|---|
| 7 |
|
|---|
| 8 | To create a new collection that talks to an iVia database, you need to create
|
|---|
| 9 | the two configuration files, collectionConfig.xml, and buildConfig.xml.
|
|---|
| 10 | The collectionConfig.xml needs to contain any display information for the
|
|---|
| 11 | collection, and any metadata that is available. Also it can contain format
|
|---|
| 12 | information for document display or search result lists if the default is
|
|---|
| 13 | not useful.
|
|---|
| 14 |
|
|---|
| 15 | The buildConfig.xml file needs to specify the IViaProxy serviceRack
|
|---|
| 16 | class. Inside this element should be the url of the iVia installation that
|
|---|
| 17 | you want to connect to. Here is an example:
|
|---|
| 18 |
|
|---|
| 19 | <buildConfig>
|
|---|
| 20 | <metadataList/>
|
|---|
| 21 | <serviceRackList>
|
|---|
| 22 | <serviceRack name="IViaProxy">
|
|---|
| 23 | <iViaServer url="http://infominehelper.ucr.edu"/>
|
|---|
| 24 | </serviceRack>
|
|---|
| 25 | </serviceRackList>
|
|---|
| 26 | </buildConfig>
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 | The following describes the iVia cgi scripts.
|
|---|
| 30 |
|
|---|
| 31 | For performing a search:
|
|---|
| 32 | ************************
|
|---|
| 33 |
|
|---|
| 34 | <serverhome>/cgi-bin/canned_search
|
|---|
| 35 |
|
|---|
| 36 | Parameters:
|
|---|
| 37 | Required parameters: theme=gsdl3&query=xxx
|
|---|
| 38 | Useful parameters: no_of_records_per_page=10&start_page_no=1&fields='kw,su'
|
|---|
| 39 | Other parameters: http://infomine.ucr.edu/help/adders/index.php?section=11
|
|---|
| 40 | Example: http://infomine.ucr.edu/cgi-bin/canned_search?query=tree&
|
|---|
| 41 | theme=gsdl3&no_of_records_per_page=10&start_page_no=1
|
|---|
| 42 |
|
|---|
| 43 | Fields include Title (ti), Subject (su), Keyword (kw), Author (au),
|
|---|
| 44 | Description (de) and full text (fu). 'all' will search all fields.
|
|---|
| 45 | It's possible to do uch more advanced searches including phrase searching
|
|---|
| 46 | and bolean queries.
|
|---|
| 47 |
|
|---|
| 48 | The canned_search result page will look something like this:
|
|---|
| 49 | Resources: 58
|
|---|
| 50 | Ids: 1015 22128 1730 6020 2981 1014 20147 2097 46569 4360
|
|---|
| 51 |
|
|---|
| 52 | For getting an HTML representation of a record:
|
|---|
| 53 | ***********************************************
|
|---|
| 54 |
|
|---|
| 55 | <serverhome>/cgi-bin/view_record
|
|---|
| 56 |
|
|---|
| 57 | Parameters:
|
|---|
| 58 | Required parameters: theme=gsdl3&record_id=x
|
|---|
| 59 | Example: http://infomine.ucr.edu/cgi-bin/view_record?theme=gsdl3&
|
|---|
| 60 | record_id=2097
|
|---|
| 61 |
|
|---|
| 62 | The result page will be an HTML fragment; specifically, it will be an HTML
|
|---|
| 63 | table. Again, the formatting is quite flexible. There's one current
|
|---|
| 64 | problem: a lot of the data is displayed as hypertext links to new infomine
|
|---|
| 65 | searches; This should be changed eventually.
|
|---|
| 66 |
|
|---|
| 67 | For now, the Greenstone services process the records, replacing infomine
|
|---|
| 68 | links with Greenstone links where possible.
|
|---|
| 69 |
|
|---|
| 70 | For getting metadata for a set of records:
|
|---|
| 71 | ******************************************
|
|---|
| 72 |
|
|---|
| 73 | <serverhome>/cgi-bin/view_record_set
|
|---|
| 74 |
|
|---|
| 75 | Parameters:
|
|---|
| 76 | Required parameters: theme=gsdl3&record_id_list=id1,id2,id3
|
|---|
| 77 | Optional parameter: field_list=f1,f2,f3
|
|---|
| 78 | Example: http://infomine.ucr.edu/cgi-bin/view_record_set?theme=gsdl3&
|
|---|
| 79 | record_id_list=1015,2128,1730&field_list=url,title
|
|---|
| 80 |
|
|---|
| 81 | The result will look like this:
|
|---|
| 82 |
|
|---|
| 83 | Record: 1015
|
|---|
| 84 | url: http://www.fruit.affrc.go.jp/index-e.html
|
|---|
| 85 | title: National Institute of Fruit Tree Science (Japan)
|
|---|
| 86 |
|
|---|
| 87 | Record: 2128
|
|---|
| 88 | url: http://www.publish.csiro.au/journals/ajb/
|
|---|
| 89 | title: Australian Journal of Botany
|
|---|
| 90 |
|
|---|
| 91 | Record: 1730
|
|---|
| 92 | url: http://usda.mannlib.cornell.edu/reports/erssor/specialty/fts-bb/
|
|---|
| 93 | title: Fruit and Tree Nuts : USDA Economics and Statistics System
|
|---|
| 94 |
|
|---|
| 95 | There are many different metadata fields that can be requested, including
|
|---|
| 96 | keywords, subjects, ivia_description, access, expert_created, foreign_source,
|
|---|
| 97 | foreign_id, and so on.
|
|---|
| 98 |
|
|---|
| 99 | Note that the metadata always fits on one line (whitespace is explicitly
|
|---|
| 100 | normalised to space) to make parsing easier. Generally, the metadata is
|
|---|
| 101 | in ISO-8859-15 format (i.e. ISO-8859-1 plus the Euro currency symbol).
|
|---|
| 102 | Metadata is usually plain text, though the description field may contain
|
|---|
| 103 | HTML entities and limited set of HTML elements (bold tags, italic tags,
|
|---|
| 104 | links, and a few others).
|
|---|
| 105 |
|
|---|
