Database server Version 7.18 This documentation is provided under restrictions on use and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this documentation, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. © 2021 Creatio. All rights reserved. Table of Contents | 3 Table of Contents Deploy MS SQL database for Creatio 4 Deploy Oracle Database for Creatio 6 Deploy PostgreSQL database (Linux) 8 I. Install PostgreSQL 8 II. Create PostgreSQL user 9 III. Restore PostgreSQL database 11 IV. Change the database owner (optional) 13 Deploy PostgreSQL database (Windows) 13 I. Install PostgreSQL 14 II. Create PostgreSQL user 14 III. Restore PostgreSQL database 16 © 2021 Creatio. All rights reserved. Deploy MS SQL database for Creatio | 4 Deploy MS SQL database for Creatio PRODUCTS: ALL CREATIO PRODUCTS Install Microsoft SQL Server Management Studio on the database server. Installation instructions are available in the Microsoft SQL Server documentation. Note. MS SQL has been tested for deployment of clustered Creatio databases. Using MS SQL Always On availability groups is a recommended method of setting up a high availability configuration. For more information on MS SQL Always On technology, please refer to the MS SQL documentation. In Microsoft SQL Server Management Studio, create two database users. A user with the “sysadmin” role, who has maximum access privileges on the database server level. This user will restore the Creatio database from a backup file and assign access permissions. A user with the “public” role, whose permissions are limited. You will need this user to set up a secure connection to the restored Creatio database using MS SQL authentication. For more on creating users and access permissions on the database server, see Microsoft SQL Server documentation. To restore a database: 1. Authenticate in Microsoft SQL Server Management Studio as a “sysadmin” user. 2. Click the [ Databases ] catalog and select the [ Restore Database ] option from the context menu (Fig. 1). Fig. 1 Selecting database backup command © 2021 Creatio. All rights reserved. Deploy MS SQL database for Creatio | 5 3. In the [ Restore Database ] window: a. Specify the name of the database in the [ Database ] field; b. Specify the [ Device ] checkbox and specify the path to the database backup copy file. The database backup file is supplied together with executable files and is located in the ~\db folder (Fig. 2). Fig. 2 Selecting database backup 4. Specify a folder on the database server where the Creatio database will be restored. Creating a folder to restore database files is required beforehand, as the SQL Server is not permitted to create directories. a. Go to the [ Files ] tab. b. In the [ Restore the database files as ] area, select the [ Relocate all files and folders ] checkbox. c. Specify paths to the folders where SQL Management Studio will save the TS_Data.mdf and TS_Log.ldf files (Fig. 3). Fig. 3 Specifying the names and paths to TS_Data.mdf and TS_Log.ldf files. © 2021 Creatio. All rights reserved. Deploy Oracle Database for Creatio | 6 5. Click the [ OK ] button and wait for the database restore process to be finished. 6. Enable connection for the public MS SQL user who Creatio will use to access the database. a. Locate the restored Creatio database in MS SQL Server Management Studio. b. Click the [ Security ] tab. c. Add the user to the [ Users ] list. d. Click [ Membership ] and specify the db_owner, which will grant the user full access to the restored Creatio database. Deploy Oracle Database for Creatio PRODUCTS: ALL CREATIO PRODUCTS Install Oracle Database on the database server. Installation instructions are available in the Oracle Database Online Documentation. The “sqlplus” and “impdp” utilities required for restoring the application database from backup are installed with Oracle Database. © 2021 Creatio. All rights reserved. Deploy Oracle Database for Creatio | 7 Note. Creatio have not been tested on Oracle high-availability configurations, however, there are cases of successful deployment of Creatio using Oracle RAC. Please refer to the Oracle Database Online Documentation for more details on Oracle Database clustering. In Oracle Database, create two database users. A user with the “admin” role, who has maximum access privileges on the database server level. This user will restore the Creatio database from a backup file and assign access permissions. A user with the “public” role, whose permissions are limited. You will need this user to set up a secure connection to the restored Creatio database using Oracle authentication. For more on creating users and access permissions on the database server, see Oracle Database Online Documentation. Download and unzip the archive with the SQL scripts that are used to restore the database from the Oracle backup file. By default the Oracle DB backup file is located in the ~\db folder with the Creatio executable files. If the backup file is located not on the Oracle server, it should be located in the network folder with general access. Note. To restore the database: 1. Open the CreateUser.sql and RecompileSchema.sql scripts in the editor and modify the following macros: a. YOUR_SCHEMA_NAME – schema name b. YOUR_SCHEMA_PASSWORD – schema password c. \\your_server.com\Share – path to the backup (*.dmp file). 2. Open the backup file in a text editor, find and save the name of the used schema located before the “.SYS_EXPORT_SCHEMA” record (Fig. 1). Fig. 1 The schema name in the backup file 3. Remove the modified scripts on the Oracle server. To create a new schema, execute the following command from the folder with the scripts: sqlplus.exe "SYS/SYS_PASSWORD@your_server.com:1521/YOUR_SERVICE_NAME AS SYSDBA" @CreateUser.sql 1. SYS_PASSWORD – a password for authorization on the Oracle server © 2021 Creatio. All rights reserved. Deploy PostgreSQL database (Linux) | 8 2. your_server.com – network address of the Oracle server 3. YOUR_SERVICE_NAME – Oracle service name. 4. Run import of the DB backup copy in the created schema: impdp "YOUR_SCHEMA_NAME/YOUR_SCHEMA_NAME@//your_server.com:1521/BPMBUILD" REMAP_SCHEMA=ORIGINAL_SCHEMA_NAME:YOUR_SCHEMA_NAME DIRECTORY=BACKUPDIR DUMPFILE=filename.dmp NOLOGFILE=YES 1. YOUR_SCHEMA_NAME – the name of the schema specified in the CreateUser.sql 2. your_server.com – network address of the Oracle server 3. ORIGINAL_SCHEMA_NAME – the name of the schema from the backup file (step 2). 4. Consistently run: sqlplus.exe "YOUR_SCHEMA_NAME/YOUR_SCHEMA_PASSWORD@your_server.com:1521/YOUR_SERVICE_NAME" @tspkg_UtilitiesGlobalTypes.sql sqlplus.exe "YOUR_SCHEMA_NAME/YOUR_SCHEMA_PASSWORD@your_server.com:1521/YOUR_SERVICE_NAME" @tspkg_UtilitiesGlobalTypes.sql sqlplus.exe "YOUR_SCHEMA_NAME/YOUR_SCHEMA_PASSWORD@your_server.com:1521/ YOUR_SERVICE_NAME" @RecompileSchema.sql Deploy PostgreSQL database (Linux) PRODUCTS: ALL CREATIO PRODUCTS Use one of two database configurations to deploy Creatio: Use a remote DBMS (recommended) Use a local PostgreSQL server. If you already have a PostgreSQL server running on the intended machine, skip to step II. If you have set up sysadmin (with privileges to log in, create and modify databases) and public (unprivileged) user roles, skip to step III. I. Install PostgreSQL PostgreSQL is unavailable in most standard repositories. To install PostgreSQL on Linux: 1. Log in as root: © 2021 Creatio. All rights reserved. Deploy PostgreSQL database (Linux) | 9 sudo su 2. Add the PostgreSQL repository: echo -e "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -sc)-pgdg main" > /etc/apt/sources.list.d/pgdg.list 3. Import the signing key of the PostgreSQL repository: wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - 4. Update the package lists: apt-get update 5. Install PostgreSQL: apt-get install -y postgresql-12 6. Log out from your root session: exit Note. High-availability PostgreSQL configurations have not been tested with Creatio. Please refer to the PostgreSQL documenation for details on PostgreSQL clustering. II. Create PostgreSQL user A fresh installation of PostgreSQL is not ready for deploying Creatio immediately. If you plan to use a fresh installation of PostgreSQL, you need to create a user that can log in to the database using a password and has sufficient privileges to create and update a database. By default, no such user will be available. We recommend to create two database users in PostgreSQL: A user with the “sysadmin” role, who has maximum access privileges on the database server level. This user will restore the Creatio database from a backup file and assign access permissions. A user with the “public” role, whose permissions are limited. You will need this user to set up a secure connection to the restored Creatio database using PostgreSQL authentication. If your PostgreSQL instance already has sysadmin (privileged) and public (unprivileged) user roles, skip this step. To create PostgreSQL users: © 2021 Creatio. All rights reserved. Deploy PostgreSQL database (Linux) | 10 1. Log in as postgres: sudo su - postgres 2. Open PostgreSQL