Varicent Incentive Compensation Management Documentation

Scheduler properties

Global properties set in the Scheduler module apply to all processes unless you have set properties at the process level. You can use these global properties to set the maximum run time for an external tool, stop an external tool after it exceeds the set run time, and send email warnings when the Scheduler module encounters an error or runs successfully.

Setting global Scheduler properties

Select options for all processes in the Scheduler module, such as stopping a process if it encounters an error.

  1. In the Scheduler module, in the toolbar, click the Settings settings.svg icon.

  2. On the Properties tab, you can select all or some of these settings:

    1. If you want to stop the whole Scheduler process if it encounters an error while it is running a task, select the Stop process on error checkbox.

    2. If you want the Scheduler module to email users when processes or tasks complete with errors or fail, select the On error, send email to these addresses checkbox and type the users' email addresses in the field.

    3. If you want the Scheduler module to email users when processes or tasks complete successfully, select the On success, send email to these addresses checkbox, and type the users' email addresses in the field.

    4. Select the Retry attempts checkbox to set the number of times that you want Scheduler to retry a failed process or task.

  3. On the External Tools tab, you can select all or some of these settings:

    1. From the Maximum run time (seconds) field, set the maximum time that you want the Scheduler module to allow an external tool to run.

    2. If you want the external tool to no longer run after it exceeds the maximum run time, select the Stop on timeout checkbox.

      Important

      If the external tool is not running on the same computer as the Varicent ICM client, stopping the external tool after the timeout is not guaranteed.

  4. Click OK.

Setting process-level properties

Select options for each process in the Scheduler module, such as stopping a process if it encounters an error.

If you don't set properties for subprocesses, they inherit the properties of the higher-level process folder. If you don't set properties for any process folders, they inherit the global properties.

  1. In the Scheduler module, place your cursor over the process folder for which you want to set properties, click more options (...), and select Properties.

  2. On the Properties tab, you can select all or some of these settings:

    1. If you want to stop the whole Scheduler process if it encounters an error while it is running a task, select the Stop Process On Error checkbox.

    2. If you want the Scheduler module to email users when processes or tasks complete with errors or fail, Select the On error, send email to these addresses checkbox and type the users' email addresses in the field.

    3. If you want the Scheduler module to email users when processes or tasks complete successfully, select the On success, send email to these addresses checkbox and type the users' email addresses in the field.

    4. Select the Retry attempts checkbox to set the number of times that you want the Scheduler module to retry a failed process or task.

  3. On the External Tools tab, you can select all or some of these settings:

    1. From the Maximum run time (seconds) field, set the maximum time that you want the Scheduler module to allow an external tool to run.

    2. If you want the external tool to no longer run after it exceeds the maximum run time, select the Stop on timeout checkbox .

      Important

      If the external tool is not running on the same computer as the Varicent ICM client, stopping the external tool after the timeout is not guaranteed.

  4. Click OK.

Setting language properties

In the Scheduler module, you can set the model language. This setting changes the date and numeric format for publications that are run through the Scheduler and Workflows modules.

Any emails that are associated with a process in the Scheduler module are affected by this setting.

  1. From the admin panel, click Settings settings.svg → More options.

  2. On the General tab, select a language from the Model Language list.

  3. Click Save.

Disabling Scheduler emails

You have the option to disable all emails associated with processes in the Scheduler module.

  1. From the admin panel, click Settingssettings.svg → More options → General.

  2. Select Disable Emails in Scheduler.