Skip to main content
OutSystems

Configuration Tool Command Line Reference

The Configuration Tool allows you to configure your OutSystems server.

The default path of the Configuration Tool command line is the following:

.NET: C:\Program Files\OutSystems\Platform Server\ConfigurationTool.com
Java: /opt/outsystems/platform/configurationtool.sh

The Configuration Tool command line returns non-zero values when an error occurs.

.NET

Syntax

ConfigurationTool.com {/SetupInstall [db_admin_username] [db_admin_password] | /UpgradeInstall [admin_password]}
                      [/RebuildSession session_db_admin_username session_db_admin_password] [/SCInstall]
                      | /GenerateTemplates
                      | /ClearInternalNetwork
                      | /UploadLicense license_file
                      | /RegenerateSettingsKey

Parameters

/SetupInstall [db_admin_username] [db_admin_password]
Creates or upgrades the OutSystems platform database model using the server.hsconf configuration file and installs Service Center. You must supply the credentials needed to create or upgrade the OutSystems platform database.
The admin username and password are not necessary for database providers that don’t require elevated user credentials (Oracle and MySQL).
/UpgradeInstall [admin_password]
Upgrades the OutSystems platform, without validating if the database exists or if the permissions are correct.
The admin password is optional and is only used for integrated authentication purposes where the password isn’t stored in the server configuration file.
/RebuildSession session_db_admin_username session_db_admin_password
Upgrades the session database model. The admin username and password must have permissions to execute these operations.
/SCInstall
Forces the Service Center installation to run after finishing Configuration Tool.
/GenerateTemplates
Generates server configuration file (.hsconf) templates for each supported database engine in Platform Server\docs.
/ClearInternalNetwork
Introduced in OutSystems 10. Resets the internal network settings so that internal applications become accessible from any origin.
/UploadLicense license_file
Uploads the license file and checks if the license is valid.
/RegenerateSettingsKey
Generates a new private.key file.

Example

Perform a clean installation for SQL Server:

ConfigurationTool.com /SetupInstall db_admin_username db_admin_password
                      /RebuildSession session_db_admin_username session_db_admin_password
                      /SCInstall

Perform a clean installation for database providers that don’t require elevated user credentials (Oracle and MySQL):

ConfigurationTool.com /SetupInstall
                      /RebuildSession session_db_admin_username session_db_admin_password
                      /SCInstall

Perform an upgrade:

ConfigurationTool.com /UpgradeInstall admin_password
                      /RebuildSession session_db_admin_username session_db_admin_password
                      /SCInstall

Logging

By default the Configuration Tool has logging enabled with log level 4 (Verbose), and the predefined log file is defined as C:\Windows\Temp\ConfigurationTool.log.

For more information on configuring logs check the Change OutSystems Platform logging levels (OSTrace) topic.

Java

Syntax

configurationtool.sh {--setup-install | --upgrade-install}
                     [--rebuild-session session_db_admin_username session_db_admin_password] [--scinstall]
                     | --generate-templates
                     | --clear-internal-network
                     | --upload-license license_file
                     | --regenerate-settings-key

Parameters

--setup-install
Creates or upgrades the OutSystems platform model using the server.hsconf configuration file and installs Service Center.
The command runs in unattended mode and only stops to inform or ask the next operation to be executed.
--upgrade-install
Upgrades the OutSystems platform, without validating if the database exists or if the permissions are correct.
--rebuild-session session_db_admin_username session_db_admin_password
Performs the same operations as the --setup-install option and additionally upgrades the session model. The admin username and password must have permissions to execute these operations.
--scinstall
Forces the Service Center installation to run after finishing Configuration Tool.
--generate-templates
Generates server configuration file (.hsconf) templates for each supported database engine in /opt/outsystems/platform/docs. The supported database engines depend on the operating system and application server currently in use.
--clear-internal-network
Introduced in OutSystems 10. Resets the internal network settings so that internal applications become accessible from any origin.
--upload-license license_file
Uploads the license file and checks if the license is valid.
--regenerate-settings-key
Generates a new private.key file.

Example

Perform a clean installation:

configurationtool.sh --setup-install --rebuild-session --scinstall

Perform an upgrade:

configurationtool.sh --upgrade-install --rebuild-session --scinstall

Logging

By default the Configuration Tool has logging enabled with log level DEBUG, and the predefined log file is defined as /opt/outsystems/platform/logs/ConfigurationTool.log.

For more information on configuring logs check the Change OutSystems Platform logging levels (OSTrace) topic.

  • Was this article helpful?