IDI version 26.8 is now available.  Click here for details: IDI Updates.

Adding or Editing Jobs

Prev Next

To add a job or edit the selected job:

From the Jobs for Service form, right-click on a job and click New to add a new job or Edit to edit the selected job. This displays the Edit Job form on the Settings tab.

UG template for Help

Settings Tab

Enabled

If checked, the job runs automatically. Otherwise, the job must be run manually.

Log Errors Only

Specifies whether only errors should be logged when a job is run. If left unchecked, a new history record is created each time the job runs.

Auto-Promote with Kit Install

Specifies whether the installation of the kit should promote the version of the script being installed to be the version that runs with the job runs.

Hidden

When selected, the job is not displayed in the Jobs for Service grid. You can choose to show hidden jobs by checking the Show Hidden Jobs check box at the bottom of the Jobs for Service grid.

Name

Name of the job.

Create Date

Date and time the job was created.

Priority
(required)

Priority of the job compared to other IDI jobs. Jobs with a higher priority take precedence in the job queue over jobs with a lower priority. Priority is not affected if a priority job is running—it continues to run. This job is added to the queue in its’ priority level. Priorities include Low, Normal and High listed in ascending order.

Status

The current job status. Job statuses include:

  • Running – job is currently executing

  • Run Now Pending—job executes as soon as it is polled

  • Not Running – job is not currently executing

  • Failed – job did not execute

    The status changes depending on whether the job is running or waiting to be run.

Last Status Date

Date and time the job’s status last changed.

Start Date

Defaults to today’s date and time. The date and time the job scheduler executes. The Start Date is a date that is the same as or before the End Date.

  • If Start Date is checked, the automatic execution frequency is synchronized to that time/date.

  • If Start Date is unchecked, the job runs as soon as the service can start it and then periodically from that point.

  • If Start Date is unchecked, there is no defined beginning to the scheduling time form; for example, the job automatically runs as soon as enabled.

End Date

Defaults to today’s date and time. The date and time the job scheduler no longer executes the job automatically; end of the scheduling period. The Start Date is a date that is the same as or before the End Date.

If End Date is unchecked, there is no defined end to the scheduling time form; for example, the job automatically runs as long as Enabled.

Occurs Every

This combo field and drop-down menu lets you schedule the job to run periodically or at one of more specific times.

Periodic Scheduling

  • Select the frequency units from the drop-down menu. The choices are Seconds, Minutes, Hours or Days.

  • Then enter the quantity 1, 2, 10, etc...).

    Note

    There is no limit for maximum quantity.

    Scheduling for specific times

  • Select Specific Times from the drop-down menu. When Specific Times is selected, the scheduler disregards any entry in the Occurs every field and the View Times button at the lower left part of the dialog is enabled.

  • Clicking View Times displays a form listing times you’ve scheduled the job to run (if any). The form lets you add new times and delete existing times. To add a new time, use the selector to specify the time and click Add.

  • As you add times they’ll be listed on the form. If you need to delete a time from the list, right-click and choose Delete.

Scheduled Job Workers

Used to configure scheduled jobs for multi-threading.

Note

To use this functionality, submit a Work Order to IDI.

Allow Workers: When unchecked, the scheduled job function as a single thread. This is the default setting.

When checked, the scheduled job is run as a "multi-threaded scheduled job." If the job is disabled, all worker threads are disabled.

Worker Count: When multi-threading is enabled, this field is used to determine how many worker threads will be used to process the job. An integer between 1 and 20 is required if Allow Workers is checked.

Days to Run Job

The days of the week, as well as holidays, the job will run. To prevent the job from running on a specific day, uncheck the corresponding check box.

If the Holidays box is unchecked, the scheduling service will check the Holiday table as set up in Data Management. If the current day’s date matches a date found in the Holiday table, the job does not run.

If it is determined the job should not run based on the day of the week or a holiday, the job will be skipped and will not record any history. If, based on the frequency, a job is scheduled to run on a particular day but that day is NOT checked in the Days to Run list, the job will NOT run.

For example: A job is scheduled once a month, on the 1st of the month. The same job has been set up to only run Monday through Friday. If the 1st of the month is a Saturday or Sunday, the job will be skipped for that month, and not run again until the following month.

Note

The day of the week is based on the server’s date.

Description

Description of the job.

Last Modified Details

Displays the user name and date and time of the last modification.

Parameters Tab

The Parameters tab on both the Edit Service and Edit Job forms contain configurable parameters. Configurable parameters are defined and installed via your company's custom kit. Once these parameters have been installed, subsequent kit installations do not update the parameters. Please contact IDI to customize the parameters for installation.

Environment

Name of the environment being modified. This drop-down includes the current environment you are logged into and all environments having overrides. You can also use this field to enter an environment, however, this environment is only saved if an override is specified.

icon

If a lock icon is displayed, the parameter cannot be modified from this form. These are maintained by IDI, for example, the URL for the Provisioning Web Service.

If no lock is displayed, you can change the parameter.

Name

Name of the parameter.

Default

Value to be used in all environments without an override.

Notes:

  • Since there is only one Production environment, IDI recommends that test values be entered for the defaults and overrides set for the Production environment.

  • Although you can enter override values for environments other than the one you are logged into, the values are not set until a refresh is performed on those environment. Therefore, IDI recommends configuring overrides for the environment you are logged into.

Override

Values to be used instead of the default when the job is run for the associated environment.

Right-click the parameter you want to change and select one of the following:

Set Default: Lets you change the default value for the parameter. This value is used for all environments not having an override specifically set.

Set Override: Lets you set the override value for the environment selected in the Environment drop-down.

Clear Override: Removes the override value for the environment so it uses the default value.

Create or make changes to the Infoscript. See Editing and Saving a Script.

Note

A new script is created when you save it in the Infoscript Viewer for the job.

Click Save to make the changes or click Cancel to exit the form without making the changes.

See also:

Job Schedule Management