pod2text Open-ILS/src/support-scripts/authority_control_fields.pl.in
NAME
    authority_control_fields.pl - Controls fields in bibliographic records
    with authorities in Evergreen

SYNOPSIS
    "authority_control_fields.pl" [--configuration=*opensrf_core.conf*]
    [--refresh] [[--record=*record*[ --record=*record*]]] | [--all] |
    [--start_id=*start-ID* --end_id=*end-ID*] |
    [--days_back=*number-of-days*]

DESCRIPTION
    For a given set of records:

    *   Iterate through the list of fields that are controlled fields

    *   Iterate through the list of subfields that are controlled for that
        given field

    *   Search for a matching authority record for that combination of field
        + subfield(s)

        *   If we find a match, then add a $0 subfield to that field
            identifying the controlling authority record

        *   If we do not find a match, then insert a row into an
            "uncontrolled" table identifying the record ID, field, and
            subfield(s) that were not controlled

    *   Iterate through the list of floating subdivisions

        *   If we find a match, then add a $0 subfield to that field
            identifying the controlling authority record

        *   If we do not find a match, then insert a row into an
            "uncontrolled" table identifying the record ID, field, and
            subfield(s) that were not controlled

    *   If we changed the record, update it in the database

OPTIONS
    *   -c *config-file*, --configuration=*config-file*

        Specifies the OpenSRF configuration file used to connect to the
        OpenSRF router. Defaults to @sysconfdir@/opensrf_core.xml

    *   -r *record-ID*, --record=*record-ID*

        Specifies the bibliographic record ID (found in the
        "biblio.record_entry.id" column) of the record to process. This
        option may be specified more than once to process multiple records
        in a single run.

    *   -a, --all

        Specifies that all bibliographic records should be processed. For
        large databases, this may take an extraordinarily long amount of
        time.

    *   -r, --refresh

        Specifies that all authority links should be removed from the target
        bibliographic record(s). This will effectively rewrite all authority
        linking anew.

    *   -s *start-ID*, --start_id=*start-ID*

        Specifies the starting ID of the range of bibliographic records to
        process. This option is ignored unless it is accompanied by the -e
        or --end_id option.

    *   -e *end-ID*, --end_id=*end-ID*

        Specifies the ending ID of the range of bibliographic records to
        process. This option is ignored unless it is accompanied by the -s
        or --start_id option.

    *   --days_back=*number-of-days*

        Specifies that only bibliographic records that have been created in
        the past few days should be processed. You must specify how many
        days back to include. This option is incompatible with the -s and
        --start_id options.

EXAMPLES
        authority_control_fields.pl --start_id 1 --end_id 50000

    Processes the bibliographic records with IDs between 1 and 50,000 using
    the default OpenSRF configuration file for connection information.

AUTHOR
    Dan Scott <dscott@laurentian.ca>

COPYRIGHT AND LICENSE
    Copyright 2010-2011 by Dan Scott

    This program is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by the
    Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
    Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.