Skip to main content
OutSystems

Unattended Installation and Upgrade

This article applies to:OutSystems Platform 10.0

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 is similar for .NET and Java stacks and involves the following high-level steps:

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

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

.NET

Before You Start

  • Download the "Installation Checklist" for the .NET stack 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:

    platform_path =  C:\Program Files\OutSystems\Platform Server
    outsystems_common_path =  C:\Program Files\Common Files\OutSystems\10.0

    Adjust them if necessary.

  • Both the Configuration Tool and the OutSystems Solution Pack Tool (OSPTool) are non-blocking (i.e. they return immediately after being invoked, without waiting for the requested operation to complete). Take this into account while automating your installation procedures.
    For example, if you're automating Platform Server installations or upgrades by using batch files, prefix the ConfigurationTool.exe and OSPTool.exe commands presented below with START /WAIT, in order to wait for the process to terminate before continuing the batch file execution.

First Install

  1. Install the OutSystems platform prerequisites

    Follow the instructions in the Pre-installation checklist section of the "Installation Checklist".

  2. Install the Platform Server binaries

    Run the OutSystems Platform Server installation package as follows:

    PlatformServer-M.m.R.p.exe /S [/D=platform_path]

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

  3. Only for Oracle and MySQL: create the database users

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

  4. 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 here.

    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.exe /GenerateTemplates
    

    Keep in mind that configuration settings differ between:

    i) .NET and Java;
    ii) application server; 
    iii) 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.

  5. Run Configuration Tool and install Service Center

    For SQL Server:

    platform_path\ConfigurationTool.exe /SetupInstall db_elevated_user db_elevated_pass /RebuildSession session_db_admin_user session_db_admin_pass /SCInstall

    For Oracle and MySQL:

    platform_path\ConfigurationTool.exe /SetupInstall /RebuildSession session_db_admin_user session_db_admin_pass /SCInstall
  6. Publish System Components

    outsystems_common_path\OSPTool.exe /Publish "platform_path\System_Components.osp" hostname username password
  7. 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.exe /UploadLicense license_file.lic
  8. Publish LifeTime

    outsystems_common_path\OSPTool.exe /Publish "platform_path\LifeTime.osp" hostname username password
  9. Publish OutSystems Now

    Requires downloading OutSystems Now from Forge.

    outsystems_common_path\OSPTool.exe /Publish "OutSystemsNow-version.oap" hostname username password

Upgrade

  1. Install the OutSystems platform prerequisites

    The platform prerequisites do not change when upgrading to a new revision, so it is only necessary to do this when upgrading between major versions (e.g. from 9.1 to 10). Follow the instructions in the Pre-installation Checklist section of the Installation Checklist.

  2. Upgrade the Platform Server binaries

    Run the OutSystems Platform Server installation package as follows:

    PlatformServer-M.m.R.p.exe /S [/D=platform_path]

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

  3. 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.

  4. Run Configuration Tool and install Service Center

    platform_path\ConfigurationTool.exe /UpgradeInstall [/RebuildSession session_db_admin_user session_db_admin_pass] /SCInstall
  5. Publish System Components

    outsystems_common_path\OSPTool.exe /Publish "platform_path\System_Components.osp" hostname username password
  6. 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.exe /UploadLicense license_file.lic
  7. Publish LifeTime

    outsystems_common_path\OSPTool.exe /Publish "platform_path\LifeTime.osp" hostname username password
  8. Publish OutSystems Now

    Requires downloading OutSystems Now from Forge.

    outsystems_common_path\OSPTool.exe /Publish "OutSystemsNow-version.oap" hostname username password
  9. Republish the entire factory

    outsystems_common_path\OSPTool.exe /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).

    Run the OutSystems Platform Server installation package as follows:

    PlatformServer-M.m.R.p.exe /S [/D=platform_path]

    The optional /D switch specifies the path where the OutSystems Platform Server is 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. 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:

    platform_path\ConfigurationTool.exe /SetupInstall db_elevated_user db_elevated_pass

    For Oracle and MySQL:

    platform_path\ConfigurationTool.exe /SetupInstall

Java

Before You Start

First Install

  1. Install the OutSystems platform prerequisites

    Follow the instructions in the Pre-installation Checklist section of the Installation Checklist.

  2. Install Platform Server binaries

    a) Online installation:

    JBoss EAP 6
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum install outsystems-agileplatform-jboss6-eap
    JBoss 8 Wildfly
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum installoutsystems-agileplatform-wildfly8
    WebLogic
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum install outsystems-agileplatform-weblogic

    b) Offline installation (requires OutSystems platform RPMs to be downloaded and a local repository to be configured, so that dependencies can be retrieved on request):

    JBoss EAP 6
    yum -y localinstall outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-jboss6-eap-M.m.b-r.noarch.rpm
    JBoss 8 Wildfly
    yum -y localinstall outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-wildfly8-M.m.b-r.noarch.rpm
    WebLogic
    yum -y localinstall outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-weblogic-M.m.b-r.noarch.rpm

    The M.m and M.m.b-r placeholders mentioned above reference the OutSystems version being installed.

    Refer to Offline Installation of OutSystems for details on the required dependencies.

  3. Download Java Cryptography Extensions 8 (JCE)

    Requires downloading the Java Cryptography Extensions 8 (JCE).

    Move the JCE download (e.g. jce_policy-8.zip) to the following folder: /opt/outsystems/platform/.

  4. Only for WebLogic: activate the Admin Server service

    chkconfig --level 345 weblogic-outsystems-adminserver on
  5. Create the database users

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

  6. Update the server.hsconf configuration file

    Replace the default /etc/outsystems/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 here.

    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 /opt/outsystems/platform/docs:

    /opt/outsystems/platform/configurationtool.sh --generate-templates

    Keep in mind that configuration settings differ between:

    i) .NET and Java;
    ii) application server;
    iii) 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.

Upgrade

  1. Install or upgrade the Platform

    a) Online Installation:

    JBoss EAP 6
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum upgrade outsystems-agileplatform-jboss6-eap
    JBoss 8 Wildfly
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum upgrade outsystems-agileplatform-wildfly8
    WebLogic
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum upgrade outsystems-agileplatform-weblogic

    b) Offline Installation (requires Platform RPMs to be downloaded and a local repository to be configured, so that dependencies can be retrieved on request):

    JBoss EAP 6
    yum -y upgrade outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-jboss6-eap-M.m.b-r.noarch.rpm
    JBoss 8 Wildfly
    yum -y upgrade outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-agileplatform-wildfly8-M.m.b-r.noarch.rpm
    WebLogic
    yum -y upgrade outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-weblogic-M.m.b-r.noarch.rpm

    The M.m and M.m.b-r placeholders mentioned above reference the OutSystems version being installed.

    Refer to Offline Installation of OutSystems for details on the required dependencies.

  2. 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.

  3. Run Configuration Tool and install Service Center

    /opt/outsystems/platform/configurationtool.sh --upgrade-install --rebuild-session --scinstall
  4. Publish System Components

    /opt/outsystems/platform/osptool.sh --publish /opt/outsystems/platform/System_Components.osp hostname username password
  5. Upload license file

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

    /opt/outsystems/platform/configurationtool.sh --upload-license license_file.lic
  6. Publish LifeTime

    /opt/outsystems/platform/osptool.sh --publish /opt/outsystems/platform/LifeTime.osp hostname username password
  7. Publish OutSystems Now

    Requires downloading OutSystems Now from Forge.

    /opt/outsystems/platform/osptool.sh --publish OutSystemsNow-version.oap hostname username password
  8. Republish the entire factory (requires manual intervention for major version upgrades)

    a) When applying a patch:

    /opt/outsystems/platform/osptool.sh --publish-factory hostname username password

    b) When upgrading to a new release or major version:

    — Manually upgrade and republish the factory.

Adding a Front-end

  1. Install Platform

    Implies execution of the steps described in the Platform Pre-installation checklist (e.g. iptables installation, firewall settings)

    a) Online Installation:

    JBoss EAP 6
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum install outsystems-agileplatform-jboss6-eap
    JBoss 8 Wildfly
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum install outsystems-agileplatform-wildfly8
    WebLogic
    rpm -i http://yum.outsystems.net/M.m/noarch/outsystems-repo.rpm
    yum install outsystems-agileplatform-weblogic

    b) Offline Installation (requires Platform RPMs to be downloaded):

    JBoss EAP 6
    yum --disablerepo=* -y install outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-jboss6-eap-M.m.b-r.noarch.rpm
    JBoss 8 Wildfly
    yum --disablerepo=* -y install outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-agileplatform-wildfly8-M.m.b-r.noarch.rpm
    WebLogic
    yum --disablerepo=* -y install outsystems-agileplatform-M.m.b-r.noarch.rpm outsystems-agileplatform-libs-M.m.b-r.noarch.rpm outsystems-agileplatform-weblogic-M.m.b-r.noarch.rpm

    The M.m and M.m.b-r placeholders mentioned above reference the OutSystems version being installed.

  2. Download Java Cryptography Extensions 8

    Requires downloading the Java Cryptography Extensions 8 (JCE).

    Move the JCE download (e.g. jce_policy-8.zip) to the following folder: /opt/outsystems/platform/.

  3. Copy 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. If that is not true, you will need to run 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:
    – /opt/outsystems/platform/private.key;
    – /etc/outsystems/server.hsconf.
     

  4. Run Configuration Tool

    /opt/outsystems/platform/configurationtool.sh --setup-install
  • Was this article helpful?