Z39.50 configuration for FirstSearch databases

Welcome 

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.

Z39.50 Server

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.

Production server

Domain name: fsz3950.oclc.org
Port: 210

Test server

Domain name: fsz3950test.oclc.org
Port: 210

Hours

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.

Options supported

• Search
• Present
• Scan
• Sort
• Delete Result Set
• Access Control
• Trigger Resource Control
• Close

Preferred message size

OCLC will accept the client's proposal for Preferred Message Size.

Maximum record size

OCLC will accept the client's proposal for Maximum Record Size.

ID authentication

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.

UserInformation field

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

Search service

Present service

Scan service

Sort service

Delete results set service

Used to delete old result sets.

Trigger resource control

This is used by the origin to stop or break a Z39.50 command already in progress.

Close service

Used to terminate all operations and initiate termination of the Z-association.

How full-text is available

1. OCLC created URLs contained in 856/u fields in full MARC syntax and under the label ACCESS in full SUTRS syntax will now allow internet-based access to all full text available in virtually all applicable FirstSearch databases. These URLs can be cut and pasted, or programmatically entered, into any browser supported by FirstSearch in order to gain access to the full text. Regular full text billing charges apply to this access each time the URL is used; the URLs will time out after 7 days so if continued access is desired another search to receive an updated URL will need to be executed. The 856/i field is the indicator for full text access via this method; because 856/u fields can also indicate a link to a web site that is not necessarily full text, the 856/i should be checked to be certain the 856/u link is truly a FirstSearch full text link. The 856/i field contains instructions regarding the URL and information on whether the full text is ASCII or PDF.
    Note: If Z39.50 local holdings information is configured in the FirstSearch administrative module on your authorization, 856/u links to local holdings will appear in your records. Details on how to configure access to Z39.50 catalog in order to provide local holdings can be found in the WorldCat Admin.
2. Two databases have a different method for providing full text.
   1. CWI. For the CWI database, full-text is available using element set name T and syntax SUTRS, however this full-text display will only work with records that contains full-text. The records with full-text display the information under the label ACCESS in the full SUTRS display. In full MARC displays, if a 949/z exists full-text is available. Records without the SUTRS label ACCESS or the MARC subfield 949/z do not have full-text. Those records will cause an error if element set name T is used to try to display the record.
   2. PsycBOOKS. For the PsycBooks database, URLs to PDF files are provided for chapters of the book. The URLs are found in the SUTRS display with the label TOC. After the main label TOC, each chapter gives the information of that chapter and then the label Full text: followed by the URL for that chapter. In MARC displays, the information is found in each 505 field with the URL found in the 505/9 subfield.

Use attributes supported

The OCLC server supports many different USE attributes. Please refer to FirstSearch databases for a detailed list of attributes defined for each database.

Relation attributes supported

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.

Position attributes supported

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.

Structure attributes supported

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.

Truncation attributes supported

Truncation attributes 1, 100, 101 and 104 are defined in the Truncation Attributes section of Bib Attribute Set.

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.

Completeness attributes supported

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.