Skip to main content

Installation with the ConfigSetter tool

The ConfigSetter is a tool that you can use to make the installation process faster and easier. Instead of updating values in each configuration file for the different components of Incentives, you update each value only once in the ConfigSetter.

Important

The ConfigSetter tool is only available with Incentives Version 10.1.1.102.0 and higher.

For example, changing the host value through the REST API tab changes it for all other files that use that value.

For this to work, those file locations must be correctly set. The first time you open the ConfigSetter, check the file name under each tab. If a location is not set, the name appears in red. Click Select Config to navigate to the location of the file.

There are also 3 files that are generated as examples, so you must change the names for the ConfigSetter to recognize them:

  • Change RESTAPI.dbServers.example.config to RESTAPI.dbServers.config

  • Change RESTAPI.appSettings.example.config to RESTAPI.appSettings.config

  • Change SchedulerService.appSettings.example.config to SchedulerService.appSettings.config

  1. Open the ConfigSetter.exe tool. This tool opens automatically after running the installer.

    Tip

    You may need to run the tool as an administrator.

  2. Under each tab, check the file location. If the file location appears in red, it means the ConfigSetter cannot locate the file. Click Select Config to navigate to the location of the file and select it.

  3. Update these fields:

    Name

    Tab

    Description

    Changes

    Address

    Database

    This address points to the location of the database.

    Updates address in RESTAPI.dbservers and modelServers.servers.address in default.json.

    Type

    Database

    This is the type of database that you are using.

    To use SQL Server 2016, all configurations must be done as if using SQL Server 2014. For example, if the database you are using is SQL Server 2016, then type sqlserver2014 or sqlserver2014unicode.

    Updates Type in RESTAPI.dbservers and modelServers.servers.type in default.json.

    User

    Database

    This is the Microsoft SQL Server user and requires SQL Server Authentication.

    Updates username in RESTAPI.dbservers and modelServers.servers.user in default.json. Updates jdbc.username in jdbc.properties.

    Password

    Database

    This is the password of the associated Microsoft SQL Server user.

    Updates password in RESTAPI.dbservers and modelServers.servers.password in default.json. Updates jdbc.password in jdbc.properties.

    Host

    REST API

    This is the hostname of the server where tenant services is installed

    Updates the Host in RestAPI.appSettings.Config and SchedulerService.appSettings. Updates the api_url in index.html. Updates the host and port values for the REST API.

    MessageSecretKey

    REST API

    This value matches the JWT_KEY value in the tenant services configuration file.

    Updates the MessageSecretKey in RestAPI.appSettings.Config. Updates the JWT_KEY variable in your environment.

    Host

    Scheduler

    This is the location of the Scheduler service.

    Updates the Host in SchedulerService.appSettings. Updates the SchedulerService in RestAPI.appSettings.Config. Updates the security.api.schedulerServicePrivateUrl in security.properties.

    SchedulerSecretKey

    Scheduler

    This value matches the SCHED_KEY value in the tenant services configuration file.

    Updates the SchedulerSecretKey in SchedulerService.appSettings. Updates the SchedMessageSecretKey in RestAPI.appSettings.Config. Updates the SCHED_KEY variable in your environment.

    Host

    Tenant Services

    This is the host name or IP of the machine where SQL server is installed.

    Updates TenantServices in RestAPI.appSettings.Config and SchedulerService.appSettings. Updates tenant-services-url in security.properties. Updates auth_url in index.html.

    Public port

    Tenant Services

    This is the public port specified during the installation of tenant services.

    Updates server.port in default.json. Updates tenant-services-url in security.properties. Updates auth_url in index.html.

    Private port

    Tenant Services

    This is the private port specified during the installation of tenant services.

    Updates TenantServices in RestAPI.appSettings.Config and SchedulerService.appSettings. Updates server.privatePort in default.json. Updates tenantServicesPrivateUrl in security.properties.

    TenantSecretKey

    Tenant Services

    This matches the TENANT_KEY value in the tenant services configuration file.

    Updates TenantSecretKey in RestAPI.appSettings.Config and security.properties. Updates the TENANT_KEY value in your environment.

    ManagementSecretKey

    Tenant Services

    This matches the MANAGEMENT_KEY value in the tenant services configuration file.

    Updates ManagementSecretKey in RestAPI.appSettings.Config. Updates the MANAGEMENT_KEY value in your environment.

    SystemCallsSecretKey

    Tenant Services

    This matches the API_KEY value in the tenant services configuration file.

    Updates SystemCallsSecretKey in RestAPI.appSettings.Config and SchedulerService.appSettings. Updates the API_KEY value in your environment.

    Host

    PayeeWebV1

    This is the host used by Apache Tomcat.

    Updates the Host value in default.json.

    PayeeWebSecretKey

    PayeeWebV1

    This matches the VARICENT_WEB_KEY value in the tenant services configuration file.

    Updates the PayeeWebSecretKey in RestAPI.appSettings.Config. Updates the secretkey in security.properties. Updates the the VARICENT_WEB_KEY value in your environment.

    Model Name

    PayeeWebV1

    This is the name of your model.

    Updates jdbc.model in jdbc.properties.

    Tenant Name

    PayeeWebV1

    This is the name of your tenant.

    Updates jdbc.tenant in jdbc.properties.

    Model Name

    PayeeWebV2

    This is the name of your model.

    Updates local_database in index.html.

    Tenant Name

    PayeeWebV2

    This is the name of your tenant.

    Updates local_tenant in index.html.

  4. Click Save.

You can now continue with installation by configuring the saved import settings, followed by Setting up HTTPS for the REST API.