@jeffnm jeffnm released this Jul 16, 2018

Assets 2

System Environment Requirements

  • PHP 5.5+ (Known issue: not compatible with PHP 7.2 at this time)
    • Required PHP extensions: mbstring, gettext, mysqlnd
  • MySQL 5.5 and 5.6 (Known issue: Not working with MySQL 5.7 at this time)
  • Apache 2.2 or above

Install or Upgrade

Installation

  1. Download a copy of 3.0.0 at Github.
  2. If you use the option to download the compressed zipped file, expand this file in a working folder.
  3. Copy the expanded folder to your webserver. If using Apache, this would be something like /var/www/html/ folder. If CORAL will be in a sub folder on your webserver, change the folder name from “Coral-master” to, for example, “coral” or another name you choose. The web installation depends upon the index.php file found in the coral folder. Your Apache settings should be set to include loading the index.php file.
  4. Go to the home directory via a web browser to initiate the install process and follow the onscreen instructions.

Upgrade

You should be able to upgrade to 3.0.0 either from 2.0 or from the final 1.x modules. It will simply upgrade you to 2.0 along the way, but you'll still end up with 3.0.0.

  1. Make a fresh backup of your database and directory.
  2. Download a copy of 3.0.0 at Github.
  3. If you use the option to download the compressed zipped file, expand this file in a working folder.
  4. Copy the contents of that expanded folder into your coral web root, which might be something like /var/www/html/coral depending on your configuration.
  5. Go to the root of your coral installation in a browser "your.coral-domain.org" and the upgrader should recognize that you are using an older version of CORAL and start the upgrade process. Follow the onscreen instructions.

New Features

General (all modules)

German translation. Thanks to BSZ - Abteilung Bibliothekssysteme for this contribution.
Turkish translation. Thanks to Özhan Sağlık for this contribution.

Resource Module

EBSCO Knowledge Base (KB) Integration

This feature allows EBSCO KB customers to search the EBSCO KB from within CORAL and import titles and packages into CORAL. Thanks to SirsiDynix for this contribution.

Import Tool Enhancements

Several enhancements have been added to the Import tool. This includes a preview of the import information before importing data into CORAL, an uploads history page to see the previously uploaded files, and a few new fields added to the import interface. Thanks to North Carolina State University and BibLibre for this contribution.

Resource Statistics and Yearly Costs Dashboards

The dashboard view allows users to view resource statistics by filtering them and grouping by resource type, subject or acquisition type, with sub-totals, and to export the data as CSV. Thanks to University Lyon 3 and BibLibre for this contribution.

CORAL/ILS Interaction: Vendors

This is an optional feature allowing to synchronize vendors between CORAL and an ILS. Thanks to BibLibre and ByWater Solutions for this contribution.

Multiple orders to any record in Resource module

A new “Order” panel was added to allow users add multiple orders to a resource record. For records with multiple orders, a dropdown list will appear beside the title. Users can also clone an existing order. Thanks to Biblibre and ByWater Solutions for this contribution.

Other features

  • Separate costs in export
  • Display child records in alphabetical order
  • Duplicate an existing workflow in Admin
  • Additional search fields including Publisher, Platform and Provider
  • Make the content area wider

API Enhancements

  • API_Client fundcode dropdown and general form style enhancements
    Changed the fund code field to a dropdown list. Added css style to the API form consistent with existing CORAL CSS style. Thanks to North Carolina State University for this contribution.

  • Add new routes to CORAL API
    Get resource by resource id, ISBN or ISSN, package’s titles, licenses and organization. Thanks to Biblibre for this contribution.

Bug Fixes

General (All Modules)

  • Allow modal popup to close with the “ESC” key. (#391 & #395)

  • Removed CSS rules for capitalization of link (#371).

  • Fixed GROUP BY incompatibility with MySQL 5.7 (#236).

  • Fixed: Data type for “configuration” column in the ImportConfig table is now text (#319).

  • Fixed: Removes deprecated messages in PHP error reporting (#326 & #327).

  • Fixed: Removes PHP notice: Undefined index: http_lang in common/common_directory.php (#338 & #339).

  • Fixed: Statically called non-static methods in html class (#340 & #341).

  • Removed info.php calls (#295).

  • Fixed issue where French translations displayed incorrectly (#283).

  • Fixed undefined index notice (#358 & #359).

  • Fixed: Allows Organizations Issue class to represent Resources module Issue table (#337)

Resources Module

  • Fixed: “Report New Issue” will now correctly send an email notification to the contact. (#315)

  • Fixed: Workflow start for new resources created by AJAX form or API (#352).

  • Fixed: Create a default order when submitting a resource through the API in order for an acquisition type to attach to it (#345).

  • Fixed: Removed a test leftover in ajax_forms/getCostForm.php (#368).

  • Fixed: Button behavior when adding a step under admin when editing a workflow (#286).

  • Fixed: Allows Organizations Issue class to represent Resources module Issue table (#337)

  • Fixed: Fixed selected language displayed in language dropdown menu when language cookie is not set (#103, #403).

Management Module

  • Fixed: Corrected date format issue in “My Queue.” (#320)

Organizations Module

  • Fixed: PHP notices on Organizations index page (#356).

Usage Statistics Module

  • Fixed: SUSHI imports for DB1 did not support Activity Type (#401).

  • Fixed: SUSHI imports for JR1 incorrectly calculated sum total (#401).

  • Fixed: uploadConfirmation.php missing startDate and numMonths values when manually importing stats file causing the scripts in uploadComplete.php to incorrectly set the $multYear var to True (#328).

Installation

  • The installer now iterates through updates in sequence so it should result in fewer database conflicts during upgrades or installation.

  • Fixed: bugs around using a less privileged mysql user during installation.

  • Fixed: Empty $db_info issue during install process that resulted in error messages about “...denied from (#392).

  • Improved language used when asking for the user with database creation permissions to be more clear about what to expect (#392).

Known Issues

  • Not compatible with PHP 7.2 (Issue #360)
  • Not working with MySQL 5.7 (Issue #445). In order to use CORAL 3.0 with MySQL 5.7 you must disable the ONLY_FULL_GROUP_BY option in MySQL. See this answer on Stack Overflow for command line and phpMyAdmin instructions: https://stackoverflow.com/a/36033983/4100024.
Pre-release
Pre-release

@jeffnm jeffnm released this Jul 16, 2018 · 38 commits to master since this release

Assets 2

This is not a production ready release.

System Environment Requirements

  • PHP 5.5+ (Known issue: not compatible with PHP 7.2 at this time)
    • Required PHP extensions: mbstring, gettext, mysqlnd
  • MySQL 5.5 and 5.6
  • Apache 2.2 or above

Install or Upgrade

This is not a production ready release, but if you want to install it or test the upgrade process, the steps are as follows.

Installation

Installation is the same as for 2.0.1

  1. Download a copy of the 3.0 beta at Github.
  2. If you use the option to download the compressed zipped file, expand this file in a working folder.
  3. Copy the expanded folder to your webserver. If using Apache, this would be something like /var/www/html/ folder. If CORAL will be in a sub folder on your webserver, change the folder name from “Coral-master” to, for example, “coral” or another name you choose. The web installation depends upon the index.php file found in the coral folder. Your Apache settings should be set to include loading the index.php file.
  4. Go to the home directory via a web browser to initiate the install process and follow the onscreen instructions.

Upgrade

You should be able to upgrade to 3.0.0 beta either from 2.0 or from the final 1.x modules. It will simply upgrade you to 2.0 along the way, but you'll still end up with 3.0.0 beta.

  1. Make a fresh backup of your database and directory.
  2. Download a copy of the 3.0 beta at Github.
  3. If you use the option to download the compressed zipped file, expand this file in a working folder.
  4. Copy the contents of that expanded folder into your coral web root, which might be something like /var/www/html/coral depending on your configuration.
  5. Go to the root of your coral installation in a browser "your.coral-domain.org" and the upgrader should recognize that you are using an older version of CORAL and start the upgrade process. Follow the onscreen instructions.

New Features

General (all modules)

German translation. Thanks to BSZ - Abteilung Bibliothekssysteme for this contribution.

Resource Module

EBSCO Knowledge Base (KB) Integration

This feature allows EBSCO KB customers to search the EBSCO KB from within CORAL and import titles and packages into CORAL. Thanks to SirsiDynix for this contribution.

Import Tool Enhancements

Several enhancements have been added to the Import tool. This includes a preview of the import information before importing data into CORAL, an uploads history page to see the previously uploaded files, and a few new fields added to the import interface. Thanks to North Carolina State University and BibLibre for this contribution.

Resource Statistics and Yearly Costs Dashboards

The dashboard view allows users to view resource statistics by filtering them and grouping by resource type, subject or acquisition type, with sub-totals, and to export the data as CSV. Thanks to University Lyon 3 and BibLibre for this contribution.

CORAL/ILS Interaction: Vendors

This is an optional feature allowing to synchronize vendors between CORAL and an ILS. Thanks to BibLibre and ByWater Solutions for this contribution.

Multiple orders to any record in Resource module

A new “Order” panel was added to allow users add multiple orders to a resource record. For records with multiple orders, a dropdown list will appear beside the title. Users can also clone an existing order. Thanks to Biblibre and ByWater Solutions for this contribution.

Other features

  • Separate costs in export
  • Display child records in alphabetical order
  • Duplicate an existing workflow in Admin
  • Additional search fields including Publisher, Platform and Provider
  • Make the content area wider

API Enhancements

  • API_Client fundcode dropdown and general form style enhancements
    Changed the fund code field to a dropdown list. Added css style to the API form consistent with existing CORAL CSS style. Thanks to North Carolina State University for this contribution.

  • Add new routes to CORAL API
    Get resource by resource id, ISBN or ISSN, package’s titles, licenses and organization. Thanks to Biblibre for this contribution.

Bug Fixes

General (All Modules)

  • Allow modal popup to close with the “ESC” key. (#391 & #395)

  • Removed CSS rules for capitalization of link (#371).

  • Fixed GROUP BY incompatibility with MySQL 5.7 (#236).

  • Fixed: Data type for “configuration” column in the ImportConfig table is now text (#319).

  • Fixed: Removes deprecated messages in PHP error reporting (#326 & #327).

  • Fixed: Removes PHP notice: Undefined index: http_lang in common/common_directory.php (#338 & #339).

  • Fixed: Statically called non-static methods in html class (#340 & #341).

  • Removed info.php calls (#295).

  • Fixed issue where French translations displayed incorrectly (#283).

  • Fixed undefined index notice (#358 & #359).

  • Fixed: Allows Organizations Issue class to represent Resources module Issue table (#337)

Resources Module

  • Fixed: “Report New Issue” will now correctly send an email notification to the contact. (#315)

  • Fixed: Workflow start for new resources created by AJAX form or API (#352).

  • Fixed: Create a default order when submitting a resource through the API in order for an acquisition type to attach to it (#345).

  • Fixed: Removed a test leftover in ajax_forms/getCostForm.php (#368).

  • Fixed: Button behavior when adding a step under admin when editing a workflow (#286).

  • Fixed: Allows Organizations Issue class to represent Resources module Issue table (#337)

  • Fixed: Fixed selected language displayed in language dropdown menu when language cookie is not set (#103, #403).

Management Module

  • Fixed: Corrected date format issue in “My Queue.” (#320)

Organizations Module

  • Fixed: PHP notices on Organizations index page (#356).

Usage Statistics Module

  • Fixed: SUSHI imports for DB1 did not support Activity Type (#401).

  • Fixed: SUSHI imports for JR1 incorrectly calculated sum total (#401).

  • Fixed: uploadConfirmation.php missing startDate and numMonths values when manually importing stats file causing the scripts in uploadComplete.php to incorrectly set the $multYear var to True (#328).

Installation

  • The installer now iterates through updates in sequence so it should result in fewer database conflicts during upgrades or installation.

  • Fixed: bugs around using a less privileged mysql user during installation.

  • Fixed: Empty $db_info issue during install process that resulted in error messages about “...denied from (#392).

  • Improved language used when asking for the user with database creation permissions to be more clear about what to expect (#392).

Known Issues

  • Not compatible with PHP 7.2 (Issue #360)
  • Not working with MySQL 5.7 (Issue #445). In order to use CORAL 3.0 with MySQL 5.7 you must disable the ONLY_FULL_GROUP_BY option in MySQL. See this answer on Stack Overflow for command line and phpMyAdmin instructions: https://stackoverflow.com/a/36033983/4100024.

@t4k t4k released this Jun 8, 2017 · 363 commits to master since this release

Assets 2

Installation

If you need to update from the 2.0-beta, please run this https://github.com/Coral-erm/Coral/blob/development/resources/install/protected/2.0-beta-to-rc-manual.sql file against your resources database.

If you were already running 2.0-RC or 2.0.0 then your database should be up-to-date.

Fresh installations and upgrades from 1.x should follow the standard install documentation.

Release notes

Changes since 2.0.0

A bug was introduced in 2.0.0 since the 2.0-RC for the Resources Import Tool. This releases addresses that critical issue.

General 2.0 release notes

GENERAL (ALL MODULES)

Unified Installer and Upgrade Script

A unified installer for new installations, plus a new upgrade script for existing installations, has been contributed by Wheaton College. This is a significant structural change since previously each module had its own version and installation process. For installation instructions see http://docs.coral-erm.org/en/latest/install.html.

CSS Modifications

Thanks to contributions from SirsiDynix, this release features a thorough redo of CSS throughout CORAL which results in a fresher, more up-to-date look and feel.

Translations

With the help of BibLibre and SirsiDynix, CORAL is now available in English, French, and Chinese (Mandarin and Simplified) translations. Additional language translations can be readily added in the future.

Updated Documentation

New and updated documentation has been created for this release. This documentation comes with a quick search feature and is available via a help link in the header of each module. The new documentation has been migrated into Github and is available for community participation, development and interaction. See the following for more information on how to participate http://docs.coral-erm.org/en/latest/docstyleguide.html. This work has been coordinated and completed by members of the CORAL Web Committee.

Footer

The footer detail in each module is now consistent in terms of version, copyright statement, and links to the CORAL website and to report an issue.

RESOURCES MODULE

Import Funds/Create Funds

Another new feature from SirsiDynix is the ability to batch upload/create funds so that codes used in your ILS can readily be reused in CORAL. This is located in Admin tab > Funds. In addition, this release changes the Fund search option from a text field to a dropdown.

Enhancements to File Import

There is a much richer set of options for batch import of resource information including the ability within the Admin section to define import profiles, e.g. for KBART. Contributed by SirsiDynix.

Enhancements to Routing

North Carolina State University contributed a series of workflow enhancements in the Routing tab in this release. This includes the ability to restart and archive a completed workflow, display the archived workflows, add or delete a workflow step, re-assign a workflow step and send email reminders. The enhancements allow users to manage resource renewals and to empower users to customize a workflow associated with a resource.

API for Proposing New Resource

This is another contribution from North Carolina State University. The API allows users to submit a new resource to the Resource module via a client form.

Enhanced Cost History

New fields have been added to Cost History by BibLibre.

LICENSING MODULE

Import Licenses via ONIX-PL

CORAL allows you to import licenses via the ONIX for Publications Licenses (ONIX-PL) protocol, an XML format for the communication of license terms for digital publications. Contributed by SirsiDynix. For more details about ONIX-PL, see http://www.editeur.org/21/ONIX-PL/

@t4k t4k released this Jun 8, 2017 · 366 commits to master since this release

Assets 2

Installation

If you need to update from the 2.0-beta, please run this https://github.com/Coral-erm/Coral/blob/development/resources/install/protected/2.0-beta-to-rc-manual.sql file against your resources database.

Fresh installations and upgrades from 1.x should follow the standard install documentation.

Release notes

Changes since 2.0-RC

We’ve added a few code improvements and changed some language that was previously overlooked.

General 2.0 release notes

GENERAL (ALL MODULES)

Unified Installer and Upgrade Script

A unified installer for new installations, plus a new upgrade script for existing installations, has been contributed by Wheaton College. This is a significant structural change since previously each module had its own version and installation process. For installation instructions see http://docs.coral-erm.org/en/latest/install.html.

CSS Modifications

Thanks to contributions from SirsiDynix, this release features a thorough redo of CSS throughout CORAL which results in a fresher, more up-to-date look and feel.

Translations

With the help of BibLibre and SirsiDynix, CORAL is now available in English, French, and Chinese (Mandarin and Simplified) translations. Additional language translations can be readily added in the future.

Updated Documentation

New and updated documentation has been created for this release. This documentation comes with a quick search feature and is available via a help link in the header of each module. The new documentation has been migrated into Github and is available for community participation, development and interaction. See the following for more information on how to participate http://docs.coral-erm.org/en/latest/docstyleguide.html. This work has been coordinated and completed by members of the CORAL Web Committee.

Footer

The footer detail in each module is now consistent in terms of version, copyright statement, and links to the CORAL website and to report an issue.

RESOURCES MODULE

Import Funds/Create Funds

Another new feature from SirsiDynix is the ability to batch upload/create funds so that codes used in your ILS can readily be reused in CORAL. This is located in Admin tab > Funds. In addition, this release changes the Fund search option from a text field to a dropdown.

Enhancements to File Import

There is a much richer set of options for batch import of resource information including the ability within the Admin section to define import profiles, e.g. for KBART. Contributed by SirsiDynix.

Enhancements to Routing

North Carolina State University contributed a series of workflow enhancements in the Routing tab in this release. This includes the ability to restart and archive a completed workflow, display the archived workflows, add or delete a workflow step, re-assign a workflow step and send email reminders. The enhancements allow users to manage resource renewals and to empower users to customize a workflow associated with a resource.

API for Proposing New Resource

This is another contribution from North Carolina State University. The API allows users to submit a new resource to the Resource module via a client form.

Enhanced Cost History

New fields have been added to Cost History by BibLibre.

LICENSING MODULE

Import Licenses via ONIX-PL

CORAL allows you to import licenses via the ONIX for Publications Licenses (ONIX-PL) protocol, an XML format for the communication of license terms for digital publications. Contributed by SirsiDynix. For more details about ONIX-PL, see http://www.editeur.org/21/ONIX-PL/

@jeffnm jeffnm released this May 11, 2017 · 382 commits to master since this release

Assets 2

This is a CORAL 2.0 Release Candidate. This is a PRE-RELEASE, not intended for production. However, we believe it is very close to being a production release, and if no major bugs are found, it will be released as the production 2.0.0 release shortly.

Installation

If you need to update from the 2.0-beta, please run this https://github.com/Coral-erm/Coral/blob/development/resources/install/protected/2.0-beta-to-rc-manual.sql file against your resources database.

Fresh installations and upgrades from 1.x should follow the standard install documentation.

Release notes

Changes since 2.0-Beta

We've fixed a number of bugs and added a few missing Workflow components.

General 2.0 release notes

GENERAL (ALL MODULES)

Unified Installer and Upgrade Script

A unified installer for new installations, plus a new upgrade script for existing installations, has been contributed by Wheaton College. This is a significant structural change since previously each module had its own version and installation process. For installation instructions see http://docs.coral-erm.org/en/latest/install.html.

CSS Modifications

Thanks to contributions from SirsiDynix, this release features a thorough redo of CSS throughout CORAL which results in a fresher, more up-to-date look and feel.

Translations

With the help of BibLibre and SirsiDynix, CORAL is now available in English, French, and Chinese (Mandarin and Simplified) translations. Additional language translations can be readily added in the future.

Updated Documentation

New and updated documentation has been created for this release. This documentation comes with a quick search feature and is available via a help link in the header of each module. The new documentation has been migrated into Github and is available for community participation, development and interaction. See the following for more information on how to participate http://docs.coral-erm.org/en/latest/docstyleguide.html. This work has been coordinated and completed by members of the CORAL Web Committee.

Footer

The footer detail in each module is now consistent in terms of version, copyright statement, and links to the CORAL website and to report an issue.

RESOURCES MODULE

Import Funds/Create Funds

Another new feature from SirsiDynix is the ability to batch upload/create funds so that codes used in your ILS can readily be reused in CORAL. This is located in Admin tab > Funds. In addition, this release changes the Fund search option from a text field to a dropdown.

Enhancements to File Import

There is a much richer set of options for batch import of resource information including the ability within the Admin section to define import profiles, e.g. for KBART. Contributed by SirsiDynix.

Enhancements to Routing

North Carolina State University contributed a series of workflow enhancements in the Routing tab in this release. This includes the ability to restart and archive a completed workflow, display the archived workflows, add or delete a workflow step, re-assign a workflow step and send email reminders. The enhancements allow users to manage resource renewals and to empower users to customize a workflow associated with a resource.

API for Proposing New Resource

This is another contribution from North Carolina State University. The API allows users to submit a new resource to the Resource module via a client form.

Enhanced Cost History

New fields have been added to Cost History by BibLibre.

LICENSING MODULE

Import Licenses via ONIX-PL

CORAL allows you to import licenses via the ONIX for Publications Licenses (ONIX-PL) protocol, an XML format for the communication of license terms for digital publications. Contributed by SirsiDynix. For more details about ONIX-PL, see http://www.editeur.org/21/ONIX-PL/

Pre-release

@jeffnm jeffnm released this Feb 22, 2017 · 507 commits to development since this release

Assets 2

This is a beta of the CORAL 2.0 software. It is not intended for production use.

For information on what is included, see the release notes below.
To install it please view the installation documentation. Please note that if you are upgrading an existing installation you must have the most recent 1.x version of each module already installed.

Please report any issues you encounter when testing this beta version.

CORAL 2.0 Beta Release Notes

GENERAL (ALL MODULES)

Unified Installer and Upgrade Script

A unified installer for new installations, plus a new upgrade script for existing installations, has been contributed by Wheaton College. This is a significant structural change since previously each module had its own version and installation process. For installation instructions see http://docs.coral-erm.org/en/latest/install.html.

CSS Modifications

Thanks to contributions from SirsiDynix, this release features a thorough redo of CSS throughout CORAL which results in a fresher, more up-to-date look and feel.

Translations

With the help of BibLibre and SirsiDynix, CORAL is now available in English, French, and Chinese (Mandarin and Simplified) translations. Additional language translations can be readily added in the future.

Updated Documentation

New and updated documentation has been created for this release. This documentation comes with a quick search feature and is available via a help link in the header of each module. The new documentation has been migrated into Github and is available for community participation, development and interaction. See the following for more information on how to participate http://docs.coral-erm.org/en/latest/docstyleguide.html. This work has been coordinated and completed by members of the CORAL Web Committee.

Footer

The footer detail in each module is now consistent in terms of version, copyright statement, and links to the CORAL website and to report an issue.

RESOURCES MODULE

Import Funds/Create Funds

Another new feature from SirsiDynix is the ability to batch upload/create funds so that codes used in your ILS can readily be reused in CORAL. This is located in Admin tab > Funds. In addition, this release changes the Fund search option from a text field to a dropdown.

Enhancements to File Import

There is a much richer set of options for batch import of resource information including the ability within the Admin section to define import profiles, e.g. for KBART. Contributed by SirsiDynix.

Enhancements to Routing

North Carolina State University contributed a series of workflow enhancements in the Routing tab in this release. This includes the ability to restart and archive a completed workflow, display the archived workflows, add or delete a workflow step, re-assign a workflow step and send email reminders. The enhancements allow users to manage resource renewals and to empower users to customize a workflow associated with a resource.

API for Proposing New Resource

This is another contribution from North Carolina State University. The API allows users to submit a new resource to the Resource module via a client form.

Enhanced Cost History

New fields have been added to Cost History by BibLibre.

LICENSING MODULE

Import Licenses via ONIX-PL

CORAL allows you to import licenses via the ONIX for Publications Licenses (ONIX-PL) protocol, an XML format for the communication of license terms for digital publications. Contributed by SirsiDynix. For more details about ONIX-PL, see http://www.editeur.org/21/ONIX-PL/