You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Table of contents
This page describes the installation procedure for Blueriq using the installer. The Blueriq installer is available after unzipping the release zip file (which can be downloaded from the Customers page). Blueriq Encore (and Studio server) can only be installed with this installer, for a custom installation of the runtime on your own infrastructure see the documentation for Installing Runtime. Please refer to our platform support for a list of supported platforms on which you can install Blueriq.
Before the installation some launch conditions will be checked, like if IIS is present (if not install it first, a handy how-to guide can be found here), and if the operating system is of the correct version. Furthermore some prerequisites are automatically installed for IIS.
During the installation Tomcat will be installed. This software is part of the installation package.
Screenshots used may differ from the actual screens.
Prerequisites software
- IIS 10.0 (how to install)
Step-by-step Installation
When you start the installer you see the installer welcome screen.
In this step you can select your license which is needed for using Blueriq. If you provide the license.aql in this step, the license will be installed for the Runtime and Studio/Encore, and will be ready to use after installation.
When you click Next you can choose the type of installation:
Typical installation
The steps described in this section apply to the typical installation.
In this screen you can choose the Blueriq features you wish to install: Studio (Studio server + Blueriq Encore) , Runtime, Customerdata, DCM-lists, CaseEngine and Document Renderer. Note that the latter three are only available if you install the Runtime.
Here you can also configure the Blueriq installation directory.
A Studio/Encore user named admin will be created during the installation. To do so, a valid password needs to be entered here.
An admin user for the user management in Keycloak of Studio/Encore will also be created during the installation. To do so, a valid password needs to be entered here.
After this you are ready to install.
During installation a progress bar is shown.
The following screen lists the path to the Studio Server repository for backup purposes. For more information see backup the repository.
If you added a license during the installer it will show the dialog on the left. Otherwise the dialog on the right.
By default Blueriq will be launched when you finish the installation.
Custom installation
The steps in this section apply to the custom installation.
In this screen you can choose the Blueriq features you wish to install: Studio, Runtime, Customerdata, DCM-lists, CaseEngine and Document Renderer. Note that the latter three are only available if you install the Runtime.
Here you can also configure the Blueriq installation directory.
A Studio/Encore user named admin will be created during the installation. To do so, a valid password needs to be entered here.
An admin user for the user management in Keycloak of Studio/Encore will also be created during the installation. To do so, a valid password needs to be entered here.
When you click next you can configure the port IIS uses. Default is 160.
Any port specified in the installer is not checked for availability.
When you click next you can configure the port of the Studio Server service uses and the port for the studio Rest Service. Defaults are 16093 and 16096.
If the checkbox "Start studio on install" is checked the Studio will be started after the installation is finished.
When you click next you can configure the ports of the PostgreSQL Service and History Service. Defaults are 16094 and 16095.
These Services are use by the version management system.
When you click next the port that the Runtime uses is asked. The defaults are 16091.
If the checkbox "Start runtime on install" is checked the Runtime will be started after the installation is finished.
In the next screen you can specify the user that the Runtime uses to connect to Studio. The default is listed.
When you click next the port that Customer Data Service uses is asked. The defaults are 16097.
If the checkbox "Start customerdata on install" is checked the Customerdata service will be started after the installation is finished.
When you click next the port that Document Renderer Service uses is asked. The defaults are 16099.
If the checkbox "Start document renderer on install" is checked the Document Renderer service will be started after the installation is finished.
After this you are ready to install.
During installation a progress bar is shown.
If you added a license during the installer it will show the dialog on the left. Otherwise the dialog on the right.
By default Blueriq will be launched when you finish the installation.
Installation finished
When the installation is finished, the Blueriq start page is launched. Note that you first have to put the license file in the right location before you can start anything. For that and other configuration please take a look at Studio server and Encore.
Configuration
After installation is finished, continue to configuration of Studio Server and Encore and/or Runtime.
Logging
The installer will always save a log file during install on the location : %appdata%\Blueriq\
In case of an error during installation the log could give you more information about the cause of the error.
Common installation problems
Overview
Content Tools