Varicent Incentive Compensation Management Documentation

Scheduler tasks

Tasks are the items that you must add to a process folder to create a process in the Scheduler module.

You can schedule tasks to run individually or as part of the complete process. You can also run a task manually from the Scheduler module.

You can choose from the following task types:

Table 60. Scheduler task types

Task type

Description

Calculation

Runs calculations from your model.

From the Choose calculation drop-down list, choose to run either a full model calculation, or an individual calculation.

Import

Runs the specified saved import.

Task Generation

Generates task in Tasks Module. You must have defined groups, created rules, or enabled alerts in the Tasks module.

Star Schema Population

Populates star schemas created in the Composer module.

Lock Period

Adds period locking for a specific calendar to the next period. You can schedule locking only one period at a time.

Calculate and Lock

Runs a calculation of your model, and then adds period locking for a specific calendar to the next period.

Running this task type instead of two separate Calculate and Lock tasks prevents data submission from preventing a calendar lock after a calculation.

Web Status

Disables the Sales Portal temporarily and then enables it again. This task is useful to prevent web users from logging in to the Sales Portal and changing data while the model is being updated.

Transformation

Runs the selected saved data transformations.

Clear Table

Delete the contents of a selected table.

To use the clearing tables feature, you must have view and edit permissions for the Composer module and the component that contains the table. If the table is in the top level of the Composer module, you must have Top → Edit permission.

You must also have view and edit permissions for the structure of the table that you want to clear.

Publish

Publishes the selected saved publication.

Calculate Presenter Report

Calculates one or all Presenter reports. You must choose the report to calculate or choose to calculate all reports.

Optimize

Run the model optimization feature.

Tip

Schedule this task to run during off peak hours.

Index Rebuild

Run an index rebuild or index reorganize, which can improve the performance of the model. You must choose a table or calculation to optimize. When the task runs, it de-fragments the table so that queries run against it perform better.

Note

Index Rebuilds can take a long time.

Task Run

Runs tasks in Tasks Module. Tasks must be generated in the Tasks module first.

Add Workflow Members

Adds payees to a selected workflow in the Workflows module. You must have swimlanes that are defined with restrictions in the workflow.

Unassign Idle Inquiries

Unassigns a user from an inquiry if the inquiry assigned to them is not updated in the Sales Portal after a specified number of days.

After the inquiry is unassigned, it is returned to the same Portal Access group to be reassigned. A comment is added to the inquiry to indicate that the assignee was unassigned from the inquiry because it was inactive for the specified number of days.

Purge History

Clears the history for selected tables. If you select a data table, you must select a date range for the table data that you want to remove history data from.

Expiring Password Email Notification

Sends an email to Sales Portal users that notifies them that their passwords are about to expire.

External Tool

Runs processes that exist outside of Varicent ICM. An external tool is any program that can be run from the command line. External tools are configured from the Admin panel.

In the Arguments field, you must specify the parameter.

For example, when an external tool runs, the working directory is /root. If you have a script.py, which takes in config.json as an argument, and both files are uploaded to the Scripts folder, you must specify the full path as /root/Script/config.json in the Arguments field.

System Tool

Encrypts or decrypts files by using PGP.

You must specify the Input file path, which is the location of the file that you want to encrypt or decrypt in the following format: <folder>/<file name>. For example, Publication/payee.pdf.

You must also specify the Output file path, which is the location that you want the file to be placed after it is encrypted or decrypted. It must also be in the following format: <folder>/<file name>.

Important

Contact Support to enable this feature. You must then send the Support team a public key, and in return you are sent a public key that is generated per model.

PGP encryption and decryption is only available in Varicent ICM on Cloud and is not available in the on-premise version.

Health Dashboard evaluation

Runs a Health Dashboard evaluation to evaluate your model's performance.

Refresh Materialized View

Runs a refresh of a materialized view.

Important

This task type is only available for AWS models.



Adding tasks

In Varicent Incentive Compensation Management (ICM), to create a process in the Scheduler module, you must add a task to a process folder.

You can schedule the runtime for each task that you add to the process or you can schedule the runtime for the entire process.

  1. Open the Scheduler module and select the process folder that you want to add a task to.

  2. Click the Add Add icon.

  3. From the Type drop-down menu, select the type of task that you want to add.

  4. You can set the schedule for the task by completing the following steps:

    1. Select either the day of the month or the day of the week when you want the task to run.

    2. Select the minute and hour that you want the task to run on.

    3. Select the month that you want the task to run in.

  5. Click Create.

Viewing the tables and date ranges for a scheduled history purge

You can view the tables and date ranges that were selected for a scheduled history purge in Varicent Incentive Compensation Management (ICM).

  1. In the Scheduler module, open the process folder.

  2. Place your cursor over the Purge Table History task and click the more options menu (...).

  3. Select Edit Schedule.

Canceling a task

You can cancel a scheduled task in the Scheduler module.

  1. In the Activity module, hover over the Scheduler task that you want to cancel.

    Tip

    For each running Scheduler process, you'll see two progress bars in the Activity module. The first is for the running task and the second, labeled Executing Scheduler item is for the process folder.

  2. Click the Delete icon delete.svg.

    Important

    The Delete icon appears only if the task is able to be canceled.

When you cancel a Scheduler task, one of the following happens:

  • If the Stop process on error option is selected in Model Settings, the Scheduler process is canceled. Any other tasks in the process folder will not run.

  • The current task is canceled. Any other tasks in the process folder run as scheduled.

If the On error, send email to these addresses option is selected in Model Settings, an email is sent to those addresses when the task is canceled.