Skip to main content

Setting Up OutSystems

 

OutSystems

Unattended Installation and Upgrade

This article applies to: OutSystems 11  Other versions available: 10

The goal of this document is to describe the unattended or automated processes of installing or updating OutSystems Platform Server, and adding a new front-end server.

Overview

OutSystems allows performing silent or automated Platform Server installations and upgrades, as well as adding a new front-end server.

The process for installing or upgrading OutSystems Platform Server in unattended mode involves the following high-level steps:

  1. Install the OutSystems platform prerequisites
  2. Install the Development Environment binaries
  3. Install or upgrade the Platform Server binaries
  4. Only for Oracle: create the database users
  5. Update the server.hsconf configuration file
  6. Run Configuration Tool and install Service Center
  7. Publish System Components
  8. Upload license file (requires manual intervention)
  9. Publish LifeTime
  10. Publish OutSystems Now
  11. Only for upgrades and updates: republish the entire factory

The following sections present detailed instructions on how to install, upgrade, and add front-end servers in unattended mode.

Before You Start

  • Download the Installation Checklist from OutSystems website.

  • To publish OutSystems Now you will need to download OutSystems Now from Forge.

  • The default paths used in the procedures below are the following:

    • <development_environment_path>= C:\Program Files\OutSystems\Development Environment 11.0
    • <platform_path>= C:\Program Files\OutSystems\Platform Server
    • <outsystems_common_path>= C:\Program Files\Common Files\OutSystems\11.0

    Adjust them if necessary.

First Install

1. Install the OutSystems platform prerequisites

The OutSystems Platform Server installation package can automatically install most of the prerequisites if you provide the optional /InstallPrerequisites=True switch.

If you prefer to install the prerequisites manually, follow the instructions in the Pre-installation checklist section of the Installation Checklist before running the installation package.

Notes

When performing automatic prerequisites installation, the installation package will download the required binaries from the official Microsoft sources by default. However, you can also perform a fully offline installation.

The automatic prerequisites installation has a timeout of 15 minutes. This ensures that any unexpected occurrences during this process (e.g. downloading the prerequisites binaries taking a very long time) do not lock an automated unattended installation indefinitely.

2. Install the Development Environment binaries

Run the OutSystems Development Environment installation package as follows:

DevelopmentEnvironment-<version>.exe /S [/D=<development_environment_path>]

The optional /D switch specifies the path where the Development Environment is installed.

3. Install the Platform Server binaries

Run the OutSystems Platform Server installation package as follows:

PlatformServer-<version>.exe /S [/D=<platform_path>] [/InstallPrerequisites=True]

The optional /D switch specifies the path where the OutSystems Platform Server is installed.

The optional /InstallPrerequisites=True switch specifies if the prerequisites will be automatically installed. The same switch also specifies if the installer will automatically apply most of the mandatory steps in the Tuning and Security checklist section of the Installation Checklist.
For more information check the Automatic Prerequisites Installation and Configuration Tuning.

4. Only for Oracle: create the database users

Follow the instructions in the Database section of the Installation Checklist.

5. Update the server.hsconf configuration file

Replace the default <platform_path>\server.hsconf file with a customized template containing your specific configurations.

To help create specific server configuration files, Configuration Tool can automatically generate different configuration file templates for each database engine on which OutSystems can run on. The templates refer to the operating system and application server where the Configuration Tool is running. You can check the description of each parameter in the server.hsconf file.

Templates can be automatically generated before proceeding with the configuration steps of the unattended installation process (or even before the installation of the platform in the new machine, if you already have another machine where the platform is already installed), by using the following command line which will save them to the directory <platform_path>\docs:

<platform_path>\ConfigurationTool.com /GenerateTemplates

Keep in mind that configuration settings differ between OutSystems platform database.

To easily add a front-end later, the CompilerServerHostname parameter must include the name or IP of the machine and not localhost. The same applies to other parameters that refer hostnames.

Ensure that usernames and passwords are stored with the correct casing.

6. Run Configuration Tool and install Service Center

For SQL Server and Azure SQL:

<platform_path>\ConfigurationTool.com /SetupInstall <platform_db_admin_username> <platform_db_admin_password> [<logging_db_admin_username> <logging_db_admin_password>]
    /RebuildSession <session_db_admin_username> <session_db_admin_password>
    /CreateUpgradeCacheInvalidationService
    /SCInstall

For Oracle:

<platform_path>\ConfigurationTool.com /SetupInstall
    /RebuildSession <session_db_admin_username> <session_db_admin_password>
    /CreateUpgradeCacheInvalidationService
    /SCInstall

7. Publish System Components

<outsystems_common_path>\OSPTool.com /Publish "<platform_path>\System_Components.osp" <hostname> <username> <password>

8. Upload license file (requires manual intervention)

Manually obtain a valid OutSystems platform license from www.outsystems.com/licensing using the environment activation code.

<platform_path>\ConfigurationTool.com /UploadLicense <license_file.lic>

9. Publish LifeTime

<outsystems_common_path>\OSPTool.com /Publish "<platform_path>\LifeTime.osp" <hostname> <username> <password>

10. Publish OutSystems Now

Requires downloading OutSystems Now from Forge.

<outsystems_common_path>\OSPTool.com /Publish "<OutSystemsNow-version.oap>" <hostname> <username> <password>

Upgrade

1. Install the OutSystems platform prerequisites

The OutSystems Platform Server installation package can automatically install most of the prerequisites if you provide the optional /InstallPrerequisites=True switch.

If you prefer to install the prerequisites manually, follow the instructions in the Pre-installation checklist section of the Installation Checklist before running the installation package.

Notes

The installation package, by default, automatically downloads the required binaries for installing the prerequisites from the official Microsoft sources. However, you can also perform a fully offline installation.

The automatic prerequisites installation has a timeout of 15 minutes. This ensures that any unexpected occurrences during this process (e.g. downloading the prerequisites binaries taking a very long time) do not lock an automated unattended installation indefinitely.

2. Install the Development Environment binaries

If your Development Environment is no longer compatible with the Platform Server you are about to install, run the OutSystems Development Environment installation package as follows:

DevelopmentEnvironment-<version>.exe /S [/D=<development_environment_path>]

The optional /D switch specifies the path where the Development Environment is installed.

3. Upgrade the Platform Server binaries

Run the OutSystems Platform Server installation package as follows:

PlatformServer-<version>.exe /S [/D=<platform_path>] [/InstallPrerequisites=True]

The optional /D switch specifies the path where the OutSystems Platform Server is installed.

The optional /InstallPrerequisites=True switch specifies if the prerequisites will be automatically installed. The same switch also specifies if the installer will automatically apply most of the mandatory steps in the Tuning and Security checklist section of the Installation Checklist.
For more information check the Automatic Prerequisites Installation and Configuration Tuning.

4. Update the server.hsconf configuration file

Skip this step if no changes are necessary to the running configuration and that configuration file templates haven't changed.

5. Run Configuration Tool and install Service Center

<platform_path>\ConfigurationTool.com /UpgradeInstall [<admin_password>]
    [/RebuildSession <session_db_admin_username> <session_db_admin_password>]
    [/CreateUpgradeCacheInvalidationService]
    /SCInstall

6. Publish System Components

<outsystems_common_path>\OSPTool.com /Publish "<platform_path>\System_Components.osp" <hostname> <username> <password>

7. Upload license file (requires manual intervention)

Skip this step if the existing license is valid for the OutSystems version you're upgrading to.

Manually obtain a valid OutSystems platform license from www.outsystems.com/licensing using the environment activation code.

<platform_path>\ConfigurationTool.com /UploadLicense <license_file.lic>

8. Publish LifeTime

<outsystems_common_path>\OSPTool.com /Publish "<platform_path>\LifeTime.osp" <hostname> <username> <password>

9. Publish OutSystems Now

Requires downloading OutSystems Now from Forge.

<outsystems_common_path>\OSPTool.com /Publish "<OutSystemsNow-version.oap>" <hostname> <username> <password>

10. Republish the entire factory

<outsystems_common_path>\OSPTool.com /PublishFactory <hostname> <username> <password>

Adding a Front-End

1. Install the Platform Server binaries

Implies execution of the steps described in the Pre-installation Checklist (e.g. server roles and features, services options). The OutSystems Platform Server installation package can automatically install most of the prerequisites.

Run the OutSystems Platform Server installation package as follows:

PlatformServer-<version>.exe /S [/D=<platform_path>] [/InstallPrerequisites=True]

The optional /D switch specifies the path where the OutSystems Platform Server is installed.

The optional /InstallPrerequisites=True switch specifies if the prerequisites will be automatically installed.

2. Copy the configuration files from the controller node to the front-end

In order for this step to be successful, the server.hsconf file in the deployment controller machine must not refer to localhost in any hostname parameter, namely the deployment controller hostname and cache service hostname. If that is not true, you will need to run the Configuration Tool on the controller machine and change that address, before continuing with this step.

Copy the following files from the controller machine to the front-end machine, keeping the same path:

  • <platform_path>\private.key

  • <platform_path>\server.hsconf

3. Run Configuration Tool

For SQL Server and Azure SQL:

<platform_path>\ConfigurationTool.com /SetupInstall <platform_db_admin_username> <platform_db_admin_password> <logging_db_admin_username> <logging_db_admin_password>

For Oracle:

<platform_path>\ConfigurationTool.com /SetupInstall

Exit Codes and Logging

The OutSystems Platform Server installation package will return different exit codes depending on the install status:

  • 0 = successful install
  • 1 = system reboot is required to finalize prerequisite installation (only detected when the Platform Server installation package is automatically installing the prerequisites)
  • 2 = install failure

Capturing these exit codes requires that the installer package is executed inside the context of its own command shell.

You can check the logs generated by the installer package for detailed information. They are located in the following folder:

  • %LocalAppData%\OutSystems\PlatformInstaller
    (the default path is C:\Users\<current_user>\AppData\Local\OutSystems\PlatformInstaller)

Where <current_user> is the user installing the platform. The available log files are the following:

PrerequisitesCheck.log
Lists all the steps done to check what prerequisites are installed and/or missing.
PrerequisitesInstall.log
Lists all the steps done when installing missing prerequisites (if applicable).
PerformanceTuningCheck.log
Lists all the steps done to check which tuning optimizations can be performed.
PerformanceTuning.log
Lists all the steps done to perform tuning optimizations (if applicable).

Articles in this Section