Skip to main content

How to find Job IDs for the Remote Storage App

The SCF Job Finish Webhook Integration Profile sends out a webhook every time a job finishes running in the Institution Zone. The Remote Storage App receives all of the webhooks and specifically looks for the webhooks with a Job ID that is listed in the configuration JSON file. 

The specific Job IDs the app is looking for are for the Shared Collections Facility Integration Profile (exports a file of requests to an SCF SFTP folder) and for the SCF Data Preparation Publishing Profile (exports a file of new SCF items).

It is important to keep these Job IDs accurate and up-to-date; Request and Accession workflows are reliant on them. 

If either the Integration Profile or the Publishing Profile are edited in Alma, the Job ID changes. It is essential to communicate with WRLC Staff before editing any of these two profiles.

Follow the workflows detailed below to find the correct Job ID used in the Remote Storage App's configuration file.

 

Publishing Profile Job ID

  • Go to Alma > Resources > Publishing > Publishing Profiles
  • Find the SCF Data Preparation Profile, then choose Edit
  • Copy the Profile ID (found on the top line next to the Profile Name)
  • Copy the API key for this Institution Zone listed in the configuration JSON file
  • Create a URL following this formula:  

https://api-na.hosted.exlibrisgroup.com/almaws/v1/conf/jobs?
+ apikey=[insert API key here] 
+ &profile_id=[insert Profile ID here]

EXAMPLE:

https://api-na.hosted.exlibrisgroup.com/almaws/v1/conf/jobs?apikey=l8xx3ddc6c7128a144e8aa27a8faf383d199&profile_id=7750084200004102
  • In the resulting XML code, find the value for the id element (it is usually the letter S followed by a 17 digit number). That is the Job ID for the publishing profile 

 

Request Integration Profile Job ID

  • Copy the API key for this Institution Zone listed in the configuration JSON file
  • Create a URL following this formula:

https://api-na.hosted.exlibrisgroup.com/almaws/v1/conf/integration-profiles?
+ apikey=[insert API key here] 
+ &type=REMOTE_STORAGE

EXAMPLE:

https://api-na.hosted.exlibrisgroup.com/almaws/v1/conf/integration-profiles?apikey=l8xxdd61599bea484b8d8b7d84a722da788e&type=REMOTE_STORAGE
  • In the resulting XML code, find and copy the value for the id element (it is usually a 16 digit number)
  • Using the id number, create a URL following this formula:

https://api-na.hosted.exlibrisgroup.com/almaws/v1/conf/jobs?
+ apikey=[insert API key here] 
+ &profile_id=[insert Profile ID here]

EXAMPLE:

https://api-na.hosted.exlibrisgroup.com/almaws/v1/conf/jobs?apikey=l8xxdd61599bea484b8d8b7d84a722da788e&profile_id=10385500680004107
  • In the resulting XML code, find the value for the id element (it is usually the letter S followed by a 17 digit number). That is the Job ID for the publishing profile 
Back to top