diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c581f6d --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: "source/conf.py" + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "html" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: requirements.txt diff --git a/.yaml b/.yaml new file mode 100644 index 0000000..9423595 --- /dev/null +++ b/.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: source/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/build/html/_sources/technical.txt b/build/html/_sources/technical.txt index 1d378fe..29d109b 100644 --- a/build/html/_sources/technical.txt +++ b/build/html/_sources/technical.txt @@ -15,7 +15,7 @@ delete privileges only (no create table privileges). This “coral” user shou The CORAL modules are heavily data-driven. As a result we have provided an initial “snapshot” of our data which will be inserted when the MySQL tables are created. Most of this data may be edited through the front-end if desired – refer to the user guide for more information. -For data models and the MySQL Workbench file, refer to http://coral-erm.org/documentation +For data models and the MySQL Workbench file, refer to https://coral-erm.org/documentation #### Server-side scripting @@ -134,7 +134,7 @@ suffix Installation can occur in one of two ways – either through the web installation script or manually. Web installation will provide advantages over manual installation because it will check MySQL privileges and PHP version. -When you first [download the scripts](http://coral-erm.org/download), it is recommended to place each one into a parent `/coral/` directory if your server is sharing space with other applications. This is optional but it helps group all of the coral applications together. +When you first [download the scripts](https://coral-erm.org/download), it is recommended to place each one into a parent `/coral/` directory if your server is sharing space with other applications. This is optional but it helps group all of the coral applications together. For example you may have: ``` @@ -315,7 +315,7 @@ where they appear but leave the format alone. ### Upgrades Upgrades to CORAL will be announced through the CORAL ERM Listserv. If you wish to be added, please -consult http://coral-erm.org or email coral-admin@listserv.nd.edu directly. +consult https://coral-erm.org or email coral-admin@listserv.nd.edu directly. In general, small upgrades with simple coding changes will not be given their own version numbers. If an institution notifies us about a bug we will let them know directly when the bug fix is available. diff --git a/build/html/index.html b/build/html/index.html index 878b6a0..9afa507 100644 --- a/build/html/index.html +++ b/build/html/index.html @@ -6,7 +6,7 @@ - CORAL Documentation Project — coral_documentation_project 0.0.1 documentation + CORAL Documentation Project — Coral Documentation Project 0.0.1 documentation @@ -25,7 +25,7 @@ - + @@ -353,4 +353,4 @@

Quick search

- \ No newline at end of file + diff --git a/build/html/technical.html b/build/html/technical.html index 3f12f5d..01829b4 100644 --- a/build/html/technical.html +++ b/build/html/technical.html @@ -61,7 +61,7 @@

The CORAL modules are heavily data-driven. As a result we have provided an initial “snapshot” of our data which will be inserted when the MySQL tables are created. Most of this data may be edited through the front-end if desired – refer to the user guide for more information. -For data models and the MySQL Workbench file, refer to http://coral-erm.org/documentation

+For data models and the MySQL Workbench file, refer to https://coral-erm.org/documentation

Server-side scripting

@@ -184,7 +184,7 @@

Installation

Installation can occur in one of two ways – either through the web installation script or manually. Web installation will provide advantages over manual installation because it will check MySQL privileges and PHP version.

-

When you first download the scripts, it is recommended to place each one into a parent /coral/ directory if your server is sharing space with other applications. This is optional but it helps group all of the coral applications together.

+

When you first download the scripts, it is recommended to place each one into a parent /coral/ directory if your server is sharing space with other applications. This is optional but it helps group all of the coral applications together.

For example you may have:

/coral/resources/
 /coral/licensing/
@@ -345,7 +345,7 @@
 

Upgrades

Upgrades to CORAL will be announced through the CORAL ERM Listserv. If you wish to be added, please -consult http://coral-erm.org or email coral-admin@listserv.nd.edu directly.

+consult https://coral-erm.org or email coral-admin@listserv.nd.edu directly.

In general, small upgrades with simple coding changes will not be given their own version numbers. If an institution notifies us about a bug we will let them know directly when the bug fix is available.Versioning will happen when there is a database structure change or configuration file change.

When performing upgrades your configuration file (/admin/configuration.ini) should always be backed diff --git a/desktop.ini b/desktop.ini new file mode 100644 index 0000000..d957fd1 --- /dev/null +++ b/desktop.ini @@ -0,0 +1,4 @@ +[ViewState] +Mode= +Vid= +FolderType=Generic diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e07e255 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +sphinx>=4.0.0 +recommonmark>=0.7.1 +docutils<0.18 diff --git a/source/api.md b/source/api.md new file mode 100644 index 0000000..e0ea4ff --- /dev/null +++ b/source/api.md @@ -0,0 +1,46 @@ +## Propose New Resource API + +This API allows users to submit a new resource order request to CORAL Resource module via a client form. + +### The API and the Client Form +The API is based on [Flight](http://flightphp.com/), a simple and extensible framework for PHP. + +![Screenshot of API Client Form](img/api/apiClientForm.png) + +This is a sample of a client form, which is based on [unirest]( http://unirest.io/php.html ). Users can enter resource information in the form. This includes basic information about the resource including Title, Description, Provider, ISBN/ISSN, URL and information about the order such as fund code and cost. For Format, Acquisition Type, Resource Type, and Fund code, the data showing on the form are populated from the data predefined in Coral Admin tab. Data entered here are mapped to fields in CORAL Resources. Other fields without a matching CORAL field are loaded into CORAL as general notes. If a specific note type is created in CORAL, they can be mapped to the desired note type. + +Once submitted, a report is presented with a summary of the fields. A new resource record is created automatically in CORAL Resource module. If data entered in Format, Acquisition Type and Resource Type match with what determine a workflow, the workflow is triggered once the record is submitted via the client form. + +### API Configuration + +#### Server-side: + +Edit resources/admin/configuration.ini and fill apiAuthorizedIP with the IP address of the client accessing the API: +apiAuthorizedIP="192.168.1.1" + +You can set multiple IPs (comma-separated): +apiAuthorizedIP="192.168.1.1,192.168.2" + +You can also set incomplete IPs so the whole range will be allowed: +apiAuthorizedIP="192.168.1" +(will authorize all IPs from 192.168.1.1 to 192.168.1.255) + +If you are trying to test the example form and it is on the same machine as Coral, 127.0.0.1 should work. + +Hint: if you don't know which IP address will be requesting the API, just leave apiAuthorizedIP blank (apiAuthorizedIP="") and access the example form with your browser (http://yourcoral.tld/resources/api_client/ ), you will get an error like this: +You are not authorized to use this service. +Unauthorized IP: 127.0.0.1 + +#### Client-side: + +Edit api_client/index.php and set the $server variable: +$server = "http://yourcoral.tld/resources/api/"; + +### Install Composer, Flight and Unirest +In addition, you'll need to install Composer, Flight and Unirest. Install Composer, then run the "php computer.phar install" command from inside the [CORAL BASE DIR]/resources/api/directory. This will bring in and manage the Flight dependency for you. + +Then navigate to [CORAL BASE DIR]/resources/api_client/ and run the ‘php composer.phar install’ command again. This will bring in and manage the Unirest dependency for you. Check out [https://packagist.org/](https://packagist.org/) for instruction on getting Composer installed. The exact composer install command might be slightly different depending on which Composer install option you choose. + +Note that the Acquisition Type is hardcoded to show two options Approved and Need Approval. This can be customized to show desired acquisition types by modifying index.php (in the api_client folder). Users can either edit line 330 or remove line 330 and line 334. See the code in the screenshot below. + +![Screenshot of API Client IndexPHP File](img/api/apiClientIndexphp.png) diff --git a/source/conf.py b/source/conf.py index a902d46..5652fda 100644 --- a/source/conf.py +++ b/source/conf.py @@ -357,3 +357,18 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. # # texinfo_no_detailmenu = False + +# -- Additional Settings recommended by ReadtheDocs in July 16th Email ------------------------ +import os + +# Set canonical URL from the Read the Docs Domain +html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") + +# Initialize html_context? +html_context = {} + +# Tell Jinja2 templates the build is running on Read the Docs +if os.environ.get("READTHEDOCS", "") == "True": + html_context["READTHEDOCS"] = True + + diff --git a/source/dashboards.md b/source/dashboards.md new file mode 100644 index 0000000..374ec97 --- /dev/null +++ b/source/dashboards.md @@ -0,0 +1,36 @@ +Dashboards User Guide +--------------------------------- + +### About CORAL Resources Dashboards + +![Screenshot of Dashboards Home Menu](img/dashboards/dashboardsHomeMenu.PNG) + +The CORAL dashboards provide a quick overview of resource and cost info. + +Note: Enhanced Cost history must be enabled to use Dashboards in CORAL. See [Additional Server Configuration](http://docs.coral-erm.org/en/latest/manual.html#additional-server-configuration) + +### Statistics Dashboard + +![Screenshot of Dashboards Statistics](img/dashboards/dashboardsStatistics.PNG) + +Dashboards Statistics allows for a quick display of your Resources data by Resource Type, Subject, Acquisition Type, Order Type, Cost Details, and Year. You can also Group By: Resource, Resource Type, Subject, and Acquisition Type. Once your criteria has been selected click Display to view your results or Export to export your results. + +![Screenshot of Dashboards Statistics Results](img/dashboards/dashboardsStatisticsResults.PNG) + +### Yearly Costs Dashboard + +![Screenshot of Dashboards Yearly Cost](img/dashboards/dashboardsYearlyCost.PNG) + +Yearly Costs allows for a quick display of your Resources data by Resource Type, Subject, Acquisition Type, Order Type, Cost Details, and Year Start and end dates. You can also Group By: Resource, Resource Type, Subject, and Acquisition Type, Organization and Fund. You can also view total sum for all cost details. Once your criteria has been selected click Display to view your results or Export to export your results. + +![Screenshot of Dashboards Yearly Cost](img/dashboards/dashboardsYearlyCostResults.PNG) + + + + + + + + + + diff --git a/source/docstyleguide.md b/source/docstyleguide.md index 8b23f7e..5d6e112 100644 --- a/source/docstyleguide.md +++ b/source/docstyleguide.md @@ -1,17 +1,27 @@ -CORAL Documentation Style Guide +git CORAL Documentation Style Guide ------------------------------- ### About the Style Guide ### The purpose of the style guide is to help keep the documentation consistent in style while at the same time providing tips for contributing to the CORAL Documentation Project (CDP) and other relevant information. +### Helping Out + +The CDP is a great way to participate in a small or big way as time allows. Take something in the documentation that you would like to improve and help out, whether it is editing, adding new content, or just sharing a tip. All the information needed to get started is found below. When finished you will need to submit a pull request in GitHub for any changes. The Web Committee will review these pull requests and merge them into the documentation as they are approved. For any suggestions or questions about helping out, please email us at [help@coral-erm.org](mailto:help@coral-erm.org). + ### Setting Up ### The CDP is managed in a repo on GitHub found at [https://github.com/Coral-erm -](https://github.com/Coral-erm "https://github.com/Coral-erm "). The project uses the [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/) and [ReCommonMark](http://recommonmark.readthedocs.io/en/latest/). The documentation files are edited in a combination of [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and [Markdown](https://en.wikipedia.org/wiki/Markdown), both markup languages supported by GitHub. In addition, [Read the Docs](https://readthedocs.org/) is used for hosting the documentation and providing additional documentation conversion and indexing tools. +](https://github.com/Coral-erm "https://github.com/Coral-erm "). The project uses the [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/) and [ReCommonMark](http://recommonmark.readthedocs.io/en/latest/). The documentation files are edited in a combination of [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and [Markdown](https://en.wikipedia.org/wiki/Markdown), both markup languages supported by GitHub. In addition, [Read the Docs](https://readthedocs.org/) is used for hosting the documentation and providing additional documentation conversion and indexing tools. + +### Editing Markdown + +There are a lot of great resources online about Markdown, but to get started you may want to use a Markdown editor. There are many available free, but the best one for you will depend on your operating system. One suggestion for Microsoft Windows would be [MarkdownPad](http://markdownpad.com/). ### Basic Instructions on Getting Started with GitHub +Note: For first times users you will need to have a GitHub account. To create an account, go to [https://github.com](https://github.com). You will also need to install some type of GitHub client software on your PC. For the instructions below, we are using Git for Windows. You can download Git for Windows at [https://git-scm.com](https://git-scm.com). + **Git and Github Documentation Workflow Procedures** *Note: Except as noted the following instructions are for Microsoft Windows using the command line prompt. * @@ -36,9 +46,9 @@ Running this command will do a few things including identifying what github acco 7. You should now be in the master branch of the repo. You can use **`git status`** to see what branch is currently selected. You could make changes to the master branch, but when you copy these changes back to github you would be directly merging your changes into the master branch of the repo. Instead what you want to do is create a branch of the master version, so that later on when you copy your changes back to github, you have to go through another step, in github lingo a "push request," to request that your changes be merged into the master branch. This allows for you to make sure you don’t inadvertently write over another person’s changes in the master branch. Use the following command to create a new branch from the master. Command: **`git checkout –b `** (If the branch name already exists use **`git checkout `**). You can now start making changes to your files. Feel free to do this by commandline or gui. For us we are going to use Windows Explorer to navigate to the following folder. Taking our example earlier. **`C:\Work\Documentation\Source`** -You will notice that there are two folders under Documentation. Build and Source. You will be working primarily with the Source. This is where the individual files for the documentation are to found. There are two files types of importance: .md = Markdown files and .rst = Restructured Files. Restructured Files are Python files used by the Sphinx Documentation Generator. We are using only one of these files at this time. This file is being used primarily to create our Table of Contents structure. For now, you will be editing primarily the Markdown files. Use the recommended MarkPad 2 for Windows application to open the files. +You will notice that there are two folders under Documentation. Build and Source. Most users will be working exclusively with the Source. This is where the individual files for the documentation are to found. There are two files types of importance: .md = Markdown files and .rst = Restructured Files. Restructured Files are Python files used by the Sphinx Documentation Generator. We are using only one of these files at this time. This file is being used primarily to create our Table of Contents structure. For now, you will be editing primarily the Markdown files. If using Microsoft Windows, you can use the recommended MarkPad 2 for Windows application to open the files. -8. Make whatever edits you need to the Markdown files and be sure to save your changes. Be sure to save your changes. Once finished you are now ready to build your HTML files from your Markdown files. +8. Make whatever edits you need to the Markdown files and be sure to save your changes. 9. Go back to your command line and change your working directory to the following. For our example, **`C:\Work\Documentation`** @@ -60,11 +70,33 @@ The command **`git push` **will work alone when you have an established connecti 17. You should receive the message "This branch has no conflicts with the base branch." If so, and you have permission to do so, go ahead and select the green “Merge pull request” button to merge your changes into the master. Other options here include adding a comment or closing the pull request. -Note: If you are more comfortable having someone else merge the code, feel free to request this via the comment field. Likewise, admin rights are required to merge the pull request. Only members on the Web Committee and Steering Committee will be granted these rights, so in this case outside parties submitting a pull request will require someone on our committee to review, approve, and merge. +Note: Admin rights are required to merge the pull request. Only members on the Web Committee and Steering Committee have these rights, so in this case outside parties submitting a pull request will require someone on our committee to review, approve, and merge the changes. 18. After clicking on the "Merge pull request" button click the “Confirm merge” button. You should receive the message “Pull request successfully merged and closed.” Go ahead and delete your branch by pushing the “Delete branch” button. Doing this will keep your workflow cleaner. Likewise, creating a new branch when needed will keep your working files closer to the master branch. Once you have committed your changes they will be updated in generally less than a minute at [http://docs.coral-erm.org/](http://docs.coral-erm.org/). If changes don’t appear right away, try refreshing the cache in your browser. -19. You have finished the process of cloning the repo, creating a branch, making updates to the source files, committing the changes in your new branch to the repo, and finally merging those changes into the master branch. +19. You have finished the process of cloning the repo, creating a branch, making updates to the source files, committing the changes in your new branch to the repo, and finally merging those changes into the master branch. + +### Updating Documentation Versions + +Follow instructions from "Basic Instructions on Getting Started with Github" with the following differences. + +To preserve a version of the documentation a branch repo has been created for that version. You will want to clone that branch repo instead of the master repo. + +For example use the following git command to clone the branch: + +**`git clone -b v2.0.1-Documentation -single-branch https://github.com/coral-erm/Documentation.git`** + +Change the branch name, make your edits and use the git add, commit, and push commands as described under the "Basic Instructions..." + +Use the following git push format: + +**`git push https://github.com/coral-erm/Documentation `** + +Once your new branch has been committed and pushed to Github be sure to setup the pull request to merge your branch into the version branch originally cloned. + +### Updating the Table of Contents Structure (TOC) + + ### File Structure and File Naming Conventions ### diff --git a/source/ebscokb.md b/source/ebscokb.md new file mode 100644 index 0000000..2b694d1 --- /dev/null +++ b/source/ebscokb.md @@ -0,0 +1,253 @@ +Using EBSCO's Knowledge Base with CORAL +--------------------------------- + +### About CORAL and EBSCO's Knowledge Base Integration (HoldingsIQ) + +EBSCO offers a subscription service called HoldingsIQ for libraries that want to use the EBSCO Knowledge Base(EBSCO KB) to manage their holdings and linking information. Integrating the EBSCO KB enables your library to search the EBSCO KB for titles, packages, and vendors within CORAL, as well as import titles and packages directly into CORAL. When you import titles or packages from EBSCO, CORAL automatically creates resources along with their titles, descriptions, access URLs, resource identifiers, subjects, and coverage dates. After you set up the integration, you can access CORAL's EBSCO KB feature. + +Please note that EBSCO does not permit the importing of over 10,000 records at one time. Attempting to import 10,000 or more records may cause a time-out or other error. Also, the current implementation of CORAL does not support the ability to update holdings information from within CORAL. + +Before you set up your integration and start importing information from the EBSCO KB, you should familiarize yourself with the terminology that EBSCO uses. The EBSCO KB uses the following three data types: + +- **Titles**—Titles are synonymous with CORAL resources. When you import a title from the EBSCO KB, the title is stored in CORAL as a resource. A title might be a journal, book, or even a service such as the EBSCO Discovery Service. + +- **Packages**—Packages are collections of titles in the EBSCO KB. When you import a package from the EBSCO KB, the package is stored in CORAL as a parent resource for all of the titles it contains. An example package is JSTOR Arts and Sciences I Archive Collection. + +- **Vendors**—Vendors are synonymous with CORAL organizations. When you import a title or package, the associated vendor is assigned to the resources that CORAL creates as an organization with the provider relationship. + + +### Setting up the EBSCO KB + +Before you can integrate the EBSCO KB, your library must have an EBSCO Customer ID and have subscribed to HoldingsIQ. If you have an EBSCO account and Customer ID but you do not have a HoldingsIQ key, you can [request an API Key Information](https://developer.ebsco.com/signup) from EBSCO. + +Once you’ve received your API key, continue with the following steps to set up your EBSCO KB integration with CORAL: + +1. From any page in the Resources module, click Admin from the top menu. +2. From the Admin page, select the EBSCO KB Config tab. +3. Select the Enable EBSCO Knowledge Base checkbox. +4. Enter your Customer ID and API Key. +5. Click Save. + +After you have finished, an EBSCO KB option will display in the primary navigation menu (the blue bar at the top) of each page in the Resources module. Click this link to search the EBSCO KB. + +### Searching the EBSCO KB + +Once you’ve set up the integration, you can search the EBSCO KB for titles, packages, and vendors. + +![Screenshot of EBSCO KB Home Page](img/ebscokb/ebscokbHome.PNG) + +#### To search for titles in the EBSCO KB + +1. From any page in the Resources module, click EBSCO Kb from the top menu. +2. Select Titles from the Search For drop-down list. +3. Select either Title Name, Publisher, ISXN (ISBN or ISSN), or Subject, depending on the search field that you want to search by. +4. Type your search terms in the contains field. +5. Select which titles from the EBSCO KB you want to search from the Selection drop-down list. You can choose one of the following options: + + **All**—Searches all titles from the EBSCO KB. + + **Selected in EBSCO KB**—Searches only the titles that are selected in your EBSCO holdings instance. + + **Not Selected**—Searches only the titles that are not selected in your EBSCO holdings instance. + + **Ordered through EBSCO**—Searches only the titles that are selected in your EBSCO holdings instance and were purchased through EBSCO. + +6. Select the types of titles (e.g. Book Series or Newsletter) that you want to limit your search to from the Resource Type drop-down list. +7. Click Go!. + +![Screenshot of title search in EBSCO KB](img/ebscokb/ebscokbTitleSearch.PNG) + + + +After your search results are displayed, you can view the details for titles and import them into CORAL. + +#### To search for packages in the EBSCO KB + +1. From any page in the Resources module, click EBSCO KB from the top menu. +2. Select Packages from the Search For drop-down list. +3. Type your search terms in the Name field. +4. Select which packages from the EBSCO KB you want to search from the Selection drop-down list. You can choose one of the following options: + + **All**—Searches all packages from the EBSCO KB. + + **Selected in EBSCO KB**—Searches only the packages that are selected in your EBSCO holdings instance. + + **Not Selected**—Searches only the packages that are not selected in your EBSCO holdings instance. + + **Ordered through EBSCO**—Searches only the packages that are selected in your EBSCO holdings instance and were purchased through EBSCO. + +5. Select the types of packages (e.g. Print or Aggregated Full Text) that you want to limit your search to from the Content Type drop-down list. +6. Click Go!. + +![Screenshot of package search in EBSCO KB](img/ebscokb/ebscokbPackageSearch.PNG) + +After your search results are displayed, you can view the details for packages and import them into CORAL. + + +#### To search for vendors in the EBSCO KB + +1. From any page in the Resources module, click EBSCO KB from the top menu. +2. Select Vendors from the Search For drop-down list. +3. Type your search terms in the Name field. +4. Click Go!. + +![Screenshot of vendor search in EBSCO KB](img/ebscokb/ebscokbVendorSearch.PNG) + +After your search results are displayed, you can view the packages associated with a vendor and then import an entire package or individual titles from a package. + +![Screenshot of vendor search results in EBSCO KB](img/ebscokb/ebscokbVendorPackageResults.PNG) + +### Importing titles from the EBSCO KB + +You can import titles that you have found using the EBSCO KB search. When you import titles from EBSCO, CORAL automatically creates resource records with all of the relevant metadata, including the following fields: + + + +- Title + + +- Description + + +- ISSNs or ISBNs + + +- Subjects + + +- Resource Type + + +- URLs + +Note: If a title has more than two URLs, any additional URLs will be added to an access note for the resource. Additionally, the primary and alternate URL will be programmatically selected based on the URL's recency (newer URLs are preferred), length of embargo period (shorter periods are preferred), and coverage (longer coverage periods are preferred). + +Coverage dates and embargo periods +EBSCO KB ID (allows subsequent imports to update the resource information rather than creating a new resource) + +#### To import titles from the EBSCO KB + +1. Do one of the following: + + a. From the list of EBSCO KB search results, find the title you want to import and click Import. + + b. From an EBSCO title's details, click Import. + +2. Type the name of the organization that will be the Provider for the resource that CORAL creates. + +![Screenshot of title import for EBSCO KB](img/ebscokb/ebscokbImportTitle.PNG) + +3. Select a **Format** and **Acquisition Type**. +4. Add any notes, as necessary. +5. Click Submit. + +Note: Once you have submitted a resource, you can track its progress in the Submitted Requests tab on the My Queue page. Submitted resources also display in the resources list on the Home page with a status of In Progress. + +### Importing packages from the EBSCO KB + +You can import packages that you have found using the EBSCO KB search. When you import packages from EBSCO, you decide what information is imported into CORAL. By default, when you import a package, CORAL creates the following: + + +- A new resource containing the package's information. + +- A new resource for each selected title within the package. Each new resource is linked as a child resource of the package. + +Note: CORAL also imports each title's relevant metadata when it creates these resources. + + +- A new organization that is associated with each resource. By default, this organization is based on the EBSCO vendor. + + +- The EBSCO KB ID (allows subsequent imports to update the resource information rather than creating a new resource). + +#### Overview of Fields: Importing packages from the EBSCO KB + +Overview of metadata available for package imports. + +**Provider** + +Specifies the organization that CORAL should associate with the resource that is created for this package. If an organization already exists in CORAL with the same name as the EBSCO vendor associated with the package, CORAL displays the name of the matching organization. If CORAL did not find any matching organization, then you can select one of the following options to specify a Provider instead: + + +- Import—Creates a new organization in CORAL using the name of the EBSCO vendor associated with the package. + +- Alias—Creates an alias for an existing organization using the name of the EBSCO vendor associated with the package. + +- Override—Lets you specify an existing organization to use and ignores any of the vendor information from EBSCO Kb. + +- Parent or Child—Creates a new organization in CORAL and associates the new organization with an existing organization as a parent or child relationship (depending on your selection). + +**Package Titles** + +Specifies which title information should be imported. A note displays how many titles within the package your library has associated with its EBSCO holdings instance. You can select the following options: + +- Selected titles only—Creates a new resource for each title within the package that is associated with your library’s EBSCO account. + +- No titles—Creates a new resource for the package, but does not import any title information. + +- All titles—Creates a new resource for each title within the package, including any titles that are not selected in Full Text Finder. + +**Workflow Options** + +Specifies whether a new workflow should be made for only the package, or for the package and each title the package contains. + +**Format** + +Specifies the Format that should be associated with the resources that CORAL creates while importing this package and its titles. You can configure the Resource Formats that are available in your system on the Resources module Admin page. + +**Acquisition Type** + +Specifies the Acquisition Type that should be associated with the resources that CORAL creates while importing this package and its titles. You can configure the Acquisition Types that are available in your system on the Resources module Admin page. + +**Package Resource Type** + +Specifies the Resource Type that should be associated with the resource that CORAL creates for this package. This setting does not affect the Resource Type associated with the package's titles because CORAL automatically imports the Resource Type for any resource that it creates from a package's titles. You can configure the Resource Types that are available in your system on the Resources module Admin page. + + +#### To import packages from the EBSCO KB + +1. From the list of EBSCO Kb search results, find the package you want to import and click Import. +2. Select the import options that you want, then click Import. + +![Screenshot of package import for EBSCO KB](img/ebscokb/ebscokbImportPackage.PNG) + +After you start an import, a progress tracker displays. For large imports (greater than 1000 records) this process can take several minutes. If CORAL encounters any errors during the import, the title name and EBSCO KB ID are displayed for each title that had an error. You can use this information to import those titles individually, or you can re-import the package and its titles again. + + +#### Searching for EBSCO Packages in CORAL and Updates to EBSCO KB + +Select Packages from the dropdown menu. Searching by a package name is currently the only option, but results can be filtered by Selection and Content type. + +Once the search is initiated, a list of matching packages will appear containing the following details: + +1. Name - containing the package name with vendor in parenthesis. +2. Title Count - The number of EBSCO KB titles associated with the package with the number selected by your library appearing in parenthesis. +3. Content Type - The content type of the package. +4. Current Status - The status of the package in CORAL. +5. Current Holdings - The holdings from EBSCO KB. + +#### Package Statuses +The package status indicates the relationship of the package between EBSCO KB and CORAL. There are four possible statuses. + +Not Selected & Not Imported. The table cell will be blank, indicating that the package is not selected in EBSCO KB and has no corresponding CORAL Resource record. + +Not Selected & Imported. The table cell will have a delete symbol and a “Delete from CORAL” message. This indicates that the package is not selected in EBSCO KB, but has a corresponding Coral Resource record. Clicking on “Delete from CORAL” will present the option to delete the CORAL Resource and all child records (if applicable). + +Selected & Not Imported. The table cell will have a warning symbol and a “Import Package” message. This indicates that the package is selected in EBSCO KB, but does not have a corresponding Coral Resource record. Clicking on “Import Package” will start the import package process (see below). + +Selected & Imported. The table cell with have a check mark and a “View in CORAL” message. This indicates that the package is selected in EBSCO KB and has a corresponding Coral Resource record. Clicking on “View in CORAL” will take you to the Resource page. + +#### Package Holdings +The package holdings allow you to make changes in EBSCO KB. Clicking on the button will present you will options to toggle the package’s status and import or delete the package from CORAL (if it has been imported). +For packages that are Not Selected, you can either select the package and, if the package doesn’t not have a Resource record in CORAL, import the package. +Note: Selecting a package will select it and ALL of its titles. For a-la-carte title selection, click on View Titles and see information about title holdings below. + +For packages that are Selected, you can either deselect the package, and if the package has a corresponding Resource record in CORAL, delete the record. +Note: Deselecting a package will deselect it and ALL of its titles. + +![Screenshot of holdings update for EBSCO KB](img/ebscokb/ebscokbPackageHoldingsUpdatekb.PNG) + + + + + diff --git a/source/export.md b/source/export.md new file mode 100644 index 0000000..3661538 --- /dev/null +++ b/source/export.md @@ -0,0 +1,148 @@ +Exporting in CORAL +--------------------------------- + +The export feature allows users to retrieve data from the Resources module in CSV (spreadsheet) format. + +### How to Export Resources + +To export resources, click the green Excel icon on the right side of the screen, under the Change Module menu. + +![Screenshot of Resources module with Export button](img/export/exportButton.PNG) + +Note: If your Resources module has a lot of records, you may need to wait for the file to be prepared. + +A dialogue box will appear asking where you want to save the file, which will be named `resources_export_today's_date.csv`. Choose a folder and click Save. + +You can then open the file on your computer using Excel, OpenOffice, Google Sheets, or another spreadsheet program. + +![Screenshot of Resources data in Excel](img/export/exportResult.PNG) + +Note: If there are multiple values in a field, they will be separated by a semicolon and a space. + +### Exported Fields + +- Resource ID: The unique identifier of each resource record. + +- Date Created + +- User Created: The name of the user who created the record. + +- Date Updated: The date of the last update to the record. + +- User Updated: The name of the user who last updated the record. + +- Status: Whether the resource record is In Progress or Complete. + +*Product Tab:* + +- Name: The title of the resource. + +- Type + +- Format + +- ISSN/ISBN + +- Resource URL + +- Alt URL + +- Organizations + +- Aliases + +- Parent Resource: The name of any linked parent resource record. + +- Child Record: The name of any linked child resource records. + +*Orders Tab:* + +- Order Type + +- Acquisition Type + +- Order Number + +- System Number + +- Purchasing Sites + +- Subscription Alert Enabled + +*Acquisitions Tab:* + +- Sub Start + +- Current Sub End + +- Year + +- Fund Name + +- Fund Code + +- Tax Excluded + +- Rate + +- Tax Included + +- Payment + +- Currency + +- Details: Cost details. + +- Cost Note + +- Invoice + +- License Names + +- License Status + +*Access Tab:* + +- Authorized Sites + +- Administering Sites + +- Authentication Type + +- Access Method + +- Storage Location + +- Simultaneous User Limit + +- Coverage + +- Username + +- Password + +*Cataloging Tab:* + +- Cataloging Type + +- Cataloging Status + +- Catalog Record Set Identifier + +- Catalog Record Source URL + +- Catalog Records Available + +- Catalog Records Loaded + +- OCLC Holdings Updated + +Fields currently missing from the list above: + +- Organization Role + +- Description + +- Alias Type + +Not currently exported are fields inherited from other modules that appear in the Contacts and Accounts tabs. Nor are issues, attachments, or workflows exported. diff --git a/source/faq.md b/source/faq.md index c5bdb07..5facafc 100644 --- a/source/faq.md +++ b/source/faq.md @@ -5,9 +5,9 @@ FAQ **Restarting Workflows** -Question: My intention was to set up a workflow for renewals that could be completed and then restarted the next year. We’ve been able to set up and successfully use a workflow for this, but I don’t see any way to begin it again in subsequent years. Am I missing something or are the workflows only set up to be once and done? +**Question:** My intention was to set up a workflow for renewals that could be completed and then restarted the next year. We’ve been able to set up and successfully use a workflow for this, but I don’t see any way to begin it again in subsequent years. Am I missing something or are the workflows only set up to be once and done? -Answer: This is a known difference between how the system was designed and how many people are using it. +**Answer:** This is a known difference between how the system was designed and how many people are using it. Two workarounds: @@ -19,6 +19,46 @@ Second, there is the non-technical way: Until the last step in your workflow has ### Installation +**Question:** Why am I getting the following series of "Notice" messages or warnings when I install CORAL? + +For example: + +> -- Notice: Undefined index: orderBy in C:\xampp\htdocs\coral\resources\admin\classes\domain\Resource.php on line 805 +> +> -- Notice: Undefined index: page in C:\xampp\htdocs\coral\resources\admin\classes\domain\Resource.php on line 805 +> +> -- Notice: Undefined index: recordsPerPage in C:\xampp\htdocs\coral\resources\admin\classes\domain\Resource.php on line 805 +> +> -- Notice: Undefined variable: currentPage in C:\xampp\htdocs\coral\resources\index.php on line 32 + + +**Answer:** The messages are low level warnings from PHP and usually do not signify anything serious. Generally, best practices for PHP dictates variable are defined. The CORAL Steering Committee is aware of this and has this issue listed for correction. However, if you are seeing these messages in your CORAL pages, you should be concerned that your server is configured to show all server error messages on the page that is being loaded, which could allow malicious users to gain insight into your vulnerabilities. You should change your PHP settings in php.ini to disable that display for any production instances. Change display_errors = On to display_errors = Off and restart Apache. + +**Question:** How do I install CORAL 2.0.x on Ubuntu 14? + +**Answer:** Check out the [State of Libraria blog](http://stateoflibraria.com/2017/02/23/coral-2-on-ubuntu-14/), which has written up a nice post on installing CORAL 2 on Ubuntu 14. + + +**Question:** I subscribe to ERM through SirsiDynix and was wondering if there is a way to change the settings so that the database doesn’t “time out” so frequently? + +**Answer:** There is a way to help fix the problem via a timeout variable in the configuration.ini for the Auth module. An example of the file is copied and pasted below. The variable is highlighted in bold red. The installation process for CORAL will prompt you to change the default, but there is no end user way to update the value after the installation process is complete, unless you or IT support (or SirsiDynix?) can manually access and edit the file. The value is in seconds. + +> [settings] + +> timeout=3600 + +> [database] + +> type = "mysql" + +> host = "localhost" + +> name = "coral_auth_prod" + +> username = "root" + +> password = "mysql" + ### Technical diff --git a/source/img/api/apiClientForm.JPG b/source/img/api/apiClientForm.JPG new file mode 100644 index 0000000..9c3c2d1 Binary files /dev/null and b/source/img/api/apiClientForm.JPG differ diff --git a/source/img/api/apiClientForm.png b/source/img/api/apiClientForm.png new file mode 100644 index 0000000..fdc34e7 Binary files /dev/null and b/source/img/api/apiClientForm.png differ diff --git a/source/img/api/apiClientFormSubmitReport.PNG b/source/img/api/apiClientFormSubmitReport.PNG new file mode 100644 index 0000000..088fe2b Binary files /dev/null and b/source/img/api/apiClientFormSubmitReport.PNG differ diff --git a/source/img/api/apiClientIndexphp.png b/source/img/api/apiClientIndexphp.png new file mode 100644 index 0000000..06f6f73 Binary files /dev/null and b/source/img/api/apiClientIndexphp.png differ diff --git a/source/img/dashboards/dashboardsHomeMenu.PNG b/source/img/dashboards/dashboardsHomeMenu.PNG new file mode 100644 index 0000000..23863e7 Binary files /dev/null and b/source/img/dashboards/dashboardsHomeMenu.PNG differ diff --git a/source/img/dashboards/dashboardsStatistics.PNG b/source/img/dashboards/dashboardsStatistics.PNG new file mode 100644 index 0000000..ca30f38 Binary files /dev/null and b/source/img/dashboards/dashboardsStatistics.PNG differ diff --git a/source/img/dashboards/dashboardsStatisticsResults.PNG b/source/img/dashboards/dashboardsStatisticsResults.PNG new file mode 100644 index 0000000..ef8aa64 Binary files /dev/null and b/source/img/dashboards/dashboardsStatisticsResults.PNG differ diff --git a/source/img/dashboards/dashboardsYearlyCost.PNG b/source/img/dashboards/dashboardsYearlyCost.PNG new file mode 100644 index 0000000..c93739f Binary files /dev/null and b/source/img/dashboards/dashboardsYearlyCost.PNG differ diff --git a/source/img/dashboards/dashboardsYearlyCostResults.PNG b/source/img/dashboards/dashboardsYearlyCostResults.PNG new file mode 100644 index 0000000..eb42bc3 Binary files /dev/null and b/source/img/dashboards/dashboardsYearlyCostResults.PNG differ diff --git a/source/img/ebscokb/ebscokbHome.PNG b/source/img/ebscokb/ebscokbHome.PNG new file mode 100644 index 0000000..d220290 Binary files /dev/null and b/source/img/ebscokb/ebscokbHome.PNG differ diff --git a/source/img/ebscokb/ebscokbImportPackage.PNG b/source/img/ebscokb/ebscokbImportPackage.PNG new file mode 100644 index 0000000..8e9d701 Binary files /dev/null and b/source/img/ebscokb/ebscokbImportPackage.PNG differ diff --git a/source/img/ebscokb/ebscokbImportTitle.PNG b/source/img/ebscokb/ebscokbImportTitle.PNG new file mode 100644 index 0000000..e7995f6 Binary files /dev/null and b/source/img/ebscokb/ebscokbImportTitle.PNG differ diff --git a/source/img/ebscokb/ebscokbPackageHoldingsUpdatekb.PNG b/source/img/ebscokb/ebscokbPackageHoldingsUpdatekb.PNG new file mode 100644 index 0000000..5972e4f Binary files /dev/null and b/source/img/ebscokb/ebscokbPackageHoldingsUpdatekb.PNG differ diff --git a/source/img/ebscokb/ebscokbPackageSearch.PNG b/source/img/ebscokb/ebscokbPackageSearch.PNG new file mode 100644 index 0000000..de53cbd Binary files /dev/null and b/source/img/ebscokb/ebscokbPackageSearch.PNG differ diff --git a/source/img/ebscokb/ebscokbPackageSearchCoral.PNG b/source/img/ebscokb/ebscokbPackageSearchCoral.PNG new file mode 100644 index 0000000..d18ec4e Binary files /dev/null and b/source/img/ebscokb/ebscokbPackageSearchCoral.PNG differ diff --git a/source/img/ebscokb/ebscokbTitleSearch.PNG b/source/img/ebscokb/ebscokbTitleSearch.PNG new file mode 100644 index 0000000..ed127fe Binary files /dev/null and b/source/img/ebscokb/ebscokbTitleSearch.PNG differ diff --git a/source/img/ebscokb/ebscokbVendorPackageResults.PNG b/source/img/ebscokb/ebscokbVendorPackageResults.PNG new file mode 100644 index 0000000..49bff69 Binary files /dev/null and b/source/img/ebscokb/ebscokbVendorPackageResults.PNG differ diff --git a/source/img/ebscokb/ebscokbVendorSearch.PNG b/source/img/ebscokb/ebscokbVendorSearch.PNG new file mode 100644 index 0000000..a0f2b6c Binary files /dev/null and b/source/img/ebscokb/ebscokbVendorSearch.PNG differ diff --git a/source/img/export/exportButton.PNG b/source/img/export/exportButton.PNG new file mode 100644 index 0000000..06f67ba Binary files /dev/null and b/source/img/export/exportButton.PNG differ diff --git a/source/img/export/exportResult.PNG b/source/img/export/exportResult.PNG new file mode 100644 index 0000000..336b2a7 Binary files /dev/null and b/source/img/export/exportResult.PNG differ diff --git a/source/img/integration/integrationVendorCheck.png b/source/img/integration/integrationVendorCheck.png new file mode 100644 index 0000000..e599114 Binary files /dev/null and b/source/img/integration/integrationVendorCheck.png differ diff --git a/source/img/integration/integrationVendorDisplay.png b/source/img/integration/integrationVendorDisplay.png new file mode 100644 index 0000000..9da6cc5 Binary files /dev/null and b/source/img/integration/integrationVendorDisplay.png differ diff --git a/source/img/integration/integrationVendorExists.png b/source/img/integration/integrationVendorExists.png new file mode 100644 index 0000000..eb7fb53 Binary files /dev/null and b/source/img/integration/integrationVendorExists.png differ diff --git a/source/img/integration/integrationVendorRetrieve.png b/source/img/integration/integrationVendorRetrieve.png new file mode 100644 index 0000000..3b9d792 Binary files /dev/null and b/source/img/integration/integrationVendorRetrieve.png differ diff --git a/source/img/licensing/licensingAddExpressionDisplayNote.PNG b/source/img/licensing/licensingAddExpressionDisplayNote.PNG new file mode 100644 index 0000000..1440af6 Binary files /dev/null and b/source/img/licensing/licensingAddExpressionDisplayNote.PNG differ diff --git a/source/img/licensing/licensingAddExpressionDisplayNote.png b/source/img/licensing/licensingAddExpressionDisplayNote.png deleted file mode 100644 index 363d86d..0000000 Binary files a/source/img/licensing/licensingAddExpressionDisplayNote.png and /dev/null differ diff --git a/source/img/licensing/licensingAddILLExpression.PNG b/source/img/licensing/licensingAddILLExpression.PNG new file mode 100644 index 0000000..a44e7d7 Binary files /dev/null and b/source/img/licensing/licensingAddILLExpression.PNG differ diff --git a/source/img/licensing/licensingAddILLExpression.png b/source/img/licensing/licensingAddILLExpression.png deleted file mode 100644 index 67dffb8..0000000 Binary files a/source/img/licensing/licensingAddILLExpression.png and /dev/null differ diff --git a/source/img/management/managementEditDocumentRecord.png b/source/img/management/managementEditDocumentRecord.png deleted file mode 100644 index be66eef..0000000 Binary files a/source/img/management/managementEditDocumentRecord.png and /dev/null differ diff --git a/source/img/management/managementHomepage.png b/source/img/management/managementHomepage.png index 41d16a9..2019d9f 100644 Binary files a/source/img/management/managementHomepage.png and b/source/img/management/managementHomepage.png differ diff --git a/source/img/organizations/organizationsAddNewOrganization.png b/source/img/organizations/organizationsAddNewOrganization.png index 3a4f9e0..f56ba42 100644 Binary files a/source/img/organizations/organizationsAddNewOrganization.png and b/source/img/organizations/organizationsAddNewOrganization.png differ diff --git a/source/img/resources/Resources_Module_Home_3.0.png b/source/img/resources/Resources_Module_Home_3.0.png new file mode 100644 index 0000000..d0ea42b Binary files /dev/null and b/source/img/resources/Resources_Module_Home_3.0.png differ diff --git a/source/img/resources/resourcesAccess.PNG b/source/img/resources/resourcesAccess.PNG index 1c5dd4c..098b829 100644 Binary files a/source/img/resources/resourcesAccess.PNG and b/source/img/resources/resourcesAccess.PNG differ diff --git a/source/img/resources/resourcesAccount.PNG b/source/img/resources/resourcesAccount.PNG index 3c0f34a..cce9513 100644 Binary files a/source/img/resources/resourcesAccount.PNG and b/source/img/resources/resourcesAccount.PNG differ diff --git a/source/img/resources/resourcesAcquisition.PNG b/source/img/resources/resourcesAcquisition.PNG new file mode 100644 index 0000000..9a1d1bd Binary files /dev/null and b/source/img/resources/resourcesAcquisition.PNG differ diff --git a/source/img/resources/resourcesAcquisitions.PNG b/source/img/resources/resourcesAcquisitions.PNG new file mode 100644 index 0000000..3a2af69 Binary files /dev/null and b/source/img/resources/resourcesAcquisitions.PNG differ diff --git a/source/img/resources/resourcesAddImportConfiguration.PNG b/source/img/resources/resourcesAddImportConfiguration.PNG index 15f664d..ee1fde4 100644 Binary files a/source/img/resources/resourcesAddImportConfiguration.PNG and b/source/img/resources/resourcesAddImportConfiguration.PNG differ diff --git a/source/img/resources/resourcesAdmin.PNG b/source/img/resources/resourcesAdmin.PNG index e1df604..59c62de 100644 Binary files a/source/img/resources/resourcesAdmin.PNG and b/source/img/resources/resourcesAdmin.PNG differ diff --git a/source/img/resources/resourcesAdminAlertSettings.PNG b/source/img/resources/resourcesAdminAlertSettings.PNG index ea9c927..8f3f3ee 100644 Binary files a/source/img/resources/resourcesAdminAlertSettings.PNG and b/source/img/resources/resourcesAdminAlertSettings.PNG differ diff --git a/source/img/resources/resourcesAdminImportConfiguration.PNG b/source/img/resources/resourcesAdminImportConfiguration.PNG new file mode 100644 index 0000000..6384357 Binary files /dev/null and b/source/img/resources/resourcesAdminImportConfiguration.PNG differ diff --git a/source/img/resources/resourcesAttachments.PNG b/source/img/resources/resourcesAttachments.PNG index 16a7129..1d53bf6 100644 Binary files a/source/img/resources/resourcesAttachments.PNG and b/source/img/resources/resourcesAttachments.PNG differ diff --git a/source/img/resources/resourcesCataloging.PNG b/source/img/resources/resourcesCataloging.PNG index 0749464..93deb9a 100644 Binary files a/source/img/resources/resourcesCataloging.PNG and b/source/img/resources/resourcesCataloging.PNG differ diff --git a/source/img/resources/resourcesContacts.PNG b/source/img/resources/resourcesContacts.PNG index 4358390..7604b72 100644 Binary files a/source/img/resources/resourcesContacts.PNG and b/source/img/resources/resourcesContacts.PNG differ diff --git a/source/img/resources/resourcesDelimitedFileImport.PNG b/source/img/resources/resourcesDelimitedFileImport.PNG index 45dc4d7..ee1fde4 100644 Binary files a/source/img/resources/resourcesDelimitedFileImport.PNG and b/source/img/resources/resourcesDelimitedFileImport.PNG differ diff --git a/source/img/resources/resourcesEditCostInformation.PNG b/source/img/resources/resourcesEditCostInformation.PNG index a72afad..634c2c1 100644 Binary files a/source/img/resources/resourcesEditCostInformation.PNG and b/source/img/resources/resourcesEditCostInformation.PNG differ diff --git a/source/img/resources/resourcesEditOrder.PNG b/source/img/resources/resourcesEditOrder.PNG new file mode 100644 index 0000000..99fb7d3 Binary files /dev/null and b/source/img/resources/resourcesEditOrder.PNG differ diff --git a/source/img/resources/resourcesEditResource.PNG b/source/img/resources/resourcesEditResource.PNG index 3ae9e93..787a126 100644 Binary files a/source/img/resources/resourcesEditResource.PNG and b/source/img/resources/resourcesEditResource.PNG differ diff --git a/source/img/resources/resourcesEnhancedCostHistory.PNG b/source/img/resources/resourcesEnhancedCostHistory.PNG new file mode 100644 index 0000000..d459078 Binary files /dev/null and b/source/img/resources/resourcesEnhancedCostHistory.PNG differ diff --git a/source/img/resources/resourcesFileImport.PNG b/source/img/resources/resourcesFileImport.PNG index 239708f..98dd9ce 100644 Binary files a/source/img/resources/resourcesFileImport.PNG and b/source/img/resources/resourcesFileImport.PNG differ diff --git a/source/img/resources/resourcesImportReport.PNG b/source/img/resources/resourcesImportReport.PNG deleted file mode 100644 index 0837127..0000000 Binary files a/source/img/resources/resourcesImportReport.PNG and /dev/null differ diff --git a/source/img/resources/resourcesImportReportPreview.PNG b/source/img/resources/resourcesImportReportPreview.PNG new file mode 100644 index 0000000..1790c6d Binary files /dev/null and b/source/img/resources/resourcesImportReportPreview.PNG differ diff --git a/source/img/resources/resourcesIssues.PNG b/source/img/resources/resourcesIssues.PNG index 7a1f776..cdbef51 100644 Binary files a/source/img/resources/resourcesIssues.PNG and b/source/img/resources/resourcesIssues.PNG differ diff --git a/source/img/resources/resourcesOrders.PNG b/source/img/resources/resourcesOrders.PNG new file mode 100644 index 0000000..bd4d375 Binary files /dev/null and b/source/img/resources/resourcesOrders.PNG differ diff --git a/source/img/resources/resourcesProduct.PNG b/source/img/resources/resourcesProduct.PNG index 593bc6e..85dcaed 100644 Binary files a/source/img/resources/resourcesProduct.PNG and b/source/img/resources/resourcesProduct.PNG differ diff --git a/source/img/resources/resourcesReassignResouceStep.PNG b/source/img/resources/resourcesReassignResouceStep.PNG deleted file mode 100644 index 77d5322..0000000 Binary files a/source/img/resources/resourcesReassignResouceStep.PNG and /dev/null differ diff --git a/source/img/resources/resourcesReassignResourceStep.PNG b/source/img/resources/resourcesReassignResourceStep.PNG new file mode 100644 index 0000000..921cd8b Binary files /dev/null and b/source/img/resources/resourcesReassignResourceStep.PNG differ diff --git a/source/img/resources/resourcesReportNewProblem.PNG b/source/img/resources/resourcesReportNewProblem.PNG index 2386381..4a57610 100644 Binary files a/source/img/resources/resourcesReportNewProblem.PNG and b/source/img/resources/resourcesReportNewProblem.PNG differ diff --git a/source/img/resources/resourcesViewCurrentDowntime.PNG b/source/img/resources/resourcesViewCurrentDowntime.PNG index 8bb9f21..37eba67 100644 Binary files a/source/img/resources/resourcesViewCurrentDowntime.PNG and b/source/img/resources/resourcesViewCurrentDowntime.PNG differ diff --git a/source/img/resources/resourcesViewOpenIssues.PNG b/source/img/resources/resourcesViewOpenIssues.PNG index 3aaa805..4d86615 100644 Binary files a/source/img/resources/resourcesViewOpenIssues.PNG and b/source/img/resources/resourcesViewOpenIssues.PNG differ diff --git a/source/img/resources/resourcesWorkflow.PNG b/source/img/resources/resourcesWorkflow.PNG new file mode 100644 index 0000000..10cba0b Binary files /dev/null and b/source/img/resources/resourcesWorkflow.PNG differ diff --git a/source/img/resources/resourcesWorkflowUserGroup.PNG b/source/img/resources/resourcesWorkflowUserGroup.PNG index 19b0f1f..3a7a70a 100644 Binary files a/source/img/resources/resourcesWorkflowUserGroup.PNG and b/source/img/resources/resourcesWorkflowUserGroup.PNG differ diff --git a/source/img/terms/TermsDisplay.PNG b/source/img/terms/TermsDisplay.PNG new file mode 100644 index 0000000..609d3a9 Binary files /dev/null and b/source/img/terms/TermsDisplay.PNG differ diff --git a/source/img/terms/TermsDisplayLinks.PNG b/source/img/terms/TermsDisplayLinks.PNG new file mode 100644 index 0000000..6c4c19d Binary files /dev/null and b/source/img/terms/TermsDisplayLinks.PNG differ diff --git a/source/img/terms/termsCompletedExpressions.png b/source/img/terms/termsCompletedExpressions.png new file mode 100644 index 0000000..34c3da1 Binary files /dev/null and b/source/img/terms/termsCompletedExpressions.png differ diff --git a/source/img/terms/termsFooterLink1.png b/source/img/terms/termsFooterLink1.png new file mode 100644 index 0000000..1ac9c3f Binary files /dev/null and b/source/img/terms/termsFooterLink1.png differ diff --git a/source/img/terms/termsNoTerms.png b/source/img/terms/termsNoTerms.png new file mode 100644 index 0000000..2d1922c Binary files /dev/null and b/source/img/terms/termsNoTerms.png differ diff --git a/source/img/terms/termsProviderNoTerms.PNG b/source/img/terms/termsProviderNoTerms.PNG new file mode 100644 index 0000000..acc6334 Binary files /dev/null and b/source/img/terms/termsProviderNoTerms.PNG differ diff --git a/source/img/terms/termsResourceLink.PNG b/source/img/terms/termsResourceLink.PNG new file mode 100644 index 0000000..ef8a5e8 Binary files /dev/null and b/source/img/terms/termsResourceLink.PNG differ diff --git a/source/img/terms/termsToolEmail.png b/source/img/terms/termsToolEmail.png new file mode 100644 index 0000000..65c7fed Binary files /dev/null and b/source/img/terms/termsToolEmail.png differ diff --git a/source/index.rst b/source/index.rst index 5e6382a..8d5f2ac 100644 --- a/source/index.rst +++ b/source/index.rst @@ -21,15 +21,20 @@ CORAL Documentation Project technical glossary faq - + Appendix ======== .. toctree:: :maxdepth: 3 - + + api authentication + dashboards + ebscokb + export import + integration manual terms translation @@ -53,8 +58,7 @@ Projects merge gokb - website - + Indices and tables ================== diff --git a/source/install.md b/source/install.md index 76ec7ea..d0c1e32 100644 --- a/source/install.md +++ b/source/install.md @@ -2,20 +2,42 @@ Installing CORAL ---------------- ### Installation -Installation can occur in one of two ways – either through the web installation script or manually. For a manual installation see [Installing CORAL Manually](http://docs.coral-erm.org/en/latest/manual.html). The web +Installation can occur in one of two ways – either through the web installation script or manually. For a manual installation see [Installing CORAL Manually](http://docs.coral-erm.org/en/latest/manual.html). The web installation will provide advantages over manual installation because it will check MySQL privileges and PHP version and directory permissions. -#### Installing CORAL 2.0 +#### Software Requirements -Note: For upgrading to CORAL 2.0 see the following section [Upgrading to CORAL](http://docs.coral-erm.org/en/latest/install.html#upgrading-to-coral) +CORAL 3.0 requires the following: -New to CORAL 2.0 is the Unified Installer which simplifies the web installation. +> PHP 5.5 or above +> +> Required PHP extensions: gettext, mbstring, and mysqlnd +> +> MySQL 5.5 or above (Another alternative supported is MariaDB 10 or above) +> +> Apache 2.2 or above. The "AllowOverride" directive must be set to "All" +> +> Server space required 2 CPUs, 20GB of disk, and 2GB of RAM -Step 1: Download a copy of the [latest version at Github](https://github.com/Coral-erm/Coral). +**Note:** There are known issues with MySQL 5.7 and CORAL 3.0 (see [Issue #445](https://github.com/coral-erm/coral/issues/445)). In order to use CORAL 3.0 with MySQL 5.7 you must disable the `ONLY_FULL_GROUP_BY ` option in MYSQL. For help with this, see Stack Overflow for command line and phpMyAdmin instructions at [https://stackoverflow.com/a/36033983/4100024](https://stackoverflow.com/a/36033983/4100024). The CORAL Steering Committee is prioritizing a fix for this in the CORAL 3.1 release. + + +#### Installing CORAL 2.1 + +See [Installing CORAL 2.0.1 Documentation](http://docs.coral-erm.org/en/2.0.1/install.html). + +#### Installing CORAL 3.0 + +Note: For upgrading to CORAL from 3.0 from 1.x versions, see the following section [Upgrading to CORAL](http://docs.coral-erm.org/en/latest/install.html#upgrading-to-coral) + +The CORAL 3.0 installation uses the Unified Installer which simplifies the web installation. + +Step 1: Download a copy of the [latest version at Github](https://github.com/Coral-erm/Coral/releases). Step 2: If you use the option to download the compressed zipped file, expand this file in a working folder. -Step 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 what name you choose. +Step 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 what 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. @@ -45,10 +67,11 @@ For example, for Ubuntu Linux you would have something similar to the following. ... and so on. -When finished changing the permissions, click on "Try Again" button to continue the installation. +When finished changing the permissions, click on the "Try Again" button to continue the installation. + +Step 7: You should see the following: setup CORAL with your MySQL. Generally, this will be user root or a user that has the necessary privileges (i.e., select, insert, update, +delete, and create table privileges). This user will not be remembered after the installation since part of the process is to create a new user for CORAL to use in day-to-day operation. -Step 7: Following this you should see the following, setup CORAL with your MySQL. Generally, this will be user root or an user that has the necessary privileges (i.e., select, insert, update, -delete, and create table privileges). This user will not be remembered after the installation since part of the process is to create a new user for CORAL to use in day to day operation. However, if you don't want to give the installer user credentials with create database permissions, you can provide one with permission only for specific databases, but you will need to manually create a database for each module and use the Advance MySQL Database Setup form to provide the database names to the installer. After providing the necessary information click the "Continue Installing" button. ![Screenshot of MySQL Database Setup](img/install/installDatabaseSetup.png) @@ -59,21 +82,21 @@ Optional - Advance MySQL Database Setup form as seen below will allow you to cus ![Screenshot of MySQL Database Setup Advanced](img/install/installDatabaseSetupAdvanced.png) -Step 8: Setup a regular database user. As noted this user will need SELECT, INSERT, UPDATE and DELETE privileges. If the MySQL username you already gave CORAL has permission to create a new user it will create the name and password you provide here. Otherwise you will need to provide a username and password that you have manually configured in the database already. When finished adding the username and password click the "Continue Installing" button. +Step 8: Set up a regular database user. As noted, this user will need SELECT, INSERT, UPDATE and DELETE privileges. If the MySQL username you already gave CORAL has permission to create a new user, it will create the name and password you provide here. Otherwise you will need to provide a username and password that you have manually configured in the database already. When finished adding the username and password, click the "Continue Installing" button. ![Screenshot of Database User Setup](img/install/installDatabaseUserSetup.png) -Step 9: Setup default user. This account will be used to administer other users and features in CORAL. +Step 9: Set up default user. This account will be used to administer other users and features in CORAL. ![Screenshot of Default User Setup](img/install/installSetupDefaultUser.png) -Step 10: Setup for Auth Module. This includes setting up the session timeout and the whether or not to use [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) for authentication. The session timeout represents seconds. When finished click the "Continue Installing" button. +Step 10: Set up the Auth Module. This includes setting up the session timeout and whether or not to use [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) for authentication. The session timeout represents seconds. When finished, click the "Continue Installing" button. ![Screenshot of Default User Setup](img/install/installSetupAuthModule.png) -Step 11: If not using LDAP, setup an admin password for the Auth Module. Passwords must be at least 8 characters long. +Step 11: If not using LDAP, set up an admin password for the Auth Module. Passwords must be at least 8 characters long. ![Screenshot of Default User Setup](img/install/installAuthPasswordSetup.png) @@ -83,52 +106,53 @@ Step 12: Choose whether or not to use the [Terms Tool](http://docs.coral-erm.org ![Screenshot of Terms Tool Setup](img/install/installTermsTool.png) -Step 13: Setup Link Resolver Base URL and Outlier Flagging Feature +Step 13: Set up Link Resolver Base URL and Outlier Flagging Feature. ![Screenshot of Link Resolver Base URL and Outlier Flagging setup](img/install/installLinkResolver.png) -The Link Resolver Base URL provides a quick way to view complete holdings from within the Usage Module. Likewise, the Outlier Flagging is used in the Usage Module to help flag imported usage data that appears incorrect. See the [Usage Statistics Guide](http://docs.coral-erm.org/en/latest/usagestats.html) for more information. +The Link Resolver Base URL provides a quick way to view complete holdings from within the Usage Module. Likewise, the Outlier Flagging is used in the Usage Module to help flag imported usage data that appears incorrect. See the [Usage Statistics Guide](http://docs.coral-erm.org/en/latest/usagestats.html) for more information. Again, click the "Continue Installing" button when finished. -Step 14: Setup Resources Module +Step 14: Set up the Resources Module. ![Screenshot of setup for Resources Module](img/install/installResourcesModuleSetup.png) -Step 15: As instructed update your file permissions for better security. +Step 15: Update your file permissions for better security. ![Screenshot of Instructions for using chmod command to change file and folder permissions](img/install/installProtectFiles.png) -When finished updating click on the "Try Again" button. - -When finished you should briefly see a message indicating what modules have been successfully installed. The message will redirect to the CORAL home page in 10 seconds. +When finished updating, click on the "Try Again" button. You should briefly see a message indicating what modules have been successfully installed. The message will redirect to the CORAL home page in 10 seconds. ![Screenshot of Successful Installation](img/install/installCongratulations.png) -#### Upgrading to CORAL +#### Upgrading CORAL -Note: To upgrade to CORAL 2.0 and following you need to be sure all your modules are updated to the latest 1.x versions. Before starting any upgrade process make a backup of your previous CORAL installation and data. +Note: To upgrade to CORAL 3.0 and following, you need to be sure all your modules are updated to the latest 1.x versions. Before starting any upgrade process, make a backup of your previous CORAL installation and data. **Installation Notes:** -* There is a separate install for each 1.x module -* The CORAL-Main module does not have an installation script. You simply need to copy the module files into the parent `/coral/` folder. -* If you need to re-run the installation for any reason, you can do so **but it will remove any data in the -database and reset to original data load!** -* Be sure to remove the `/install/` directory once installation is complete. + +- There is a separate install for each 1.x module. + +- The CORAL-Main module does not have an installation script. You simply need to copy the module files into the parent `/coral/` folder. + +- If you need to re-run the installation for any reason, you can do so, **but it will remove any data in the database and reset to original data load!** + +- Be sure to remove the `/install/` directory once installation is complete. ##### Steps for Upgrading to the latest 1.x versions -**Auth Module** +**Auth Module:** Step 1: [Download the latest 1.x Auth Module (v.1.1.1)](https://github.com/ndlibersa/auth/archive/v1.1.1.zip) and unzip the file into a webserver folder. Step 2: Copy the `configuration.ini` file from the `admin` folder of your current Auth module into the `admin` folder of the latest Auth module. -**PLEASE NOTE: For all the following steps "latest ... module" refers to your expanded download of the latest version of CORAL that you are upgrading to.** +**PLEASE NOTE: For all the following steps, "latest ... module" refers to your expanded download of the latest version of CORAL that you are upgrading to.** -Your Auth module should now be upgraded to the latest version of CORAL 1.x +Your Auth module should now be upgraded to the latest version of CORAL 1.x. -**Resources Module** +**Resources Module:** Step 1: [Download the latest 1.x Resources Module (v1.4.1)](https://github.com/ndlibersa/resources/archive/v1.4.1.zip) and unzip the file into a webserver folder. @@ -140,19 +164,20 @@ Step 3: Copy the content of the `attachments` folder of your current Resources m ---------- Note: -If you require Unicode support, be sure to check the following settings and update as needed. Older versions of CORAL/MySQL implementations may not have been setup for Unicode support. +If you require Unicode support, be sure to check the following settings and update as needed. Older versions of CORAL/MySQL implementations may not have been set up for Unicode support. -In the `install/protected` folder of the latest Resources module, go to the `update_1.4.sql` file found under the latest Resources module. Remove the comment from the following line and replace the placeholder `_DATABASE_NAME_` with your current Resources module database name. Be sure to save your changes when finished. +In the `organizations/install` folder, go to the `update_1.3.sql`. Remove the comment from the following line and replace the placeholder `_DATABASE_NAME_` with your current Resources module database name. Be sure to save your changes when finished. -Here is the line you are changing. +For example, if your database name is `coral_productions_prod_v1`, find the following line in `update_1.3.sql`: +`ALTER DATABASE '_DATABASE_NAME_' CHARACTER SET utf8 COLLATE utf8_general_ci` ---ALTER DATABASE '_DATABASE_NAME_' CHARACTER SET utf8 COLLATE utf8_general_ci; +And change it to the following: +`ALTER DATABASE 'coral_organizations_prod_v1' CHARACTER SET utf8 COLLATE utf8_general_ci ` ----------- -Step 4: Open up a browser and type the URL pointing to your latest Resource module followed by `/install/update.php` and hit enter. The v1.4.1 Resource update script can detect your current Resource module version. Let's assume your current Resource version is v1.0.0. If so, you should see the first screen below. +Step 4: Open up a browser and type the URL pointing to your latest Resource module followed by `/install/update.php` and hit Enter. The v1.4.1 Resource update script can detect your current Resource module version. Let's assume your current Resource version is v1.0.0. If so, you should see the first screen below. ![Screenshot of CORAL Resources update for Version 1.1](img/install/installResourcesUpdate1.png) @@ -170,13 +195,13 @@ Step 7: Click the "Run Update 1.3" button. Step 8: Click the "Run Update 1.4" button. -You should now see the following +You should now see the following: ![Screenshot of CORAL Resources showing successful update up to Version 1.4.1](img/install/installResourcesUpdate4Successful.png) Step 9: Secure or move the install folder under the latest Resources module to a safer location. -**Organizations Module** +**Organizations Module:** Step 1: [Download the latest 1.x Organizations Module (v1.3.1)](https://github.com/ndlibersa/organizations/archive/v1.3.1.zip) and unzip the file into a webserver folder. @@ -185,31 +210,31 @@ Step 2: Copy the `configuration.ini` file from the `admin` folder of your curren ---------- Note: -If you require Unicode support, be sure to check the following settings and update as needed. Older versions of CORAL/MySQL implementations may not have been setup for Unicode support. +If you require Unicode support, be sure to check the following settings and update as needed. Older versions of CORAL/MySQL implementations may not have been set up for Unicode support. -In the `install/protected` folder of the latest Organizations module, go to the `update_1.4.sql` file found under the latest Organizations module. Remove the comment for the following line and replace the placeholder `_DATABASE_NAME_` with your current Resources module database name. Be sure to save your changes when finished. +In the `install/protected` folder of the latest Organizations module, go to the `update_1.4.sql` file found under the latest Organizations module. Remove the comment for the following line and replace the placeholder `_DATABASE_NAME_` with your current Resources module database name. Be sure to save your changes when finished. -Here is the line you are changing. +Here is the line you are changing: --ALTER DATABASE '_DATABASE_NAME_' CHARACTER SET utf8 COLLATE utf8_general_ci; ---------- -Step 3: Open up a browser and enter the URL pointing to your latest Organizations module followed by `/install/upgrade.php` and hit enter to see the screen below. +Step 3: Open up a browser and enter the URL pointing to your latest Organizations module, followed by `/install/upgrade.php`, and hit Enter to see the screen below. ![Screenshot of CORAL Organizations update for Version 1.3](img/install/installOrganizationsUpdate1.png) -Step 4: Click on the "Continue" button. The next screen should look like the following. +Step 4: Click on the "Continue" button. The next screen should look like the following: ![Screenshot of CORAL Organizations MySQL permissions info](img/install/installOrganizationsMySQLSetup.png) -Step 5: Fill in the fields for hostname or IP address of the host where your CORAL database is running, the current Organizations database name, and the database username and password granted permissions to the Organizations database. Click on the "Continue" button when finished. +Step 5: Fill in the fields for hostname or IP address of the host where your CORAL database is running, the current Organizations database name, and the database username and password granted permissions to the Organizations database. Click on the "Continue" button when finished. ![Screenshot of CORAL Organizations showing successful update up to Version 1.3.1](img/install/installOrganizationsSuccessful.png) Step 6: Secure or move the `install` folder under the latest Organizations module to a safer location. -**Licensing Module** +**Licensing Module:** Step 1: [Download the latest 1.x Licensing Module (v1.4.2)](https://github.com/ndlibersa/licensing/archive/v1.4.2.zip) and unzip the file into a webserver folder. @@ -219,7 +244,7 @@ Step 3: Copy the content of the `attachments` folder from your current Licensing Step 4: Copy the content of the `documents` folder from your Licensing module into the `documents` folder of the latest Licensing module. -Step 5: Open up a browser and enter the URL pointing to your v.1.4.2 Licensing module followed by `/install/update.php` and hit enter. You should see the following. +Step 5: Open up a browser and enter the URL pointing to your v.1.4.2 Licensing module followed by `/install/update.php` and hit enter. You should see the following: ![Screenshot of CORAL Licensing update for Version 1.2](img/install/installLicensingUpdate1.png) @@ -231,9 +256,9 @@ Step 7: Click the "Run Update 1.3" button. ![Screenshot of CORAL Licensing showing successful update up to Version 1.3](img/install/installLicensingSuccessful.png) -Step 8: Since there are no database changes since v.1.3.0, your installation is updated to v.1.4.2. Secure your CORAL installation by moving the latest 1.x `install` folder for your Licensing module to another location. +Step 8: Since there are no database changes since v.1.3.0, your installation is updated to v.1.4.2. Secure your CORAL installation by moving the latest 1.x `install` folder for your Licensing module to another location. -**Management Module** +**Management Module:** Step 1: [Download the latest 1.x Management Module (v1.2.0)](https://github.com/ndlibersa/management/archive/v1.2.0.zip) and unzip the file into a webserver folder. @@ -243,110 +268,111 @@ Step 3: Copy the content from the `attachments` folder of your current Managemen Step 4: Copy the content of the `documents` folder of your current Management module into the `documents` folder of the latest Management module. -Step 5: Open up a browser and enter the URL pointing to your latest Management module followed by `/install/update.php` and hit enter. You should see the following and have Management module v1.2.0 installed. +Step 5: Open up a browser and enter the URL pointing to your latest Management module followed by `/install/update.php` and hit Enter. You should see the following and have Management module v1.2.0 installed. ![Screenshot of CORAL Management showing successful update](img/install/installManagementSuccessful.png) Step 6: Secure or move the `install` folder for the latest 1.x Management module to a safer location. -**Usage Module** +**Usage Module:** -Step 1: [Download the latest 1.x Usage Module (v1.2.1)](https://github.com/ndlibersa/usage/archive/v1.2.1.zip) and unzip the file into a webserver folder. Alternatively, for those comfortable with git may prefer to check out v.1.2.1 rather than download. +Step 1: [Download the latest 1.x Usage Module (v1.2.1)](https://github.com/ndlibersa/usage/archive/v1.2.1.zip) and unzip the file into a webserver folder. Alternatively, those comfortable with git may prefer to check out v.1.2.1 rather than download. Step 2: Copy the `configuration.ini` file from the `admin` folder of your current Usage module into the `admin` folder of the latest Usage module. -Step 3: Open up a browser and enter the URL pointing to your latest Usage module followed by `/install/update.php` and then hit enter. You are on v.1.0.0 and should see the following. +Step 3: Open up a browser and enter the URL pointing to your latest Usage module followed by `/install/update.php` and then hit Enter. You are on v.1.0.0 and should see the following: ![Screenshot of CORAL Usage module update for Version 1.2](img/install/installUsageUpdate1.png) -Step 4: Next we need to upgrade from v. 1.0.0 to v1.1. [Download Usage Module v.1.1](https://github.com/ndlibersa/usage/archive/v1.1.zip) and unzip the file into a webserver folder. Or, if you use git, switch to v.1.1. Enter the URL pointing to the v1.1 Usage module followed by `/install/update.php` and hit enter to see the following. +Step 4: Next we need to upgrade from v. 1.0.0 to v1.1. [Download Usage Module v.1.1](https://github.com/ndlibersa/usage/archive/v1.1.zip) and unzip the file into a webserver folder. Or, if you use git, switch to v.1.1. Enter the URL pointing to the v1.1 Usage module followed by `/install/update.php` and hit enter to see the following: ![Screenshot of CORAL Usage module update for Version 1.3](img/install/installUsageUpdate2.png) -Step 5: Click the "Run Update 1.1" +Step 5: Click the "Run Update 1.1". ![Screenshot of CORAL Usage module showing successful update](img/install/installUsageSuccessful1.png) -Step 6: Now switch back to the v1.2.1 `update.php` file. Enter the URL pointing to your latest Usage module followed by `/install/update.php` and hit enter. +Step 6: Now switch back to the v1.2.1 `update.php` file. Enter the URL pointing to your latest Usage module followed by `/install/update.php` and hit Enter. ![Screenshot of CORAL Usage module update for Version 1.2](img/install/installUsageUpdate3.png) -Step 7: Click the "Run Update 1.2" button. You should see the following and have v.1.2.1 installed. +Step 7: Click the "Run Update 1.2" button. You should see the following and have v.1.2.1 installed. ![Screenshot of CORAL Usage module showing successful update](img/install/installUsageSuccessful2.png) Step 8: Secure or move the install folder for the latest 1.x Usage module to a safer location. -**Reports Module** +**Reports Module:** Presently, v.1.0.0 is the only version of the Reports module, so there is no need to upgrade this module. ----- -Once you have updated all your existing modules to the latest 1.x version you are ready to start the CORAL 2.0 upgrade. +Once you have updated all your existing modules to the latest 1.x version, you are ready to start the CORAL 3.0 upgrade. -Step 9: Download a copy of the [latest version at Github](https://github.com/Coral-erm/Coral). +Step 9: Download a copy of the [latest version at Github](https://github.com/Coral-erm/Coral/releases). -Step 10: If you use the option to download the compressed zipped file, expand this file in a working folder. +Step 10: If you use the option to download the compressed zipped file, unzip this file in a working folder. -Step 11: 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 what name you choose. +Step 11: Copy the unzipped 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 whatever 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. +The web installation depends on the index.php file found in the coral folder. Your Apache settings should be set to include loading the index.php file. -Step 12: Similar to the upgrade process, move your current `configuration.ini` files found under the `/admin` folders of the version of CORAL you just upgraded into the appropriate `/admin` folders under the new copy of CORAL. You will need to do this for all the modules you are updating. +Step 12: Similar to the upgrade process, move your current `configuration.ini` files found under the `/admin` folders of the version of CORAL you just upgraded into the appropriate `/admin` folders under the new copy of CORAL. You will need to do this for all the modules you are updating. The following is a list of modules applicable: -Auth +- Auth -Licensing +- Licensing -Management +- Management -Organizations +- Organizations -Reports +- Reports -Resources +- Resources -Usage +- Usage -Note: If you want to add a new module to the upgrade, create a new `configuration.ini` under the module's respective `/admin` folder. Fill out the appropriate settings, such as the CORAL MySQL login info, module database names, URLs, etc. For a more in-depth description of the `configuration.ini` settings see [Installing CORAL Manually](http://docs.coral-erm.org/en/latest/manual.html) +Note: If you want to add a new module to the upgrade, create a new `configuration.ini` under the module's respective `/admin` folder. Fill out the appropriate settings, such as the CORAL MySQL login info, module database names, URLs, etc. For a more in-depth description of the `configuration.ini` settings, see [Installing CORAL Manually](http://docs.coral-erm.org/en/latest/manual.html) -When finished updating the `configuration.ini` file under all the applicable `/admin` module folders for the new version of CORAL, you are now ready to start the unified installer script. +When finished updating the `configuration.ini` file under all the applicable `/admin` module folders for the new version of CORAL, you are ready to start the unified installer script. Step 13: Go to the home directory for the new version of CORAL via a web browser to initiate the United Installer script. Using our example folder above, you may have something similar to the following `http://localhost/Coral-master/`. + As long as your Apache server is setup to read by default the `index.php` file, the installation process will start. -You should see the following. +You should see the following: ![Screenshot of Pre-installation Check](img/install/installUpgradePreviousVersion.png) Step 13: Click the "CORAL ALREADY INSTALLED (UPGRADE/REPAIR)" button. -Following this, you should see the unified installer modules to use list. +Following this, you should see the unified installer modules to use list: ![Screenshot of Unified Installer](img/install/installUnifiedInstaller.png) -Step 14: All the modules are selected by default. De-select any modules not required for your installation and then click the "Continue Installing" button. Remember you should only be selecting modules that you modified the `configuration.ini` for according to Step 12. +Step 14: All the modules are selected by default. De-select any modules not required for your installation and then click the "Continue Installing" button. Remember you should only be selecting modules that you modified the `configuration.ini` for according to Step 12. Step 15: Follow the instructions for any messages received. -For example, you may receive a message asking to change the folder and file permissions similar to the following. +For example, you may receive a message asking to change the folder and file permissions, similar to the following: ![Screenshot of Instructions for using chmod command to change file and folder permissions](img/install/installUpgradeFilePermissions.png) Update the appropriate permissions on your folders and then proceed with the installation by clicking on "TRY AGAIN." -You should receive the following. +You should receive the following: ![Screenshot of Instructions to protect your configuration.ini file](img/install/installCheckingProtectedFiles.png) Again, update your permissions to lock your `configuration.ini` file again and click on "TRY AGAIN." -Once finished, you should see the successfully upgraded CORAL 2.0 message before being redirected to the CORAL homepage. +Once finished, you should see the successfully upgraded CORAL 3.0 message before being redirected to the CORAL homepage. ![Screenshot of Successful Upgrade](img/install/installUpgradeSuccessful.png) - \ No newline at end of file + diff --git a/source/integration.md b/source/integration.md new file mode 100644 index 0000000..9c03b6a --- /dev/null +++ b/source/integration.md @@ -0,0 +1,59 @@ +ILS Integration +--------------------------------- + +### About ILS Integration + +Currently only Koha is implemented, but interactions with other ILSes could be added in the future. + +#### Koha + +##### Features +Vendors can be synchronized between Coral and Koha. + +##### Prerequisites + +Koha 18.05 or later is needed to use OAuth authentication. Earlier versions of Koha used cookie-based authentication to access the REST API, which is not suitable in our case. + +##### Installation +In Coral, install Unirest and league/oauth2-client in resources/api_client (composer might be the easiest way to do it) + +In Koha, install Net::OAuth2::AuthorizationServer and enable RESTOAuth2ClientCredentials system preference. + +##### Configuration +In Koha, create a user for the REST API, edit this user, click on more -> manage API Keys -> Generate new client id/secret pair. + +In Coral, edit the `[ils]` section in `organizations/admin/configuration.ini`, and add/edit the following values: + +``` +[ils] +ilsConnector=koha +ilsVendorRole="Vendor" +ilsApiUrl="http://mykoha.tld/api/" +ilsAdminUrl="http://pro.mykoha.tld/" +oauthid="" +oauthsecret="" +``` + +- `ilsConnector` is the name of the ILS you want to connect to. +- `ilsVendorRole` is the Coral organization role you want to map with Koha vendors. +- `ilsApiUrl` is Koha's API address. +- `ilsAdminUrl` is Koha's intranet address. +- `oauthid` is the client ID generated in Koha. +- `oauthsecret` is the secret generated in Koha. + +Once enabled, you can search for an existing vendor in Koha when creating an organization in Coral: + +![Vendor does not exist in koha](img/integration/integrationVendorCheck.png) + +If the vendor does not already exist in Koha, it will be added if the vendor role has been selected. + +If the vendor already exists in Koha, we can automatically retrieve its informations: + +![Vendor exists in koha](img/integration/integrationVendorExists.png) +![Vendor is retrieved from koha](img/integration/integrationVendorRetrieve.png) + +In both cases, the vendor can no longer be modified in Coral, as the ILS is authoritative. + +Once the Coral organization and the Koha vendor are linked, a link to open the vendor in Koha is displayed: +![Vendor in Coral](img/integration/integrationVendorDisplay.png) + diff --git a/source/licensing.md b/source/licensing.md index 42fbe19..040a417 100644 --- a/source/licensing.md +++ b/source/licensing.md @@ -15,9 +15,9 @@ anticipating a variety of agreements and institutional goals for managing agreements. The module allows users to identify license clauses most important to record and track from an institutional point of view. With related features like a clause comparison function, and -ILL and course pack terms tools that can be implemented to deliver -terms through other systems such as SFX, the CORAL Licensing module -provides a way to make better use of permissions included in the +ILL and course pack Terms Tool that can be implemented to deliver +terms through other systems such as SFX, or EBSCO Full Text Finder, and potentially for Ex Libris (formerly Serials Solutions) the CORAL Licensing module +the CORAL Licensing module provides a way to make better use of permissions included in the license agreement. *Please note that screenshots and text in this document are just @@ -37,14 +37,14 @@ the top of each page. - ONIX-PL File Import - Admin -### Home +#### Home ![image of home screen for Licensing modules. Search features are on the left and a table of licenses on the right.](img/licensing/licensingHome.png) The home screen contains a search on the left and a list of license records on the right. The search runs against the following fields: license name, publisher/provider, consortium, license status, document type, and expression type. -### New License +#### New License Select *New License* from the main navigation to begin adding new licensing records. This will open the License pop-up window. @@ -58,7 +58,7 @@ Select *New License* from the main navigation to begin adding new licensing reco -### Adding / Editing New License Record +#### Adding / Editing New License Record ![screenshot of the License Record.](img/licensing/licensingLicenseRecord.png) Here is a license record which has been created for @@ -91,14 +91,14 @@ The license record has four sections located on the left-hand column: - *Attachments* -### Documents +#### Documents The Documents tab contains all the documents for each license record. Any document may be uploaded to the system including licenses, amendments, order forms, purchase requests, or any other important document. Select *Upload New Document* to begin. -#### Adding New Documents +##### Adding New Documents The *Upload New Document* link opens the window in the below screenshot. Here you can fill out the initial details of the document and upload the actual file. Document Name is the only required field. @@ -122,7 +122,7 @@ delete it from the system. It also does not delete any expressions attached to that document. -#### Editing Documents +##### Editing Documents Once added, the documents will display on the *Documents* tab sorted first by Document Type and then by signature date with most recent first. @@ -130,13 +130,13 @@ Multiple signatures for both licensee and licensor can be added using the *Add Signatures* link. On the right side of the table are links to view, edit, and delete each document. -### Expressions +#### Expressions The *Expressions tab* is where the expressions or clauses of the license are entered. Expressions are not required. You should however assign an appropriate *License Status* to the record that indicates it is a document only record. -#### Adding Expressions +##### Adding Expressions The *Add New Expression* link opens a pop-up window, where you can add expressions for the documents that have been previously loaded. ![screenshot of the Expressions form. There are 3 fields.](img/licensing/licensingAddNewExpression.png) @@ -151,7 +151,7 @@ The *Add New Expression* link opens a pop-up window, where you can add expressio - **Document Text:** The actual text of the license clause. -#### Adding Display / Internal Notes +##### Adding Display / Internal Notes Actual legal text can be quite confusing so the next step is to add Display or Internal Notes to hold an interpretation of the text of the clause. @@ -179,24 +179,23 @@ he/she can check this box which indicates that the expression is finished and it makes the expression available through the Terms Tool. An email is then generated by the system indicating that a new expression has been completed and is ready for display. You can edit the recipients of this email in the [*Admin*](#Admin) page. -### Terms Tool +#### Terms Tool Once the expressions or terms of the license are known, the next question to ask is ‘Which journals are covered by these terms?’. -That’s where the *Terms Tool* tab comes into play. The Terms Tool currently works only with the SFX link resolver. It is true that not every institution uses SFX. The *Terms Tool* tab could be renamed and/or repurposed for use with other openurl resolvers or journal management systems. + +That’s where the *Terms Tool* tab comes into play. The Terms Tool works with the SFX, and EBSCO link resolvers with potentially options for integration with Ex Libris Serials Solutions. Using this tab it is possible to relate a specific license to the covered journals in a specific SFX target or package. -![screenshot of terms tool tab](img/licensing/licensingTermsTool.png) +![screenshot of display notes window](img/licensing/licensingTermsTool.png) + + +In this example, the Cambridge University Press License Agreement is being associated with the 'Cambridge University Press Journals Complete' target in SFX ('Cambridge University Press Journals Complete' is the SFX target public name). This SFX – License connection allows for the delivery of license terms through the SFX menu as detailed in the Terms Tool User Guide. This tab is meant to be used in conjunction with the Terms Tool and can be disabled for those who do not wish to use it. -In this example, the Cambridge -University Press License Agreement is being associated with the -Cambridge Journals Online target in SFX (Cambridge Journals Online is -the SFX target public name). This SFX – License connection allows for -the delivery of license terms through the SFX menu as detailed in the -Terms Tool User Guide. This tab is meant to be used in conjunction with the Terms Tool and can be disabled for those who do not wish to use it. +For more information on the Terms Tool, go to the [Terms Tool documentation](http://docs.coral-erm.org/en/latest/terms.html). -### Attachments +#### Attachments For any resource there may be documents in addition to the actual license that are important to retain. Title lists and email @@ -211,7 +210,7 @@ attached document was received but since the date is manually chosen it can be any date of your choice. The *View Attachment 1* link will open the uploaded file. -### Licenses in Progress +#### Licenses in Progress ![screenshot of Licenses in progress section. There is a table of licenses in progress.](img/licensing/licensingLicensesinProgress.png) @@ -222,7 +221,7 @@ status *Awaiting Document* or *Editing Expressions* and will also show new licenses which have not yet been given any status. The hyperlinked *License Name* will take you into the license record. -### Expression Comparison +#### Expression Comparison *Expression Comparison* allows the user to see all the instances of a specific expression type across all documents in a single screen or @@ -242,7 +241,7 @@ access to all expressions in the system. Other library staff however, may only need access to specific types of expressions and this particular page may be information overload. -###ONIX-PL File Import +#### ONIX-PL File Import ![screenshot of ONIX-PL File Import section](img/licensing/licensingONIX-PL.png) @@ -250,13 +249,13 @@ particular page may be information overload. You can upload licensing terms using the *ONIX-PL File Import*. ONIX-PL is a standardized XML format used to express license terms. The upload will create a new licenses with imported documents (in HTML format) and expressions. You can find such files in [GOKb](http://gokb.org/), an open data platform that provides information about electronic resources. -### Admin +#### Admin -The [*Admin*](#Admin) page is where you will edit Document Types, Expression Types, Qualifiers, Signature Types, Licenses Statuses, and Calendar Settings. +The Admin page is where you will edit Document Types, Expression Types, Qualifiers, Signature Types, Licenses Statuses, and Calendar Settings. Each of these fields can have as many values as needed so that the system can better meet local needs. -*Admin* is also where you will edit and manage user permissions. CORAL Licensing has been built with the ability to limit access to select individuals given the confidential nature of license agreements. Users may not access CORAL Licensing until they are first set up with an account by an administrator. The following figure shows the ‘add new user’ window available from the [*Admin*](#Admin) page. +*Admin* is also where you will edit and manage user permissions. CORAL Licensing has been built with the ability to limit access to select individuals given the confidential nature of license agreements. Users may not access CORAL Licensing until they are first set up with an account by an administrator. The following figure shows the ‘add new user’ window available from the Admin page. ![screenshot of the add new user window](img/licensing/licensingAddNewUser.png) @@ -265,9 +264,9 @@ details on authentication. **Privilege:** The user’s level of access. -- Admin users have complete add/edit rights and can remove licenses and associated fields. They also have access to the [*Admin*](#Admin) page, the Terms Tool tab on the license record and the terms tool checkbox. +- Admin users have complete add/edit rights and can remove licenses and associated fields. They also have access to the Admin page, the Terms Tool tab on the license record and the terms tool checkbox. -- Add/Edit users can remove licenses and associated fields, but not have access to the [*Admin*](#Admin) page and the Terms Tool. +- Add/Edit users can remove licenses and associated fields, but not have access to the Admin page and the Terms Tool. - View Only users can view all license information and are allowed access to the uploaded documents. diff --git a/source/management.md b/source/management.md index 8c44228..1330213 100644 --- a/source/management.md +++ b/source/management.md @@ -9,59 +9,56 @@ Developed by Texas A&M University, CORAL Management provides a way to store and CORAL Management has three components in the primary navigation at the top of each page. -• Home +- Home +- New Document +- Admin -• New Document - -• Admin - - -### Home - -![Screenshot of Management Home Page](img/management/managementHomePage.png) +![Screenshot of Management Home Page](img/management/managementHomepage.png) Document records are listed alphabetically by name and the name field can be searched. Additionally, the records can be filtered by category and document type. -### New Document +#### New Document -Select New Document from the main navigation to begin adding new document records. This will open the New Document pop-up window. +Select *New Document* from the main navigation to begin adding new document records. This will open the New Document pop-up window. ![Screenshot of Management's New Document form](img/management/managementNewDocument.png) -The ‘Name’ is the document name to be uploaded. The Management module only allows one active document per record so a document named Sample Letter to Excess Download Offender would only include a copy of the letter. +**Name:** Document name to be uploaded. The Management module only allows one active document per record so a document named Sample Letter to Excess Download Offender would only include a copy of the letter. -The ‘Description’ is a brief explanation of the document, if necessary. +**Description:** Brief explanation of the document, if necessary. -‘Type’ is the type of document. The options listed in the dropdown box may be created from the Admin tab or by using the ‘add type’ link under the dropdown box. In the case of the Sample Letter to Excess Download Offender, the type could be template. +**Type: **type of document. The options listed in the dropdown box may be created from the Admin tab or by using the ‘add type’ link under the dropdown box. In the case of the Sample Letter to Excess Download Offender, the type could be template. -‘Last Document Revision’ is the date the document was last revised. If no date is entered, today’s date is used by default. +**Last Document Revision**: The date the document was last revised. If no date is entered, today’s date is used by default. -‘Categories’ is the group of documents to which the document belongs. A document can be included in more than one category. For example, the document *Retiree Policy Regarding Access to Electronic Resources* could be in both an ‘Access Policy’ category and a ‘Licensing’ category. Categories may be created from the Admin tab or by using the ‘add category’ link under the ‘Categories’ selection box. +**Categories:** The group of documents to which the document belongs. A document can be included in more than one category. For example, the document 'Retiree Policy Regarding Access to Electronic Resources' could be in both an *Access Policy* category and a *Licensing* category. Categories may be created from the [Admin](http://coral-documentation.readthedocs.io/en/latest/management.html#admin) tab or by using the *add category* link under the *Categories* selection box. -Selecting the ‘Browse…’ button opens the navigation pane used to browse and upload the document. +Selecting the *Browse…* button opens the navigation pane used to browse and upload the document. -‘Archived’ is used to identify documents that have been superseded by a newer version of the document. +**Archived:** Used to identify documents that have been superseded by a newer version of the document. -Selecting the ‘Add Optional Note’ link allows notes to be linked to the document by opening up two additional fields. +Selecting the *Add Optional Note* link allows notes to be linked to the document by opening up two additional fields. ![Screenshot of Management's Editing a Document Record form](img/management/managementAddOptionalNote.png) -‘Note’ provides a space to add any notes about the document. +**Note:** Provides a space to add any notes about the document. + +**Note Type:** Provides a way to categorize the type of note. The options listed in the dropdown box may be created from the Admin tab or by using the *add note type* link under the dropdown box. -‘Note Type’ provides a way to categorize the type of note. The options listed in the dropdown box may be created from the Admin tab or by using the ‘add type’ link under the dropdown box. +#### Editing a Document Record -### Editing a Document Record +Once a document record has been created, the document record opens. A document record can also be opened by selecting it from the *Home* screen. -Once a document record has been created, the document record opens. A document record can also be opened by selecting it from the ‘Home’ screen. + ![Screenshot of Management's Editing a Document Record](img/management/managementEditDocumentRecord.png) -![Screenshot of Management's Editing a Document Record](img/management/managementEditDocumentRecord.png) +The above record is for a Cancellation of an E-Journal checklist. Below the name is the description of the document, the associated categories, the documents creation date and creator, and the date the record was last updated and by whom. -The above record is for a License Agreement Checklist. Below the name is the description of the document, the associated categories, the documents creation date and creator, and the date the record was last updated and by whom. In this example, there are two archived versions of the checklist as evidenced by the “2 archive(s) available” note. Selecting ‘show archives’ makes these copies visible and accessible. To add another archived version, select ‘upload archived document’ and fill in the appropriate information. As previously mentioned, there can only be one current/active document. Therefore, to add a new version of a document, the current document must be archived first. Once that happens, an ‘upload new document’ link will display. Select this and complete the necessary information to add the new version. +In this example, there is an archived version of the checklist as evidenced by the *1 archive(s) available” note. Selecting *show archives* makes archived copies visible and accessible. To add another archived version, select *upload archived document* and fill in the appropriate information. As previously mentioned, there can only be one current/active document. Therefore, to add a new version of a document, the current document must be archived first. Once that happens, an *upload new document* link will display. Select this and complete the necessary information to add the new version. -### Admin +#### Admin The Admin tab provides for the management of users, document types, note types, and categories. diff --git a/source/manual.md b/source/manual.md index 0f23006..e2abd33 100644 --- a/source/manual.md +++ b/source/manual.md @@ -1,9 +1,9 @@ Installing CORAL Manually ------------------------- -### Notes for Installing CORAL 2.0 Manually +### Notes for Installing CORAL 3.0 Manually -When you first [download the code](http://coral-erm.org/download), you will want to place the unzipped 2.0 code in your web server directory. +When you first [download the code](https://github.com/Coral-erm/Coral/releases), you will want to place the unzipped 3.0 code in your web server directory. You will need to configure each module individually. @@ -143,10 +143,10 @@ side until both modules are installed. 1. Join the listserv used for product updates, support, and general discussion by sending an email to listserv@listserv.nd.edu. Leave the subject line blank and include 'SUBSCRIBE CORAL-ERM Your Name' in the body; ex. SUBSCRIBE CORAL-ERM John Smith. -**CORAL 2.0 Configuration.ini** +**CORAL 3.0 Configuration.ini** There is one last configuration.ini file that you'll need to edit. In the root coral directory you will see a /common/ directory. Inside is a `configuration_sample.ini` file which you will want to copy or rename to `configuration.ini` -- `[installation_details]` has a `version = ` which should be set to `"2.0.0"` +- `[installation_details]` has a `version = ` which should be set to `"3.0.0"` - `[database]` has the same values that you entered for that section in the specific modules - each module has it's own entry like `[licensing]` with `enabled=` and `installed=` flags which can be set to `"Y"` or `"N"` @@ -164,6 +164,14 @@ Note that this will send an email to the feedbackEmailAddress also set in `confi temporary testing purposes you may wish to change or remove this email address. The number of days in advance and other email addresses can be modified in the Alert Settings tab of the Admin page. +By default CORAL will open modules in new windows. However, it can be configured to open modules in the same window. + +In common/configuration.ini: + +[settings] +open_new_windows = Y/N + + ### Additional CORAL Resources customization options #### Payment formatting @@ -194,6 +202,31 @@ or `Date.format = 'dd-mm-yyyy';` +### Number formatting +CORAL can be configured to define how numbers should be parsed and displayed. The default format is: + + - en_US + - 2 decimals + +To define how numbers display in your instance, install the php-intl package. + +The configuration takes place in common/configuration.ini, as such: + +[settings] +number_locale = "fr_FR" +number_decimals = 2 + +If number_locale is omitted, it will be defaulted to en_US +If number_decimals is omitted, it will be defaulted to 2 + +This will affect every part of the resources module using +cost_to_integer and integer_to_cost function: + + new resource, api, api_client, imports, summary and cost history. + +Special sql processing has been made to exports and dashboards. +Special javascript processing has been made to cost history. + #### Email customization The templates for the workflow notification and alert emails are located in `/admin/emails/` @@ -202,7 +235,7 @@ where they appear but leave the format alone. ### Upgrades Upgrades to CORAL will be announced through the CORAL ERM Listserv. If you wish to be added, please -consult http://coral-erm.org or email coral-admin@listserv.nd.edu directly. +consult https://coral-erm.org or email coral-admin@listserv.nd.edu directly. In general, small upgrades with simple coding changes will not be given their own version numbers. If an institution notifies us about a bug we will let them know directly when the bug fix is available. @@ -258,4 +291,6 @@ variable in the lefthand column. If interoperability isn’t working (you’ll know it’s not working when you get red errors), verify that you have the database setting and that your database user can connect to that database. Also, be sure to complete installation of both modules involved. -If your remote user auth variable isn’t working, verify that you have `register_globals = On` \ No newline at end of file +If your remote user auth variable isn’t working, verify that you have `register_globals = On` + + diff --git a/source/organizations.md b/source/organizations.md index 8271c21..46ab28d 100644 --- a/source/organizations.md +++ b/source/organizations.md @@ -11,17 +11,15 @@ CORAL TIP: New installations pre-populate the Organizations module with numerous CORAL Organizations has three major components in the main navigation at the top of each page. -• Home +- Home +- New Organization +- Admin -• New Organization - -• Admin - -### Home +#### Home The home screen contains a search on the left and a list of organizations on the right. The up and down arrows in the table header can be used to sort the organizations by name, alias, parent, or role. -![Screenshot of Organizations Home Page](img/organizations/organizationsHomePage.png) + ![Screenshot of Organizations Home Page](img/organizations/organizationsHomePage.png) There are four facets for search. These facets can be used in conjunction. @@ -35,16 +33,15 @@ There are four facets for search. These facets can be used in conjunction. -### New Organization +#### New Organization ![Screenshot of Add New Organizations window](img/organizations/organizationsAddNewOrganization.png) - -Select New Organization from the main navigation to begin adding new organization records. +Select *New Organization* from the main navigation to begin adding new organization records. * **Name**: Name of the organization (i.e. MetaPress, Sage Publications, etc). This is the only required field. -* **Parent:** Name of the parent organization (i.e. Proquest as parent of Chadwyck-Healey). The purpose of the ‘Parent’ field is to relate multiple organizations together and to create an organization hierarchy. The field includes an auto-fill populated by existing organization records. The parent organization must already have an existing organization record in order for it to be assigned. Each organization may have only one parent assigned but multiple organizations may have the same parent thereby creating a useful parent-child hierarchy. +* **Parent:** Name of the parent organization (i.e. Proquest as parent of Chadwyck-Healey). The purpose of the *Parent* field is to relate multiple organizations together and to create an organization hierarchy. The field includes an auto-fill populated by existing organization records. The parent organization must already have an existing organization record in order for it to be assigned. Each organization may have only one parent assigned but multiple organizations may have the same parent thereby creating a useful parent-child hierarchy. * **Company URL:** The URL of the organization’s homepage. @@ -54,11 +51,11 @@ Select New Organization from the main navigation to begin adding new organizatio * **Notes:** General notes. -### The Organization Record +#### The Organization Record ![Screenshot of Organizations record](img/organizations/organizationsRecordView.png) -Here is an organization record for Cambridge Scientific Abstracts. The information on the record is split among six tabs. +Here is an organization record for 'Cambridge Scientific Abstracts'. The information on the record is split among six tabs. * **Organization:** Displays the information found on the New Organizations screen explained on the previous page. @@ -70,41 +67,45 @@ Here is an organization record for Cambridge Scientific Abstracts. The informati * **Issues:** Information about an organization that may be valuable over time such as notes about frequent breaks in access or an oddity in an organization's invoicing process. -* **Licenses:** Links to the records in CORAL Licensing for all licenses from the organization. +* **Licenses:** Links to the records in [CORAL Resources](http://coral-documentation.readthedocs.io/en/latest/licensing.html) for all licenses from the organization. -#### Organization +##### Organization -The figure above shows the organization tab for Cambridge Scientific Abstracts. Notice that this screenshot does not display the ‘Account Details’, ‘Notes’ or ‘Company URL’ fields that were found on the New Organization window on the previous page. These three fields are not displayed because no data was entered into those fields when the record was added. +The figure above shows the organization tab for 'Cambridge Scientific Abstracts'. Notice that this screenshot does not display the *Account Details*, *Notes* or *Company URL* fields that were found on the New Organization window on the previous page. These three fields are not displayed because no data was entered into those fields when the record was added. -The ‘edit organization details’ link ![edit icon](img/general/editicon.png), will open up a window that allows you to edit the information originally entered in the New Organization’s window. +The *edit organization details* link ![edit icon](img/general/editicon.png), will open up a window that allows you to edit the information originally entered in the New Organization’s window. -In this example Cambridge Scientific Abstracts has been assigned ProQuest as the parent organization. The ‘view’ link +In this example 'Cambridge Scientific Abstracts' has been assigned ProQuest as the parent organization. The *view* link ![view icon](img/general/viewicon.png) next to ProQuest LLC will open the ProQuest organization record. -#### Aliases +##### Aliases ![Screenshot of Aliases view](img/organizations/organizationsAliasesView.png) The Aliases tab allows the user to add multiple aliases for the organization. The default alias types are Alternative Name, Name Change, and Acronym. These fields can be customized using the [Admin](#bookmark=id.26in1rg)[ ](#bookmark=id.26in1rg)page -#### Contacts +##### Contacts ![Screenshot of Contact view](img/organizations/organizationsContactView.png) + + The Contacts tab allows the user to add contact information for both specific personnel and general support. None of the fields are required except for Role(s). -The values for the ‘Role(s)’ field can be customized through the [Admin](#bookmark=id.26in1rg)[ ](#bookmark=id.26in1rg)page. When the contact is no longer accurate, it can either be deleted (deletion is restricted to users with admin privileges) or archived for historical tracking purposes. Contacts that have the ‘Archived’ box checked are kept in the system but are collapsed beneath a ‘Show Archived Contacts’ link so that all users know that the contact information is out of date. +The values for the *Role(s)* field can be customized through the [Admin](#bookmark=id.26in1rg)[ ](#bookmark=id.26in1rg)page. When the contact is no longer accurate, it can either be deleted (deletion is restricted to users with admin privileges) or archived for historical tracking purposes. Contacts that have the *Archived* box checked are kept in the system but are collapsed beneath a *Show Archived Contacts* link so that all users know that the contact information is out of date. + +Contact information can be entered in either CORAL Organizations or CORAL Resources. Contact information which is resource specific may be entered in [CORAL Resources](http://coral-documentation.readthedocs.io/en/latest/resources.html#contacts). Information stored at the organization level will be inherited by individual resources within CORAL Resources. -#### Accounts +##### Accounts ![Screenshot of accounts view](img/organizations/organizationsAccountView.png) The Accounts tab is used for storing login information that library personnel use for site administration, gathering usage statistics, etc. -Account login information can be entered in either CORAL Organizations or CORAL Resources. Account login information which is resource specific may be entered in CORAL Resources. Account login information that is not resource specific (ex. A single administrator login for all Gale databases) should be entered here in CORAL Organizations. Information stored at the organization level will be inherited by individual resources within CORAL Resources. +Account login information can be entered in either CORAL Organizations or CORAL Resources. Account login information which is resource specific may be entered in [CORAL Resources](http://coral-documentation.readthedocs.io/en/latest/resources.html#account). Account login information that is not resource specific (ex. A single administrator login for all Gale databases) should be entered here in CORAL Organizations. Information stored at the organization level will be inherited by individual resources within CORAL Resources. -Add new login information by selecting the ‘Add New External Login’ link. +Add new login information by selecting the *Add New External Login* link. Most of the fields are self-explanatory, with the exception of @@ -113,27 +114,29 @@ Most of the fields are self-explanatory, with the exception of * **Local Account Email:** The address of the library personnel registered on the account. -#### Issues +##### Issues ![Screenshot of issues view](img/organizations/organizationsIssuesView.png) -The Issues tab is meant for recording general information about an organization that may be valuable over time. One example would be recording when an organization has frequent breaks in access or significant server downtimes. Another example would be having an organization that is often slow when it comes to sending out renewal invoices. The ‘add new issue’ link opens a new window which includes a date and notes field. This field can be handy for recording the institutional knowledge that exists among various personnel. +The Issues tab is meant for recording general information about an organization that may be valuable over time. One example would be recording when an organization has frequent breaks in access or significant server downtimes. Another example would be having an organization that is often slow when it comes to sending out renewal invoices. The *add new issue* link opens a new window which includes a date and notes field. This field can be handy for recording the institutional knowledge that exists among various personnel. -#### Licenses +##### Licenses ![Screenshot of licenses view](img/organizations/organizationsLicensesView.png) -The Licenses tab provides links to the license records entered into CORAL Licensing for all licenses where the organization has been identified as the Publisher/Provider. The hyperlinked license name will open the license record in a new window. +The Licenses tab provides links to the license records entered into [CORAL Licensing](http://coral-documentation.readthedocs.io/en/latest/licensing.html) for all licenses where the organization has been identified as the Publisher/Provider. The hyperlinked license name will open the license record in a new window. -#### Admin +##### Admin The Admin page is where you can manage the module's user privileges as well as edit the values for organization role, contact role, alias type, external login type, and issue type. -#####Adding New Users#### -The ‘add new user’ link on the Admin page opens the following window. +#### Adding New Users +The *add new user* link on the Admin page opens the following window. + + ![Screen shot for adding new user](img/organizations/organizationsAddNewUser.png) -If you utilize your institution's existing authentication system, the ‘Login ID’ would be the user’s campus ID. +If you utilize your institution's existing authentication system, the *Login ID* would be the user’s campus ID. All valid users are given view only access when logged into CORAL Organizations unless they have specifically been granted additional privileges. You only need to add specific user accounts for personnel that need more than view only privileges. The available privileges are: @@ -144,3 +147,7 @@ All valid users are given view only access when logged into CORAL Organizations * **View only:** provides only the ability to view existing organization records. + + +* **View only:** provides only the ability to view existing organization records. + diff --git a/source/overview.md b/source/overview.md index 893cc50..11c2ed2 100644 --- a/source/overview.md +++ b/source/overview.md @@ -15,45 +15,11 @@ CORAL was originally developed locally by Hesburgh Libraries at the University o ##### What is the Steering Committee? -The steering committee consists of the individuals and libraries that have decided to contribute their time to developing coral and with assisting others by answering questions on this list. There is a level of commitment made for this work which in turn gives the group members the chance to help plan and manage coral's future development. It is our attempt at sharing ownership among interested and motivated parties without having to rely one just one institution to manage the product. +The steering committee consists of the individuals and libraries that have decided to contribute their time to developing CORAL and with assisting others by answering questions on this list. There is a level of commitment made for this work which in turn gives the group members the chance to help plan and manage CORAL's future development. It is our attempt at sharing ownership among interested and motivated parties without having to rely on just one institution to manage the product. ##### Who is on the committee? -Current members: [as of 1/6/2017] - -- Steve Oberg, Wheaton College (Chair of Steering Committee, Assistant Professor of Library Science) - -- Tommy Keswick, CalTech (Digital Technologies Development Librarian) - -- Heather Wilson, CalTech (Acquisitions and Electronic Resources Librarian) - -- Remington Steed, Calvin College (Developer) - -- Katherine Swart, Calvin College (Collection Development Librarian) - -- Emma Cryer, Duke Medical Center Library (Associate Director) - -- Scott Vieira, Rice University (Chair of Web Committee, Electronic Resources Librarian) - -- Mang Sun, Rice University (Systems Librarian) - -- Eric Hartnett, Texas A&M (Electronic Resources Librarian) - -- Doug Hahn, Texas A&M (Developer) - -- Benjamin Heet, TRLN (Technology Program Officer) - -- Jeffrey Mudge, Wheaton College (Developer) - - -Affiliate Members: - -- Paul Poulain, BibLibre - -- Matthias Meusburger, BibLibre (Developer) - -- Carla Clark, SirsiDynix (Product Manager) - +[Meet the Team](https://coral-erm.org/meet-the-team/) Anyone with a desire to contribute, and the time to do so, is welcome to join. Just email the Admin List and express your interest! @@ -76,21 +42,9 @@ The web committee consists of the individuals and libraries that have decided to Who is on the committee? -Current members are as follows. [as of 2/10/2017] - -- Nathan Ahlstrom, Medtronic - -- Katherine Landry, SHSU - -- Lauren Mueller, Rice - -- Louisa Choy, Wheelock College - -- Yan Song, NCSU - -- Scott Vieira (Chair), Rice +[Meet the Team](https://coral-erm.org/meet-the-team/) -Anyone with a desire to contribute, and the time to do so, is welcome to join. Just email the CORAL Web Committee or the CORAL Admin List and express your interest! +Anyone with a desire to contribute, and the time to do so, is welcome to join. Just email us at [help@coral-erm.org](mailto:help@coral-erm.org) to express your interest! What does the committee do? @@ -114,11 +68,11 @@ Here is the proposed path for decision making authority. The Steering Committee will maintain a Chair position. The Chair position is restricted to the SC members with e-resources management experience. This restriction is not meant to belittle the contributions of developers but to make sure that the strongest voice in determining CORAL's future is someone who has expertise in e-resources management. In the absence of the Chair, other members of the Steering Committee with e-resources management experience will fill in as needed. -The Steering Committee will seek volunteers from its members for the role of Chair to serve a two year term. If there is no volunteer for the role of Chair one will be appointed by a majority vote of SC members. If there are multiple volunteers one will be selected by a majority vote of SC members. If there is only one volunteer that person will be appointed as Chair. +The Steering Committee will seek volunteers from its members for the role of Chair to serve a two year term. If there is no volunteer for the role of Chair one will be appointed by a majority vote of SC members. If there are multiple volunteers one will be selected by a majority vote of SC members. If there is only one volunteer that person will be appointed as Chair. If there are no volunteers from its members for the role of Chair, and the existing Chair is open to re-election, the Steering Committee can choose to re-elect the existing chair for another term. -The Steering Committee will attempt to maintain a minimum of eight members representing four separate institutions. There is no maximum number of members but the Steering Committee will consider the appropriate functional size of the committee when considering new members. +The Steering Committee will attempt to maintain a minimum of eight members representing four separate institutions. There is no maximum number of members but the Steering Committee will consider the appropriate functional size of the committee when considering new members. The chair of the Web Committee is automatically granted a seat on the Steering Committee. -Libraries may volunteer to join the Steering Committee or may be invited by the Steering Committee. Steering Committee members must have a local production installation of CORAL and will be asked to contribute two individuals; a technical services librarian/staff member with e-resources management expertise and an information technology professional/developer. New members are approved by a two-thirds majority vote of SC members. +Libraries may volunteer to join the Steering Committee or may be invited by the Steering Committee. Steering Committee members must have a local production installation of CORAL and will be asked to contribute two individuals; a technical services librarian/staff member with e-resources management expertise and an information technology professional/developer. New members are approved by a two-thirds majority vote of SC members. In special cases, the Steering Committee can choose to invite an individual to the committee that may not be able to meet the requirement of contributing two individuals. Libraries and affiliate members are strongly encouraged to contribute individuals not only to the Steering Committee, but also the Web Committee. Overlapping membership between both committees is permitted. Affiliates may volunteer or be invited by the Steering Committee. New affiliates are approved by a two-thirds majority vote of the SC members. Affiliate members are allowed two participants on the coral-admin list and may have two participants join the monthly conference calls. The number of affiliate members participating on the coral-admin listserv and the monthly SC conference calls will not exceed the number of steering committee members. @@ -154,7 +108,7 @@ Affiliates may volunteer or be invited by the WC. New affiliates are approved by Github Documentation Repository Governance -Each WC member will be granted admin and ownership rights to the GitHub documentation repositories. Each Affiliate will be granted two accounts with admin rights to the GitHub documentation repositories that will supply merge rights for contributions (if they want them). WC members are responsible for policing the documentation repositories on GitHub and making sure that all members follow agreed upon procedures and in accordance with the WC’s style guide. WC members may remove admin rights to documentation repositories as necessary. +Each WC member will be granted admin and ownership rights to the GitHub documentation repositories. Each Affiliate will be granted two accounts with admin rights to the GitHub documentation repositories that will supply merge rights for contributions (if they want them). WC members are responsible for policing the documentation repositories on GitHub and making sure that all members follow agreed upon procedures and in accordance with the WC’s style guide. WC members may remove admin rights to documentation repositories as necessary. diff --git a/source/resources.md b/source/resources.md index 911cb0d..506569e 100644 --- a/source/resources.md +++ b/source/resources.md @@ -1,7 +1,8 @@ CORAL Resources Module User Guide --------------------------------- -## About CORAL Resources + +About CORAL Resources A component of Hesburgh Libraries locally developed ERM, CORAL Resources aids in the management of the electronic resource workflow @@ -11,7 +12,7 @@ CORAL Resources Module User Guide queue in which automated email alerts indicate to staff when new tasks are available. -## Component Overview +### Component Overview CORAL Resources has five major components in the primary navigation at the top of each page. @@ -26,14 +27,13 @@ CORAL Resources Module User Guide • Admin -## Home -======== +#### Home -![Screenshot of Resources Home Page](img/resources/resourcesHome.PNG) +![Screenshot of Resources Home Page](img/resources/Resources_Module_Home_3.0.png) -Home provides both search and AZ browse access to the resource records. +Home provides both search and A-Z browse access to the resource records. The *Name (contains)* field searches against resource name, resource -alias, parent resource name and organization name. Multiple fields can +alias, parent resource name and organization name. The sidebar also allows for searching across the Publisher, Platform, and ISBN/ISSN fields for more specific searching. Multiple fields can be combined in a single search for more precise searching. Search results can be exported to a spreadsheet using the excel icon in the upper right corner. The exported file includes more fields than what are @@ -67,8 +67,8 @@ Please note that the system does allow duplicate records for the same resource to be entered. The form will however alert the user that another record with the same resource name already exists. -## The Resource Record -### Product +#### The Resource Record +##### Product ![Screenshot of Product](img/resources/resourcesProduct.PNG) @@ -77,7 +77,7 @@ resource is logically grouped. The first tab, *Product*, contains the descriptive information such as name, alias, issn, publisher, etc which identifies and defines the resource. -### Edit product details +##### Edit product details ![Screenshot of Edit Resource](img/resources/resourcesEditResource.PNG) @@ -109,31 +109,25 @@ status as ‘Archived’. This was intended to be used to identify resources that were no longer available but for which there was value in retaining a record in CORAL. -### Add new note - +##### Add new note ![Screenshot of Add New Note](img/resources/resourcesAddNewNote.PNG) + An additional notes feature has been added to the *Product*, *Acquisitions* and *Access* tab. The note will be visible only on the tab on which it is added. The Note Type field has been included to provide context to the note. The values for the Note Type field can be customized through the *Admin* page. -### Acquisitions - -![Screenshot of Acquisition](img/resources/resourcesAcquistion.PNG) - - The Acquisitions tab contains details of the libraries’ acquisition of - the resource such as order number, cost, fund, license status, etc. +##### Orders +![Screenshot of Orders](img/resources/resourcesOrders.PNG) -### Edit acquisitions information +The Orders information allows for tracking of multiple orders for each resource. Users can choose between "create new order," "clone order," and "edit order information." -![Screenshot of Edit Acquistion](img/resources/resourcesEditAcquistion.PNG) +##### Create and Edit order information +![Screenshot of Edit Orders](img/resources/resourcesEditOrder.PNG) - The acquisitions information can be edited by using the edit - order information link or the matching edit icon. The - information here is meant to provide context to the local acquisitions - processes. The *Acquisition Type* field is the same as was entered on + The order information can be created, cloned, or edited by using the create, clone, or edit order links located under Orders. The orders information is meant to provide description to local acquisitions. The *Acquisition Type* field is the same as was entered on the add new resource form. The *Acquisitions* tab also includes the ability to track subscription @@ -159,14 +153,21 @@ The values can be customized through the *Admin* page. Order number and System Number fields are meant to provide match points with the ILS. -### Edit Cost History +##### Acquisitions +![Screenshot of Acquisition](img/resources/resourcesAcquisition.PNG) + The Acquisitions tab contains details of the libraries’ acquisition of + the resource such as order number, cost, fund, license status, etc. + +##### Edit Cost History ![Screenshot of Edit Cost History](img/resources/resourcesEditCostInformation.PNG) Additional cost history can be added through the *Edit Cost History* link. This allows to track cost history for the same resource. -### Edit license and status +Note: If enhanced cost history is enabled, then the user will see the following additional fields. +![Screenshot of Enhanced Cost History View](img/resources/resourcesEnhancedCostHistory.PNG) +##### Edit license and status ![Screenshot of Edit Licenses](img/resources/resourcesEditLicenses.PNG) The *Acquisitions* tab includes information about the relevant @@ -183,9 +184,8 @@ Additional cost history can be added through the *Edit Cost History* link. This link to each associated license is added to the Helpful Links section of the resource record for quick navigation between modules. -### Access - -![Screenshot of Access](img/resources/resourcesAccess.PNG) +##### Access + ![Screenshot of Access](img/resources/resourcesAccess.PNG) The *Access* tab includes the information about how the resource is accessed including things such as IP versus username/password @@ -193,9 +193,8 @@ authentication, simultaneous user limits, authorized sites, etc. The access information can be edited by using the edit access information link or the matching edit icon. -### Edit access information - -![Screenshot of Edit Access](img/resources/resourcesEditAccess.PNG) +##### Edit access information + ![Screenshot of Edit Access](img/resources/resourcesEditAccess.PNG) The values for all fields on the *Access* tab except for username and password can be customized through the *Admin* page. The Authorized Site @@ -220,8 +219,7 @@ link or the matching edit icon. administration. Administrative logins are to be stored on the *Accounts* tab. -### Cataloging - +##### Cataloging ![Screenshot of Cataloging](img/resources/resourcesCataloging.PNG) The *Cataloging* tab includes data and workflow information related to @@ -231,7 +229,7 @@ link or the matching edit icon. information can be edited by using the *Edit Cataloging Details* link or the matching edit icon. -### Edit Cataloging Details +##### Edit Cataloging Details ![Screenshot of Edit Cataloging](img/resources/resourcesEditCataloging.PNG) @@ -245,7 +243,7 @@ link or the matching edit icon. Completed, Ongoing, and Rejected. Checking the OCLC Holdings checkbox indicates that the resource is made available in OCLC. -### Contacts +##### Contacts ![Screenshot of Contacts](img/resources/resourcesContacts.PNG) @@ -261,9 +259,8 @@ Resources Module includes a Contact Role field for each contact (support, invoicing, etc). The values for Contact Role can be edited through the *Admin* page. -### Account - -![Screenshot of Accounts](img/resources/resourcesAccount.PNG) +##### Account + ![Screenshot of Accounts](img/resources/resourcesAccount.PNG) The *Accounts* tab is the same as is found on an organization record in the Organizations Module. It is intended to store the login credentials @@ -277,38 +274,36 @@ will be inherited and displayed here on the *Accounts* tab. As with Organizations, the Resources Module includes a Login Type field. The values for Login Type can be edited through the *Admin* page. -### Issues - -![Screenshot of Attachments](img/resources/resourcesIssues.PNG) +##### Issues + ![Screenshot of Attachments](img/resources/resourcesIssues.PNG) -Issues related to a resource can be recorded in the *Issues* tab. Users can report an issue, view open issues or view archived issues. Downtime can also be recorded under Downtime section, where users may report a new downtime, or view current/upcoming downtime or view archived downtime. +Issues related to a resource can be recorded in the *Issues* tab. Users can report an issue, view open issues or view archived issues. Downtime can also be recorded under Downtime section, where users may report a new downtime, or view current/upcoming downtime or view archived downtime. -![Screeshot of Report New Problem](img/resources/resourcesReportNewProblem.PNG) + ![Screeshot of Report New Problem](img/resources/resourcesReportNewProblem.PNG) -The *Report New Issue* link allows users to enter a new issue. There are several required fields marked with a red star. To add a contact, use the *Add Contact* link. Users may choose to CC themselves or add additional CCs. All contacts and CCs will receive an email alert about the issue. Fill in the Subject field and a brief description about the issue in the Body field. The *Applies to* check box has three options and users can select only one of them. For the *Applies to all Elsevier resources* option (shown in the example here), the issues will be recorded for all Elsevier resource records in CORAL. If *Applies to selected Elsevier resources* option is selected (as shown in the figure), a list of the available resources from the same organization will show up and users can select one or multiple items on the list. In the example shown, both items on the list are selected. +The *Report New Issue* link allows users to enter a new issue. There are several required fields marked with a red star. To add a contact, use the *Add Contact* link. Users may choose to CC themselves or add additional CCs. All contacts and CCs will receive an email alert about the issue. Fill in the Subject field and a brief description about the issue in the Body field. The *Applies to* check box has three options and users can select only one of them. For the *Applies to all Project Euclid resources* option (shown in the example here), the issues will be recorded for all Project Euclid resource records in CORAL. If *Applies to selected Project Euclid resources* option is selected (as shown in the figure), a list of the available resources from the same organization will show up and users can select one or multiple items on the list. In the example shown, both items on the list are selected. -![Screenshot of View Open Issues](img/resources/resourcesViewOpenIssues.PNG) + ![Screenshot of View Open Issues](img/resources/resourcesViewOpenIssues.PNG) To look at all open issues, users can click on *View Open Issues* link and all open issues will be expanded below the linking text. Open issues can be closed by clicking on the *Close* link in the same view. See screenshot above. Open issues can be downloaded in a csv file by clicking on the excel icon beside the text View Open Issues. The *View Archived Issues* link will display all archived/closed issues. Users can also download closed issues in a csv file by clicking on the excel icon. + ![Screenshot of Resource Downtime Report](img/resources/resourcesResourceDowntimeReport.PNG) -![Screenshot of Resource Downtime Report](img/resources/resourcesResourceDowntimeReport.PNG) - -Users can record downtime related to the resource record via the *Report New Downtime* link. The downtime report includes downtime start date, downtime resolution date, problem type and some notes. Please note, when it reaches the downtime resolution date, the downtime report will be archived automatically. If the Downtime Resolution date is not entered here, a *Resolve* link will show in the *View Current/Upcoming Downtime* link shown the figure below. Problem Type can be configured in *Admin* Downtime Type tab. - -![Screenshot of View current Downtime](img/resources/resourcesViewCurrentDowntime.PNG) +Users can record downtime related to the resource record via the *Report New Downtime* link. The downtime report includes downtime start date, downtime resolution date, problem type and some notes. Please note, when it reaches the downtime resolution date, the downtime report will be archived automatically. If the Downtime Resolution date is not entered here, a *Resolve* link will show in the *View Current/Upcoming Downtime* link shown the figure below. Problem Type can be configured in *Admin* Downtime Type tab. New downtime can also be entered in the Organizations Module. Please note Report New Downtime in Organizations module is an optional feature, which can be turned on by updating the Organization module configuration file (resourceIssues=Y). + + ![Screenshot of View current Downtime](img/resources/resourcesViewCurrentDowntime.PNG) The *View Current/Upcoming Downtime* will display all current or upcoming downtime reports, either organizational level or resource level. To archive/close a downtime report, click on the *resolve* link and the archived downtime should appear in the *View Archived Downtime* section. Please note, there is a bug here, resolved downtime reports are not displaying in the designated section. A bug fix is in progress. Organization related downtime should be entered in the *Organization* module. -### Attachments +##### Attachments ![Screenshot of Attachment](img/resources/resourcesAttachments.PNG) Additional documents relevant to the resource can be uploaded and made available through the *Attachments* tab. Multiple attachments are grouped and sorted by attachment type. -![Screenshot of Add New Attachment](img/resources/resourcesAddNewAttachment.PNG) + ![Screenshot of Add New Attachment](img/resources/resourcesAddNewAttachment.PNG) New attachments are added using the *Add New Attachment* link. The Name field is intended to be a descriptive name for the attachment. The @@ -317,11 +312,11 @@ available through the *Attachments* tab. Multiple attachments are grouped and so etc) provides context and allows for a way to group the attachments. The values for attachment Type can be edited through the *Admin* page. -### Routing +##### Workflow -![Screenshot of Routing](img/resources/resourcesRouting.PNG) +![Screenshot of Routing](img/resources/resourcesWorkflow.PNG) -The *Routing* tab shows the workflow through which the resource needs to +The *Workflow* tab shows the workflow through which the resource needs to follow. The workflow and routing rules can be customized through the *Admin* page. That process is described later on in this document. @@ -351,7 +346,7 @@ through the use of template files. The templates exist in the /admin/emails/ directory. See the technical documentation and installation guide for more information on editing the email templates. -![Screenshot of Reassign Resource Step](img/resources/resourcesReassignResouceStep.PNG) +![Screenshot of Edit Resource Step](img/resources/resourcesReassignResourceStep.PNG) Workflow steps can be reassigned to a group by clicking on the pencil icon beside the group name. As shown in the figure above, selecting a group from the dropdown list will assign the step to a selected group. @@ -372,7 +367,7 @@ The *Edit The Current Workflow* link will open a Edit Workflow window, where use Task reminders are often seen in task management software. The email reminder function will remind users after the configured number of days when the step is assigned to the assigned group/member. It's worth noting that the edits made here will not overwrite the workflow configuration in *Admin* tab. -## My Queue +#### My Queue ![Screenshot of My Queue](img/resources/resourcesMyQueue.PNG) @@ -393,28 +388,31 @@ on their association with a workflow group. Resources are removed from the user’s queue once the outstanding workflow task on the resource’s *Routing* tab is marked as complete. -## File Import +#### File Import ![Screenshot of File Import](img/resources/resourcesFileImport.PNG) File Import allows users to import a file into CORAL. Users may choose a file from a local drive. The file has to be a delimited CSV file with any of the three delimiter options: comma, semicolon or pipe delimited. The upload button loads the CSV into CORAL. -### File Import Configuration +##### File Import Configuration ![Screenshot of File Import](img/resources/resourcesDelimitedFileImport.PNG) -Next users need to configure the import settings in the Delimited File Import window. Users can select an existing import configuration, which is configured in *Admin* (see Admin section below for more details). Once selected, the column number will be populated in the form automatically. If users have not previously created an Import Configuration, then for each of the resource fields please input the number of the corresponding column in your CSV file. For example, if your import file contains Name in the second column that corresponds to the Resource Title, then you would enter 2 for the value for the Resource Title field. For columns with multiple values that are character-delimited, indicate the delimiter using *If delimited, delimited by field*. For fields with values across multiple columns, add additional sets using the *+Add another* links. Use the *Dedupe on this column* option for ISBN/ISSN sets to ignore any duplicate values that might occur across those columns. The Alias Types, Note Types, and Organization Roles that you can assign to your mapped columns can be configured on the Admin page. +Next users need to configure the import settings in the Delimited File Import window. Users can select an existing import configuration, which is configured in *Admin* (see Admin section below for more details). Once selected, the column number will be populated in the form automatically. If users have not previously created an Import Configuration, then for each of the resource fields, users need to input the column number for each corresponding column in the CSV file. The column number for each column can be found right above the mapping fields in the top portion of the interface. For columns with multiple values that are character-delimited, indicate the delimiter using *If delimited, delimited by field*. For fields with values across multiple columns, add additional sets using the *+Add another* links. Use the *Dedupe on this column* option for ISBN/ISSN sets to ignore any duplicate values that might occur across those columns. The Alias Types, Note Types, and Organization Roles that you can assign to your mapped columns can be configured on the Admin page. +Users can also map a set of order related fields in the Acquisitions section, which contains Fund Code, Cost, Order Type and Currency. Lastly, users have the option to enable sending emails when starting workflows, which can be triggered automatically if records imported have the fields (Resource Format, Resource Type and Acquisition) matching with any existing workflows. If users don't want to bothered with the email notification, then leave this option unchecked. + +Once submit, users will be taken to the import preview window. (shown in the screenshot below). -Once submit, records in the file will be loaded into CORAL Resources module and an import report is generated (shown in the screenshot below). +##### File Import Report Preview -### File Import Report +![Screenshot of Admin](img/resources/resourcesImportReportPreview.PNG) -![Screenshot of Admin](img/resources/resourcesImportReport.PNG) +The preview allows users to look at the import summary and choose to either proceed with the import or go back to the field mapping windows if anything goes wrong. -The report summarizes the import settings and the results. In the example shown above, 3 records have been processed and added, one new parent record and two new organizations have been created. +After the import is finally submitted, it'll take users to the final results page. The import will be archived and users can access it again in Imports history. -## Admin +#### Admin ![Screenshot of Admin](img/resources/resourcesAdmin.PNG) @@ -422,7 +420,10 @@ The *Admin* page is available only to users with admin privileges. It is the page through which field values are customized and through which user privilege and access is set. -### Edit User +##### Edit User + + + ![Screenshot of Edit User](img/resources/resourcesEditUser.PNG) @@ -435,16 +436,16 @@ credentials that only a select few users need to see. Checking the ‘View Accounts’ box on the edit user form will allow the user to see the *Accounts* tab, for all other users the *Accounts* tab will be hidden. -### Workflow / User Group +##### Workflow / User Group ![Screenshot of Workflow User Group](img/resources/resourcesWorkflowUserGroup.PNG) The *Workflow / User Group* tab contains the settings which control the workflow routing features. The Resources Module allows for the creation of multiple workflow rules based on resource type. The figure above -shows three workflows including one for paid electronic resources, one for free electronic resources and one for paid electronic monographs. New workflows are added using the add workflow link. +shows three workflows including one for paid electronic resources, one for free electronic resources and one for paid electronic monographs. New workflows are added using the add workflow link. Users can also copy any existing workflows by clicking on the yellow duplicate icon. -### Edit workflow +##### Edit workflow ![Screenshot of Admin Edit Workflow](img/resources/resourcesAdminEditWorkflow.PNG) @@ -471,9 +472,8 @@ parent step assigned will become active as soon as the new record is submitted. Workflow steps that have an assigned parent step will become active once the parent step is marked as complete. -### Edit user group - -![Screenshot of Admin Edit User Group](img/resources/resourcesAdminEditUserGroup.PNG) +##### Edit user group + ![Screenshot of Admin Edit User Group](img/resources/resourcesAdminEditUserGroup.PNG) Each step or task in a workflow must be assigned to a user group. Enter a group name and a group email address. An email alert will be sent to @@ -482,18 +482,16 @@ active. Users that are assigned to the group will then have the in-process resource appear on the *Outstanding Tasks* tabs of their *My Queue* pages. -### Import Configuration +##### Import Configuration -![Screenshot of Admin Edit User Group](img/resources/resourcesImportConfiguration.PNG) +![Screenshot of Admin Edit User Group](img/resources/resourcesAdminImportConfiguration.PNG) Here, users can add a new import configuration or edit an existing configuration. -![Screenshot of Admin Edit User Group](img/resources/resourcesAddImportConfiguration.PNG) - The instruction for adding a new one or editing an existing one is similar to what's in File Import section described earlier and a configuration name can be entered here. The corresponding column number in the importing csv file can be entered for any field shown in the screenshot. -### Other Admin Settings +##### Other Admin Settings There are many other fields which can be customized through the *Admin* page. Select the field you wish to edit in the left hand column and then @@ -503,9 +501,8 @@ this document. There is however an additional setting managed here on the *Admin* page which needs to be described in more detail; Alert Settings. -### Alert settings - -![Screenshot of Admin Alert Settings](img/resources/resourcesAdminAlertSettings.PNG) +##### Alert settings + ![Screenshot of Admin Alert Settings](img/resources/resourcesAdminAlertSettings.PNG) These alert settings determine the functionality of the alert feature associated with the subscription period end date on the *Acquisitions* diff --git a/source/sushi.md b/source/sushi.md index 36aff2e..21af6f7 100644 --- a/source/sushi.md +++ b/source/sushi.md @@ -5,11 +5,8 @@ SUSHI The following pages are recommended reading for anyone new to setting up the SUSHI functionality in CORAL. -[NISO SUSHI Tools and Other Aids](http://www.niso.org/workrooms/sushi/tools/ "NISO SUSHI Tools and Other Aids") - -[Known SUSHI Compliant Vendors](http://www.niso.org/workrooms/sushi/registry_server/ "Known SUSHI Compliant Vendors") - -[SUSHI Starters Project](http://cclibweb-4.dmz.cranfield.ac.uk/projects/sushistarters/ "SUSHI Starters Project") +[Known SUSHI Compliant Vendors](https://www.projectcounter.org/about/register/ "Known SUSHI Compliant Vendors") +[NISO SUSHI Tools and Other Aids](https://www.niso.org/standards-committees/sushi/sushi-tools "NISO SUSHI Tools and Other Aids") #### Confirmed Providers @@ -73,4 +70,4 @@ Taylor and Francis -Please let us know if you have tested and confirmed a working configuration for any other providers. \ No newline at end of file +Please let us know if you have tested and confirmed a working configuration for any other providers. diff --git a/source/technical.md b/source/technical.md index 25bbdcf..8fc59c1 100644 --- a/source/technical.md +++ b/source/technical.md @@ -129,4 +129,8 @@ suffix * Method names are prefixed with: * Is – Answers a question, returns true/false, e.g. for User class `isAdmin()` method * Get – retrieves a value - * Set – sets a value \ No newline at end of file + * Set – sets a value + +#### Database Schema + +For an overview of the database schema see [CORAL Database Schema](http://www.coral-erm.org/schema/) \ No newline at end of file diff --git a/source/terms.md b/source/terms.md index aa2f5a3..5caf481 100644 --- a/source/terms.md +++ b/source/terms.md @@ -1,142 +1,94 @@ Terms Tool User Guide --------------------- - ### About the CORAL Terms Tool - - An add-on to CORAL Licensing, the Terms Tool enables key stakeholders - such as interlibrary loan staff to view the license terms without - needing direct access to CORAL Licensing. The tool allows authorized - users to retrieve license terms for a specific resource based on an - ISSN or ISBN query. In addition to CORAL Licensing, the Terms Tool - requires the installing site to have either the SFX or - SerialsSolutions openURL resolver (or alternatively any openURL - resolver with an API). The Terms Tool queries the openURL resolver for - a specific ISSN or ISBN, retrieves the list of available providers for - that ISSN/ISBN, and then queries CORAL Licensing for the license terms - for each provider. It is a multi-step process but it all takes place - behind the scenes and results in a seamless easy to use process for - the user. +### About the CORAL Terms Tool + +An add-on to CORAL Licensing, the Terms Tool enables key stakeholders such as interlibrary loan staff to view the license terms without needing direct access to CORAL Licensing. The tool allows authorized users to retrieve license terms for a specific resource based on an ISSN or ISBN query. In addition to CORAL Licensing, the Terms Tool requires the installing site to have either the SFX, or EBSCO Full-text Finder openURL link resolver (or alternatively any openURL resolver with an API). The Terms Tool queries the openURL link resolver for a specific ISSN or ISBN, retrieves the list of available providers for that ISSN/ISBN, and then queries CORAL Licensing for the license terms for each provider. It is a multi-step process but it all takes place behind the scenes and results in a seamless easy to use process for the user. +direct access to CORAL Licensing. The tool allows authorized users to retrieve license terms for a specific resource based on an ISSN or ISBN query. In addition to CORAL Licensing, the Terms Tool requires the installing site to have either the SFX or EBSCO Full Text Finder openURL resolver (or alternatively any openURL resolver with an API). The Terms Tool queries the openURL resolver for a specific ISSN or ISBN, retrieves the list of available providers for that ISSN/ISBN, and then queries CORAL Licensing for the license terms for each provider. It is a multi-step process but it all takes place behind the scenes and results in a seamless easy to use process for the user. + +*Please note that screenshots and text in this document are just examples and do not necessarily reflect terms for a particular resource.* ### Enabling the Terms Tool - The process of using the Terms Tool begins with the license record - within CORAL Licensing. The first step is for the licensing personnel - to create a license record with completed expressions as in the - following screenshot. - - Please note that these are not the actual license terms for Allen - Press journals. This is only a fabricated example. This license record - shows both the Coursepacks and Interlibrary Loan expressions for the - license agreement titled *Allen Press Online Journals Terms and - Conditions of Use*. There are two important items to note about these - expressions that directly impact the terms tool. The first is that the - expressions are using Display Notes rather than Internal Notes. Each - expression type can be configured within the CORAL Licensing Admin tab - to use either Display or Internal Notes. Only those expressions which - use Display Notes are made available through the Terms Tool. The - second item of note is the presence of the checkbox next to the - expression type. This is the Terms Tool Checkbox. It is used by the - licensing personnel to indicate that the expression is completed and - is ready to be included in the Terms Tool. The action of checking this - box will send out an email to the personnel managing the Terms Tool - - alerting them that new license terms are available. The recipients of - this email are configured on the Admin tab of CORAL Licensing. The - following screenshot shows the details of a user entry in CORAL - Licensing. Any user with an email address in the ‘Terms Tool Email’ - field will receive the system generated email when the terms tool +The process of using the Terms Tool begins with the license record within [CORAL Licensing](http://coral-documentation.readthedocs.io/en/latest/licensing.html). The first step is for the licensing personnel to create a license record with completed expressions as in the following screenshot. + +![screenshot of Expressions table.](img/terms/termsCompletedExpressions.png) + +This license record shows both the *Coursepacks* and *Interlibrary Loan *expressions for the license agreement titled "Cambridge University Press License Agreement". There are two important items to note about these expressions that directly impact the terms tool: + + +1. The expressions are using *Display Notes* rather than *Internal Notes*. Each expression type can be configured within the CORAL Licensing Admin tab to use either Display or Internal Notes. Only those expressions which use *Display Notes* are made available through the Terms Tool. +2. Note the presence of the checkbox next to the expression type. This is the Terms Tool Checkbox. It is used by the licensing personnel to indicate that the expression is completed and is ready to be included in the Terms Tool. The action of checking this box will send out an email to the personnel managing the Terms Tool alerting them that new license terms are available. The recipients of this email are configured on the Admin tab of CORAL Licensing. The following screenshot shows the details of a user entry in CORAL Licensing. Any user with an email address in the *Terms Tool Email* field will receive the system generated email when the terms tool checkbox is selected. + +![screenshot of the update user information pop-up](img/terms/termsToolEmail.png) + ### Mapping License Terms to Resources - At this point there is a completed license record showing the terms - for the license agreement *Allen Press Online Journals Terms and - Conditions of Use*. The next step which needs to be completed is to - identify which journals are covered by this specific license - agreement. This is accomplished using the ‘Terms Tool’ tab on the - license record as in the following screenshot. - - The task is to identify which journals are covered by the *Allen Press - Online Journals and Conditions of Use* license agreement. This is - accomplished by making a connection between the license agreement and - the list of journals as entered in the library’s openURL resolver. In - this example all of the journals that are covered by the terms of the - agreement were activated and entered as a distinct group within the - library’s openURL resolver. In SFX for example this is accomplished by - activating all the journals covered by the agreement within the same - target. The target is then given a target public name of ‘Allen Press’ - (serialsolutions calls this field databaseName). Then within the - ‘Terms Tool’ tab of CORAL Licensing the link can be entered between - the document *Allen Press Online Journals and Conditions of Use* and - the SFX target named ‘Allen Press’. The Terms Tool will now know that - all journals available within the Allen Press target are covered by - the terms of this specific license agreement. - - The Terms Tool now has the information it needs to operate. The - scenario is as follows. The Terms Tool receives an ISSN via the url - *http://.../coral/terms/?issn=XXXX-XXXX*. The Terms Tool sends a query - with the provided issn to the library’s openURL resolver. The openURL - resolver returns an xml reply listing all of the provider names (SFX’s - target public name or SerialsSolutions’ databaseName) for the provided - ISSN. The Terms Tool queries CORAL Licensing for all license - agreements which have been mapped to each provider name and retrieves - all of the associated license terms from the identified license - agreements. The terms are then displayed on screen to the user. +At this point there is a completed license record showing the terms for the license agreement "Cambridge University Press License Agreement". The next step which needs to be completed is to identify which journals are covered by this specific license agreement. This is accomplished using the Terms Tool tab on the license record as in the following screenshot. + +The task is to identify which journals are covered by the "Cambridge University Press License Agreement" license agreement. This is accomplished by making a connection between the license agreement and the list of journals as entered in the library’s openURL resolver. In this example all of the journals that are covered by the terms of the agreement were activated and entered as a distinct group within the library’s openURL resolver. + +In SFX for example this is accomplished by activating all the journals covered by the agreement within the same target. The target is then given a target public name of "Cambridge University Press Journals Complete" (serialsolutions calls this field databaseName). Then within the +Terms Tool tab of CORAL Licensing the link can be entered between +the document "Cambridge University Press License Agreement" and the SFX target named "Cambridge University Press Journals Complete". The Terms Tool will now know that all journals available within the "Cambridge University Press Journals Complete" target are covered by the terms of this specific license agreement. + +![screenshot of table of terms tool resource links](img/terms/termsResourceLink.PNG) + +The Terms Tool now has the information it needs to operate and can perform the query for license expressions. First the Terms Tool receives an ISSN via the url *https://{server name}/licensing/terms.php?issn={ISSN}*. The Terms Tool sends a query with the provided issn to the library’s openURL link resolver. The openURL link resolver returns an xml reply listing all of the provider names (SFX’s target public name, Ex Libris' Database Name, or EBSCO's equivalent) for the provided ISSN. The Terms Tool queries CORAL Licensing for all license agreements which have been mapped to each provider name and retrieves all of the associated license terms from the identified license agreements. The terms are then displayed on screen to the user. ### Terms Tool in Action - The following screenshot shows the Terms Tool display for the journal - *Intellectual and Developmental Disabilities* (issn 1934-9491). - - At this point the Terms Tool has already queried both the openURL - resolver and then CORAL Licensing and identified that Coursepack and - Interlibrary Loan terms are available for this journal. The link for - Interlibrary Loan leads to the following screenshot. - - And in the above screenshot the user now sees the specific - interlibrary loan license terms for this journal. Access to this - journal is available via Allen Press and interlibrary loan use is - permitted. The Display Notes from the license record detail how the - interlibrary loan is to be handled. The actual document text from the - license agreement is hidden beneath a ‘view license snippet’ link for - those wishing to see the original language. The provider name at the - end of the opening line is hyperlinked and will take the user directly - to the provider’s webpage for the journal. This example lists only one - provider, Allen Press, but the Terms Tool will display terms for all - providers when the library does have - - access through multiple providers. If no license terms are available - for a provider the Terms Tool will show that as well as in the - following example. +The following screenshot shows the Terms Tool display for the journal "American Political Science Review" (issn 0003-0554). This screenshot is taken from a live in-use terms tool instance that has customized expression types that differentiate between print and electronic. + +![screenshot of terms tool display of links to terms.](img/terms/termsTermsDisplayLinks.png) + +At this point the Terms Tool has already queried both the openURL resolver and then CORAL Licensing and identified that Coursepack, Course Reserves, and Interlibrary Loan terms are available for this journal. The link for Interlibrary Loan leads to the following screenshot. + +![screenshot of terms tool display of terms](img/terms/termsTermsDisplay.png) + +And in the above screenshot the user now sees the specific interlibrary loan license terms for this journal. Access to this journal is available via Cambridge University Press and interlibrary loan use is *Not Clear* (note that this is fabricated data). + +The *Display Notes* from the license record detail how the interlibrary loan is to be handled. The actual document text from the license agreement is hidden beneath a *view license snippet* link for those wishing to see the original language. The provider name at the end of the opening line is hyperlinked and will take the user directly to the provider’s webpage for the journal. + +The Terms Tool will display terms for all providers when the library does have access through multiple providers. In this example, access is also provided through Proquest Education Journals. If no interlibrary loan license terms are available for a provider the Terms Tool will show that as well as in the +following example: + +![screenshot of terms tool display of providers with no entered license terms](img/terms/termsProviderNoTerms.png) + Again, please note that the license terms in these screenshots are all fabricated examples and do not reflect the actual terms of the -provider’s real license agreements. In the preceding screenshot access -is available to the library through multiple providers but license terms -are only available for the BioMed Central access. +provider’s real license agreements. In the *American Political Science Review* example, access is also provided through multiple Gale databases but no license terms were entered for Gale in our system. + + ### Finding the Terms Tool The Terms Tool is used by querying it with a url containing either an ISSN or ISBN such as [*http://coral.mylibrary.edu/coral/terms/?issn=XXXX-XXXX*.](http://coral.mylibrary.edu/coral/terms?issn=XXXX-XXXX) - Using the Terms Tool requires some way for users to easily send this - type of ISSN/ISBN query. One option is to place a link to the Terms - Tool on the library’s openURL resolver menu. The template for the SFX - menu, for instance, can be edited in such a way as to create a link to - the Terms Tool which will dynamically use the ISSN and/or ISBN for the - specific resource being requested. The University of Notre Dame chose - this option and implemented the Terms Tool by placing the necessary - code in the footer of the SFX menu template. Similar options should - exist for the SerialsSolutions openURL resolver. A number of options - exist for how the Terms Tool could be implemented. It will be up to - each library to determine how they wish to create the necessary - ISSN/ISBN links. + Using the Terms Tool requires some way for users to easily send this type of ISSN/ISBN query. In order to use the Terms Tool, the library's link resolver must be configured with the URL. To configure consult documentation for the openURL link resolver used by your library. A number of options + exist for how the Terms Tool could be implemented and utilized. It is up to + the individual library to determine how they wish to create the necessary + ISSN/ISBN links and use the Terms Tool. + +![screenshot of SFX Menu with License Terms Link..](img/terms/termsSFXMenuLink.png) + ### Technical Documentation Additional technical documentation for installing and implementing the - Terms Tool is available on the CORAL Documentation page. Please read - the technical documentation thoroughly as it explains additional - details and configuration options necessary for proper use of the - Terms Tool. + Terms Tool is currently being worked on. + + + + + + + + + + + diff --git a/source/website.md b/source/website.md deleted file mode 100644 index 15b3015..0000000 --- a/source/website.md +++ /dev/null @@ -1,18 +0,0 @@ -Website 2015 Suggestions ------------------------- - -Some suggestions TBD, for the new website: - -1. sea animals : have them consistent (the green one for example, look left on top, and right at bottom) -1. copyright : update the footer, switching to "Copyright 2015 Coral Steering Commitee", adding a page presenting the CSC. -1. removing the "contact us" at the bottom (replacing it with #4) -1. adding a support page, with 2 parts: 4a- community support : link to the mailing list 4b- paid support : link to the BibLibre webpage dedicated to Coral (http://biblibre.com/en/solutions/coral) -1. Adding on the main page that CORAL means (Centralized Online Resources Acquisition and Licensing), as told on the homepage of the software -1. Remove all "text images", like "Welcome to a flexible, innovative and intuitive ERMS" -1. create a multilingual version of the website (I'll take care of the french), by translating all Drupal articles to languages. Adding a language sorter at bottom -1. rewrite the About page : say it's been started by UND, and is now managed by a worldwide community. separate more clearly functional / technical / licence paragraph -1. (later) clean/rewrite the Download page = provide everything in one package, put some infos about set-up directly here. -1. live demo : move it to demo.coral-erm.org (BibLibre can host it if you want). On this demo, we could load the default database, and reset it every sunday (that's what we do on koha demo. Very handy: ppl can do what they want, and if they break something, next monday, everything is OK again, no need to check !) -1. add a news block on the homepage (and a news menu between home and about). Pierre, BibLibre communication man would announce some news at least once a month (for sure, the Coral community will have something to say every month : the ER&L meeting, new users, coming new features, ...) -1. add page listing CORAL users and the modules they are using (this can be done via form submission from the users) -1. add page(s) for training videos, and presentations made by users