Configuration Jobs

The jobs.yaml is required to be in the config directory and is the main file that is used to control the system. This files is used to schedule what jobs will be ran by the system.

Basic file structure

Sample data can be found at config/sample.jobs.yaml

vars:
  run_env: "TEST"
  trans_active: true

jobs:
    -   name: "Transfer"
        run_env: "${run_env}"
        trans_active: ${trans_active}
        job_config: "transfer.yaml"
        run_days: 
            - 2
            - 3
            - 4
            - 5
        run_on_month: "EVERY"
        run_on_day:
            - 1
            - 15
            - 30

vars Fields

The vars section allows you to set variables that can be used in the jobs section. This allows you to set a variable once and use it in multiple jobs.

Jobs Fields

name

• The name of the processor. This will be used in the count data returned by the backend system.

run_env

Used by the processing system to determine which environment variables are used to connect to FOLIO. This allows you to easily change from a Test to Production environment without having to change usernames and passwords in the .env file.

Any value can be used as long as there are matching credentials.

Suggested values:

• PRODUCTION
• TEST
• TRAINING

process_active

• (options) true or false
  • true if selected this means that the fee/fine will be processed by the system.
  • false if selected this means that the fee/fine will not be processed by the system but a pre-flit will be returned as well as the url and body that would have been sent.

false is used for testing if processing functions without changing data. WARNING If set to false the system will not process any data no matter the setting in Processing.

job_config

• The name of the file that contains the job configuration. This file should be in the same directory as the jobs.yaml file.

Run days

These three settings can be used to determine when the job will run. all three settings are required and can be used in a few different combinations to determine to achieve the desired outcome.

run_days

The day of the week that this should be ran. This can be used independently or with the run_on_month setting.

• Weekday as a decimal number, where 0 is Sunday and 6 is Saturday.

Decimal	Weekday
0	Sunday
1	Monday
2	Tuesday
3	Wednesday
4	Thursday
5	Friday
6	Saturday

run_on_month

The month that the job will run on. This is a list of months that the job will run on or EVEN or ODD months. This can be combined with either run_days or run_on_day to determine when the job will run.

• The month that the job will run on. This is a list of months that the job will run on.
  • EVERY - The job will run every month.
  • ODD - The job will run on odd months.
  • EVEN - The job will run on even months.
  • 1-12 - The job will run on the month specified.

run_on_day

This is what day the job should be ran. This can be used independently or with the run_on_month setting. It should not be used with the run_days setting.

• The day of the month that the job will run on. This is a list of days that the job will run on.
  • 1-31 - The job will run on the day specified.
  • EVERY - The job will run every day.
  • ODD - The job will run on odd days.
  • EVEN - The job will run on even days.
  • LAST - The job will run on the last day of the month.
  • FIRST - The job will run on the first day of the month.
  • WEEKDAY - The job will run on weekdays.
  • WEEKEND - The job will run on weekends.