Onboarding a system (Containing Agencies)

Collecting Data

Before you begin read the Collecting Data page to understand what resources DCB needs to understand for different roles, what files and mapping tables you need to prepare, and how to get ready to implement.

Configuring Systems

Hosting providers can onboard libraries through a number of mechanisms. Initially, posting JSON to the /hostlmss endpoint is sufficient for DCB to begin the process of harvesting records.


curl -X POST $TARGET/hostlmss -H "Content-Type: application/json"  -H "Authorization: Bearer $TOKEN" -d '{
  "id":"'uuidgen --sha1 -n $HOSTLMS_NS_UUID --name CODE-OF-SYSTEM'",
  "code":"CODE-OF-SYSTEM",
  "name":"Name",
  "lmsClientClass": "org.olf.dcb.core.interaction.sierra.SierraLmsClient",
  "clientConfig": {
    "base-url": "https://some.url/",
    "key": "akey",
    "page-size": "1000",
    "secret": "asecret",
    "ingest": "false"
  }
}'

The currently supported Host LMS clients are Sierra, Folio and Polaris. The dev team seek guidance from the community on priorities for other LMS implementations.

Client Config

Each class supports different clientConfig properties:

Property	Sierra	Polaris	FOLIO	Dummy

Property	Sierra	Polaris	FOLIO	Dummy
lmsClientClass	`org.olf.dcb.core.interaction.sierra.SierraLmsClient`	`org.olf.dcb.core.interaction.polaris.PolarisLmsClient`	`org.olf.dcb.core.interaction.folio.FOLIOLmsClient`	`org.olf.dcb.devtools.interaction.dummy.DummyLmsClient`
base-url	https://some.url/	https://some.url/	https://some.url/
key	akey	akey	akey
page-size	1000	1000	1000
secret	asecret	asecret	asecret
ingest	false	false	false	true
shelving-locations				list of location codes
num-records-to-generate				1000

DummyLMSClient

An additional DummyLmsClient is available (org.olf.dcb.devtools.interaction.dummy.DummyLmsClient).

This client allows an administrator to configure a working DCB-Service which mocks an arbitrary number of records and supports a full requesting flow without the need for a live backend library management system.

Supported configuration settings are

shelving-locations - A list of location codes which will be used to generate fake item availability records for the dummy records generated. Users will need to configure Agencies and Locations corresponding to any test locations specified.
num-records-to-generate - An integer which tells the client how many dummy records to generate

curl -X POST $TARGET/hostlmss -H "Content-Type: application/json"  -H "Authorization: Bearer $TOKEN" -d '{
  "id":"'uuidgen --sha1 -n $HOSTLMS_NS_UUID --name DUMMY1'",
  "code":"DUMMY1",
  "name":"Dummy1",
  "lmsClientClass": "org.olf.dcb.devtools.interaction.dummy.DummyLmsClient",
  "clientConfig": {
    "ingest": "true",
    "num-records-to-generate": 1000,
    "shelving-locations": "LMS-A1-SL1,LMS-A1-SL2,LMS-A2-SL1,LMS-A2-SL2,LMS-A2-SL3"
  }
}'

Library Configurations

MOBIUS Implementation

Earliest changes can be made to existing production systems is after INN-Reach freeze
Latest changes to existing production systems is before launch.

Window is 24 Apr to 21 May.

Sierra

Update eligible patron types setting to include patron types expected to be recognised for DCB mappings
Circulation rules
1. Loan rules
  1. Lending rule loan period (currently the institutional loan rule) should be modified <normal loan period days> + <renewal period(s) days> + <return to home library days>
2. Reconcile patron types with updated MOBIUS spine values
3. Remove redundant patron types from loan rule determiner table
4. Reconcile local item types with updated MOBIUS spine values
Maintain circulation statuses: REQUESTED (&) and RECEIVED (#)
Item paging slips [need information from @Scott Peterson to create this instruction]
SIP2 enabled clients are expected to work out of the box.

Polaris

[Stephanie N. meeting 2/20/24 to help me fill the remainder of this]
Reuse or create anew patron code for “OpenRS DCB”
SIP2 enabled clients are expected to work out of the box.