On-site deployment 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 S3 file storage integration 7 Step 1. Set up the S3 storage 7 Step 2. Set up the file storage 8 Global search 9 Set up the global search service (version 2.0) 10 Client-side system requirements 23 Creatio .NET Core products 24 Feature support in Creatio .NET Core products 24 The lifecycle of products using .NET Framework and .NET Core platforms 25 Developing features with simultaneous .NET Framework and .NET Core support 26 Migrating Creatio from .NET Framework to .NET Core 26 Deploying Creatio .NET Core application 26 Deploy MS SQL database for Creatio 26 Set up Creatio caching server (Redis) on Linux 29 Enable required Windows components 30 Enable required Windows Components on Windows Server 2016 32 Enable required Windows Components on Windows 10 42 Prepare to deploy Creatio .NET Core on Linux 43 Prepare the setup files 43 Set up ConnectionStrings.config 44 General Creatio deployment procedure 46 Deploy the Creatio .NET Framework application on Windows 46 Deploy the Creatio .NET Core application on Linux 46 Global search and deduplication FAQ 47 How do I check which version of the global search service I have? 47 How do I initiate the re-indexing of my Creatio site? 47 How do I enable the global search service logging? 48 Which metrics and tracking schema can I use to monitor the global search operation? 48 How do I set up access to ElasticSearch via a password? 48 How do I add a new object to the ElasticSearch indexing, or change the settings for the indexed fields of existing objects? 48 How do I deploy ElasticSearch on several servers with a single URL? How do I set up clustering? 49 Why is the “Duplicates search rules” setting not displayed for me? 49 Can I use the global search and bulk duplicate search services in two Creatio applications simultaneously? 49 How does Creatio sort the search results? 49 Do microservices support Windows authentication? 50 Server-side system requirements 50 © 2021 Creatio. All rights reserved. Table of Contents | 4 General guidelines 52 Connection channels 52 Requirements to servers for the Exchange Listener synchronization service 53 Software requirements 53 Deploy Oracle Database for Creatio 54 Modify ConnectionStrings.config for MS SQL Server 56 Set up ConnectionStrings.config 56 Required ConnectionStrings.config settings 57 Optional ConnectionStrings.config settings 58 Google integration 59 Redis Sentinel 59 Notable Sentinel specifics 60 Minimal fault tolerance requirements for Redis Sentinel 60 Network separation issues 61 System requirements 62 Installing and configuring Sentinel 63 Configuring Creatio to work with Redis Sentinel 63 Creatio setup FAQ 65 Which Internet Information Services (IIS) components are required for Creatio? 65 How do I switch from HTTP to HTTPS? 66 Which account is used when you first log in to the system? 66 Does the number of active Creatio users affect the number of Microsoft SQL Server? 66 Bulk duplicate search 66 Components of the bulk duplicate search service 67 Set up the environment variables 67 Launch the containers 68 Verify successful running of containers 68 Verify logging 68 Enable the bulk duplicate search functionality in Creatio 68 Modify the “Deduplication service api address” system setting value 69 Add the “Duplicates search” system operation 69 Enable the bulk duplicate search functionality in Creatio 69 For Microsoft SQL DBMS 69 For Oracle DBMS 70 For PostgreSQL DBMS 72 Restart the Creatio application 73 Recommended service maintenance operations 73 Deploy PostgreSQL database (Linux) 73 I. Install PostgreSQL 74 © 2021 Creatio. All rights reserved. Table of Contents | 5 II. Create PostgreSQL user 74 III. Restore PostgreSQL database 76 IV. Change the database owner (optional) 78 Modify ConnectionStrings.config for Oracle Database 79 Set up ConnectionStrings.config 79 Required ConnectionStrings.config settings 79 Optional ConnectionStrings.config settings 80 Deploy the Creatio .NET Core application server on Linux 80 Method 1. Deploy the Creatio .NET Core application server on Linux directly 81 Method 2. Deploy the Creatio .NET Core application server on Linux using Docker 83 Set up landing page integration 85 Redis Cluster 86 Redis Cluster's fault tolerance 86 Redis Cluster system requirements 87 Install and configure Redis Cluster 87 Configure Creatio to work with Redis Cluster 89 Deploy PostgreSQL database (Windows) 90 I. Install PostgreSQL 90 II. Create PostgreSQL user 90 III. Restore PostgreSQL database 92 Modify ConnectionStrings.config for PostgreSQL 95 Set up ConnectionStrings.config 95 Required ConnectionStrings.config settings 96 Optional ConnectionStrings.config settings 96 Machine learning service 97 Getting started 97 Set up machine learning service 98 Update the machine learning service components 101 Case resolution notifications 101 Modify Web.config 101 Additional Web.config setup (Oracle only) 102 Exchange Listener synchronization service 103 Exchange Listener deployment methods 103 Set up the Exchange Listener service on Creatio's end 107 Exchange Listener Service Diagnostics 109 Data enrichment service 111 Set up Creatio application server on IIS 111 Set up application website in IIS 112 Add an application pool 114 © 2021 Creatio. All rights reserved. Table of Contents | 6 Bulk emails 120 Integration with Creatio cloud email service (for on-site users) 120 Sender domain list 122 Additional settings for integration with bulk email service 122 Bulk email monitoring on-site 123 Set up WebSockets 123 Check websocket settings for Windows Server 2012 or Windows server 2016 124 Configure websockets for Windows Server 2008 125 Check port availability 126 Websocket setup FAQ 126 Application server web-farm 127 General deployment procedure 128 Install HAProxy balancer 129 Set up HAProxy balancer 130 Switch a Creatio website from HTTP to HTTPS 134 IIS setup 134 Web.config setup 139 Secure access to the portal 140 Version control system for development environments 141 Deploy SVN and create a Creatio repository 141 Connect the repository to Creatio 143 Chat access 145 Set up OAuth 2.0 authorization for integrated applications 145 Install and set up the Identity Service 146 Set up the Identity Service integration on Creatio's end 148 Set up the OAuth 2.0 authorization 149 © 2021 Creatio. All rights reserved. S3 file storage integration | 7 S3 file storage integration PRODUCTS: ALL CREATIO PRODUCTS You can integrate the S3 file storage with Creatio version 7.18.1 and later. The file storage integration setup is required for Creatio on-site. S3 (Simple Storage Service) is a data transfer protocol developed by Amazon. S3 file storage is a REST cloud service for object storage. The S3 storage stores data in its original format without scaling restrictions. By default, Creatio stores all uploaded files in the database. You can store the files uploaded to the [ Attachments ] detail in the S3 storage. To do this, set up the integration. Using the S3 storage will reduce the database size and the time it takes to back up the database. Creatio only supports a single S3 storage instance. Note. If S3 integration is configured, Creatio will use the S3 storage for the files uploaded to the [ Attachments ] detail in the mobile application or a business process as well. To set up an S3 storage integration: 1. Set up the S3 storage. Read more >>> 2. Set up the file storage. Read more >>> Step 1. Set up the S3 storage 1. Sign up for a data storage service that supports the S3 protocol. 2. Retrieve the “ServiceUrl” for your account. Creatio will use this endpoint to access the S3 storage. 3. Generate the “AccessKey” and “SecretKey” for your account. These parameters will allow you to execute authorized requests to the S3 storage. 4. Create “ObjectBucketName” and “RecycleBucketName” buckets with unique names. “ObjectBucketName” – the file storage bucket. The files are stored indefinitely. “RecycleBucketName” – the bucket that stores deleted files required for database backups. Buckets follow the soft deletion principle: the storage service transfers the file to the “RecycleBucketName” bucket after deleting it from the “ObjectBucketName” bucket. The bucket's file storage period depends on the service's bucket settings. For example, the bucket can store the file for 90 days before deleting it. In Creatio, the file storage period equals the database backup storage period. Learn more about how to create a bucket in the official Amazon documentation. © 2021 Creatio. All rights reserved. S3 file storage integration | 8 Step 2. Set up the file storage Configure Creatio to save the new files uploaded using the [ Attachments ] detail to the S3 storage instead of the database: 1. Add the connection string with the S3 storage connection parameters to the <connectionStrings> element of the ConnectionStrings.config