Nautical Poseidon Mythology

    @orbis-cascade/primo-explore-my-ill

    1.0.0 • Public • Published

    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

    screenshot

    Install

    1. Make sure you've installed and configured 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.

    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 for further solutions to get this working.

    Usage

    Once this package is installed, add my-ill as a dependency for your custom module definition.

    var app = angular.module('viewCustom', ['myILL'])

    Note: If you're using the --browserify build option, you will need to first import the module with:

    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)

    The code below adds a banner similar to the above image.

    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/",
     
     
    })

    Install

    npm i @orbis-cascade/primo-explore-my-ill

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    ISC

    Unpacked Size

    392 kB

    Total Files

    8

    Last publish

    Collaborators

    • kveldhui
    • eoulib
    • bryan_v
    • budak
    • jeremy2443