Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alliance-pcsg/primo-explore-my-ill
Load illiad requests & articles into Primo "My Account"
https://github.com/alliance-pcsg/primo-explore-my-ill
angularjs interlibraryloan primo-explore
Last synced: about 2 months ago
JSON representation
Load illiad requests & articles into Primo "My Account"
- Host: GitHub
- URL: https://github.com/alliance-pcsg/primo-explore-my-ill
- Owner: alliance-pcsg
- License: mit
- Created: 2017-08-07T22:36:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-02T21:57:41.000Z (over 6 years ago)
- Last Synced: 2024-08-08T20:14:56.318Z (5 months ago)
- Topics: angularjs, interlibraryloan, primo-explore
- Language: JavaScript
- Size: 341 KB
- Stars: 9
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# primo-explore-my-ill
Load illiad requests & articles into Primo "My Account"
## Features
Creates a pane in Primo New UI "My Account". Queries ILLiad for user's current requests and received articles, and displays them in the pane, including direct links to articles.
### 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-my-ill --save-dev
```
5. Generate an ILLiad Web Platform API Key, as described [here](https://prometheus.atlas-sys.com/display/illiad/The+ILLiad+Web+Platform+API).
6. Deploy the php file to a server accessible to you. Edit lines 7, 10, and 11.
7. Place the .htaccess file in the same directory as your PHP file to add CORS authorization. Note: if CORS is still an issue, please visit [this page](https://awesometoast.com/cors/) for further solutions to get this working.
## Usage
Once this package is installed, add `my-ill` as a dependency for your custom module definition.
```js
var app = angular.module('viewCustom', ['myILL'])
```
Note: If you're using the `--browserify` build option, you will need to first import the module with:
```javascript
import 'primo-explore-my-ill';
```
You can configure the banner by passing a configuration object. All properties are required.
| name | type | usage |
|-----------|--------------|-----------------------------------------------------------------------------------------|
| `groups` | array | array of alma user group codes in which this should appear |
| `remoteScript` | string | url of server-side php script |
| `boxTitle` | string | Text to appear at the top of the ILL box |
| `illiadURL` | string | url of your ILLiad login page |
| `apiURL` | string | url of ILLiad Web Platform endpoint for Transactions/UserRequests (documentation [here](https://prometheus.atlas-sys.com/display/illiad/The+ILLiad+Web+Platform+API)) |
The code below adds a banner similar to the above image.
```js
app.constant('illiadOptions', {
"groups": [0,1,2,3],
"remoteScript": "https://mydomain.com/illiad.php",
"boxTitle": "My Library Interlibrary Loan",
"illiadURL": "https://illiad.myinstitution.edu/illiad/Logon.html",
"apiURL": "https://illiad.myinstitution.edu/ILLiadWebPlatform/Transaction/UserRequests/",
})
```