Skip to main content

Scheduler tasks

In the Scheduler module, you add tasks to a schedule to automate your model maintenance processes. A task makes up a piece of the schedule, and there are many different task types to help keep your model up to date and to automate administrative tasks.

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 59. Scheduler task types

Task type

Description

Add members to workflow

Includes payees in the designated swimlanes even after a workflow has started.

For more information, see: Adding payees after a workflow has started.

Calculate and lock calendar

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.

Select a calendar to run this task.

Calculation

Runs calculations from your model.

From the Select a calculation drop-down list, select one of the following:

  • Select All active plans and all reports to run a full model calculation

  • Select an individual calculation to run

Clear tables

Deletes the contents of a selected table. Select a table to clear to run this task.

External tool

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

In the Add arguments field, you must specify the parameter.

In the Add 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 Add arguments field.

System tool

Encrypts or decrypts files by using PGP.

Select a system tool to run this task.

In the Add an input file path field, specify the location of the file that you want to encrypt or decrypt in the following format: <folder>/<file name>. For example, Publication/payee.pdf.

In the Add an output file path field, specify where you want the file placed after it's 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 Incentives on Cloud and is not available in the on-premise version.

Expiring password notification

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

In the Select the user type drop-down list, select which group of users you'd like to email.

Folder

Adds a folder to a schedule.

Enter a name for the folder.

Health Dashboard Evaluation

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

Import

Runs a saved import.

Select a saved import to run this task.

Index rebuild

Runs an index rebuild or index reorganize, which can improve the performance of the model.

Select a table and a build type to run this task. 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.

Lock period

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

Select a calendar for period locking to run this task.

Manage workflow access

Disables or enables access to selected user-initiated and admin-initiated workflows in Sales Portal Message Center. Temporarily blocking payee access to your workflows in Message Center preserves the integrity of the workflow while data is in flux, like during data refreshes or loads.

There are two actions available:

  • Disable access in Message Center - disables access to selected workflows in Sales Portal Message Center. Payees will be unable to access the workflows, but workflows remain active.

  • Enable access in Message Center - enables access to selected workflows in Sales Portal Message Center. Payees will be able to access and perform actions on workflows.

For more information, see: Managing workflow access in Sales Portal Message Center.

Optimize

Runs the model optimization feature.

To run this task, select if you'd like to optimize all of your tables, or only some of them.

Tip

Schedule this task to run during off-peak hours.

Publish

Publishes the selected saved publication.

To run this task, check the publication(s) you'd like to publish.

Publish query tool

Publishes saved queries.

Purge table 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.

Select the table you want to purge the history of, and the time period you want purged.

Refresh materialized view

Runs a refresh of a materialized view.

To learn more, read: Adding view tables.

Star schema population

Populates star schemas created in the Composer module.

Select a star schema to populate.

Task generation

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

Task run

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

Transformation

Runs the selected saved data transformations.

Select a transformation to run.

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.

Select the number of days idle inquiries should remain assigned.

Web status

Select whether to enable or disable the Sales Portal.

Run Presenter report calculations

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

Run Varicent ELT pipe

Runs the selected Varicent ELT pipe. This task executes a complete Varicent ELT pipe without needing to import the pipe results into Incentives .

Note

This task is available only when Varicent ELT integration is set up.

This task, when scheduled to run, will appear as Export request from Incentives within the Exports page in Varicent ELT . This task will not trigger the global action flag, and will keep your model unlocked when the pipe runs.

Optionally, turn on the Refresh pipe data toggle to refresh all the pipe's data sources before running it. Any changes made to the data source will be updated, and the pipe will run as scheduled. Monitor this progress within the Status menu under Imports and My data page in Varicent ELT .