Installation Guide

Last updated: 27 May 2025

Installing ControlWORQ Server¶

This topic will guide you through the process of installing the ControlWORQ Server Components.

Before you Begin¶

Please be sure to review System Requirements and the following installation subtopics:

Installation Checklist: This subtopic covers some of the prerequisites you'll need before installing the ControlWORQ Server components.
Upgrading from a Prior Release: This subtopic should be reviewed, along with the Release Notes, before upgrading from a prior release of ControlWORQ or JRE for TM1.
Architecture & Distributed Installations: This topic covers options for performing a distributed install of ControlWORQ Server components, if required.

Installation Step-by-Step¶

Execute the ControlWORQ installation by double-clicking on the downloaded ControlWORQ installation package (e.g., ControlWORQInstaller_1.2.3.4.exe). This will launch an installation wizard which will guide you through the remaining installation steps:

.NET Framework Prerequisites
Main ControlWORQ Installation
Feature/Component Selection
SQL Server Authentication Information (if component selected)

.NET Framework 4.0 Prerequisites¶

If ControlWORQ detects that you do not already have the .NET Framework 4.0 prerequisites installed, it will attempt to download and install it for you. If you already have them installed, you may proceed to the next section.

Once the installation of the .NET Framework prerequisites succeeds, a reboot may be required:

If you say yes, the machine will reboot and the installation routine will resume. If a reboot is not required, the install will proceed normally.

Main ControlWORQ Installation¶

After launching setup, you may need to elevate privileges if User Account Control is active:

After confirming and completing any install Prerequisites, you will notice the installation wizard loading and extracting its required files to the local computer:

Once this has completed, you will see the Welcome screen. Click Next to proceed:

At the license agreement page, click Next once you've agreed to the licensing terms:

Custom Install Settings¶

At the next screen, you can choose whether to do a complete installation or customize the installation settings:

If you do not choose to do a Custom install, proceed to the SQL Server connection settings step. Otherwise, you will be presented with an option to change the installation location:

Followed by the available installation components, which can be selected/deselected depending on what you need to install. For example, if you are considering a Distributed Installation, you may only need to select the Server or Configuration Application components:

The available options can be summarized as follows:

ControlWORQ Servers: All available ControlWORQ Server-related components
ControlWORQ Application Server: contains the ControlWORQ Windows Service
ControlWORQ Relational Database: runs the DB create script in SQL Server to create the relational database required by ControlWORQ. Not required if a previous ControlWORQ database already exists.
ControlWORQ Web Site: Installs the ControlWORQ web application into IIS on the server
ControlWORQ Client Components: Server-related clients used in configuration and administration
Configuration Application: The configuration and administrative interface used by ControlWORQ
Database Upgrade Tools: Contains utilities needed to migrate data from a legacy JRE for TM1 (or earlier) relational database to ControlWORQ's database structure
ControlWORQ Documentation: Contains documentation for the ControlWORQ Server; note that any documentation for the web application is included with that component.

SQL Server Settings¶

You will be prompted for SQL Server login if you have chosen a Complete installation type or have selected the "ControlWORQ Relational Database" option in the Custom Installation type:

After filling out connection information, ControlWORQ will attempt to validate your connection information. You will need to resolve any SQL Server connectivity issues before you can proceed, to ensure that the ControlWORQ installation can create the database.

ℹ️ Note: The installation program will also install SQL Server scripts needed to create new and upgrade prior ControlWORQ databases; if needed, you can manually create the required ControlWORQ relational database independently of the installation package.

Completing the Install¶

At this point, ControlWORQ is ready to be installed:

After clicking install, you will see the installation proceed; this can take several minutes to complete. Once the install is completed you will see the following Finished screen indicating that the installation has completed successfully:

At this point, the ControlWORQ add-in Server components that you selected should be installed and ready for additional configuration, as defined in topics such as Post-Installation Steps.