Creating and managing jobs in a project
You create jobs to run assets or files in tools, such as Data Refinery flows, SPSS Modeler flows, Notebooks, and scripts, in a project.
When you create a job you define the properties for the job, such as the name, definition, environment runtime, schedule and notification specifications on different pages. You can run a job immediately or wait for the job to run at the next scheduled interval.
Each time a job is started, a job run is created, which you can monitor and use to compare with the job run history of previous runs. You can view detailed information about each job run, job state changes, and job failures in the job run log.
How you create a job depends on the asset or file.
Asset or file | Create job in tool | Create job from the Assets page | More information |
---|---|---|---|
Data Refinery flow | ✓ | ✓ | Creating jobs in Data Refinery |
SPSS Modeler flow | ✓ | ✓ | Creating jobs in SPSS Modeler |
Notebook created in the Notebook editor | ✓ | ✓ | Creating jobs in the Notebook editor |
Pipelines | ✓ | Creating jobs for Pipelines |
Creating jobs for files in a project with deprecated Git integration
You can't create jobs directly in JupyterLab or RStudio. To create jobs for Notebooks or scripts that are created in JupyterLab or RStudio in a project with deprecated Git integration, you must push the files from the IDE to the Git repository associated with your project and then sync the repository files with the project. Any Notebooks, scripts, or RShiny apps that are pushed to a Git repository with a size of zero bytes are considered invalid and are not synced with the project.
You can create jobs after you have synced your Git files to create project assets:
- From the Notebook viewer for Notebooks. See Creating jobs in the Notebook viewer.
- From the project Assets page for Notebooks and scripts. See Creating jobs from the Assets page.
Creating jobs from the Assets page
You can create a job to run an asset from the project's Assets page.
- Required permissions
- You must have an Editor or Admin role in the project.
In a project with default Git integration, you need to create a code-based job for non-listed assets by selecting a file from your local Git branch. See Creating jobs for code files.
To create jobs for a listed asset from the Assets page of a project:
-
Select the asset from the section for your asset type and choose New job from the Menu icon
with the lists of options at the end of the table row.
-
Define the job details by entering a name and a description (optional).
-
If you can select Setting, specify the settings that you want for the job.
-
If you can select Configure, choose an environment runtime for the job. Depending on the asset type, you can optionally configure more settings, for example environment variables or script arguments.
To avoid accumulating too many finished job runs and job run artifacts, set how long to retain finished job runs and job run artifacts like logs or notebook results. You can either select the number of days to retain the job runs or the last number of job runs to keep.
-
On the Schedule page, you can optionally add a one-time or repeating schedule. You can schedule jobs within git-based projects.
If you select the Repeat option and unit of Minutes with the value of n, the job runs at the start of the hour, and then at every multiple of n. For example, if you specify a value of 11 it will run at 0, 11, 22, 33, 44 and 55 minutes of each hour.
If you also select the Start of Schedule option, the job starts to run at the first multiple of n of the hour that occurs after the time that you provide in the Start Time field. For example, if you enter 10:24 for the Start of Time value, and you select Repeat and set the job to repeat every 14 minutes, then your job will run at 10:42, 10:56, 11:00, 11:14. 11:28, 11:42, 11:56, and so on.
You can't change the time zone; you must set your job schedule in your web browser's time zone. The schedule will be translated to the time zone of the compute node where your job runs.
If you exclude certain weekdays, the job might not run as you would expect. The reason might be due to a discrepancy between the time zone of the user who creates the schedule, and the time zone of the compute node where the job runs.
Note: Your scheduled job can appear differently if your web browser’s time zone is set to your local time zone following Daylight Savings Time (DST). For example, your scheduled job appears at 3:00PM Eastern Standard Time Zone (EST) daily corresponding to 8:00PM Coordinated Universal Time (UTC). When your local time zone changes to Eastern Daylight Time Zone (EDT), your scheduled job continues to run at 8:00PM (UTC) which will now appear as 4:00PM (EDT) daily. -
(Optional): Select to see notifications for the job. You can select the type of alerts to receive.
-
Review the job settings. Then, create the job and run it immediately, or create the job and run it later.
Managing jobs
You can view all of the jobs that exist for your project from the project's Jobs page. With Admin or Editor role for the project, you can view and edit the job details. You can run jobs manually and you can delete jobs. With Viewer role for the project, you can only view the job details. You can't run or delete jobs with Viewer role.
To view the details of a specific job, click the job. From the job's details page, you can:
- View the runs for that job and the status of each run. If a run failed, you can select the run and view the log tail or download the entire log file to help you troubleshoot the run. A failed run might be related to a temporary connection or environment problem. Try running the job again. If the job still fails, you can send the log to Customer Support.
- Edit job settings by clicking Edit job, for example to change schedule settings or to pick another environment template.
- Run the job manually by clicking the Run icon
from the job's action bar. You can start a scheduled job based on the schedule and on demand.
- Delete the job by clicking the Delete
from the job's action bar.
Viewing and editing jobs in a tool
You can view and edit job settings associated with an asset directly in the following tools:
- Data Refinery
- SPSS Modeler
Viewing and editing jobs in Data Refinery, Notebooks, SPSS Modeler, and Pipelines
- In the tool, click the Jobs icon
from the toolbar and select Save and view jobs. This action lists the jobs that exist for the asset.
- Select a job to see its details. You can change job settings by clicking Edit job.
Jobs after upgrading Cloud Pak for Data
Job runs in projects fail if the job is using an environment that has been deleted or is no longer supported after a Cloud Pak for Data version upgrade. To get the job running again, edit the job to point to an alternative environment.
To prevent job runs from failing due to an upgrade, create a custom environment based on the existing environment and point the job to that custom environment. Jobs associated with these environments will still run after an upgrade. For details, see Customizing environments.
Learn more
- Creating jobs in Data Refinery
- Creating jobs in SPSS Modeler
- Creating jobs in the Notebook editor or Notebook viewer
- Creating code-based jobs
- Creating jobs for Pipelines
Parent topic: Working in projects