Skip to main content

Installing the Varicent Incentives files

To get the installation files:

  1. In the Support Portal toolbar, click Open a Case to open a ticket with our Support team.

  2. In the ticket description, request the latest version of Incentives on-premise.

The installation package is a compressed file that contains installers for all parts of the application.

If you're installing version 10.1.1.105.0 or lower, you have the option of installing each file manually or by using the Unified installer. The Unified installer contains all of these files:

File name

Description

Tenant services

Tenant services, where tenants are located, is needed to manage users and models. It contains information to map the admin client with your database.

Incentives-restAPI

The REST API handles all the API calls made from the admin client. Based on actions you take in the admin client, the REST API communicates and makes changes to the database.

UI

The user interface (UI) is needed so you can interact with the admin client in a browser window.

Payeeweb

Sales Portal files are needed to deploy Sales Portal.

Web

Web files are needed to deploy Payee Web Classic.

Incentives-SchedulerService

The Scheduler Service is needed to run Scheduler so you can perform automated tasks in the admin client.

Incentives-modelupgrader

The model upgrader is needed to upgrade your model. When you want to upgrade to a newer version, you run the model upgrader so that the schema numbers are compatible with the new Incentives version.

Incentives-encrypter

The encryptor is needed to to encrypt the database server's username and password in the restAPI.dbservers.config. This is optional, but it increases the level of security.

Incentives-cli

The Command Line Interface (CLI) is needed to run tasks. Generally, you only need this if you are upgrading from an earlier version and have legacy tasks that you cannot run using the REST API.

ConfigSetter

The Configuration Setter is a tool that updates the configuration files used in the installation process. Instead of editing individual configuration files, you update the ConfigSetter and those fields are updated in the configuration files.

To install the files using the installer:

  1. Run the UnifiedVaricentInstaller.

  2. Follow the steps in the wizard to complete the installation.

    Tip

    On the Custom Setup step, you can choose which services to install. The installed.png icon indicates the service will be installed. The not_installed.png icon indicates the service will not be installed. Click the feature menu to change whether the service will be installed.

When the installation completes, the ConfigSetter will automatically open. You can use the ConfigSetter to the configuration files for the REST API, tenant services, admin and Sales Portal features. If you want to configure your files manually, close the ConfigSetter and read the Manual installation instructions.