---
title: Jobs and Automation
sidebar_position: 8
---

# Jobs and Automation

A **Job** represents the execution of a function (tool) on a file. Jobs are used for operations like extracting artifacts, running transformations, and processing data.

## View Your Jobs

1. Click **Jobs** in the sidebar (or navigate to `/jobs`).
2. By default, you see **Jobs** — a table of jobs you have created.
3. The jobs table shows:
   - **Tool / Function** — the tool and function that was executed
   - **Job ID** — first 6 characters of the UUID with ellipsis (click to copy the full ID)
   - **Started On** — the date and time the job was started
   - **Status** — current job status badge
   - **Actions** — cancel button for jobs that have not yet reached a terminal state

## View All Jobs (Administrators)

1. Navigate to the **Jobs** page.
2. The page header has **Jobs** and **Tools** for every user.
3. Administrators also see **All Jobs**, which lists the jobs of every user in every tenant. Only a Platform Administrator (on installations without tenant management, an organization administrator) can load the list; for a Tenant Administrator it does not load.

## Create a Job (Run a Function)

Users with the **Executor** role (or Editor and above) can create and run jobs on a file when they also have permission for the tool/function.

### From the Resources Page

1. Navigate to **Resources** and select a Resource.
2. In the tab header, click **Create Job** (next to **Download**, **Archive**, and **Share**).
3. In the **Create Job** dialog:
   - **Tool/Function Combination** — the tool and function to run.
   - **Select a Tool Version** (if multiple versions are available).
   - **Configure Parameters** (if the selected function requires input parameters).
   - **Advanced options** — choose an **Agent** or **Agent Pool** (Automatic by default, or select a specific agent/pool).
4. Click **Execute Function** to start the job.

### From a System Page

1. Open a system, click **Directory**, and select a file.
2. Click **Create a job** to open the **Create Job** dialog.
3. Follow the same steps as above to configure and execute the function.

## Extract Artifacts from a File

"Extract" is a specific job type that processes a file to produce viewable artifacts.

### From the Resources Page

1. Select a file that has no preview (you will see a **"No Preview Available"** message).
2. Click the **Extract** button in the empty state.
3. The **Create Job** dialog opens pre-configured for extraction — configure and execute.

### From a System Page

1. Open a system, click **Directory**, and select a model.
2. If the **Preview** tab shows **No Preview Available**, click **Extract**. Otherwise, click **Create a job**.
3. The **Create Job** dialog opens. Configure and execute.

> **Required role:** Permission to run jobs on the Resource (Executor, Editor, or above).

## View Job Details

1. From the **Jobs** page: Click the **Tool / Function** link on any job row.
2. From the **Resources** page: open the **Activity** tab and click a job group name in the artifacts browser.
3. The **Job Details** dialog shows:
   - **Status** with icon
   - **Job ID**
   - **Tool Name** and **Function Name**
   - **Agent Name**, **Agent Assignment**, **Agent ID**, and **Pool Assignment** (when assigned to a pool)
   - **Started On** date and **Started By** user
   - **Inputs** section (only visible to the job creator): Lists the input files with name, type, and size.
   - **Status History**: A collapsible table of all status transitions with timestamps.

You can also view job details by navigating directly to `/jobs/:jobId`.

## Cancel a Job

You can cancel any job that has not yet finished — that is, any job that has not reached a terminal state (**Completed**, **Failed**, or **Canceled**).

1. Navigate to the **Jobs** page.
2. Find the job you want to cancel. If it has not finished, an **X** (cancel) button is shown in the **Actions** column.
3. Click the **X** to cancel the job.
4. The job status will change to **Canceled**.

> **What happens when you cancel a job**
>
> Canceling sets the job's status to **Canceled** and tells the platform to stop
> accepting further status updates and file uploads from that job. However, any
> operation already in progress on the agent is allowed to finish. This means:
>
> - The job may continue running on the agent, but once it is canceled the
>   platform no longer accepts output from it. Any results or logs the job
>   produces after cancellation are **not recorded** in the Istari Digital Platform.
> - If an in-progress operation modifies an external system (for example, an
>   `update_tags` operation that updates a model in a connected third-party
>   application), that change may still complete even though the job is canceled
>   in the Istari Digital Platform.
>
> This is the current behavior. We are considering additional capabilities in the
> [Integrations SDK](../../connect/04-custom-modules/01-integrations-sdk-intro.md)
> that would let modules provide tool-specific handling when a job is canceled —
> for example, cleanly stopping or rolling back in-progress work in the underlying tool.
> We welcome feedback from customers interested in these additional capabilities.

## Job Statuses

| Status         | Description                                       |
| -------------- | ------------------------------------------------- |
| **Created**    | Job has been created                              |
| **Pending**    | Job is queued, waiting for an agent to pick it up |
| **Claimed**    | An agent has claimed the job                      |
| **Running**    | The job is actively executing                     |
| **Validating** | Output is being validated                         |
| **Uploading**  | Results are being uploaded                        |
| **Completed**  | Job finished successfully                         |
| **Failed**     | Job encountered an error                          |
| **Canceled**   | Job was cancelled by a user                       |
| **Unknown**    | Status could not be determined                    |

Active jobs (Pending, Claimed, Running, Validating, Uploading) show a **spinner** indicator. When a job **completes successfully**, you will receive a **browser notification** and an **audio cue**. Failed and canceled jobs show a **toast notification** only.

## Tools

The **Tools** tab on the **Jobs** page lists the tools and functions available to you based on your access.

1. Navigate to **Jobs** in the sidebar.
2. Click the **Tools** tab in the page header.
3. Browse or search for a tool by name.
4. Click a tool to see its available functions, version, and description.