Scheduled Jobs
Click here to see this page in full context

  Scheduled Jobs

Overview

A Scheduled Job is used to execute a specific process based on either a one-time schedule, or at a recurring frequency.

Access

To access the Scheduled Jobs screen, select Integrations from the Main Navigation Menu, then select Scheduled Jobs from the Sub-Category menu.

Features

The Scheduled Jobs screen provides the following features:

 Searching and Sorting

Click hereClick here

Search

The search feature allows you to search for a specified text string anywhere within the Scheduled Job's Description, Display Name, or Internal Name.

  1. Optionally, in the search field near the top of Scheduled Jobs screen, enter the desired text string.

  2. Optionally, from the "Status" drop-down menu, select a Scheduled Job status (or "Any status").  

  3. Optionally, from the "Effectivity" drop-down menu, select a Scheduled Job effectivity (or "Any effectivity").  

  4. Press Enter, or click the search button (magnifying glass icon).

  5. The Scheduled Jobs screen is refreshed to show only the Scheduled Jobs that meet your search criteria. Please note that if you enter multiple search criteria, the platform displays only the Scheduled Jobs that meet ALL criteria.

  6. To remove all search criteria, click the remove button ("X" icon).

Sort

The "Sort" drop-down menu allows you to sort the Scheduled Jobs on a variety of different fields. To sort the list of Scheduled Jobs, select the desired sort option from this menu.

  • Name (default)

  • Created Date

  • Updated Date

View Mode

By default, the Scheduled Jobs are displayed in "List View." Optionally, click the Calendar View toggle to see a calendar of the current month. The Scheduled Jobs that are scheduled to execute each day are displayed, along with their execution time. Navigation buttons near the top-right corner allow you to move to next or previous months. Click the List View toggle to return to the default List View. 

Navigation

Once you've found the desired Scheduled Job, you can navigate to the following other screens:

 

 Create a New Scheduled Job

Click hereClick here

To create a new Scheduled Job:

  1. In the "Enter Display Name" field, enter the Display Name value for the new Scheduled Job.

  2. Click create. The "Edit Scheduled Job" pop-up window is displayed.

  3. The "Display Name" field is populated with the value you entered above; optionally edit this value.

  4. The "Internal Name" is automatically populated based on the "Display Name" value. This field is disabled by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  5. In the "Description" field, optionally enter a description of the Scheduled Job.

  6. Select the recurrence option:

Recurrence: Run OnceRecurrence: Run Once

You can schedule the job to execute once at a specified date / time

  1. From the Recurrence drop-down menu, select Once.

  2. Click into the "Execute Once On" field. A calendar pop-up window is displayed.

  3. Select the desired date when you want the Scheduled Job to execute.

  4. Within the calendar pop-up window, click the clock icon.

  5. Define the time when you want the Scheduled Job to execute.

  6. From the "Time Zone" menu, select the time zone to use when determining the time to execute.

 

Recurrence: RepeatRecurrence: Repeat

You can schedule the job to run on a recurring frequency:

  1. From the Recurrence drop-down menu, select Repeat.

  2. Next to Schedule Composer, select an interval:

  • Hour: Select the minute past the hour.

  • Day: Select the time of day.

  • Week: Select the day of the week, and the time of day.

  • Month: Select the day of the month, and the time of day.

  • Year: Select the day, the month, and the time of day.

  1. Optionally, to manually enter a CRON expression, check Advanced Mode, then enter the expression.

  2. Define the Scheduled Job start and end date. If you leave these date ranges blank, the Scheduled Job will run indefinitely.

  3. From the Time Zone menu, select the time zone to use when determining the time to execute.

 

Recurrence: On DemandRecurrence: On Demand

You can schedule the job to run only on demand: 

  1. From the Recurrence drop-down menu, select On demand.

 

  1. Toggle active to On to enable this Scheduled Job.

  2. If you want to log every execution of this Scheduled Job, select Yes from the "Log every run" drop-down menu. 

  3. From the "Priority" drop-down menu, select a processing priority: Default or High.

  4. If you want to send notification emails each time the Scheduled Job executes, enter one or more (separated by commas) recipient email addresses in the "Notification Emails" field. 

  5. The "Calendar Background" field lets you pick the color of this Scheduled Job when viewing jobs in Calendar View. Either enter the desired hexadecimal value, or use the color picker to choose a color. 

  6. The Scheduled Job will perform an action each time it executes; select the desired action from the "Action Type" drop-down menu. The platform displays the available parameters for the selected action.

  7. Select or enter the action parameters as needed. 

  8. Click save. 

 

 

 View or Edit a Scheduled Job

Click hereClick here

To view or edit the details of an Scheduled Job:

  1. Search, sort, or filter the Scheduled Jobs screen as described above.

  2. Click on the desired Scheduled Job name. 

  3. The Scheduled Job Details screen is displayed and populated with all of the information about this Scheduled Job.

 

Back to Integrations Overview

 

 

© Cheetah Digital    Engagement Data Platform Online Help 22.0  April 2022