v5.0 - v5.5 Data Sync Documentation
  • Overview
  • Release Notes
    • V4.5
    • V4.6
    • v4.7
    • v4.8
    • v4.9
    • v4.10
    • v4.12
    • v4.13
  • v4 Connections Installation Guide
    • v5 Connections and CLI Installation Guide
  • v4 Worker/Listener Installation Guide
    • v5 Worker/Listener Installation Guide
  • Upgrades & Config Changes
  • Builder Guide
    • Overview
    • Types of Data Syncs
    • Subscribing to Event Streams
      • Supported Stream Sources
        • Amazon Simple Queue Service (SQS)
        • Cinchy Change Data Capture
        • Data Polling
        • Kafka Topic
        • MongoDB
        • Salesforce
          • Push Topic
          • Platform Event
    • Configuring a Data Sync
      • Connections Experience & XML Config Reference
        • Info
          • Parameters
            • String Escape
        • Source Config Reference
          • Schema Columns
            • Calculated Column Examples
          • Auth Requests
          • Request Headers
          • Pagination
          • Source Filter
        • Target Destination Config Reference
          • Column Mappings
          • Target Destination Filter
        • Sync Behaviour
        • Post Sync
        • Permissions
        • Jobs
        • Connections Usage Example
      • Data Validation
      • Transformations
        • StringReplacement
      • Supported Data Sources
        • File Based Source
          • Binary File
            • Binary File Data Source Example
          • Delimited File
            • Delimited File Data Source XML Example
          • Fixed Width File
          • Excel
            • Excel Source XML Example
        • Cinchy Event Broker/CDC
          • Cinchy Event Broker/CDC XML Config Example
        • Cinchy Table
          • Cinchy Table XML Config Example
        • Cinchy Query
          • Cinchy Query Data Source Example
        • Copper
        • DB2
        • Dynamics 2015
        • Dynamics
        • DynamoDB
        • Kafka Topic
          • Apache AVRO Data Format
          • Kafka Topic Source Example
        • LDAP
        • MongoDB Collection
          • MongoDB Collection Source XML Example
        • MongoDB Collection (Cinchy Event Triggered)
        • MS SQL Server Query
        • MS SQL Server Table
        • ODBC Table
        • ODBC Query
        • Oracle Table
        • Oracle Query
        • Parquet
        • Polling Event
          • Polling Event Example
        • REST API (Cinchy Event Triggered)
        • REST API
          • REST API XML Example
        • SAP SuccessFactors
        • Salesforce Object (Bulk API)
        • Salesforce Platform Event
        • Salesforce Push Topic
        • Snowflake
          • Snowflake Source XML Example
        • SOAP 1.2 Web Service
      • Supported Sync Targets
        • Cinchy Table
        • DB2 Table
        • Dynamics
        • Kafka Topic
        • MongoDB Collection (Column Based)
        • MS SQL Server Table
        • Oracle Table
        • REST API
        • Salesforce
        • Salesforce Object
        • Snowflake Table
          • Snowflake Table Target XML Example
        • SOAP 1.2 Web Service
    • Common Design Patterns
    • Testing a Data Sync
    • Promoting a Data Sync
    • Scheduling a Data Sync
    • CLI Command List
    • Connections Functions
    • Monitoring
  • Cinchy Platform Documentation
Powered by GitBook
On this page
  • Requirements
  • Setup

Was this helpful?

v4 Connections Installation Guide

Previousv4.13Nextv5 Connections and CLI Installation Guide

Last updated 2 years ago

Was this helpful?

Requirements

  • .NET Core 3.1 Hosting Bundle (see below for download link)

Setup

1. Extract the applet’s files to the folder where you want to host the applet

  • We suggest to create the following path and extract it there: C:\Connections\

2. Create an IIS Application Pool

  • On the Windows Server machine, launch an instance of PowerShell as Administrator.

  • Run the below commands to create the application pool and set its properties.

Import-Module WebAdministration

$applicationPoolNameConnections="Cinchy Connections"

New-WebAppPool -Name $applicationPoolNameConnections

$appPath = "IIS:\AppPools\"+ $applicationPoolNameConnections

$appPool = Get-IISAppPool $applicationPoolNameConnections

$appPool.managedRuntimeVersion = ""

Set-ItemProperty -Path $appPath -Name managedRuntimeVersion $appPool.managedRuntimeVersion

Set-ItemProperty "IIS:\AppPools\$applicationPoolNameConnections" -Name Recycling.periodicRestart.time -Value 0.00:00:00

Set-ItemProperty "IIS:\AppPools\$applicationPoolNameConnections" -Name ProcessModel.idleTimeout -Value 1.05:00:00

3. Import the provided CSVs into their corresponding tables

  • C:\Connections\ClientApp\dist\assets\Domains.csv into the table [Cinchy].[Domains]

  • C:\Connections\ClientApp\dist\assets\Saved Queries.csv into the table [Cinchy].[Saved Queries]

  • C:\Connections\ClientApp\dist\assets\Integrated Clients.csv into the table [Cinchy].[Integrated Clients]

  • C:\Connections\ClientApp\dist\assets\Applets.csv into the table [Cinchy].[Applets]

4. In the [Cinchy].[Integrated Clients] table, update the columns “Permitted Login Redirect URLs” and “Permitted Logout Redirect URLs” to “<url>/connections” where Client ID = “cinchy-connections”

5. In the [Cinchy].[Applets] table, update the column “Application Url” to “<url>/connections” on the record where name=“Connections”.

6. Configure the Connections applet

a. Update C:\Connections\appsettings.json properties to match your environment.

  • “Client Secret” should match the Guid of the cinchy-connections record in the Integrated Clients table.

  • “Url” should be the URL of your Cinchy environment

  • “TempDirectory” should be a path pointing to a folder that exists, this will hold all log and error files

b. Update C:\Connections\ClientApp\dist\index.html

  • Do a find and replace on “/connections/” and change it to be the path of which you deployed the application to on IIS. This usually requires no change unless you choose to deploy to a different URL path.

c. Update C:\Connections\ClientApp\dist\assets\config.json

  • “authority” should be your CinchySSO URL in lowercase (<base-url>/cinchysso)

  • “cinchyRootUrl” should be your Cinchy URL (<base-url>/Cinchy)

  • “redirectUri” should be this applet’s url (<base-url>/connections)

  • “model” should be the model where your data sync configs are. Keep this as “Cinchy” if you don’t know.

  • “domain” should be the model where your data sync configs are. Keep this as “Cinchy” if you don’t know.

  • “useHttps” should be true if your Cinchy platform is hosted on a secure environment

  • “server” should be your Cinchy URL without “http://” or “https://”

7. Create the IIS Application

New-WebApplication -Name connections -Site 'Default Web Site' -PhysicalPath C:\Connections -ApplicationPool 'Cinchy Connections'

Download .NET Core 3.1 (Linux, macOS, and Windows)Microsoft
Logo