Registry Job Shell is a command line utility for running various scheduled tasks. It is primarily intended to be run via Cron, though it can also be run manually.
Prior to v1.1.0, JobShell was known as CronShell.
Installation and Running
For installation instruction via cron, see Registry Installation - Cron.
To run JobShell manually, the usage is
JobShell Usage
$ cd ${REGISTRY_SRC}/app
$ su -c "./Console/cake job ${ARGS}" ${APACHE_USER}
After running JobShell, it may be necessary to manually clear or change ownership on cache files, especially if the command is not run as the Apache user.
Arguments
Usage: job [-hqv] [-c coid] [task] [task...]
Where:
- c: Numeric CO ID to process tasks for (default: All COs) (
--coid) - h: Display help (
--help) - q: Quiet mode, suppress most output (
--quiet) - v: Verbose mode, enable additional output (
--verbose) - task: Task or tasks to run (default: All available tasks)
JobShell is designed to provide minimal command line output, with actions instead recorded in Registry Job History.
Tasks
The following tasks are supported by Job Shell:
- expirations: Run Expiration Policies
- In most cases, it makes sense to run expirations once per day, as this task is primarily useful for expirations driven by calendar dates. However, if your deployment includes business processes that manually manage criteria for expiration (eg: expiration driven by moving a record to a different COU) you may wish to run expirations more frequently.
- syncorgsources: Sync Organizational Identity Sources