[Evergreen-documentation] z39.50 documentation
Simone Rauscher
srauscher at grimsby.ca
Mon Sep 18 09:18:56 EDT 2023
Hi there,
I just wanted to share some documentation Lauren Mous and I worked on for adding new z39.50 servers. Lauren attended the last DIG meeting and let me know there is currently no documentation for adding new Z39.50 servers in the official Evergreen docs, so we took our notes and created some step-by-step instructions based on what we figured out.
There are some issues and unknown factors, but below is what we came up with. Not sure if this can be used to add to the official Evergreen documentation, but perhaps it is somewhere to start? Please let us know if you have any comments, feedback, questions, etc... Also, let us know if we should send this somewhere else in the Evergreen world. Thanks!
Z39.50 Server Administration
Permissions required:
ADMIN_Z3950_SOURCE
REMOTE_Z3950_QUERY
Known issues when adding new servers:
Cannot "clone" existing Z39.50 Attributes from other sources when creating a new source - worked in previous Evergreen versions, no bug created in Launchpad for this yet
Other known attributes are not included in Z39.50 Attributes creator, such as "Relation Attributes", "Position Attributes" and "Completeness Attributes" - https://www.loc.gov/z3950/agency/bib1.html
Some sources/servers do not work as expected - https://bugs.launchpad.net/evergreen/+bug/1745249 Though not precisely articulated, seems to say that some sources show partial results and some don't
Add New Z39.50 Servers and Source Configuration:
1. Locate Server information via a Z39.50 Target Directory
Example of source target directory:
a. https://irspy.indexdata.com/
2. Go to Administration > Server Administration > Z39.50 Servers
3. Click "New Z39.50 source"
4. Fill out fields:
a. Z39.50 Source: [Source name]
b. Label: [Source name] - can be same as z39.50 Source ex. Seattle Public Library
c. Host: [URL link to their host, copy exactly from source]
d. Port: [copy exactly from source]
e. DB: [Database name, copy exactly from source]
f. Record format: [Element set names: F, B, FA, FI or T]
* F - Full record display
* B - Brief record display
* FA - Full with all Holdings (supported by SUTRS only; used to display the full record with all holdings attached)
* 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
g. Transmission format: [or "record syntax", often usmarc, SUTRS, xml, etc., copy directly from source]
h. Auth: ["Authentication" - Evergreen function, leave blank unless required, username and password on import screen and is used for resources like OCLC]
i. Use permission: [Evergreen function, leave blank unless required]
5. Click "Save"
Add Attribute Configuration to Z39.50 servers
Definition: Z39.50 Attributes dictate the fields that appear in the "Import Record from Z39.50" screen for that source
1. Locate coding for Z39.50 Attributes
Example of source:
a. https://www.loc.gov/z3950/agency/bib1.html
2. Go to Z39.50 Attribute Configuration [can click on "Attr" next to source]
3. Click "New Z39.50 Attribute"
4. Fill out fields using appropriate coding (see Appendix A for common attributes and the associated coding):
a. Code: ["Use" Attribute - Use attribute specifies an access point (e.g., author, title, subject, ISBN, UPC) - coded by number]
b. Format: ["Structure" Attribute - The Structure attribute specifies the type of search term (e.g., a single word, a phrase, several words to be treated as multiple single terms, etc.). - coded by number], best practice is to mimic existing numeric coding for other z39.50 sources
c. Label: [Term for Use Attribute - term that appears next to blank field on Z39.50 import screen]
d. Name: [Attribute that is being searched, usually same as "Label"]
e. Truncation: ["Truncation" Attribute - The Truncation attribute specifies whether one or more characters may be omitted in matching the search term in the target system at the position specified by the Truncation attribute - coded by number]
f. Z39.50 Source: [Select Z39.50 Server to apply attribute to, may auto-fill depending on Server Source selected]
5. Click "save"
6. Create as many new Attributes as needed using the above guidelines that is required/useful for that particular Z39.50 server
Appendix A
Z39.50 Source
Z39.50
Attribute ID
Name
Label
Code
Format
Truncation
link for the source you are coding for
auto assigned value
title
Title
4
6
1
link for the source you are coding for
auto assigned value
isbn
ISBN
7
6
1
link for the source you are coding for
auto assigned value
issn
ISSN
8
1
1
link for the source you are coding for
auto assigned value
lccn
LCCN
9
1
1
link for the source you are coding for
auto assigned value
tcn
Title Control Number
12
1
1
link for the source you are coding for
auto assigned value
pubdate
Publication Date
31
1
1
link for the source you are coding for
auto assigned value
item_type
Item Type
1001
1
1
link for the source you are coding for
auto assigned value
author
Author
1003
6
1
link for the source you are coding for
auto assigned value
upc
UPC
1007
6
0
link for the source you are coding for
auto assigned value
upc
UPC
1007
1
1
link for the source you are coding for
auto assigned value
publisher
Publisher
1018
6
1
Simone Rauscher (she/her)
Cataloguing and Collections Coordinator
srauscher at grimsby.ca<mailto:srauscher at grimsby.ca>
www.grimsby.ca/library<http://www.grimsby.ca/library>
905-945-5142
From: Simone Rauscher
Sent: August 3, 2023 1:21 PM
To: evergreen-documentation at list.evergreen-ils.org
Subject: Re: Evergreen-documentation Digest, Vol 34, Issue 1
Hi there,
We are looking to add new servers to our z39.50 interface and found there was not a lot of documentation covering a step-by-step guide on how to do this. (ie. if we wanted to add New York Public Library or Library of Congress, etc. to the server options for our z39.50 search)
Is DIG the right place to request for documentation to be added to the documentation on https://evergreen-ils.org/? If this is not the right place, could someone let me know where to direct this request?
The documentation that exists there for z39.50 seems to be more to do with how to enhance or restrict searches, adding credentials, quality sets, etc. but not the basics on how to add/remove servers.
Here: https://docs.evergreen-ils.org/eg/docs/latest/cataloging/z39.50_search_enhancements.html
Or here: https://docs.evergreen-ils.org/eg/docs/latest/admin/restrict_Z39.50_sources_by_perm_group.html
We did get sent a older training video showing how to do it on a previous version of Evergreen, and were able to figure it out - but the instructions are no longer up-to-date, and the current mechanism is missing the "clone" option for the Attributes section: https://vimeo.com/517264760
Let me know, thanks!
Simone Rauscher
Cataloguing & Collections Coordinator
Grimsby Public Library
srauscher at grimsby.ca<mailto:srauscher at grimsby.ca>
905.309.2063
________________________________
From: Evergreen-documentation <evergreen-documentation-bounces at list.evergreen-ils.org<mailto:evergreen-documentation-bounces at list.evergreen-ils.org>> on behalf of evergreen-documentation-request at list.evergreen-ils.org<mailto:evergreen-documentation-request at list.evergreen-ils.org> <evergreen-documentation-request at list.evergreen-ils.org<mailto:evergreen-documentation-request at list.evergreen-ils.org>>
Sent: August 3, 2023 12:00 PM
To: evergreen-documentation at list.evergreen-ils.org<mailto:evergreen-documentation at list.evergreen-ils.org>
Subject: Evergreen-documentation Digest, Vol 34, Issue 1
CAUTION: Email external to Grimsby!
Send Evergreen-documentation mailing list submissions to
evergreen-documentation at list.evergreen-ils.org<mailto:evergreen-documentation at list.evergreen-ils.org>
To subscribe or unsubscribe via the World Wide Web, visit
https://linkprotect.cudasvc.com/url?a=http%3a%2f%2flist.evergreen-ils.org%2fcgi-bin%2fmailman%2flistinfo%2fevergreen-documentation&c=E,1,XgDjWL5RIHC-XI-u9cWE0TGQ_cFdaEQE86yY61U8t5_Mp8BbXgNZYJxBhj5lLNmVXE9cIhHlaooB-2N-Tpo8aBZDgO8Umt_RWS_hxzeOCe4Zz_Xo74bRNe1Od7iw&typo=1
or, via email, send a message with subject or body 'help' to
evergreen-documentation-request at list.evergreen-ils.org<mailto:evergreen-documentation-request at list.evergreen-ils.org>
You can reach the person managing the list at
evergreen-documentation-owner at list.evergreen-ils.org<mailto:evergreen-documentation-owner at list.evergreen-ils.org>
When replying, please edit your Subject line so it is more specific
than "Re: Contents of Evergreen-documentation digest..."
Today's Topics:
1. Date Change - DIG Meeting (Deborah Luchenbill)
----------------------------------------------------------------------
Message: 1
Date: Thu, 3 Aug 2023 09:16:42 -0500
From: Deborah Luchenbill <deborah at mobiusconsortium.org<mailto:deborah at mobiusconsortium.org>>
To: Documentation discussion for Evergreen software
<evergreen-documentation at list.evergreen-ils.org<mailto:evergreen-documentation at list.evergreen-ils.org>>
Subject: [Evergreen-documentation] Date Change - DIG Meeting
Message-ID:
<CAGv20nP85Y2Y7P-KM6G3xFivCCeNyhTJv3SZYSu7tEocfYLAbw at mail.gmail.com<mailto:CAGv20nP85Y2Y7P-KM6G3xFivCCeNyhTJv3SZYSu7tEocfYLAbw at mail.gmail.com>>
Content-Type: text/plain; charset="utf-8"
Hi all,
I am very sorry for the late notice, but I need to reschedule today's DIG
meeting to next Thursday, August 10.
Everything else will remain the same--the agenda can be found here:
https://linkprotect.cudasvc.com/url?a=https%3a%2f%2fwiki.evergreen-ils.org%2fdoku.php%3fid%3devergreen-docs%3adig_meetings%3a20230803-agenda&c=E,1,601gVnCQ6i1z4wsQFUkSNHt4mh8axFoP7G-6jsMocLQp0asndmf6Jw6f9-oLpUfSFlEwgtwtMrDLcv9StRb-y6X_l35jwM7X9jsGYPZgWiyD7Ko,&typo=1
Feel free to add anything, just put your name in parentheses after your
addition.
Thanks--I hope to see you next week!
Best,
Debbie
DIG Facilitator
Debbie Luchenbill
Associate Director, Open Source Initiatives
MOBIUS
2511 Broadway Bluffs, Ste. 101
Columbia, MO 65201
debbie at mobiusconsortium.org<mailto:debbie at mobiusconsortium.org> <deborah at mobiusconsortium.org<mailto:deborah at mobiusconsortium.org>>
573-234-4914
https://linkprotect.cudasvc.com/url?a=https%3a%2f%2fmobiusconsortium.org&c=E,1,HfJVj8W0JMBvAvO2PKRdZMbRxf1jmweNpXONrqOU7-ZzMfLZWNM4llu8NzyBJcYU8tPWPMCra8GL8ho2xxHruxIAm8RCflnX9p6PfhRVnQ,,&typo=1 <https://linkprotect.cudasvc.com/url?a=http%3a%2f%2fmobiusconsortium.org&c=E,1,YLwOjiHl7b5t47oei-4JLefrhs5x-TDSGNqf8ph_QSI0mVKFWQ8ACUDEiKthfr_TpVuylzbxPE7rIBHZtrtvQT9Wbc8nPg8fy_FSH1o14Qw,&typo=1>
MOSS Help Desk: help at mobiusconsortium.org<mailto:help at mobiusconsortium.org> / 877-312-3517
Pronouns: She/Her or She/They (see https://linkprotect.cudasvc.com/url?a=https%3a%2f%2fpronouns.org%2f&c=E,1,MNsgXQwqLSJH_V2EYaqPi4t2MkDJ38i7Pf6oRC8YOD345I9lT-qhS5C9bXUeU33wgdSgPV2027lbpLzeStnNpJILn0YmvIX7RxGXciwAxnfQDZ1UzZOVWA-V&typo=1 to learn more)
Input | Maximizer | Intellection | Relator | Adaptability
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://linkprotect.cudasvc.com/url?a=http%3a%2f%2flist.evergreen-ils.org%2fpipermail%2fevergreen-documentation%2fattachments%2f20230803%2fedd4010b%2fattachment-0001.htm&c=E,1,FI85EyOVd6HI46EnWj__NLpbXgcmoGmEROtqTs0isSpSuYlT45-dsXdW7uWqjQZ-xgXSqqSD3gCD3WmrMysoS3IkJXJ8j6vailXGfWUd2aOZUvBoNVQ3kvNC0g,,&typo=1>
------------------------------
Subject: Digest Footer
_______________________________________________
Evergreen-documentation mailing list
Evergreen-documentation at list.evergreen-ils.org<mailto:Evergreen-documentation at list.evergreen-ils.org>
https://linkprotect.cudasvc.com/url?a=http%3a%2f%2flist.evergreen-ils.org%2fcgi-bin%2fmailman%2flistinfo%2fevergreen-documentation&c=E,1,9pBjoH3N31003n0LcyWK97QYc6jcr-qXVTW9UAQZNM1TvuTLhwoOINTnn_YFSkI4CJRSKsfL3TTWBjLa1eQt30VPbULhNPqfApgMuY8gA_D1rYf1gjWLoYL--y00&typo=1
------------------------------
End of Evergreen-documentation Digest, Vol 34, Issue 1
******************************************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.evergreen-ils.org/pipermail/evergreen-documentation/attachments/20230918/062ef038/attachment-0001.htm>
More information about the Evergreen-documentation
mailing list