Skip to main content

Remote Storage App Configuration

Configuration Files

JsonThere configare filetwo configuration files, one for sandboxthe islive inproduction environment (opt/tomcat/webapps/AlmaRSA-PSB/WEB-INF/classes/conf.json

json),

Jsonand config fileone for productionthe issandbox in (opt/tomcat/webapps/AlmaRemoteStorageApp/WEB-INF/classes/conf.jsonjson).

DefaultThis locationJSON forfile locationgives codesthe notremote storage app important information regarding institution, library, and locaiton codes, as well as API keys, publishing profile IDs, etc.

What exactly is found in the configuration file?

    SCF IZSFTP isserver information Default location code for items in the remote_storage_holding_locationSCF portionIZ of(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 config__ 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 thethis config filesfile requires a reloading of the appRemote

    Storage

    What is in the config file?

    SCF locations

    Publishing job and Request webhooksApp

    Logs


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

    LogsThe file name denotes the type of log file; logs with a file name beginning with PSB-application are for the sandbox

    sandbox,

    Logsand 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"

    .

    Names the subdirectory where publishing job files are placed; thisThis is the S/FTPdestination definition that is configured forwhere the publishing job.profile exports the daily item information file and where the Requests file is also sent.

    SandboxThe needs to be updated with correctspecified subdirectory afteris every"Alma" (or "AlmaRSA-PSB" for sandbox refreshenvironments).

    FTPThe ServerSCF informationData inPreparation configPublishing fileProfile mustfor matchaccessions theuses informationa subdirectory in the sftpformat:
    [Institution definition in Alma
    Code]/items

    ex.01WRLC_AMU/items

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

    Createsex.01WRLC_AMU/requests

    webhooks

    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 (holds,made digitization,to move,items workwith order,a etc.)Remote

        Publishing_job_id

        Storage

        Requests_job_id 

        Exports request infolocation to an SFTP folderserver every 12 hours (at midnight and again at noon)

        Both arefor the sameremote storage app to process. The app searches for the job id (publishing_job_id) in the sandboxconfig.json file

        Relevant Workflows 
          Requests

          Do not edit this profile without communicating with WRLC Central staff. If you save edits it will change the ID of the job to export requests that the Remote Storage App looks for in the Job Finish Webhook.

            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:
                Accessions

                The profile listed below is in production,the unlessSCF 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 
                      Accessions Loans

                       

                      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 profilejob finishes. The job ID is updated in one environment but notlisted in the otherconfig environment.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 ID of the job to export requests that the Remote Storage App looks for in the Job Finish Webhook.

                       

                       
                      Back to top