Job Scheduling
The Job Scheduling page shows all the jobs that have been scheduled to run for the current Data Hub tenant. From this page you:
- Add, edit, and delete job wrapper schedules
- Run a wrapper on demand
- Click View Unscheduled Wrappers to see a list of wrappers that do not have a schedule
Guidelines
Note the following:
- You add a schedule to run a wrapper one or multiple times per day, week, or month.
- You can add more than one schedule for a single wrapper, although those schedules cannot conflict.
- A wrapper cannot be scheduled to run more than once every four hours. For example, you cannot schedule a job to run every two hours. Jobs can be configured to run a maximum of six times a day. For example, if a wrapper is scheduled to run once a day at 1AM, you cannot schedule a second conflicting job for that wrapper to run at 3AM once a week. When you try to submit a conflicting job schedule, you are alerted to the conflict.
- When you run a wrapper job on-demand (unscheduled), ensure the wrapper is not currently running.
- As a best practice, to avoid performance impacts it is recommended that you do not run multiple wrappers at the same time.
- You can create override profiles that are used to override the wrapper’s default settings. When scheduling a wrapper job, you can apply an existing override profile to the job; for example, to run the wrapper with different settings on a certain day of the week. See Wrapper Override Profiles.
Add and edit job wrapper schedules
From the Job Scheduling page, you add new wrapper job schedules and make edits to existing schedules.
Note: Initial loads will be historical and subsequent loads will be incremental.
Add job wrapper schedules
- Go to the Setup > Job Scheduling page and click Add. The Add Job Schedule page opens.
- Specify the following. Properties are required, unless otherwise noted:
- Job Name. Enter a name using letters, numbers, underscores, and spaces only. No special characters are supported.
- Wrapper Name. Select a scheduled or unscheduled wrapper.
- Description (Optional). Include a brief description of the job.
- Override Profile (Optional). Select an Override Profile for the wrapper, if one exists. None is the default.
- State. Select Enabled or Disabled. For example, you may want to disable a job to ensure it is not running when system maintenance is being performed.
- Time Zone. Select a time zone. The scheduled job will run based on the this time zone.
- Frequency. Select Daily, Weekly, or Monthly.
- Schedule Time. Select a time (at 15-minute increments) you want the job to run. If you selected a Frequency of Weekly, select the day of the week you want to the job to run. If you selected a Frequency of Monthly, select a date in the month you want the job to run.
- Click Add to add one or more schedules for this wrapper job. To delete a time, click its minus icon.
- Do one of the following:
- Ensure all the required fields are filled and click Submit. The job displays on the Job Scheduling page.
- Click Cancel to close the Add Job Schedule page without saving the schedule.
Edit job wrapper schedules
- From the Setup > Job Scheduling page, click Edit
for the job. The Edit Job Schedule page opens. - Make your changes and click Submit.
Run wrappers on demand
Scheduled and unscheduled wrappers can be run immediately (on demand) at any time.
Guidelines
Note the following:
- You can run a scheduled or unscheduled job to run on-demand.
- Running a wrapper on-demand does not affect any jobs scheduled for that wrapper. After the on-demand job runs, the next scheduled job for that wrapper will run as scheduled.
- Before you run a wrapper, ensure it is not currently running.
- You run one wrapper job at a time.
- If a wrapper has been disabled (not running), it can be restarted from the Job History – Wrapper page.
Run wrapper job now
- From the Setup > Job Scheduling page, do one of the following:
- Click Run Wrapper. The Run Wrapper dialog opens. Select a Wrapper Name. Scheduled and unscheduled wrappers are available.
- Select the check box for the job you want to run and click Run Wrapper. The Run Wrapper dialog opens with the Wrapper Name field populated with the selected wrapper.
- If an Override Profile exists for this wrapper, you can select to use. None is the default.
- For Run Type, select one of the following:
- Default. Pipelines use default pipeline setting values (with no overrides) to calculate the start and end date range when extracting data.
- Historical. Pipelines use the Global pipeline HISTORICALSTARTDATE setting value as the start date for extracting data. Some pipelines calculate the end date of the range as the current date plus one year, while others use the standard calculated end date associated with the FWD_DAYS setting value.
- Partial Reload. When selected, specify the start and end date range used for extracting data. Only data in that range will be reloaded.
- Click Submit. To monitor the job’s progress, go to the Job History – Wrapper page.
Delete scheduled wrapper jobs
You can delete one or more scheduled jobs at a time.
- From the Setup > Job Scheduling page, select the check box for one or more jobs.
- Click Delete. A Confirmation message opens. Click Yes. The jobs no longer display.