Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Create a notification job

Add a job, manually or from a template, implementing a code-based notification policy. To view and add notification jobs, navigate to the Jobs > Notification tab, and then:

  • To add a new notification job manually, click + Add new notification job (or the minimized add button when the job panel is open).

  • To create a notification job from a template, next to the add button, click , and then, under Notification, click Create new from template.

The new job opens to the Assemble tab. Depending on the creation option you selected, proceed to the configuration steps linked in the table below.

Notification job type Description
Add new notification job Manually add a job implementing a code-based notification policy.
Create new from template Add a job, from a template provided by DataRobot, implementing a code-based notification policy.

Add a new notification job

To manually add a job for code-based notifications:

  1. On the Assemble tab for the new job, click the job name (or the edit icon ) to enter a new job name, and then click confirm :

  2. In the Environment section, select a Base environment for the job.

  3. In the Files section, assemble the custom job. Drag files into the box, or use the options in this section to create or upload the files required to assemble a custom job:

    Option Description
    Choose from source / Upload Upload existing custom job files (run.sh, metadata.yaml, etc.) as Local Files or a Local Folder.
    Create Create a new file, empty or containing a template, and save it to the custom job:
    • Create run.sh: Creates a basic, editable example of an entry point file.
    • Create metadata.yaml: Creates a basic, editable example of a runtime parameters file.
    • Create README.md: Creates a basic, editable README file.
    • Create job.py: Creates a basic, editable Python job file to print runtime parameters and deployments.
    • Create example job: Combines all template files to create a basic, editable custom job. You can quickly configure the runtime parameters and run this example job.
    • Create blank file: Creates an empty file. Click the edit icon next to Untitled to provide a file name and extension, then add your custom contents. In the next step, it is possible to identify files created this way, with a custom name and content, as the entry point. After you configure the new file, click Save.

    File replacement

    If you add a new file with the same name as an existing file, when you click Save, the old file is replaced in the Files section.

  4. In the Settings section, configure the Entry point shell (.sh) file for the job. If you've added a run.sh file, that file is the entry point; otherwise, you must select the entry point shell file from the drop-down list. The entry point file allows you to orchestrate multiple job files:

  5. In the Resources section, next to the section header, click Edit and configure the following:

    Preview

    Custom job resource bundles are off by default. Contact your DataRobot representative or administrator for information on enabling this feature.

    Feature flag: Enable Resource Bundles

    Setting Description
    Resource bundle Preview feature. Configure the resources the custom job uses to run.
    Network access Configure the egress traffic of the custom job. Under Network access, select one of the following:
    • Public: The default setting. The custom job can access any fully qualified domain name (FQDN) in a public network to leverage third-party services.
    • None: The custom job is isolated from the public network and cannot access third party services.
    Default network access

    For the Managed AI Platform, the Network access setting is set to Public by default and the setting is configurable. For the Self-Managed AI Platform, the Network access setting is set to None by default and the setting is restricted; however, an administrator can change this behavior during DataRobot platform configuration. Contact your DataRobot representative or administrator for more information.

  6. (Optional) If you uploaded a metadata.yaml file, define the Runtime parameters, clicking the edit icon for each key value row you want to configure.

  7. (Optional) Configure additional Key values for Tags, Metrics, Training parameters, and Artifacts.

Create a notification job from a template

To add a pre-made notification job from a template:

Preview

The jobs template gallery is on by default.

Feature flags: Enable Custom Jobs Template Gallery, Enable Custom Templates

  1. In the Add custom job from gallery panel, click the job template you want to create a job from.

  2. Review the job description, Execution environment, Metadata, and Files, then, click Create custom job:

    The job opens to the Assemble tab.

  3. On the Assemble tab for the new job, click the job name (or the edit icon ()) to enter a new job name, and then click confirm :

  4. In the Environment section, review the Base environment for the job, set by the template.

  5. In the Files section, review the files added to the job by the template:

    • Click the edit icon to modify the files added by the template.

    • Click the delete icon to remove files added by the template.

  6. If you need to add new files, use the options in this section to create or upload the files required to assemble a custom job:

    Option Description
    Upload Upload existing custom job files (run.sh, metadata.yaml, etc.) as Local Files or a Local Folder.
    Create Create a new file, empty or containing a template, and save it to the custom job:
    • Create run.sh: Creates a basic, editable example of an entry point file.
    • Create metadata.yaml: Creates a basic, editable example of a runtime parameters file.
    • Create README.md: Creates a basic, editable README file.
    • Create job.py: Creates a basic, editable Python job file to print runtime parameters and deployments.
    • Create example job: Combines all template files to create a basic, editable custom job. You can quickly configure the runtime parameters and run this example job.
    • Create blank file: Creates an empty file. Click the edit icon () next to Untitled to provide a file name and extension, then add your custom contents. In the next step, it is possible to identify files created this way, with a custom name and content, as the entry point. After you configure the new file, click Save.

    File replacement

    If you add a new file with the same name as an existing file, when you click Save, the old file is replaced in the Files section.

  7. In the Settings section, review the Entry point shell (.sh) file for the job, added by the template (usually run.sh ). The entry point file allows you to orchestrate multiple job files:

  8. In the Resources section, review the default resource settings for the job. To modify the settings, next to the section header, click Edit and configure the following:

    Availability information

    Custom job resource bundles are off by default. Contact your DataRobot representative or administrator for information on enabling this feature.

    Feature flag: Enable Resource Bundles

    Setting Description
    Resource bundle Preview feature. Configure the resources the custom job uses to run.
    Network access Configure the egress traffic of the custom job. Under Network access, select one of the following:
    • Public: The default setting. The custom job can access any fully qualified domain name (FQDN) in a public network to leverage third-party services.
    • None: The custom job is isolated from the public network and cannot access third party services.
    Default network access

    For the Managed AI Platform, the Network access setting is set to Public by default and the setting is configurable. For the Self-Managed AI Platform, the Network access setting is set to None by default and the setting is restricted; however, an administrator can change this behavior during DataRobot platform configuration. Contact your DataRobot representative or administrator for more information.

  9. If the template included a metadata.yaml file, define the Runtime parameters, clicking the edit icon () for each key value row you want to configure.

  10. Configure additional Key values for Tags, Metrics, Training parameters, and Artifacts.

After you create a notification job, you can add it to a notification template as a notification channel.


Updated January 8, 2025