Skip to content

Instantly share code, notes, and snippets.

@hektech
Last active August 29, 2015 14:02
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save hektech/8dce2d62e841b3ccc162 to your computer and use it in GitHub Desktop.
Save hektech/8dce2d62e841b3ccc162 to your computer and use it in GitHub Desktop.

Support Scripts

Various scripts are included with Evergreen in the /openils/bin/ directory (and in the source code in Open-ILS/src/support-scripts and Open-ILS/src/extras). Some of them are used during the installation process, such as eg_db_config, while others are usually run as cron jobs for routine maintenance, such as fine_generator.pl and hold_targeter.pl. Others are useful for less frequent needs, such as the authority control linking scripts. You may explore these scripts and adapt them for your local needs. You are also welcome to share your improvements or ask any questions on the Evergreen IRC channel or email lists.

Here is a summary of the most commonly used scripts. The script name links to more thorough documentation, if available.

  • action_trigger_runner.pl — Useful for creating events for specified hooks and running pending events

  • authority_authority_linker.pl — Links reference headings in authority records to main entry headings in other authority records

  • authority_control_fields.pl — Links bibliographic records to the best matching authority record

  • autogen.sh — Generates web files used by the OPAC, especially files related to organization unit hierarchy, fieldmapper IDL, locales selection, facet definitions, compressed JS files and related cache key

  • clark-kent.pl — Used to start and stop the reporter (which runs scheduled reports)

  • eg_db_config — Creates database and schema, updates config files, sets Evergreen administrator username and password

  • fine_generator.pl

  • hold_targeter.pl

  • marc2are.pl — Converts authority records from MARC format to Evergreen objects suitable for importing via pg_loader.pl (or parallel_pg_loader.pl)

  • marc2bre.pl — Converts bibliographic records from MARC format to Evergreen objects suitable for importing via pg_loader.pl (or parallel_pg_loader.pl)

  • marc2sre.pl — Converts serial records from MARC format to Evergreen objects suitable for importing via pg_loader.pl (or parallel_pg_loader.pl)

  • marc_export — Exports authority, bibliographic, and serial holdings records into any of these formats: USMARC, UNIMARC, XML, BRE, ARE

  • osrf_control — Used to start, stop and send signals to OpenSRF services

  • parallel_pg_loader.pl — Uses the output of marc2bre.pl (or similar tools) to generate the SQL for importing records into Evergreen in a parallel fashion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment