coral-erm / documentation Goto Github PK

I followed the ILS integration documentation for Koha but was having trouble while trying to add a new organization in Coral (version used was 2020.09). Specifically, while typing the first few letters of a vendor in Coral's Name field (the vendor I was looking up already existed in Koha), I could not get any information from my Koha instance (version 20.05.05).

Turns out Koha was actually replying with a 403 which included the required permissions that needed to be set so that the Coral user would be able to query vendor data:

HTTP/1.1 403 Forbidden
Date: Fri, 26 Feb 2021 12:41:38 GMT
Server: Apache/2.4.38 (Debian)
Content-Length: 122
Vary: User-Agent
Content-Type: application/json; charset=utf8

{"error":"Authorization failure. Missing required permission(s).","required_permissions":{"acquisition":"vendors_manage"}}

After I gave my user the required permissions I was able to successfully query vendor data from Koha.

I suggest we update the documentation to reflect this requirement -- expect a PR soon.

I was researching the documentation for the Terms Tool and noticed that there seems to be some missing pieces (e.g. screenshots):

http://docs.coral-erm.org/en/latest/terms.html

For example, the second paragraph mentions a screenshot but there isn't one where it's referred to:

"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."

https://github.com/coral-erm/documentation/blob/master/source/install.md#software-requirements

I think it would be very helpful, and reduce the number of inquiries to help and the mailing list if a few items are added to the software requirements.

• for PHP 5 the system needs the MySQL Native Driver extension (mysqlnd)
• for all versions(?) of PHP the Multibyte String extension is required (mbstring)
• the server needs to have software for sending mail like sendmail or postfix

The calendar section on this page: http://docs.coral-erm.org/en/latest/licensing.html seems to have been skipped.

I don't think a link to the CORAL schema is anywhere: http://www.coral-erm.org/schema/