File Locations

The files in a git repository are organized in a different hierarchical tree structure than the files that have already been installed on a running server. So, both locations are listed below as either 'Git' or 'Installed.' This is not a comprehensive list of file locations, but merely a list of locations where commonly customized or referred to files are located.

Note: After changing configuration files, server restarts are usually required. See the Restarting Things Cheat Sheet

Field Mapper / IDL / Database Schema

The field mapper assists the UI in connecting to the database.

• Git: \Open-ILS\examples\fm_IDL.xml
• Installed: /openils/conf/fm_IDL.xml

A version of the field mapper is also installed specifically for use by the reports engine.

• Installed: /openils/var/web/reports/fm_IDL.xml

You can view the live version on your server through a browser by going to:

• https://<your domain>/reports/fm_IDL.xml

An outline of the database schema is at:

• https://wiki.evergreen-ils.org/doku.php?id=newdevs:db:schemas:3.10_schma

Virtual Host Configuration File

• Git: \Open-ILS\examples\apache_24\eg_vhost.conf.in
• Installed: /etc/apache2/eg_vhost.conf

Perl Modules

• Git: \Open-ILS\src\perlmods\lib\OpenILS\
• Installed: /usr/local/share/perl/[version number]/OpenILS/

Note: If adding a new page to the OPAC, add the new path to EGCatLoader.pm in the "load" subroutine Note: After changing the Perl modules, you will need to restart Apache

KPAC (Kids' Catalog)

• Git: \Open-ILS\examples\kpac.xml.example
• Installed: /openils/conf/kpac.xml.example

Defaults for Notification Action Triggers

• Git: \Open-ILS\src\sql\Pg\950.data.seed-values.sql

Page Templates

• Git: \Open-ILS\src\templates\opac\
• Installed: /openils/var/templates/opac/

Images

• Git: \Open-ILS\web\images\
• Installed: /openils/var/web/images/

CSS

• Git: \Open-ILS\src\templates\opac\css\
• Installed: /openils/var/templates/opac/css/

Page Templates

• Git: \Open-ILS\src\templates-bootstrap\opac\
• Installed: /openils/var/templates-bootstrap/opac/

Images

• Git: \Open-ILS\web\images\
• Installed: /openils/var/web/images/

CSS

• Git: \Open-ILS\src\templates-bootstrap\opac\css\
• Installed: /openils/var/templates-bootstrap/opac/css/

Both versions of the OPAC share some simple JavaScript files in:

• Git: \Open-ILS\web\js\ui\default\opac\
• Installed: /openils/var/web/js/ui/default/opac

Some files of interest here:

• autosuggest.module.js - the typeahead feature for the catalog search input
• simple.js - contains advanced search row add/remove logic

Configuration File

• Git: \Open-ILS\examples\kpac.xml.example
• Installed: /openils/conf/kpac.xml.example

Page Templates

• Git: \Open-ILS\src\templates\kpac\
• Installed: /openils/var/templates/kpac/

Images

• Git: \Open-ILS\web\images\kpac\
• Installed: /openils/var/web/images/kpac/

Page Templates

• Git: \Open-ILS\src\templates\staff\
• Installed: /openils/var/templates/staff/

CSS

• Git: \Open-ILS\src\templates\staff\css\
• Installed: /openils/var/templates/staff/css/

AngularJS

• Git: \Open-ILS\web\js\ui\default\staff\
• Installed: /openils/var/web/js/ui/default/staff/

Angular

• Git: \Open-ILS\src\eg2\src\app\
• Installed: /​home/​opensrf/​Evergreen/​Open-ILS/​src/​eg2/​src/​app/​
• Note: After changing an Angular file, it must be recompiled using ng build.
• Advanced Note: If you add –watch, and leave it running in a screen session, and create a symbolic link from /openils/var/web/eg2 to Open-ILS/web/eg2 it will watch this directory for new files and recompile them on the fly.

Circulation Pop-Up Messages

• Git: \Open-ILS\src\extras\ils_events.xml
• Installed: /openils/var/data/ils_events.xml

Page Templates

• Git: \Open-ILS\src\templates\circ\selfcheck\
• Installed: /openils/var/templates/circ/selfcheck/

JavaScript

• Git: \Open-ILS\web\js\ui\default\circ\selfcheck\
• Installed: /openils/var/web/js/ui/default/circ/selfcheck/

• Git: \docs\
• Installed: /home/opensrf/Evergreen/docs/

When adding release notes, copy the RELEASE_NOTE_TEMPLATE.adoc into the correct folder, rename it to describe the change, and fill it out in ASCIIDoc format.

• Table: The database table where data is stored.
  • Evergreen Database Schema
• View: A view is the result of a SQL query. It combines data from multiple tables and keeps it in memory for easier programmatic access.