This section provides the steps that you must follow to successfully install your Deployment Controller or Server.
| * |
In Microsoft Azure PortalSQL Server, create three database catalogs to be used by OutSystems
Platform Server:
- One of the catalogs will be used to configure platform settings in Configuration Tool;
- Another catalog will be used to configure log settings in Configuration Tool;
- The other catalog will be used to configure session settings in Configuration Tool.
|
| * |
Install the Platform Server:
- The user that will install the Platform Server needs to be part of the Create symbolic links User Rights Assignment.
If this is not the case, the installer might fail to copy some required files during installation. If the user is part of Local Policies > User Rights Assignment > Create symbolic links, make sure there is no Domain Security Policy that overlaps the Local Policy. If this happens, the assignment needs to be done at the Domain level.
- Run the installation file PlatformServer-M.F.P (Build B).exeLifeTimeWithPlatformServer-M.F.P (Build B).exe and follow the on screen installation instructions
|
| * |
Check that Platform Server Services' restricted permissions are in place:
Check that the OutSystems services are running with their respective users:
- OutSystems Deployment Controller Service: NT Service\OutSystems Deployment Controller Service
- OutSystems Scheduler Service: NT Service\OutSystems Scheduler Service
Open Local Security Policy, navigate to Local Policies > User Rights Assignment and check that NT Service\OutSystems Deployment Controller Service and NT Service\OutSystems Scheduler Service are in the following policies:
- Create symbolic links;
- Log on as batch job;
- Log on as service.
Check that the user you are currently logged in to is in the following policy Create symbolic links. You must ensure that this is true for every user that tries to run the Configuration Tool.
Check our documentation for more information.
|
|
Install SAP Connector Libraries:
-
Installation steps
- Download the SAP Connector for Microsoft.NET 3.1.x for Windows 64bit (Compiled with .NET Framework 4.6.2) from SAP Support Portal.
- You will need a valid SAP user to download the connector.
- Unblock the downloaded installer file.
- Install the Connector.
- From the %WINDIR%\Microsoft.NET\assembly\GAC_64\ directory, copy the sapnco.dll and sapnco_utils.dll files to the \thirdparty\lib\ directory in the Platform Server installation directory (e.g.: C:\Program Files\OutSystems\Platform Server\thirdparty\lib\)
- From the %WINDIR%\Microsoft.NET\assembly\GAC_64\ directory, copy the rscp4n.dll to the %WINDIR%\system32\ directory
-
Post-installation steps
- Publish the SAPDevService in Service Center
- Log in to Service Center (http://(yourserver)/ServiceCenter) using your administrator credentials for Platform Server.
- Go to Factory > Modules.
- Search for SAPDevService and click in the eSpace name
- Click the Publish button at the last version.
NOTES
- These steps are only required if you are going to integrate OutSystems Platform with your SAP.
- If you need to update the SAP NCO connector you must uninstall the SAP NCO first with "Apps & Features" windows settings and repeat the Installation steps.
- If this step is done later, after you have installed the Platform, you must follow the Post-installation steps to publish the SAPDevService.
|
| * |
If until now you have not installed Platform Server in your Deployment Controller you should follow the Deployment Controller checklist up until that point.
Once that step has been completed you will be instructed to resume this checklist.
|
| * |
At this point you need to have the data and session model created. If you do not have it created yet, please refer to the Database profile in this checklist.
|
| * |
Execute the Platform Database creation script.
-
You can find it in the Deployment Controller under the OutSystems Platform Server installation directory, in
db\platform_creation_oracle.sql. This file allows you to create users, tablespaces and grants the necessary permissions. By default, when executing this file, the following objects will be created:
- Users: OSADMIN, OSRUNTIME, OSLOG
- Tablespaces: OSSYS, OSIDX, OSUSR, OSLOG
- Grants:
- OSADMIN: Create Session, Create View, Create Table, Alter Session, Create Sequence, Create Procedure, Create Trigger
- OSRUNTIME: Create Session
- OSLOG: Create Session
- Please check with your Database Administrator how to do this according to your database environment.
- This script can be customized, however, you should make sure the file paths, tablespaces and users don't clash with existing objects in the database.
- If you change any of these settings, remember to do so throughout the file.
- You'll need the usernames, passwords and tablespaces used in this script to configure Platform Server later on.
- As mentioned in the Pre-Instalation section, if MAX_STRING_SIZE is set to EXTENDED, ensure to modify the script to create the OSIDX tablespace with a 32KB block size.
|
| * |
Execute the Platform Database creation script.
-
You can find it in the Deployment Controller under the OutSystems Platform Server installation directory, in
db\RDS_platform_creation_oracle.sql. This file allows you to create users, tablespaces and grants the necessary permissions. By default, when executing this file, the following objects will be created:
- Users: OSADMIN, OSRUNTIME, OSLOG
- Tablespaces: OSSYS, OSIDX, OSUSR, OSLOG
- Grants:
- OSADMIN: Create Session, Create View, Create Table, Alter Session, Create Sequence, Create Procedure, Create Trigger
- OSRUNTIME: Create Session
- Please check with your Database Administrator how to do this according to your database environment.
- This script can be customized, however, you should make sure the file paths, tablespaces and users don't clash with existing objects in the database.
- If you change any of these settings, remember to do so throughout the file.
- You'll need the usernames, passwords and tablespaces used in this script to configure Platform Server later on.
- As mentioned in the Pre-Instalation section, if MAX_STRING_SIZE is set to EXTENDED, ensure to modify the script to create the OSIDX tablespace with a 32KB block size.
|
| * |
Execute the Logging Database creation script.
-
You can find it in the Deployment Controller under the OutSystems Platform Server installation directory, in
db\logging_creation_oracle.sql. This file allows you to create users, tablespaces and grants the necessary permissions for the logging database. By default, when executing this file, the following objects will
be created:
- Users: OSADMIN_LOG, OSRUNTIME_LOG
- Tablespaces: OSSYS_LOG, OSIDX_LOG, OSUSR_LOG
- Grants:
- OSADMIN_LOG: Create Session, Create View, Create Table, Alter Session, Create Sequence, Create Procedure, Create Trigger
- OSRUNTIME_LOG: Create Session
- Please check with your Database Administrator how to do this according to your database environment.
- This script can be customized, however, you should make sure the file paths, tablespaces and users don't clash with existing objects in the database.
- If you change any of these settings, remember to do so throughout the file.
- You'll need the usernames, passwords and tablespaces used in this script to configure Platform Server later on.
- As mentioned in the Pre-Instalation section, if MAX_STRING_SIZE is set to EXTENDED, ensure to modify the script to create the OSIDX_LOG tablespace with a 32KB block size.
|
| * |
Execute the Logging Database creation script.
-
You can find it in the Deployment Controller under the OutSystems Platform Server installation directory, in
db\RDS_logging_creation_oracle.sql. This file allows you to create users, tablespaces and grants the necessary permissions for the logging database. By default, when executing this file, the following objects
will be created:
- Users: OSADMIN_LOG, OSRUNTIME_LOG
- Tablespaces: OSSYS_LOG, OSIDX_LOG, OSUSR_LOG
- Grants:
- OSADMIN_LOG: Create Session, Create View, Create Table, Alter Session, Create Sequence, Create Procedure, Create Trigger
- OSRUNTIME_LOG: Create Session
- Please check with your Database Administrator how to do this according to your database environment.
- This script can be customized, however, you should make sure the file paths, tablespaces and users don't clash with existing objects in the database.
- If you change any of these settings, remember to do so throughout the file.
- You'll need the usernames, passwords and tablespaces used in this script to configure Platform Server later on.
- As mentioned in the Pre-Instalation section, if MAX_STRING_SIZE is set to EXTENDED, ensure to modify the script to create the OSIDX_LOG tablespace with a 32KB block size.
|
| * |
Configure Platform Server Database settings with the Configuration Tool
Start the Configuration Tool (Start -> Programs -> OutSystems -> Administration Tools).
Configure the Platform Database Schema (Platform tab):
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Configure Logging Database settings with the Configuration Tool
Configure the Logging Database Schema (Log tab):
- Set the Oracle database to be used by configuring the Database section.
If you have any questions on how to configure this section, please use the More info link, near the Naming method drop-down.
- Fill in User in the Admin section using the database login previously created for the logging Admin role
- Fill in Tablespace and Index Tablespace fields in the Admin section with the logging Tablespace and the Index Tablespace previously created
- Fill in User in the Runtime section using the database login previously created for the logging Runtime role
- Fill in Tablespace field in the Runtime section with the logging Runtime Tablespace previously created
- Test all users to confirm correct connectivity. For this, click Test Connection for each of the users configured.
- Create the Logging Database schema by clicking the Create/Upgrade Database button.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Execute the Platform Server session creation script.
- You can find it in the Deployment Controller under the OutSystems Platform Server installation directory, in
db\session_creation_oracle.sql.
- This allows you to configure the tablespace, the tablespace's datafile location, the user and password. By default, the objects are set to:
- Tablespace: OSSTATE
- User: OSSTATE
- If you change any of these settings, remember to do so throughout the file.
- Run this script like you did with the script to create the data model of OutSystems Platform.
|
| * |
Execute the Platform Server session creation script.
- You can find it in the Deployment Controller under the OutSystems Platform Server installation directory, in
db\RDS_session_creation_oracle.sql.
- This allows you to configure the tablespace, the tablespace's datafile location, the user and password. By default, the objects are set to:
- Tablespace: OSSTATE
- User: OSSTATE
- If you change any of these settings, remember to do so throughout the file.
- Run this script like you did with the script to create the data model of OutSystems Platform.
|
| * |
Configure Session Database settings with the Configuration Tool
Configure the Platform Session Database (Session tab):
- Set the Oracle database to be used by configuring the Database Section.
The configuration process for this Database is the same used in the Platform Database
- Configure the User, Password and Tablespace with the session database login and the session tablespace previously created
- Press the Test Login button to confirm that the settings are correct
- Create the Session Database schema by clicking the Create Session Database button.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Configure Platform Server Database settings with the Configuration Tool
Start the Configuration Tool (Start -> Programs -> OutSystems -> Administration Tools).
Configure the Platform Database (Platform tab):
- In the Database Provider drop-down list, choose SQL Server / Azure SQL
- Configure Server and Database fields:
- Server is the name or IP of the database server, and instance or TCP port indication if it is the case.
Examples: localhost, 192.168.1.2, srvdatabase\CORP, 10.10.10.01,1433
- Database is the name of the database catalog created to be used by the Platform Server.
Example: outsystems
Note: if a catalog with the same name exists in the database, it will be re-used. If it does not exist, it will be created with the Latin1_General_CI_AI collation.
- Select Database Authentication as the Database Authentication
Note: if you prefer using Windows users and passwords, please select Windows Authentication as the database authentication mechanism on the top of this document to update the checklist content.
- Select Windows Authentication as the Database Authentication
Note: if you prefer using SQL Server users and passwords, please review this checklist's selections in the top of this document to update the checklist content.
- Select the Admin user:
- Fill in the User and Password fields in the Admin section.
-> the Admin user must be an existing and valid domain user. The password is needed to configure the identity for the OutSystems Deployment services.
This user will be granted local administrator permission (to deploy new applications and manage the IIS) and Database owner privileges (to create and upgrade the
applications database models). This user will also be granted the "Log on as a Service" privilege.
- Select the Runtime user:
- Fill in the User and Password fields in the Runtime section.
-> the Runtime user must be an existing and valid domain user. The password is needed to configure the identity for the OutSystems application pool and some OutSystems services.
This user will have restricted local permissions (to execute applications) and Database read & update privileges. This user will also be granted the "Log on as a Service" privilege.
- Click on Advanced Settings:
- Increase the Default Query Timeout. As a baseline set it to 60 seconds. Adjust it as necessary according to your database service tier.
- Click the Grant Permissions button. This will:
- Create the database catalog (if it does not exist);
- Create the users you indicated (if they do not exist);
- Grant the needed permissions for the Platform Admin and Platform Runtime roles.
-> To do this, the Configuration Tool may prompt you to provide a database login with permissions to create a new database.
For example, you can use the credentials of the sa
Server admin user.
If you prefer to have your DBA run the setup script you can go to File > Generate Platform Script to get it.
We recommend that your DBA sets the recovery model to Full for the Platform database.
After the DBA runs the script, click the Grant Permissions button to grant the required permissions to the application server and OutSystems services.
- Create the Platform Database schema by clicking the Create/Upgrade Database button.
This step includes the creation of complementary indexes in the database. This can take up to 10 minutes to complete. For more information click here.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Configure Logging Database settings with the Configuration Tool
Configure the Logging Database (Log tab):
- Configure Server and Database fields:
- Server is the name or IP of the database server, and instance or TCP port indication if it is the case.
Examples: localhost, 192.168.1.2, srvdatabase\CORP, 10.10.10.01,1433
You can use the same database server you used in the Platform tab, or you can use another server.
- Database is the name of the database catalog to store the Logging Database model.
This catalog can be the same as the one configured in the Platform tab, or you can use another catalog.
Example: outsystems_logging
Note: if a catalog with the same name exists in the database, it will be re-used. If it does not exist, it will be created with the Latin1_General_CI_AI collation.
- Select the Admin user:
- Fill in the User and Password fields in the Admin section.
- Select the Runtime user:
- Fill in the User and Password fields in the Runtime section.
- Click the Grant Permissions button. This will:
- Create the database catalog (if it does not exist);
- Create the users you indicated (if they do not exist);
- Grant the needed permissions for the Logging Admin and Logging Runtime roles.
-> To do this, the Configuration Tool may prompt you to provide a database login with permissions to create a new database.
For example, you can use the credentials of the sa
Server admin user.
If you prefer to have your DBA run the setup script you can go to File > Generate Logging Script to get it.
We recommend that your DBA sets the recovery model to Simple for the Logging database.
After the DBA runs the script, click the Grant Permissions button to grant the required permissions to the application server and OutSystems services.
- Create the Logging Database schema by clicking the Create/Upgrade Database button.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Configure Session Database settings with the Configuration Tool
Configure the Platform Session Database (Session tab):
- Configure Server and Database fields:
- Server is the name or IP of the database server, and instance or TCP port indication if it is the case.
Examples: localhost, 192.168.1.2, srvdatabase\CORP, 10.10.10.01,1433
You can use the same database server you used in the Platform tab, or you can use another server.
- Database is the name of the database catalog to store the Session Database model.
This catalog cannot be the same as the one configured in the Platform tab.
Example: ASPStateOS
Note: if a catalog with the same name exists in the database, it will be re-used. If it does not exist, it will be created.
- Choose the credentials for the Session user:
- Fill in the User and Password fields in the Session section.
A user will be created, with these credentials, in the next step.
- Click Create Session Database. This will:
- Create the database catalog (if it does not exist);
- Create the login you indicated (if it does not exist) and grant the needed permissions to the user;
- Update the catalog definition.
-> To do this, the Configuration Tool may prompt you to provide a database login with permissions to create a new database.
For example, you can use the credentials of the sa
Server admin user.
If you prefer to have your DBA run the setup script you can go to File > Generate Session Script to get it.
We recommend that your DBA sets the recovery model to Simple for the Session database.
Just make sure you DBA runs it before continuing with the next step.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Configure Session settings with the Configuration Tool
For more information on requirements and Redis configuration options, refer to the Configuring OutSystems with Redis in-memory session storage documentation.
Configure the Platform Session Redis storage (Session tab):
- Select "Redis" from the Session Provider drop-down.
- Configure Hosts and Password fields:
- Hosts is a mandatory field. You can enter several hosts separated by commas. Include the port number on each host where the port if different than the default one (port 6379). For example, 192.168.1.3:6380.
Examples: 192.168.1.2 for a standalone Redis server listening on port 6379, 192.167.1.5:6380 for a standalone Redis server listening on port 6380, 192.168.1.3:7000,192.168.1.4:7000,192.168.1.5:7000 for a Redis cluster with 3 master nodes listening on port 7000.
If you have multiple machines on the Redis cluster, you don't have to enter every IP address. Redis implements a self-discovery protocol to
obtain all the cluster IP addresses.
- Password is a mandatory field in Configuration Tool. If the Redis server is not configured with a password/access key, the password is ignored when connecting to Redis. Make sure that the Redis server is
configured to use strong passwords — for example, that passwords must include special characters and must be longer than 16 characters.
-
Configure Use SSL and SSL Host if SSL is required to connect to Redis. By default, SSL is not used.
SSL Host enforces a particular SSL host identity on the server's certificate.
- Click Advanced Settings to specify additional connection parameters, such as connection timeout, connection retry and default database.
- Press the Test Connection button and ensure there are no connection errors.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
| * |
Define the password for the Platform Server administrator account
If you had previously defined this password, you may skip this step.
- Go to the Credentials tab in the Configuration Tool;
- Fill the Password and Confirm Password fields. Remember that your password:
- Is case sensitive;
- Must be at least 6 characters long;
- Cannot be equal to or contain your username;
- Ensure that both passwords match.
|
| * |
Install and Configure RabbitMQ
In OutSystems 11, RabbitMQ is used to propagate cache invalidation messages across applications. RabbitMQ is installed and configured in the Cache tab in Configuration Tool.
This step should only be performed on the Deployment Controller.
Note: You can also use a pre-existing RabbitMQ installation that you may have in your environment. Minimal version required for RabbitMQ Server is 4.1.2 with Erlang 27.3.4.10. These versions can be upgraded to RabbitMQ 4.1.x and Erlang 27.x if compliant with official documentation.
To set up RabbitMQ, follow these steps:
- Configure the Host, Port, and Virtual Host fields:
-
Host is the name of the server running a RabbitMQ instance. If you are configuring RabbitMQ for the first time, make sure that the host name matches the Deployment Controller address.
-
The port that is bound to the RabbitMQ service.
-
Virtual Host is the virtual RabbitMQ partition that will be used by OutSystems applications.
A virtual host must be unique for each OutSystems environment.
Example: /outsystems, /outsystems_qa_env,
/my_custom_virtual_host
- Fill in the Username and Password of the RabbitMQ user.
-
If you want to use TLS connections between RabbitMQ and OutSystems applications, ensure that the Enable TLS option is checked. When this option is enabled, there are some extra configurations that need
to be manually applied. Check our documentation for more information.
- If you have a custom RabbitMQ installation on another machine or if you are using a pre-existing RabbitMQ that is not managed by Configuration Tool, proceed to the next step.
Otherwise, click the Create/Upgrade Service button. This will:
- Install or update RabbitMQ;
- Install or update Erlang (a requirement of RabbitMQ);
- Configure the RabbitMQ service to use the specified port;
- Create the specified virtual host (if it doesn't exist);
- Create the user you specified (if it doesn't exist);
- Grant the necessary permissions for the virtual host to the specified user;
- Delete the default guest user;
- After RabbitMQ is installed and configured, click Test Connection to check if everything is working correctly.
If necessary, check our documentation for troubleshooting guidelines.
Do not close the Configuration Tool at this point - further tasks are to be performed.
|
|
If the Server being configured has more than one network card, and if the Deployment Controller can only communicate with this Server on one of the network cards, you need to change a setting in the Configuration Tool to specify
which IP will be used by the Deployment Controller to communicate with the Server. To do this:
- Access the Network tab in the Configuration Tool;
- Under Front-End Registration, choose the IP which the Deployment Controller will use to communicate from the Local IP Address drop-down. If you don't see the IP there, you can type it manually.
|
| * |
In the Platform Server Configuration Tool, Controller tab, set the Deployment Controller Server IP address or host name. |
|
Configure OutSystems Scheduler Service ports with the Configuration Tool
Configure the Scheduler Service (Scheduler tab):
- Configure the Max. Concurrent Timers field, which is the maximum number of Timers (asynchronous jobs) that can be executed at the same time in each Server.
- Configure the Scheduler Service ports fields:
- Scheduler Service Primary Port is the primary port the Scheduler Service listens to.
- Scheduler Service Secondary Port is the secondary port the Scheduler Service listens to.
|
|
Configure OutSystems Deployment Service ports with the Configuration Tool
Configure the Deployment Service (Controller tab) ports fields:
- Deployment Service Primary Port is the primary port the Deployment Service listens to.
- Deployment Service Secondary Port is the secondary port the Deployment Service listens to.
|
| * |
Click the Apply and Exit button on the Configuration Tool.
- Answer Yes if a popup shows up asking to start the OutSystems Scheduler Service.
- Answer No if a popup shows up asking to start the OutSystems Scheduler Service.
- A Platform Upgrade popup will be shown asking you to publish the latest version of Service Center and System Components. Accept by clicking Ok.
|
| * |
Stop and disable the OutSystems Deployment Service.
Disable the OutSystems Scheduler Service. |
|
Disable the OutSystemsApplications app pool in IIS:
- Open Internet Information Services (IIS) Manager;
- On the left pane expand your server and click Application Pools;
- On the center pane right click the OutSystemsApplications pool and click Stop.
|
| * |
Ensure this machine is not present in a Load Balancer as it does not have the Server role.
|
| * |
Export the configuration file, for use in the Servers
In the Platform Server Configuration Tool, export the configuration file by using File -> Export configuration...
Save the file in a convenient
location.
Exit the Configuration Tool by clicking File -> Exit. |
| * |
Import the configuration file decryption's key
Copy the Controller's \Program Files\OutSystems\Platform\private.key to the same location. |
| * |
Import the configuration file
In the Platform Server Configuration Tool, import the configuration file by using File -> Import configuration... and choosing the appropriate file, exported from the Deployment
Controller.
Confirm the IP which will be used to register the Server with the Deployment Controller:
- Access the Controller tab in the Configuration Tool;
Confirm that the Deployment Controller Server is set to the IP address of the Deployment Controller. Avoid using "localhost", as the controller should be on another server.
- Access the Network tab in the Configuration Tool;
- Under Front-End Registration, if the Local IP Address option is not set as (automatic), confirm that the IP address belongs to the machine where the Configuration Tool is being run. If needed, fix
this by choosing an IP address from the drop-down, choosing (automatic) or typing it manually.
- If the Server being configured has more than one network card, and if the Deployment Controller can only communicate with this Server on one of the network cards, choose the IP which the Controller will use to communicate
from the Local IP Address drop-down. If you don't see the IP there, you can type it manually.
|
| * |
Apply the Configurations
- Fill in the Password field in the Admin section.
- Click the Apply and Exit button on the Configuration Tool.
- Answer Yes if a popup shows up asking to start the OutSystems Scheduler Service.
- Answer No when a popup asks you to run the Service Center and System Components installations.
|
| * |
Disable the OutSystems Deployment Controller Service |
| * |
Install Service Studio:
- Run the installation file ServiceStudio-M.F.P (Build B).exe and follow the on screen installation instructions.
|
| * |
Install Integration Studio:
- Run the installation file IntegrationStudio-M.F.P (Build B).exe and follow the on screen installation instructions.
|
| * |
Install an SSL certificate:
|