Job
User Guide — Defining Jobs, Their Queues, and Their Types
| Last updated: September 2026
Contents
1. Overview
A job is a task OnCoor can run — on demand or on a schedule. The Job screen (shown as Define Job) is where jobs and the things they depend on are set up. Once a job is defined here, you can Start it to run it now, a Worker can run it automatically on a calendar (see the Worker guide), and every run appears in Scheduled Jobs (see the Scheduled Jobs guide).
The screen is organised into three tabs — Job, Queue, and Job Type — which together define the jobs, the lanes they run on, and the kinds of job available.
WHERE TO FIND IT — Job is under Process → Config. It opens the Define Job screen on the Job tab, with Queue and Job Type alongside.
2. Finding Your Way Around
The three tabs across the top do different jobs:
| Tab | What it's for |
|---|---|
| Job | Define the jobs themselves — and run them (section 3). |
| Queue | Manage the queues jobs run on (section 4). |
| Job Type | Manage the kinds of job available (section 5). |
Because a job is assigned to a queue and built from a job type, it helps to set up your queues and job types first, then define the jobs that use them.
3. The Job Tab
The Job tab lists the jobs that have been defined. Each row is one job.
| Column | What it shows |
|---|---|
| Record Name | The job's short record name (comes from its job type). |
| Job Name | Its full, friendly name. |
| Check Availability | Whether the job checks that it's able to run before it starts. |
| Assigned Queue | The queue the job runs on. |
| Status | Whether the job is active. |
Each row also has three actions: Parameters (section 3.2), Start (section 3.3), and Delete to remove the job.
3.1 Adding a Job
- Click the Add button (the +) to open Add New Job.
- Fill in the fields:
| Field | What it's for |
|---|---|
| Job Record Name | The job type's record name — pick it from the list. |
| Job Name | The specific job to run. |
| Check Availability | Whether the job should confirm it can run before starting. |
| Assigned Queue | The queue the job runs on. |
| Status | Whether the job is active. |
- Save. The job appears in the list.
3.2 Parameters
Many jobs need values to run with — for example a date to process up to. The Parameters action on a job is where those values are defined.
- Click the Parameters icon on the job to open Param Details.
- Each parameter is listed by Job Param Name and whether it's Is Required.
- Add a parameter with the Add button (Add New Job Param): choose the Job Param and set Is Required (whether the job must be given a value for it). Remove one with the delete icon on its row.
The parameters you define here are the values the job asks you for when you Start it.
REQUIRED VS. OPTIONAL — A parameter marked Is Required must be given a value each time the job runs. Mark only the values the job genuinely can't run without.
3.3 Start — Running a Job
The Start action runs the job now. Clicking it opens the Job Initialization window.
- Fill in any parameters the job needs — the required ones must be provided. (If the job takes no parameters, you may simply set an As of Date.)
- Click Initiate.
OnCoor places the run on the job's queue and confirms "Job Initialized Successfully!". From there, follow how the run is going in Scheduled Jobs.
START PUTS A RUN ON THE QUEUE — Clicking Start doesn't necessarily run the job that instant — it queues a run, which then executes in turn. To watch its status, timing, and any error, open Scheduled Jobs.
4. The Queue Tab
A queue is a lane that jobs run on. Queues let OnCoor line jobs up and run them in order rather than all at once. The Queue tab manages them.
| Column | What it shows |
|---|---|
| Queue Name | The name of the queue. |
| Active | Whether the queue is in use. |
| Updated By / Updated Date | Who last changed it, and when. |
Add a queue with the + button and remove one with the delete icon. When you create a job (section 3.1), you assign it to one of these queues.
5. The Job Type Tab
A job type is the kind of job — it ties a record name to the underlying action (the API/lookup) that actually does the work. The Job Type tab manages them.
| Column | What it shows |
|---|---|
| Job Record Name | The record name used to identify the job type. |
| Job Name LookUp | The lookup used to find the job's name. |
| Api | The underlying action the job runs. |
| Updated By / Updated Date | Who last changed it, and when. |
Add a job type with the + button and remove one with the delete icon. When you define a job on the Job tab, its Job Record Name and Job Name come from the job types set up here.
6. Quick Reference
| I want to… | Do this |
|---|---|
| Open the Job screen | Process → Config → Job |
| Define a job | Job tab → + → Record Name, Job Name, Queue, Status |
| Set the values a job runs with | Job tab → Parameters icon → Add → pick a Job Param, set Is Required |
| Run a job now | Job tab → Start → fill parameters → Initiate |
| Watch a running job | Open Scheduled Jobs |
| Run a job automatically on a schedule | Set up a Worker for it |
| Add a queue for jobs to run on | Queue tab → + |
| Add a new kind of job | Job Type tab → + |
| Remove a job, queue, or job type | Click the delete icon on its row |
Source: OnCoor Process Management product documentation, written for end users. For the latest screens and options, always refer to the in-app interface.