Go to file
Jared Camins-Esakov f09e2ca27e Bug 5528: Analytic records support
Display links to parent biblios, show linked items in holdings, allow holds on
linked items. This uses MARC to maintain relationships.

Sponsored by the Mississippi Department of Archives and History and RapidRadio
Solution. Originally developed by Savitra Sirohi and Amit Gupta at OSSLabs, with
UNIMARC support added by Zeno Tajoli. Commits squashed and merge conflicts
resolved by Chris Cormack from Catalyst. Respect for NORMARC and some small
framework portability fixes made by Jared Camins-Esakov of C & P Bibliography
Services.

IMPORTANT NOTE: A bug in the 773 coding for MARC21 was corrected from the
original OSS Labs code. The 773s generated by the pre-release code did not have
the first indicator set to '0', which means that they were not supposed to
display. Going forward, the first indicator will be set correctly, but existing
records created with this code will no longer appear (they appeared before only
due to another bug). To correct this, you could globally (or, to make sure you
only modify records created with the Analytics tool, for records with 773$0)
change the first indicator of the 773 from blank to '0'.

== Background ==
An analytic record for an item is a more detailed, monographic biblio for an
item attached to a serial record .  This is often used for special issues of a
journal that are released as books on their own (assigned an ISBN, as well as an
ISSN/volume/issue).  It is important for researchers to be able to search for
these items both as issues of the serial, and as monographs.  It is equally
important for the library to not have duplicate item records for the item in
question to have to keep synchronized.

== Establishing relationships ==
Analytical records are connected to items belonging to parent or host
bibliographic records. This can be accomplished by:
* From an analytical bibliographic record linking to an host item by providing
  the item barcode as input
* From a host item by using option "analyze", this creates a new empty
  bibliographic record with field 773 (MARC21) populated
* Running a new CLI script that establishes a relationship between the
  analytical record and the host item identified by the barcode in the
  analytical record's 773$o (MARC21)

== Connecting Records ==
The relationships are maintained in the MARC records, we have not used database
tables at all.

== MARC Representation ==
In MARC21/NORMARC we have used:
* 773$9 to store the Koha item number of the host item
* 773$0 to store the Koha biblio number of the host bibliographic record

The above fields are used to display the relationships in various screens in the
OPAC and the staff interface. Additionally, when populating field 773 with host
item's details, we have used following MARC 21 mapping:
* 'a' <= 100/110/111 $a (author main)
* 'b' <= 250$a (edition)
* 'd' <= 260$a, 260$b, 260$c (place, publisher, year)
* 'o' <= barcode
* 't' <= 245$a (title)
* 'w' <= (003)001 --> if no 001 is available, we can populate biblionumber
* 'x' <= 022$a (issn)
* 'z' <= 020$a (isbn)

In UNIMARC, this code uses:
* 461$9 to store the Koha item number of the host item
* 461$0 to store the Koha biblio number of the host bibliographic record

When populating field 461 in UNIMARC, the following mapping is used:
* 't' <= 200$a (title)

== Treatment of Holds ==
A key requirement was to allow holds to be placed on host items from the
analytical record. We have accomplished this by allowing holds on specific
copies only. Biblio level holds are not allowed. This ensures that holds are
placed on specific items that are relevant to the analytical record.

== Deleting host items with linked analytical records ==
As we have not used database tables to maintain relationships, we had to use
search to find out if any linked analytical records are present. If 1 or more
analytical are present, we do not allow deletion of items. This is similar to
what we see when we try to delete authority records.

== Importing analytical records ==
Analytical records can be imported using bulkmarcimport or the GUI tools. The
new CLI script can be executed after the import to establish relationships with
host items. The script will establish relationships using the host item's
barcode, the barcode must be present in 773$o of the analytical record.

== What if there are two or more copies of the host item? ==
The current design will require that there be two host (773) fields, one for
each copy.

== What if there is no barcode available for the host item? ==
It is still possible to establish a relationship, by populating 773$9 with the
host's item number. However the CLI script uses barcode in 773$o to establish
relationships so it won't work where barcodes are unavailable. Also from an
analytical record, it is possible to establish a relationship to a host item by
providing the barcode as input, this option will not be available as well.

Commits that added the following features were squashed by Chris Cormack (this
is not a list of every commit):
* Display links to host records from biblio detail screens
* Support for UNIMARC, respecting the system preference 'marcflavor'
* Support holds from the OPAC
* Ability to link to items belong to host records from a analytical record
* Display items belonging to host records in the moredetail page
* Ability to edit items belonging to host records, also ability to delink from
  them
* Move get host items code into a C4 routine, also calling the new routine in
  related perl scripts
* Move host field population to a C4 routine, all changes in pl files to call
  new routine
* Allow only specific copy holds for analytical records plus changes to use new
  C4 routines
* Support for holds on items linked via host records
* Storing bibnumber and itemnumber in subfields 0 and 9, plus other mapping
  changes
* New command line script that establishes relationships between analytical
  records and host items and bibs. The script looks for host field (MARC21 773)
  in records, and based on barcode in subfield 'o' populates host bibnumber in
  subfield '0' and host itemnumber in subfield '9'. The script can be run after
  an import of analytical records, it can also be run in the crontab to maintain
  the relationships
* Ability to create analytical records from items, to view linked analytics, and
  prevent deletion of items that have linked analytics
* New template for catalogue/detail.pl (NOTE: not a new template file, just a
  new way of displaying analytics), template displays linked analytics and
  allows creation of analytical records
* New zebra index for item number in host fields. This index will be used to
  display links to analytical records from host records
* Display title of host record instead of the phrase host record
* Using detail.tmpl for analytics tab instead of a new template file
* Improved qualification info prepration in Prephostmarcfield
* Check for linked analytics before deleting item
* Display link to host record and more meaningful anchor text for edit item link
* Analytical record: Unimarc index in record.abs and help in
  create_analytical_rel.pl
* Adding a sys pref that controls display of options to create analytical
  relationships
* Add host entry in XSLT stylesheet in staff item detail
* Added host record support to OPAC detail XSLT
* Adding 773$0 and 773$9 to all frameworks
* Adding 773 subfields 0 and 9 to default marc framework via updatedatabase.pl
* Display create analytics and used in links in catalog detail
* Fixed problem where analytical records not showing in OPAC search results
  because GetMarcBiblio now needs a flag to add item records
* Fixed problem where analytics count was set to 1 for all records, not just
  those with analytics
* Fixed catalogue detail page not to show analytics counts if count is 0

Conflicts:
	installer/data/mysql/updatedatabase.pl
	koha-tmpl/intranet-tmpl/prog/en/modules/cataloguing/addbiblio.tt
	kohaversion.pl

Co-author: Savitra Sirohi <savitra.sirohi@osslabs.biz>
Co-author: Zeno Tajoli <tajoli@cilea.it>

Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
Signed-off-by: Ian Walls <ian.walls@bywatersolutions.com>
Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
2011-10-13 10:03:39 +13:00
C4 Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
acqui Bug 6268: (MT #6408) Bad Total in basket.pl 2011-10-07 10:59:06 +13:00
admin Fix for Bug 6872 - Can't set default SMS messaging options for patron category 2011-09-27 21:35:41 +13:00
authorities Merge remote-tracking branch 'kc/new/bug_6679' into kcmaster 2011-09-23 14:19:11 +12:00
basket Bug 6050 Make calls to GetItemsInfo consistent 2011-06-14 14:12:02 +12:00
catalogue Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
cataloguing Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
circ Enh 6403: Record local use stats when checking in unissued materials 2011-10-09 19:50:41 +13:00
debian Merge remote-tracking branch 'kc/new/enh/bug_4877' into kcmaster 2011-09-23 15:01:21 +12:00
docs Bug 6992 - add missing tab chars to history.txt 2011-10-10 10:01:37 +13:00
errors Housekeeping in errors scripts 2010-05-12 07:29:03 -04:00
etc Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
install_misc Bug 5468: removin apt-get-debian-lenny and updating INSTALL.debian 2011-08-04 13:40:09 +12:00
installer Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
koha-tmpl Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
labels Bug 6733: change branchcode call in Labels to use userenv instead of LoginBranchname 2011-09-28 20:29:39 +13:00
members Bug 6801: checkoverdues returns unnecessary fields, causing slowness 2011-09-27 09:43:25 +13:00
misc Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
offline_circ Bug 5449: JSON malformed in Koha - Blocker with jQuery 1.4.x 2011-03-12 08:53:41 +13:00
opac Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
patroncards Bug 6733: change branchcode call in Labels to use userenv instead of LoginBranchname 2011-09-28 20:29:39 +13:00
reports Fix for Bug 6602 - Reports dictionary doesn't properly recognize text columns 2011-08-25 11:49:04 +12:00
reserve Bug 5528: Analytic records support 2011-10-13 10:03:39 +13:00
reviews Modifying Members : Add Mod and GetMember 2009-09-30 11:29:23 +02:00
rotating_collections Bug 6553 : Follow up adding license statements 2011-08-13 19:54:38 +12:00
selenium Adding selenium tests for filterMembers 2009-09-30 11:30:37 +02:00
serials Bug 6479 Converts all the serialseq variables to UTF-8. 2011-09-03 06:31:03 +12:00
skel installer: fixed chown invocation; added skel for KOHA_LOG_DIR 2007-12-17 09:13:53 -06:00
sms Bug 2505 - Add commented use warnings where missing in the sms/ directory 2010-04-21 20:25:08 +12:00
suggestion Bug 5453 Move declarations out of conditionals 2011-07-15 15:50:23 +12:00
svc bug 4896: granular permissions now always on (DB rev 138) 2010-06-19 07:56:03 -04:00
t Fixing a broken test 2011-09-26 11:55:58 +13:00
tags Fix for Bug 2377 - Review tags: format date according to system preference 2010-10-06 09:31:56 -04:00
test Bug 5449: JSON malformed in Koha - Blocker with jQuery 1.4.x 2011-03-12 08:53:41 +13:00
tmp/modified_authorities changing DO_NOT_REMOVE to README.txt 2007-10-21 19:14:41 -05:00
tools Bug 6733: change branchcode call in Labels to use userenv instead of LoginBranchname 2011-09-28 20:29:39 +13:00
virtualshelves Bug 6555 : only 10 lists show in the staff client 2011-09-07 09:00:38 +12:00
xt Bug 6537 - squashed version of the previous 5 commits, signed-off 2011-09-07 09:19:07 +12:00
.htaccess Fix file permissions: if it is not a script, it should not be executable. 2010-04-16 00:40:34 -04:00
INSTALL Updating upgrade information to note the fact language templates need 2011-06-09 09:51:15 +12:00
INSTALL.debian Bug 5468: removin apt-get-debian-lenny and updating INSTALL.debian 2011-08-04 13:40:09 +12:00
INSTALL.fedora7 fixing various links to point to *.koha-community.org 2010-10-21 22:08:24 -04:00
INSTALL.opensuse Updating INSTALL.opensuse file with the changes by Freek de Kruijf 2011-06-09 09:45:22 +12:00
INSTALL.ubuntu Updating upgrade information to note the fact language templates need 2011-06-09 09:51:15 +12:00
INSTALL.ubuntu.lucid Updating upgrade information to note the fact language templates need 2011-06-09 09:51:15 +12:00
LICENSE Update LICENSE with a fresh copy from upstream. This updates the FSF address, and refers to the LGPL with its current name, and changes a few other minor things of the typographical sort. No semantic changes. 2010-03-16 20:17:48 -04:00
MANIFEST.SKIP Bug Fixing : 3334 2009-06-19 06:33:34 -05:00
Makefile.PL Bug 3644 Add support for NORMARC 2011-03-30 10:13:37 +02:00
README updated links in README 2010-05-24 08:14:16 -04:00
README.robots Bug 6411 add another example to README.robots 2011-07-05 14:48:05 +12:00
about.pl Bug 6755 Problems with switching languages 2011-09-23 09:47:09 +12:00
changelanguage.pl Bug 6755 Problems with switching languages 2011-09-23 09:47:09 +12:00
edithelp.pl Bug 6923 : Fixing a bug introduced by 6755 - was blocking help being used or edited 2011-09-27 11:14:06 +13:00
fix-perl-path.PL installer: improvements to fix-path-perl.PL on Win32 2007-12-20 19:20:12 -06:00
help.pl Bug 6923 : Fixing a bug introduced by 6755 - was blocking help being used or edited 2011-09-27 11:14:06 +13:00
install-CPAN.pl Bug 5370: Fix all the references to koha.org 2010-11-08 09:41:49 +13:00
koha_perl_deps.pl Bug 4844 Remove a circular dependency in koha_perl_deps.pl 2010-06-03 19:59:10 -04:00
kohaversion.pl Bumping database version to 3.05.00.015 2011-10-11 15:31:23 +13:00
mainpage.pl Bug 4330 : Updating copyright statements 2011-07-15 14:03:43 +12:00
rewrite-config.PL Bug 5370: Fix all the references to koha.org 2010-11-08 09:41:49 +13:00

README

Koha is a free software integrated library system.

Koha is distributed under the GNU GPL version 2 or later.
Please read the file LICENSE for more details.

To install or upgrade Koha, please see the INSTALL file appropriate
to your platform.

Report bugs at http://bugs.koha-community.org/

Visit the Koha Project website at http://www.koha-community.org/