tamulib / mod-spine-o-matic Goto Github PK

License: MIT License

Dockerfile 3.69% Java 96.31%

mod-spine-o-matic's Introduction

mod-spine-o-matic

A middleware module for providing Alma like XML responses for use with SpineOMatic.

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

API

There is a single endpoint /spine-label?identifier={item barcode|item hrid}.

Sample use with SpineOMatic

Configure Alma Access to mod-spine-o-matic

Use default call number parsing

Use custom label

available XML fields

<title>
<call_number_prefix>
<call_number>
<call_number_type_name>
<call_number_type>
<enumeration>
<chronology>
<issue_level_description>
<library_name>
<library_code>
<location_name>
<location_code>
<current_date>
<enum_latest>
<chron_latest>
<enum_n> *
<chron_n> *

* where n is the line number from receiving history (i.e. chron_2)

seperate call number prefix

barcode	item hrid
A14839145884

Custom

XML sources:

<call_number_prefix>
%<call_number>

A14839145884

Oversize
PN
6728
A37
M55
2006

enumeration and chronology populated

barcode	item hrid
A14811944997	it00000000005
A14814371046	it00000000006
A14812022756	it00000000007

Custom

XML sources:

%<call_number>
<chronology>
<enumeration>

A14811944997

SB
450.9
N45
1987
v.1:no.1-6

A14814371046

SB
450.9
N45
1987
v.1:no.7-12

A14812022756

SB
450.9
N45
1988
v.2

enumeration null, chronology populated

barcode	item hrid
A14809369076	it00000663619
A14809369084	it00000663620
A14809369092	it00000663621

Custom

XML sources:

%<call_number>
<chronology>

A14809369076

TK
454.2
I15
1985:v.1

A14809369084

TK
454.2
I15
1985:v.2

A14809369092

TK
454.2
I15
1985:v.3

enumeration populated, chronology null

barcode	item hrid
A14809356455	it00000663602
A14809356463	it00000663603
A14809356471	it00000663604

Custom

XML sources:

%<call_number>
<enumeration>

A14809356455

PQ
6089
C37
1982
v.1:pt.a

A14809356463

PQ
6089
C37
1982
v.2

A14809356471

PQ
6089
C37
1982
v.3

barcode is null, so input hrid

barcode	item hrid
	it00000165900
	it00000000042
	it00000165904

Spine

SpineOMatic parsing <call_number>

it00000165900

Z
1006
C6

it00000000042

PN
1992.8
S35
J38
1987

it00000165904

enumerations and chronologies from holdings by hrid

barcode	holdings hrid
	ho00000044908

Custom

XML sources:

%<call_number>
<chron_1>
<enum_1>
<chron_latest>
<enum_latest>

ho00000044908

UG
633
A65
(2021 May)
v. 104, no. 5 
(2020 Jan.-Feb.)
v. 104, no. 1-2

Additional Information

Other modules.

Other FOLIO Developer documentation is at dev.folio.org.

Docker deployment

When deploying docker, be sure to set the appropriate ports for your environment (make the guest port matches the port specified in src/main/resources/application.yml file). In the example below, the -p 9000:9000 represents -p [host port]:[guest port] with guest referring to the docker image and host referring to the system running docker.

docker build -t folio/mod-spine-o-matic .
docker run -d -p 9000:9000 folio/mod-spine-o-matic

Publish docker image

docker login [docker repo]
docker build -t [docker repo]/folio/mod-spine-o-matic:[version] .
docker push [docker repo]/folio/mod-spine-o-matic:[version]

Issue tracker

See project FOLIO at the FOLIO issue tracker.

mod-spine-o-matic's People

Contributors

Watchers

Forkers

mbubaf ebscois

mod-spine-o-matic's Issues

Mod-Spine-O-Matic - Unable to get the results as is documented in the QA template

We are able to ping the API endpoint successfully - but the Spine-O-Matic tool (PC platform) does not respond with the desired result

Try setting the URL https://github.com/TAMULib/mod-spine-o-matic/blob/main/config/ in SpineOMatic as the place where it can find the aboveLabel.txt.

Upgrade Spring module core dependency (1.1.1)

Thymeleaf XML template for ALMA response

Update Spine-o-Matic README HRIDs after final migration

Mod Spine-O-Matic Nolana QA on Testing

Service to take JSON and return result of templating

Spine-o-Matic QA - Need procedures in wiki. Starting point is README at https://github.com/TAMULib/mod-spine-o-matic

Dynamically pull and store reference data

Service to request item from FOLIO

Need to configure the request URL and the subpath for the endpoint. Do this in application.properties.
This service will return a JSON node that is immediately interpretable by the Thymeleaf template.

Call number parsing for custom labels

When the data in the call number field isn't enough to generate the label (i.e. it needs a prefix or location) we need to parse the call number into the <parsed_call_number> field to generate the correct label.

Custom prefix lookup

There is a case for prefixes that are not in FOLIO. These will need to be expressed in a file and loaded on startup.

Spine-o-Matic prefixes should be in all caps

Currently Oversized is being converted to all caps, we need to confirm that all prefixes should be all caps or obtain a list of what needs to be reformatted.

Mod Spine-O-Matic Nolana QA on Dev

Location gloss no longer needed with external configuration

Remove database configuration

Not needed and is only complicating the app.

Generate application with FOLIO Okapi parent

Afford lookup by hrid

In addition, to call number, should be able to supply hrid.

Print receipt data for checked-in issues.

Example, look at holdings record hrid=ho00000044909, receiving history section. There are 6 lines there -- the operator would need to have location & call number from the holdings record plus be able to select one of those lines, which contain enumeration and chronology, to print on the label.

SpineOMatic isn't printing, gives error message when list of fetched items is of length 0

Error report when using Spine-O-Matic:
Copied item ID from FOLIO it000041933902
Opened spine label program & pasted in it000041933903.
get an error message ***** ERROR ***** Can't retrieve XML file.Error message: The remote server returned an error: (500) Internal Server Error.

Suggestion from William:
Looks like we need some more guard clauses in the okapi service

https://github.com/TAMULib/mod-spine-o-matic/blob/e18780ac19284cd479179c0833273e3a[…]src/main/java/edu/tamu/modspineomatic/service/OkapiService.java

These are all assuming at least one response and when it grabs the 0 index of empty array it returns null.

Spine label samples

Both enumeration and chronology populated
   barcode    |     hrid
--------------+---------------
 A14811944997 | it00000000005
 A14814371046 | it00000000006
 A14812022756 | it00000000007

enumeration null, chronology populated
   barcode    |     hrid
--------------+---------------
 A14809369076 | it00000663749
 A14809369084 | it00000663750
 A14809369092 | it00000663751

enumeration populated, chronology null
   barcode    |     hrid
--------------+---------------
 A14809356455 | it00000663732
 A14809356463 | it00000663733
 A14809356471 | it00000663734

barcode is null, so input hrid
 barcode |     hrid
---------+---------------
         | it00000165938
         | it00000000042
         | it00000165945

location requiring special label printing
 A14823400064 | it00000498821 | mtxt,film
 A14823883296 | it00000498822 | mtxt,film
              | it00000831473 | cush,wode
              | it00000748781 | cush,wode
 A14809478998 | it00000667357 | wein
 A14809479009 | it00000667360 | wein
              | it00002821308 | cush,afri
              | it00002821372 | cush,afri
              | it00002821509 | cush,afri
              | it00002933250 | cush,asia
              | it00002933253 | cush,asia
              | it00002690836 | cush,asia

tamulib / mod-spine-o-matic Goto Github PK

mod-spine-o-matic's Introduction

mod-spine-o-matic

API

Sample use with SpineOMatic

available XML fields

seperate call number prefix

enumeration and chronology populated

enumeration null, chronology populated

enumeration populated, chronology null

barcode is null, so input hrid

enumerations and chronologies from holdings by hrid

Additional Information

Docker deployment

Publish docker image

Issue tracker

mod-spine-o-matic's People

Contributors

Watchers

Forkers

mod-spine-o-matic's Issues

Recommend Projects

Recommend Topics

Recommend Org