Discrete tasks executed asynchronously in response to events
ack
to acknowledge the job, update
to update the job’s progress, and complete
or fail
to complete or fail the job.To make this simpler, we provide a plugin called Job Handler that handles the job lifecycle for you. This plugin works by listening to the job:ready
event and executing the handler callback. There is also an optional tick
function which allows you to update the Job’s progress.For example, this listener implementation contains all the code necessary to handle a job:Event | Description |
---|---|
job:created | Fires when a Job is created, but before it does anything. |
job:ready | Fires when a Job is ready to move into the execution stage, but before it does anything. |
job:updated | Fires when there is an update to a Job while it is executing. |
job:completed OR job:failed | job:completed fires when a Job is completed successfully, job:failed fires if a Job is completed but fails. One of these events will fire upon Job completion, but never both. |
job:outcome-acknowledged | Fires when a user acknowledges the completion of a Job through a UI popup. |
job:ready
.
job:ready
Event for a Job named [domain]:[operation]
is published. Your Listener can then be configured to respond to that Action via its Event.job:ready
event, filtered by the domain:operation
Job - where, in this case, workbook
is the domain, export
is the operation.
api.jobs.create()
method.
Creating a custom Job in your Listener enables any Event to trigger a Job.
Here’s an example of creating a custom Job in a Listener:
Job Name | Description |
---|---|
Extract | Extracts data from the specified source. |
Map | Maps data from its ingress format to Blueprint fields. |
DeleteRecords | Deletes records from a dataset based on specified criteria. |
Export | Exports data to a specified format or destination. |
MutateRecords | Alters records in a dataset according to defined rules. |
Configure | Sets up or modifies the configuration of a Space. |
AiAssist | Utilizes AI to assist with tasks such as data categorization. |
FindReplace | Searches for specific values and replaces them. |
export
, extract
, map
, delete
, etcmanual
or immediate
created
, planning
, scheduled
, ready
, executing
, complete
, failed
, cancelled
foreground
, background
, toolbarBlocking
executing
.
Progress
is a numerical or percentage value indicating the completion status of the work. You may also provide an estimatedCompletionAt
value which will display your estimate of the remaining processing time in the foreground Job overlay. Additionally, the Jobs Panel will share visibility into the estimated remaining time for acknowledged jobs.
Example of estimated time
outcome
.
Example of a 'next' button