Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alliance-pcsg/primo-explore-reserves-request
functionality for requesting items for course reserve within the catalog, for selected user groups
https://github.com/alliance-pcsg/primo-explore-reserves-request
Last synced: about 1 month ago
JSON representation
functionality for requesting items for course reserve within the catalog, for selected user groups
- Host: GitHub
- URL: https://github.com/alliance-pcsg/primo-explore-reserves-request
- Owner: alliance-pcsg
- Created: 2018-11-04T19:03:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-29T21:52:30.000Z (almost 2 years ago)
- Last Synced: 2024-11-05T14:59:36.285Z (2 months ago)
- Language: JavaScript
- Size: 233 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# primo-explore-reserves-request
## Features
Allows users to submit requests for course reserves directly from the Primo catalog. Requires a server side php file to receive the request from Primo, and send as email to reserves staff. Within the app.constant options, you can indicate which user groups will see the request option.
### Screenshot
## Install
1. Make sure you've installed and configured [primo-explore-devenv](https://github.com/ExLibrisGroup/primo-explore-devenv).
2. Navigate to your template/central package root directory. For example:
```
cd primo-explore/custom/MY_VIEW_ID
```
3. If you do not already have a `package.json` file in this directory, create one:
```
npm init -y
```
4. Install this package:
```
npm install primo-explore-reserves-request --save-dev
```
## Usage
Once this package is installed, add `reservesRequest` as a dependency for your custom module definition.
```js
var app = angular.module('viewCustom', ['reservesRequest'])
```
Note: If you're using the `--browserify` build option, you will need to first import the module with:
```javascript
import 'primo-explore-reserves-request';
```
You can configure this customization by passing the following options via reserveRequestOptions (a full example is at the bottom of [this file](https://github.com/alliance-pcsg/primo-explore-reserves-request/blob/master/example/custom.js).) :
| param | type | usage |
|-----------|--------------|----------------------------------------------------------------------------------------------------------------------|
| `instCode` | string | the short code of your institution target |
| `formatBlacklist` | array | format types for which you don't want the request option to appear (e.g. journal) |
| `userGroupWhitelist` | array | Alma user groups for which you want the request option to appear
| `selectProps` | mixed | values for the reserves loan period select menu
| `targetUrl` | string | URL where your PHP script lives, for converting data to email request |
| `successMessage` | html | Message users will see upon successful request |
| `failureMessage` | html | Message users will see upon failed request |
| `primoDomain` | string | Domain of your primo instance (e.g. primo.lclark.edu). Used to generate permalink for staff. |
| `primoVid` | string | VID of your Primo view. Used to generate permalink for staff. |
| `primoScope` | string | Primo scope. Used to generate permalink for staff. |
For example:
```
/* edit these below to fit your local environment */
app.constant('reserveRequestOptions', {
instCode : "LCC", /* code of your library */
formatBlacklist : ["journal", "ebook"], /* formats for which this will not appear */
userGroupWhitelist : ["2","3","anotherGroup"], /* array of whitelisted group members who will see this when authenticated */
selectProps : {
"value": "3 hours", /* initial default text display in select menu */
"values": ["3 hours", "1 day", "3 days"], /* pulldown menu options for loan periods*/
"loanRule" : "3 hours" /* defaut select value for value*/
},
targetUrl : "https://mylibrary.edu/process.php", /* URL to send data to, for emailing, etc.*/
successMessage : "
Your request has been placed. Watzek Library Access Services staff will aim to place the item on reserve within 24 hours. Items that are checked out will be recalled and placed on reserves as soon as possible. If you have questions, please email [email protected], or contact the Service Desk at 503-768-7270.
",
failureMessage : "We're sorry, an error occurred. Please let us know at [email protected], or contact the Service Desk at 503-768-7270.
",
primoDomain : "primo.lclark.edu",
primoVid : "LCC",
primoScope : "lcc_local"
});
```