Skip to main content

Prerequisite software

This software is required to download and install before installing Incentives on-premise.

Unless otherwise specified, it is recommended that you use the latest version of any of this software. Where specified, using that version will most closely match the installation instructions.

This page was last updated 12 Aug 2025. If you find any broken links, please let us know by sending us an email.

Postman

You'll use Postman to make REST API calls.

Download from www.postman.com.

Tip

You can use any application that allows you to make REST API calls, but this guide assumes you are using Postman. You'll be able to follow along more easily if you're using the same application.

You'll use Postman during installation to initialize the database, create a model, and create users.

postgreSQL

Important

During the installation and setup, make a note of the password you set for the database superuser and the port number (the default is usually 5432).

postgreSQL stores the database that organizes the model.

Download from www.postgresql.org/download/.

Caution

You can use the latest version (12), but the instructions will diverge from this guide, as the latest version is a browser application. You should do this only if you have a strong understanding of databases.

This application stores information from tenant services (like users, SSO configuration, and so on) as tables. It is often referred to as postgres as a shorthand. As part of the installation, you'll add a tenants database on postgres. You can do that now or later in the installation.

Adding a tenants database on postgreSQL

  1. Open PG admin III and right click Databases to create a new database.

  2. Name this database tenants.

    Warning

    The name of the database is case-sensitive.

  3. Under the Schemas section of the new database, delete the public schema.

    Later in the installation process, you'll create a new Incentives schema to replace this public schema.

Apache Web Server (httpd) (2.4)

You'll use an Apache web server to deploy an HTTP server so users can access the admin client. You'll also use this to deploy an HTTP server if you're using the latest version of Sales Portal.

Download from httpd.apache.org/download.cgi.

The Apache httpd download doesn't come with an installer, so you'll need to set this up as a service. You can find detailed information here: http://httpd.apache.org/docs/current/platform/windows.html#down.

Apache Tomcat

You'll use Apache Tomcat to deploy an HTTP server for Payee Web Classic.

Download from tomcat.apache.org/.

For more information about which versions of Apache Tomcat are supported, read: Web application server.

Microsoft Visual Studio C++ Redistributable for Visual Studio 2015

Without this package, enabling Apache web server 2.4 as a service on Windows will fail.

Optional

Notepad++

You'll use this to edit configuration files throughout the installation process.

Download from notepad-plus-plus.org/downloads/.

Tip

You can use any text editor that supports syntax highlighting. The syntax highlighting will make it easier to find and edit the right section of the configuration files.

OpenAM

Required only if you want to use SSO (single sign on) for user logins and you're using the Classic version of Sales Portal. If you're using the newest version of Sales Portal, download OpenSSL instead.

Download from backstage.forgerock.com/downloads/ (search for openam).

Tip

Make sure you download the .war file.

openSSL

Required only if you want to use SSO (single sign on) for user logins and you're using the newest version of Sales Portal. If you're using Payee Web Classic, download OpenAM instead.

Download from https://slproweb.com/products/Win32OpenSSL.html

AD Explorer

AD Explorer lets you review Active Directories.

Download from docs.microsoft.com/en-us/sysinternals/downloads/adexplorer.

Windows SDK

Required only if you are using Command Line Interface (CLI) tool. It creates and binds certificates.

Download from https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/.