This guide contains the technical specifications for connecting an external client to the FirstSearch 5.0 OCLC Z39.50 test server.
Note: Z39.50 searching in FirstSearch is available to institutions that maintain both FirstSearch and OCLC cataloging subscriptions. OCLC will consider enabling Z39.50 searching of FirstSearch for non-cataloging customers for very limited purposes that accord with OCLC terms and conditions for the FirstSearch service. If you believe that you have a use that complies with OCLC terms and conditions, please contact OCLC Support.
The OCLC server implements Z39.50-1995 (version 3 of the protocol).
The server provides access to all databases available through FirstSearch. We maintain both a production and a test server for external access. The test server provides access to databases for testing purposes. Authentication of authorization and password is required for access to the test server. The production server provides access to all the databases available and requires a valid FirstSearch authorization.
Note: Please do any configuration and client test on our test server. If you have questions, please contact OCLC Support with any questions or comments about FirstSearch.
See FirstSearch databases for detailed information about FirstSearch databases.
Domain name: fsz3950.oclc.org
Port: 210
Domain name: fsz3950test.oclc.org
Port: 210
The OCLC Z39.50 production servers are available during the same hours as the online FirstSearch service. The servers are available 24 hours a day, except Sunday. Downtime hours are Sunday, from 2:00 am to 6:00 am, U.S. Eastern Time.
The OCLC Z39.50 test servers are generally available during the same hours as the online and production Z39.50 services. Some functionality, like full text access, is not reliable on the test server, but all indexes and display options are available for testing.
Initialization service
Protocol version Z39.50-1995 (Version 3)
OCLC will accept the client's proposal for Preferred Message Size.
OCLC will accept the client's proposal for Maximum Record Size.
OCLC supports ID authentication as prescribed by the standard. We recognize the userId and password fields; the groupId field is ignored. The service patron password is the password that must be used.
On the Init Response message, we return the OCLC_Information Record in the UserInformation field. The OID for this is 1.2.840.10003.10.1000.17.1
OCLC-UserInformation ::= SEQUENCE {
motd [1] IMPLICIT VisibleString OPTIONAL,
dblist SEQUENCE OF DBName OPTIONAL,
failReason [3] IMPLICIT BOOLEAN OPTIONAL,
text [2] IMPLICIT VisibleString OPTIONAL
}
DBName ::= [2] IMPLICIT VisibleString
Consult the database information file and provide either the database name or the nickname listed (case-insensitive). Multiple database names can be supplied on the query using the IMPLICIT SEQUENCE of DatabaseName.
The server maintains any number of named results sets during the Z-association.
Type-1 & Type-101 are supported.
Bib-1 only is supported.
The Result Set ID (i.e., "default") can be used in the Operand (for qualifying searches).
AND
OR
AND-NOT
The server attempts to find the requested record(s) from named result set. If the Result-set-id is not supplied, the server gets records from the last result set created.
Consult the database information file and provide either the database name or the nickname listed (case-insensitive).
Multiple database names can be supplied on the query using the IMPLICIT SEQUENCE of DatabaseName.
Combine structure attribute 1 (phrase), 2 (word) or 5 (date) with the appropriate use attribute in order to scan an index. See individual database specifications in FirstSearch databases for use/structure combinations for each database.
Currently, the generic sortElement is supported.
Used to delete old result sets.
This is used by the origin to stop or break a Z39.50 command already in progress.
Used to terminate all operations and initiate termination of the Z-association.
When the PresentRequest indicates a SUTRS record, OCLC returns a text record looking like the FirstSearch Web display. When the PresentRequest is for USMARC, OCLC generates a record using the best available USMARC tags. For XML, OCLC returns a record containing 15 elements that offer basic descriptive information about the item in question. If no Preferred Record Syntax is supplied, the OCLC server defaults to USMARC.
| Value | Description |
|---|---|
| 10 | USMARC |
| 101 | SUTRS |
| 109 | XML |
Full views include all the data from the record. Brief views generally include just author, title, and date. If no Element Set Name is supplied, OCLC defaults to Full.
| Value | Description |
|---|---|
| F | Full record display |
| B | Brief record display |
| FA | Full with All Holdings (supported with SUTRS only; used to display the full record with all holdings attached to item) |
| FI | Full record display with No Holdings |
| T | Full text (Available for the CWI database using syntax SUTRS only; used to display full-text of this database when the 949/z is present in the MARC record or when ACCESS is displayed in the SUTRS record) |
Note: A few records may contain large amounts of holdings, while most contain medium to small amounts. Test your system's performance with holdings using the following WorldCat records:
Holdings available in a variety of ways:
Note: The codes used in display are described in the following websites:
The OCLC server supports many different USE attributes. Please refer to FirstSearch databases for a detailed list of attributes defined for each database.
The OCLC server supports the following Relation attributes. If no attribute value is sent, our implementation performs the search as if the value Equal (3) were sent.
| Value | Description |
|---|---|
| 1 | Less than (as of 12/16/2001) |
| 2 | Less than or equal to (as of 12/16/2001) |
| 3 | Equal |
| 4 | Greater or equal (as of 12/16/2001) |
| 5 | Greater than (as of 12/16/2001) |
The OCLC server supports the following position attributes. If no attribute value is sent, our implementation performs the search as if the value is Any.
| Value | Description |
|---|---|
| 1 | First in field (only with structure= 1 or 4) |
| 3 | Any |
For any USE attribute where we specify that WORD is a valid structure attribute, the values of word list (6) and ordered word list (7) are also valid. We implement word list as "AND" within a field. We implement ordered word list (7) as "AND" with a proximity of 1 with order being important. Date (5) is implemented much like word with the most useful difference being it allows for ranging of dates (ie: 1987-1993 will only hit on records between 1987 and 1993 inclusive). If no attribute value is sent, our implementation performs the search as if the value is Word.
| Value | Description |
|---|---|
| 1 | phrase |
| 2 | word |
| 3 | key |
| 4 | year |
| 5 | date (normalized) |
| 6 | word list |
| 7 | ordered word list |
| 101 | normalized |
Truncation attributes 1, 100, 101 and 104 are defined in the Truncation Attributes section of Bib Attribute Set.
| Value | Description |
|---|---|
| 1 | Right truncation |
| 100 | Do not truncate |
| 101 | Process # in search term (# is zero or more characters) |
| 104 |
Truncation is defined in Z39.58-1992
|
Truncation and wildcard characters can only be used after 3 characters in the search term. Limits are imposed on truncation/wildcards in order to maintain high performance standards -- an error will be sent if the truncation/wildcard query is too general.
The OCLC server supports the following completeness attributes. If no attribute value is sent, our implementation performs the search as if the value is Incomplete subfield.
| Value | Description |
|---|---|
| 1 | Incomplete subfield |
| 3 | Complete field (only with structure=1 or 4) |
Additional Z39.50 information can be found at Z39.50 International Standard Maintenance Agency.