A process file is a JSON file defining the processes to run and the required arguments for that process. You can also define verbosity level, if the processes shall be executed or not, if the process should overwrite (update) existing data or delete existing data.

If you do not define:

  • verbosity,
  • execute,
  • overwrite, or
  • delete

The values for those arguments will be inherited from the scheme file.

The process file(s) to run are defined in the job file.

Process file for creating database schemas

The process create_schema requires a single parameter (schema) and the process file for setting up the default schemas of the framework database looks like this:

{
  "process": [
    {
      "process_id": "create_schema",
      "parameters": {
        "schema": "utility"
      }
    },
    {
      "process_id": "create_schema",
      "parameters": {
        "schema": "process"
      }
    },
    {
      "process_id": "create_schema",
      "parameters": {
        "schema": "community"
      }
    }
  ]
}

Note how the actual processes to run are constructed as an array and you can stack any number of processes in a single process file.

If you want to change verbosity, execute, overwrite, or delete for a particular process, you need to expand the JSON:

{
  "process": [
    {
      "process_id": "create_schema",
      "verbosity": 2,
      "overwrite": true,
      "parameters": {
        "schema": "utility"
      }
    },
    ...
    ...
  ]
}

Updated: