Creating and managing jobs in a project
You create jobs to run assets or files in tools 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.
Viewing jobs
You can view jobs on the Jobs page in the project.
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.
You can view all jobs across all projects. See Viewing all jobs across projects.
Creating a job
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 |
Job scheduling options
You can configure a job to repeat on a set schedule. You can schedule jobs within Git-based projects.
You can't change the time zone for the job schedule. You must set your job schedule in your web browser's time zone. Then, the schedule is converted to the time zone of the compute node where your job runs.
You can specify the following properties of the job schedule:
- Frequency
- You can choose to run the job with a frequency of by minute, hour, day, week, or month.
- If you select by minute, 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, the job runs at 0, 11, 22, 33, 44 and 55 minutes of each hour.
- Start of schedule
- You can set a start date and time. The job starts to run at the first multiple of n of the hour that occurs after the start time that you specify. For example, if you enter 10:24, and you set the job to repeat every 14 minutes, then your job runs at 10:42, 10:56, 11:00, 11:14. 11:28, 11:42, 11:56, and so on.
- Exclude weekdays
- You can specify which days to skip. If you exclude certain weekdays, the job might not run as you expect. The job might run at unexpected times because of 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.
- End of schedule
- You can set an end date and time.
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 the Permanent Admin, Admin or Editor role in the project.
In a project with default Git integration, you need to create a code-based job for unlisted 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. -
Optional. Define the job details by entering a name and a description.
-
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.
-
Optional. On the Schedule page, you can configure a one-time or repeating schedule. See Job scheduling options.
-
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.
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 sync your Git files to create project assets:
- From the Notebook viewer for Notebooks.
- From the project Assets page for Notebooks and scripts. See Code files.
Managing jobs
You can view all of the jobs that exist for your project from the project's Assets page. With a Permanent Admin, 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 do the following actions:
- View the runs
- See runs for the current 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
- Edit settings by clicking Edit job. For example, you can change schedule settings or to pick another environment template.
- Run the job manually
- Run the job 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
- Delete the job by clicking the Delete
from the job's action bar.
Editing jobs in a tool
If you can create a job within a tool, you can also view and edit job settings that are associated with an asset in the tool.
Running jobs after upgrading
Job runs in projects fail if the job is using an environment that is deleted or is no longer supported after a 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 that are associated with these environments continue to run after an upgrade. For details, see Customizing environments.