Using the Aleph REST API to support item requests from a separate discovery system (Aquabrowser)

by Corinna Baksik

Development work by

Michael Vandermillen

Why 1 Seamless user experience httphollisharvardeduitemid=|librarymaleph|012353769 httpcheethamhulharvardedu8992Ffunc=item-hold-requestampdoc_library=HVD50ampadm_doc_number=012353769ampitem_sequence=000010

Why 1 Seamless user experience httphollisharvardeduitemid=|librarymaleph|012353769 httpcheethamhulharvardedu8992Ffunc=item-hold-requestampdoc_library=HVD50ampadm_doc_number=012353769ampitem_sequence=000010

Why 2 Better stats

Why 3 Better mobile experience

Setting up JBOSS server

1 Start stop server via utilw (Server does not appear in utilw1 (Monitor

servers)

2 Type jlog at prompt to see log

3 Update globalproperties file with ports server names

4 $alephe_rootdlf_engdlf-globaltng

(we use to delete private data we donrsquot need)

5 open port 189

Design

Link to local app (with ADM + Item Seq )

Authentication

Check for Patron Blocks

Send Request

Check Borrower Expiration Date

Show Request Options and Instructions

Aquabrowser

PIN System

Local app

Retrieve Patron ID via call to X-server

REST

API

Aquabrowser interface

httphollisserviceslibharvardeduitemrequestbibid=HVD01012809860 ampitemid=HVD50012353769000010

Why 3 Better mobile experience

Setting up JBOSS server

1 Start stop server via utilw (Server does not appear in utilw1 (Monitor

servers)

2 Type jlog at prompt to see log

3 Update globalproperties file with ports server names

4 $alephe_rootdlf_engdlf-globaltng

(we use to delete private data we donrsquot need)

5 open port 189

Design

Link to local app (with ADM + Item Seq )

Authentication

Check for Patron Blocks

Send Request

Check Borrower Expiration Date

Show Request Options and Instructions

Aquabrowser

PIN System

Local app

Retrieve Patron ID via call to X-server

REST

API

Aquabrowser interface

httphollisserviceslibharvardeduitemrequestbibid=HVD01012809860 ampitemid=HVD50012353769000010

Setting up JBOSS server

1 Start stop server via utilw (Server does not appear in utilw1 (Monitor

servers)

2 Type jlog at prompt to see log

3 Update globalproperties file with ports server names

4 $alephe_rootdlf_engdlf-globaltng

(we use to delete private data we donrsquot need)

5 open port 189

Design

Link to local app (with ADM + Item Seq )

Authentication

Check for Patron Blocks

Send Request

Check Borrower Expiration Date

Show Request Options and Instructions

Aquabrowser

PIN System

Local app

Retrieve Patron ID via call to X-server

REST

API

Aquabrowser interface

httphollisserviceslibharvardeduitemrequestbibid=HVD01012809860 ampitemid=HVD50012353769000010

Design

Link to local app (with ADM + Item Seq )

Authentication

Check for Patron Blocks

Send Request

Check Borrower Expiration Date

Show Request Options and Instructions

Aquabrowser

PIN System

Local app

Retrieve Patron ID via call to X-server

REST

API

Aquabrowser interface

httphollisserviceslibharvardeduitemrequestbibid=HVD01012809860 ampitemid=HVD50012353769000010

Aquabrowser interface

httphollisserviceslibharvardeduitemrequestbibid=HVD01012809860 ampitemid=HVD50012353769000010

Authentication

bull Harvard PIN Server

bull Harvard ID Aleph Patron ID

httpcheethamhulharvardedu8992

Xop=bor-by-key

ampbor_id=HUIDampverification=HUIDamplibrary=hvd50

ampuser_name=clientIDampuser_password=clientPW

REST call for patron info

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronInformationaddress

Expired ID Aleph OPAC

Expired ID Aquabrowser

REST call

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusregistration

Patron Blocks Aleph OPAC

bull Patron is presented with a confirmation screen

bull When they go to library to get book theyrsquoll be told they canrsquot check it out due to blocks

Patron Blocks Aleph OPAC

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Expired ID Aleph OPAC

Expired ID Aquabrowser

REST call

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusregistration

Patron Blocks Aleph OPAC

bull Patron is presented with a confirmation screen

bull When they go to library to get book theyrsquoll be told they canrsquot check it out due to blocks

Patron Blocks Aleph OPAC

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Expired ID Aquabrowser

REST call

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusregistration

Patron Blocks Aleph OPAC

bull Patron is presented with a confirmation screen

bull When they go to library to get book theyrsquoll be told they canrsquot check it out due to blocks

Patron Blocks Aleph OPAC

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

REST call

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusregistration

Patron Blocks Aleph OPAC

bull Patron is presented with a confirmation screen

bull When they go to library to get book theyrsquoll be told they canrsquot check it out due to blocks

Patron Blocks Aleph OPAC

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Patron Blocks Aleph OPAC

bull Patron is presented with a confirmation screen

bull When they go to library to get book theyrsquoll be told they canrsquot check it out due to blocks

Patron Blocks Aleph OPAC

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

bull Patron is presented with a confirmation screen

bull When they go to library to get book theyrsquoll be told they canrsquot check it out due to blocks

Patron Blocks Aleph OPAC

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Patron Blocks Aleph OPAC

The only place they would see a block is in their My Account page

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Patron Block Aquabrowser

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Use REST to check for block

httpcheethamhulharvardedu1892rest-dlfpatron patronIDpatronStatusblocks

Hold Request Aleph OPAC

Hold Request Aquabrowser

Hold Request httpcheethamhulharvardedu1892rest-dlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

Hold Request Aquabrowser

Hold Request httpcheethamhulharvardedu1892rest-dlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

Hold Request httpcheethamhulharvardedu1892rest-dlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

Use XSL to modify what Aleph returns

Example Item on loan with a waitlist

Apply XSLT to XML from Aleph API

Notes returned by Aleph API

XSLT applied to Notes

On Loan until 123199

Send Request httpcheethamhulharvardedu1892restdlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

post_xml=

lthold-request-parametersgt

ltpickup-locationgt

pickup-locationcode

ltpickup-locationgt

ltnote-1gtltnote-1gt

ltnote-2gtltnote-2gt

lthold-request-parametersgt

Apply XSLT to XML from Aleph API

Notes returned by Aleph API

XSLT applied to Notes

On Loan until 123199

Send Request httpcheethamhulharvardedu1892restdlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

post_xml=

lthold-request-parametersgt

ltpickup-locationgt

pickup-locationcode

ltpickup-locationgt

ltnote-1gtltnote-1gt

ltnote-2gtltnote-2gt

lthold-request-parametersgt

On Loan until 123199

Send Request httpcheethamhulharvardedu1892restdlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

post_xml=

lthold-request-parametersgt

ltpickup-locationgt

pickup-locationcode

ltpickup-locationgt

ltnote-1gtltnote-1gt

ltnote-2gtltnote-2gt

lthold-request-parametersgt

Send Request httpcheethamhulharvardedu1892restdlfpatron patronIDrecordHVD01bibitemsHVD50ADMSEQhold

post_xml=

lthold-request-parametersgt

ltpickup-locationgt

pickup-locationcode

ltpickup-locationgt

ltnote-1gtltnote-1gt

ltnote-2gtltnote-2gt

lthold-request-parametersgt

Success

Mobile stylesheet

httphollisserviceslibharvardeduhollisservicesitemrequestbibid=HVD01012809860ampitemid=HVD50007605221000010

Mobile stylesheet

httphollisserviceslibharvardeduhollisservicesitemrequestbibid=HVD01012809860ampitemid=HVD50007605221000010

About the local app (Developer Michael Vandermillen Harvard Library)

bull Resides on separate server

bull Tomcat application running behind Apache

bull Groovy and Grails web app framework (Java platform)

Future Plans

bull Create new interface for all My Account info

bull Create an interface that also includes other patron requests so users can see all library activity in one place

(ILL Borrow Direct EDD Aeon)

Questions

Corinna Baksik Systems Librarian Office for Information Systems Harvard Library Email corinna_baksikharvardedu Skype corinna_baksik

See also bull Ex Libris Commons bull ldquoAleph Restful APIs ldquo Powerpoint on Doc Center

Future Plans

bull Create new interface for all My Account info

bull Create an interface that also includes other patron requests so users can see all library activity in one place

(ILL Borrow Direct EDD Aeon)

Questions

Corinna Baksik Systems Librarian Office for Information Systems Harvard Library Email corinna_baksikharvardedu Skype corinna_baksik

See also bull Ex Libris Commons bull ldquoAleph Restful APIs ldquo Powerpoint on Doc Center

Questions

Corinna Baksik Systems Librarian Office for Information Systems Harvard Library Email corinna_baksikharvardedu Skype corinna_baksik

See also bull Ex Libris Commons bull ldquoAleph Restful APIs ldquo Powerpoint on Doc Center