istex-jobs

Schedule manager for the creation of istex institutional holdings, kbart and such.

• Works with tasks Function that may be scheduled with the jobManager
• Email can be send on Error
• Istex-jobs is compatible with ezMaster
• Configuration via config.json file

Jobs

parameters:

• task (string): The task to invoke.
• [taskArgs] (...*): The arguments to invoke the task with.
• [spec] (string): A cron string to schedule the task. Default: "* * * * *"
• [jobName] (string): The job name. Default: randomName
• [isOneTimeJob] (boolean): Invoke the task only once. Default: false
• [options] (Object):
  1. [sendMailOnErrorTo] (...string): A email list to send alerts message if an error occure on this task.

Tasks

generateKbart

parameters:

• [corpus] (string): Filter by corpus name
• [type] (string): Filter by type serial/monograph
• [reviewBaseUrl] (string): The base url of the Istex review instance. Default: "https://revue-sommaire.data.istex.fr"
• [apiBaseUrl] (string): The base url of the Istex API instance. Default: "https://api.istex.fr"
• [collectionName] (string): The generated collection name. Default: "allTitle" or "${corpus}_${type}"
• [titleBaseUrl] (string): Url for building the title_url value, may be handy if reviewBaseUrl is different than titleBaseUrl. default: "https://revue-sommaire.data.istex.fr"
• [parallel] (number): Number of parallel request to ISTEX API. Default: 15
• [providerName] (string): Provider name for the KBART file. Default: "ISTEX"
• [outputPath] (string): Where to generate files. Default: "./output/exchange"
• [force] (boolean): Does the task must run even if not needed. Default: false
• [doWarn] (boolean): Does Exchange warn about failed request. Default: false

generateHoldings

parameters:

• [contacts] (...string): contacts emails listed in the institutional_links file
• [reviewBaseUrl] (string): The base url of the Istex review instance. Default: "https://revue-sommaire.data.istex.fr"
• [apiBaseUrl] (string): The base url of the Istex API instance. Default: "https://api.istex.fr"
• [parallel] (number): Number of parallel request to ISTEX API. The total number of request is parallel * concurency Default: 15
• [concurency] (number): Number of concurent Corpus processed AKA number of concurent request to ISTEX review. Default: 2
• [outputPath] (string): Where to generate files. Default: "./output/exchange"
• [force] (boolean): Does the task must run even if not needed. Default: false
• [doWarn] (boolean): Does Exchange warn about failed request. Default: false