---
title: "Introduction"
url: https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction/
description: "Learn about the Catalyst Pipelines jobs in detail, the associated keywords and sample code snippets."
last_updated: 2026-08-28T06:26:16Z
service: Pipelines
type: general
related_links:
  - name: "Configure the Pipeline"
    url: /en/pipelines/help/catalyst-pipelines.yaml/implementation
---

# Jobs

# Introduction

A job is a sequence of [steps](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/steps) to be executed in the pipeline. It is mandatory to define at least one job in the pipeline. You can define the required jobs for the pipeline as key-value pairs using the `jobs`  key. 

Apart from the regular jobs defined in the pipeline, you can configure the following jobs as well :

* **Approval Job**
* **Parallel Job**

You can retrieve the status of a job by using `<< status.{stage_name}.{job_name} >>`. 

### Properties of a Job 

<table class="content-table">
        <thead>
            <tr>
                <th>Key</th>
                <th>Value</th>
                <th>is Mandatory</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`[variables](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/variables)`</td>
                <td>An array of variables</td>
                <td>No</td>
            </tr>
            <tr>
                <td>`[artifacts](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts)`</td>
                <td>This includes the `upload`  and `download` keys. Refer to [this help page](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts) for more details.</td>
                <td>No</td>
            </tr>
            <tr>
                <td>`notify`</td>
                <td>This key can be configured to send notification emails about the job before it starts execution and after the job execution completes.
                Contains the sub-keys `on-start`  and `on - end` </td>
                <td>No</td>
            </tr>
            <tr>
                <td>`on-start / on -end`</td>
                <td>Contains the sub-keys `notify-type` and `notify-variables`.</td>
                <td>Yes (if `notify` is used)</td>
            </tr>
            <tr>
                <td>`notify-type`</td>
                <td>Provide the value as `email` .</td>
                <td>Yes (if `notify` is used)</td>
            </tr>
            <tr>
                <td>`notify-variables`</td>
                <td>Provide the email address to be notified when the job execution starts (for `on-start`) and the email address to be notified when the job successfully completes execution (for `on-end` )</td>
                <td>Yes (if `notify` is used)</td>
            </tr>
            <tr>
                <td>`[runner](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners)`</td>
                <td>Specify the runner name in which the jobs need to be executed.</td>
                <td>No</td>
            </tr>
            <tr>
                <td>`[image](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images)`</td>
                <td>Specify the name of the image needed for the specific job execution.</td>
                <td>No</td>
            </tr>
            <tr>
                <td>`cwd`</td>
                <td>Specify the current working directory in which the job has to be executed.</td>
                <td>No</td>
            </tr>
            <tr>
                <td>`[steps](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/steps)`</td>
                <td>An array containing the scripts that need to be executed in the pipeline.</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`[when](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition)`</td>
                <td>Specify the conditions that determine whether the job has to be executed or not.</td>
                <td>No</td>
            </tr>
            </tbody>
</table>

### YAML Code Snippet for Job 

Here's an example code snippet for jobs that can be defined in a pipeline:

```yaml
jobs:
  testJob1:
    steps:
      - echo "Enter your scripts here"
  testJob2:
    variables:
      BRANCH: main
    artifacts:
      upload:
        - name: artifactTest
          type: zip
          location: stratus://mybucket/home/artifacts
          files:
            - '**/*'
      download:
        - name: artifactTest
		    type: zip
          location: stratus://mybucket/home/artifacts
   notify:
      on-start:
        - notify-type: email
          notify-variables:
            to: amelia.burrows@zylker.com
      on-end:
        - notify-type: email
          notify-variables:
            to: amelia.burrows@zylker.com
    runner: runner2
    image: testImage1
    cwd: cd ./src
    steps:
      - echo "Enter your scripts here"
    and:
      - equal:
          - << pipeline.event.branch >>
          - main
      - true
  testJob3:
    steps:
      - echo "Hello"

```

The above code illustrates the following workflow:

* There are three jobs defined in the pipeline - `testJob1`, `testJob2`, `testJob3`.
* The `testJob2` is configured to be executed only if the current working branch in the repository is the main branch. 
* The `testJob2` handles the process to store and retrieve the generated build files to and from Catalyst Stratus. This is defined using the `upload` and `download` keys. 
* It also sends a notification to the defined email address in order to keep them informed about the start of the job execution and the completion of the job as well. This is achieved using the `notify on-start` and `on-end keys`.