Skip to main content
OutSystems

server.hsconf Configuration File Reference

The server.hsconf is an XML file with all necessary configurations for the OutSystems platform. The settings in the server.hsconf configuration file correspond to the settings that are available on the user interface of the Configuration Tool.

To generate templates for the server.hsconf configuration file use the following Configuration Tool command line and choose the template that corresponds to your database management system:

.NET
ConfigurationTool.exe /GenerateTemplates
Java
configurationtool.sh --generate-templates

The server.hsconf configuration file defines the settings in key-value pairs organized in categories, according to the following syntax:

<EnvironmentConfiguration>
<CATEGORY [ProviderKey="[SqlServer|Oracle|MySQL]"]>
    		<KEY [encrypted="[false|true]"]>VALUE</KEY>
    		...
</CATEGORY>
	...
</EnvironmentConfiguration>

The following sections describe in detail the configurations that are available in each category of the configuration file.

Platform Database Configuration

The following XML element defines the configurations in the Platform Database Configuration category:

<PlatformDatabaseConfiguration ProviderKey="[SqlServer|Oracle|MySQL]">
    <KEY [encrypted="[false|true]"]>VALUE</KEY>
    ...
</PlatformDatabaseConfiguration>

The attribute ProviderKey specifies the database management system that the configurations apply to.

Common Configurations

The following are the configurations that do not depend on the database management system:

Key Value Description
AdminUser Name of the owner of the OutSystems metamodel tables.  
AdminPassword Password of the owner of the OutSystems metamodel tables. Configuration Tool will read the clear text password and save an encrypted version.
RuntimeUser Name of the owner of the tables created in the Development Environment.  
RuntimePassword Password of the owner of the tables created in the Development Environment. Configuration Tool will read the clear text password and save an encrypted version.
LogUser Name of the owner of the logging tables.  
LogPassword Password of the owner of the logging tables. Configuration Tool will read the clear text password and save an encrypted version.
RuntimeAdvancedSettings

If using .NET:
Settings in ADO.NET format to be appended to the connection string for OutSystems services.

If using Java with MySQL:
Settings in JDBC URL parameters format (propertyName1=propertyValue1&propertyName2=propertyValue2).

If using Java with Oracle:
All configurations must be done in the file /etc/outsystems/tnsnames.ora.

Allows you to use a specific connection string for the OutSystems applications.
ServicesAdvancedSettings

If using .NET:
Settings in ADO.NET format to be appended to the connection string for OutSystems services.

If using Java with MySQL:
Settings in JDBC URL parameters format (propertyName1=propertyValue1&propertyName2=propertyValue2).

If using Java with Oracle:
All configurations must be done in the file /etc/outsystems/tnsnames.ora.

Allows you to use a specific connection string for the OutSystems services.
AdvancedConfigurationMode “true” or “false”.

Indicates if the connection strings should include the advanced settings.

Leave false if you didn’t set the configurations RuntimeAdvancedSettings  or ServicesAdvancedSettings.

SQL Server

The following are the configurations that are specific to SQL Server:

Key Value Description
Unicode

“true” or “false”.

Do not customize this field. OutSystems only supports non-Unicode in legacy systems.

Defines If the database supports unicode or not.
UsedAuthenticationMode “Database Authentication” or “Windows Authentication”. Authentication protocol to be used.
Server Hostname or IP address of the database server.  
Catalog Database catalog to be used by OutSystems.  

Oracle

The following are the configurations that are specific to Oracle:

Key Value Description
IntrospectionMethod Internal, do not customize.  
CI_AI

“true” or “false”.

Internal, do not customize.

Case insensitive and accent insensitive mode.
DateFunction

Function used to get date.

Internal, do not customize.

 
DDLLockTimeout

Numeric value.

Internal, do not customize.

Timeout used in DDL lock operations.
NamingType “Service Name” or “TNS Name”. Connection mode used.
TNSName Address name defined in the tnsnames.ora configuration file.

This option is only available when NamingType is set to “TNS Name”.

More information here.

Host Hostname or IP address of the database server.

This option is only available when NamingType is set to “Service Name”.

More information here.

Port Port where the database service listens.

This option is only available when NamingType is set to “Service Name”.

More information here.

ServiceName Oracle database service name.

This option is only available when NamingType is set to “Service Name”.

More information here.

NLS_Language NLS_LANG Language Oracle environment parameter. Changes the locale of the messages returned by the Oracle driver.
NLS_Territory NLS_LANG Territory Oracle environment parameter. Changes the locale of the messages returned by the Oracle driver.
AdminTablespace Table space where the system tables are stored.  
IndexTablespace Table space where all the indexes of the platform are stored.  
RuntimeTablespace Table space where the tables created in the Development Environment are stored.  
LogTablespace Table space where the logging tables are stored.  

MySQL

The following are the configurations that are specific to MySQL:

Key Value Description
Server Hostname or IP address of the database server.  
Schema Database schema to be used by OutSystems.  

Session Database Configuration

The following XML element defines the configurations in the Session Database Configuration category:

<SessionDatabaseConfiguration ProviderKey="[SqlServer|Oracle|MySQL]">
    <KEY [encrypted="[false|true]"]>VALUE</KEY>
    ...
</SessionDatabaseConfiguration>

The attribute ProviderKey specifies the database management system that the configurations apply to.

Common Configurations

The following are the configurations that do not depend on the database management system:

Key Value Description
SessionUser Name of the owner of the OutSystems session metamodel tables.  
SessionPassword Password of the owner of the OutSystems session metamodel tables. Configuration Tool will read the clear text password and save an encrypted version.
SessionAdvancedSettings

If using .NET:
Settings in ADO.NET format to be appended to the connection string for OutSystems services.

If using Java with MySQL:
Settings in JDBC URL parameters format (propertyName1=propertyValue1&propertyName2=propertyValue2).

If using Java with Oracle:
All configurations must be done in the file /etc/outsystems/tnsnames.ora.

Allows you to use a specific connection string for the OutSystems applications.
AdvancedConfigurationMode “true” or “false”. Indicates if the connection strings should include the advanced settings. Leave false if you didn’t set the configuration SessionAdvancedSettings.
DeleteExpiredSessionsAvoidLockRowCount

Numeric value.

Internal, do not customize.

 

SQL Server

The following are the configurations that are specific to SQL Server:

Key Value Description
UsedAuthenticationMode “Database Authentication” or “Windows Authentication”. Authentication protocol to be used.
Server Hostname or IP address to the database server.  
Catalog Database catalog to be used by OutSystems.  

Oracle

The following are the configurations that are specific to Oracle:

Key Value Description
IntrospectionMethod Internal, do not customize.  
CI_AI

“true” or “false”.

Internal, do not customize.

Case insensitive and accent insensitive mode.
DateFunction

Function used to obtain the date.

Internal, do not customize.

 
DDLLockTimeout

Numeric value.

Internal, do not customize.

Timeout for DDL lock operations.
IdType “Service Name” or “TNS Name” Connection mode used.
TNSName Address name defined in the tnsnames.ora configuration file.

This option is only available when IdType is set to “TNS Name”.

More information here.

Host Hostname or IP address of the database server.

This option is only available when IdType is set to “Service Name”.

More information here.

Port Port where the database service listens.

This option is only available when IdType is set to “Service Name”.

More information here.

ServiceName Oracle database service name.

This option is only available when IdType is set to “Service Name”.

More information here.

NLS_Language NLS_LANG Language Oracle environment parameter. Changes the locale of the messages returned by the Oracle driver.
NLS_Territory NLS_LANG Territory Oracle environment parameter. Changes the locale of the messages returned by the Oracle driver.
SessionTablespace Table space where the session tables are stored.  

MySQL

The following are the configurations that are specific to MySQL:

Key Value Description
Server Hostname or IP address to the database server.  
Schema Database schema to be used by OutSystems.  

Service Configuration

The following XML element defines the configurations in the Service Configuration category:

<ServiceConfiguration>
    <KEY>VALUE</KEY>
    ...
</ServiceConfiguration>

The following are the available configurations:

Key Value Description
CompilerServerHostname Hostname or IP address of the Deployment Controller Server. To make it easier to add a front-end server later, we do not recommend using the value localhost as the hostname.
CompilerServerPort Numeric value. Port used by the Deployment Controller Service, in the Deployment Controller Server.
DeploymentServerPort Numeric value. Port used by the Deployment Service, in the Front-End Servers.
LogQueuePath    
LogServerPort Numeric value. Port used by the Log Service, in the Front-End Servers.
RMIRegistryPort
(Java Only)
Numeric value. Port used by the RMI Service, in the Front-End Servers.
SchedulerServerPort Numeric value. Port used by the Scheduler Service, in the Front-End Servers.
SupportAsynchronousLog

“true” or “false”.

Internal, do not customize.

 

Server Configuration

The following XML element defines the configurations in the Server Configuration category:

<ServerConfiguration>
    <KEY>VALUE</KEY>
    ...
</ServerConfiguration>

The following are the available configurations:

Key Value Description
ApplicationServerPort Internal, do not customize. The default port is 80.
ApplicationServerSecurePort Internal, do not customize. The default port is 443.
MaxConcurrentTimers Numeric value. Maximum number of Timers (asynchronous jobs) that can be executed at the same time in each Front-End Server.
WeeksToKeep Numeric value. Indicates for how long the log files are kept. After this time, the log tables are rotated and information is lost.

Kannel Configuration (.NET Only)

The following XML element defines the configurations in the Server Configuration category:

<KannelConfiguration>
    <KEY>VALUE</KEY>
    ...
</KannelConfiguration>

The following are the available configurations in .NET only:

Key Value Description

KannelHost
IP address of the SMS Gateway.  
KannelPassword Password of the SMS Gateway user.  
KannelPort Numeric value. Port used by the SMS Gateway to send messages.
KannelStatusPassword Password used when requesting the status of the SMS requests.  
KannelStatusPort Numeric value. Port used by the SMS Gateway to receive the operational status of the requests and to monitor the SMS status in the environment management console.
KannelUsername Name of the SMS Gateway user. Must be an existing SMS Gateway user.
KannelVersion Version of the Kannel.  
MaxBulkSms Numeric value. Maximum number of bulk messages sent to the SMS Gateway per block.
UnifiedPrefix Country prefix, including the “+” signal. Example: “+351”.

SMS Configuration (.NET Only)

The following XML element defines the configurations in the SMS Configuration category:

<SMSConfiguration>
    <KEY>VALUE</KEY>
    ...
</SMSConfiguration>

The following are the available configurations in .NET only:

Key Value Description
SMSCInboundFailedQueue Internal, do not customize. Queue used by OutSystems to deal with failed inbound messages.
SMSCInboundQueue Internal, do not customize. Queue used by OutSystems to deal with inbound messages.
SMSCInboundThreads Numeric value. Number of threads that process incoming messages.
SMSConnectorPort Numeric value. Port of the SMS Connector Service.
SMSCOutboundFailedQueue Internal, do not customize. Queue used by OutSystems to deal with failed outbound messages.
SMSCOutboundQueue Internal, do not customize. Queue used by OutSystems to deal with outbound messages.
SMSCOutboundThreads Numeric value. Number of threads that process outgoing messages.
SMSCTriesBeforeQuiting Numeric value. Maximum number of attempts to deliver a message. When this number is reached, the delivery of the SMS fails.

Network Configuration

The following XML element defines the configurations in the Network Configuration category:

<NetworkConfiguration>
    <KEY>VALUE</KEY>
    ...
</NetworkConfiguration>

The following are the available configurations:

Key Value Description
ApplicationServerVersion Internal, do not customize.  
FrontendIpAddress (.NET Only) IP address of the Front-End Server that will be used by the SMS gateway adapter.  
OutgoingIPAddress IP address that the Front-End server will register in the Deployment Controller Service. Leave empty for automatic.  
RequiresSoapHeadersSlowRetrieva Internal, do not customize.  
ServerKind Internal, do not customize.  

Other Configurations

The following XML element defines the configurations in the Other Configurations category:

<OtherConfigurations>
    <KEY>VALUE</KEY>
    ...
</OtherConfigurations>

The following are the available configurations:

Key Value Description
DBIntrospectionTimeout Numeric value. Default timeout for database queries that do metamodel introspection.
DBTimeout Numeric value. Default timeout for database queries to complete. The value can be overridden for each query in the Development Environment.
DBUpdateTimeout Numeric value. Default timeout for database updates to run when 1-Click Publishing an application.
InstallationDir Path of the OutSystems platform installation. Leave this setting as is, there is no need to configure.
InstanceName Internal, do not customize. Leave this setting as is, there is no need to configure.
PlatformVersion Version of the OutSystems platform. Leave this setting as is, there is no need to configure.
QueuesAvailable “true” or “false”. Indicates if the messages queues are installed.

Extension Point Configurations (Java Only)

The following XML element defines the configurations in the Extension Point Configurations category:

<ExtensionPointConfigurations>
    <KEY>VALUE</KEY>
    ...
</ExtensionPointConfigurations>

The following are the available configurations in Java only:

Key Value Description
OutSystems.Jboss71.DeployDir Internal, do not customize.  
OutSystems.Wildfly.DeployDir Internal, do not customize.  
OutSystems.Weblogic.ConsoleHost Internal, do not customize.  
OutSystems.Weblogic.ConsolePort Internal, do not customize.  
OutSystems.Weblogic.ProtocolInUse Internal, do not customize.  
OutSystems.Weblogic.ConsoleUsername Internal, do not customize.  
OutSystems.Weblogic.ConsolePassword Internal, do not customize.  
OutSystems.Weblogic.ServerTarget Internal, do not customize.  
OutSystems.Weblogic.DeployDir Internal, do not customize.  
  • Was this article helpful?