Skip to main content

Remote Storage App Configuration

Configuration Files

There are two configuration files, one for the live production environment (opt/tomcat/webapps/AlmaRSA-PSB/AlmaRemoteStorageApp/WEB-INF/classes/conf.json), and one for the sandbox (opt/tomcat/webapps/AlmaRemoteStorageApp/AlmaRSA-PSB/WEB-INF/classes/conf.json).

This JSON file gives the remote storage app important information regarding institution, library, and locaitonlocation codes, as well as API keys, publishing profile IDs, etc.

What exactly is found in the configuration file?

  • SCF SFTP server information
  • Default location code for items in the SCF IZ (wrlc stor)
  • API keys for all WRLC Institution Zones
  • Publishing Profile IDs and Job IDs for each IZ (information on how to find these can be found on the __How to find Job IDs for the Remote Storage App page)
  • Institution and Library codes for each IZ
  • Remote Storage Location codes for each IZ

If any changes are made to anything listed above, the configuration file must be updated. Changes made to this file requires a reloading of the Remote Storage App

Logs

Logs for both the production and sandbox environment are in opt/tomcat/logs

The file name denotes the type of log file; logs with a file name beginning with PSB-application are for the sandbox, and logs with a file name beginning with application are for the production environment. 

Log files starts at 6:30 am of the day listed in the name of the log, and ends at 6:30 am of the next day

The log will have thread numbers - each request/action is given a specific thread number. if there are many requests at once, the thread numbers are an easy way to keep track of one request

SCFTP for SCF App S/FTP Definition

The S/FTP Definition configured in Alma is named "SFTP for SCF App". This is the destination where the publishing profile exports the daily item information file and where the Requests file is also sent.

The specified subdirectory is "Alma" (or "AlmaRSA-PSB" for sandbox environments).

The SCF Data Preparation Publishing Profile for accessions uses a subdirectory in the format:
[Institution Code]/items

ex.01WRLC_AMU/items

The Shared Collections Facility Integration Profile for requests uses a subdirectory in the format:
[Institution Code]/requests

ex.01WRLC_AMU/requests

After each sandbox refresh, the sandbox environment must be updated with the correct subdirectory.

Integration Profiles

There are three Integration Profiles used for the Remote Storage App.

The two listed below are in each participating Institution's IZ

  • Shared Collections Facility Integration Profile
    • Profile Type : Remote Storage
    • It runs twice daily (at noon and at midnight) and sends a file of all requests made to items with a Remote Storage location to an SFTP server for the remote storage app to process. The app searches for the job id (publishing_job_id) in the config.json file
    • Relevant Workflows 

Do not edit this profile without communicating with WRLC Central staff. If you save edits, it will change the Job ID, which is what the Remote Storage App looks for in the Job Finish Webhook. Editing this profile requires finding the new Job ID, and then updating the configuration JSON file with the new information.

  • SCF Job Finish Webhook Integration Profile
    • Profile Type: Webhook

    • Sends out a webhook for every job that finishes running in the Institution Zone. The remote storage app searches for the job id (publishing_job_id) in the conf.json file and the institution is selected according to it.

    • Relevant Workflows:

The profile listed below is in the SCF IZ

  • SCF Loans Webhooks Integration Profile
    • Profile Type: Webhook

    • Sends out a webhook for loans in the SCF IZ. The SCFapp changes the status of the owning institution’s item record based on the changes made in the SCF IZ. 

    • Relevant Workflows 

Set for SCF Item records

Every participating WRLC Institution Zone has a Physical Items set that searches for all item records with either a temporary or permanent location at the Shared Collections Facility. Each set has an Internal Note stating DO NOT DELETE.

This set is used for the SCF Data Preparation Profile. 

Publishing Profile

A publishing profile (called the "SCF Data Preparation Profile") in the owning IZ exports a MARC XML file containing new, deleted, and updated items found in a specific Alma set ("Set for SCF Data Prep"). 

The XML file names are :

Institution abbreviation + iz2scf + yyyymmdd + two-digit number + Alma Process ID + new or delete 

ex. au_iz2scf_2025060308_18906688690004102_new

The job is run daily, usually at night or early in the morning

A webhook is sent by the SCF Job Finish Webhook Integration Profile when the publishing job finishes. The job ID is listed in the config file for the app, letting the app know that this is a job that it should look out for. When the app recognizes the job id for the publishing profile, the app examines the file of items published and goes to work creating or updating the items in the SCF IZ.

Do not edit this profile without communicating with WRLC Central staff. If you save edits, it will change the Job ID, which is what the Remote Storage App looks for in the Job Finish Webhook. Editing this profile requires finding the new Job ID, and then updating the configuration JSON file with the new information.

Back to top