ILLiad-Alma User Data Integration version 1

Target releaseversion 1
Epic
Document status
DRAFT
Document owner
Project Team
Developers
QA

Deliverables

User Data via New Alma API

Alma-ILLiad-User-Data-Integration

Bitbucket

Github

Login and team membership required

Public

ILLiad Login 

ILLiad-Login-with-External-User-Data-Source

Bitbucket

Github

Login and team membership required.

Public


Goals

  • Automated creation and update of ILLiad user accounts utilizing Alma User Data API.
  • Script package available for deployment at all campuses.

Background and strategic fit

This project utilizes the capabilities of the Systemwide ULMS to create a more efficient account management process in ILLiad. 

Assumptions

  • Locally-hosted ILLiad instance for campuses wanting to deploy this integration.

Requirements

#TitleUser StoryImportanceNotes
1Automated user account creationMust Have
2Automated account data update upon successful authentication Must Have 
3    

User feedback, interaction, and design specifications

Initial survey to determine campus requirements

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome

Where should API lookup script live?

Do all campuses have a server where they can place the script? 
If campus is not able to self-host, should SDLS host the script? 

Not Doing

  • Implementation of Shibboleth for ILLiad authentication across multiple campuses. This is best addresses in follow-up project.

Major tasks

Description / Lead / Completion Date

  • Create survey to campuses asking for contact and specific use cases / Lauren Magnuson (Unlicensed) /  
  • Wrap-up survey / Lauren Magnuson (Unlicensed) 
  • Update San Marcos sample script to utilize REST API / Ian Chan (Unlicensed) 
  • Analyze survey submissions and update requirements / ALL /  
  • Communicate updated requirements to campus contacts / ???? /  
  • Update and make it a deployable package / Various /  
  • Test / Various /   
  • Version 1 ready for campus testing / Ian Chan (Unlicensed) 
  • Campuses complete testing of version 1 / Ian Chan (Unlicensed) 
  • Production version ready for campuses / Ian Chan (Unlicensed) /   
  • Instructions for using the ILLiad Login / ILLiad Login with External User Data Source / Ian Chan (Unlicensed)