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
  • Overview
  • Prerequisites
  • 1. Downloading the Resources
  • 2. Deploying Connections
  • 3. Running the CLI

Was this helpful?

  1. v4 Connections Installation Guide

v5 Connections and CLI Installation Guide

This page details the steps for installing the Connections Experience (for Cinchy v5) used in creating data syncs.

Previousv4 Connections Installation GuideNextv4 Worker/Listener Installation Guide

Last updated 2 years ago

Was this helpful?

Table of Contents

Overview

The Connections Experience is designed to facilitate the creation of data syncs through an easy to use Cinchy UI. Once installed, you can access Connections directly through your Cinchy platform using the applet (Image 1).

In a Kubernetes deployment of the Cinchy Platform, Connections is automatically installed with the exception of the CLI. If you are on Kubernetes and want to deploy the CLI, you can skip to section 3 of this page.

Prerequisites

  • Windows Server 2012+

  • Cinchy Platform

1. Downloading the Resources

The Connections.zip file contains: Worker.zip, WebApi.zip, and CLI.zip.

2. Extract the WebApi.zip to the folder where you want to host the applet.

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

2. Deploying Connections

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

  2. Run the below commands to create the IIS 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

Set-ItemProperty "IIS:\AppPools\$applicationPoolNameConnections" -Name Recycling.periodicRestart.privateMemory -Value 0

Steps 3 and 4 are only needed if you deployed your Cinchy instance along a base path.

  1. Within the Cinchy platform, navigate to 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_experience”

  2. Within the Cinchy platform, navigate to the [Cinchy].[Applets] table. Update the column “Application URL” to “<url>/connections” on the record where name=“Connections”.

  3. Configure the Connections applets as follows:

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

Value

Update

"URL"

This is the private URL of your Cinchy environment.

“TempDirectory”

This should be a path pointing to an existing folder that will hold all of your log and error files.

"StorageType"

Select either Local, S3, or AzureBlobStorage.

"BasePathOverride"

(Optional) Connections should be hosted on "/connections". In the case that this is hosted on another url path, this property must be populated with the relative path (eg. "/dev-aurora-2/connections" or "/" if deployed to the root)

  • Update the C:\Connections\ClientApp\dist\assets\config.json as follows:

Value

Description

“authority”

Your public CinchySSO URL in lowercase (ex: <base-url>/cinchysso)

“cinchyRootUrl”

Your public Cinchy URL (ex: <base-url>/Cinchy)

“redirectUrl”

The applet’s public URL (ex: <base-url>/connections)

silentRefreshRedirectUri

The applet’s public URL plus the silent refresh path.

“model”

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

“domain”

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”

Your private Cinchy URL without “http://” or “https://”

6. Create the IIS Application by running the following command in Powershell:

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

3. Running the CLI

The Cinchy CLI is a command line program you run against to encrypt, export data, or run data syncs. By design it is agnostic to IIS and Kubernetes

  1. Extract the CLI.zip folder to your machine.

  2. From the CLI folder, either:

    1. Run the Cinchy.Connections.CLI.exe; or

    2. Run the Cinchy.Connections.CLI.dll using the "dotnet Cinchy.Connections.CLI.dll" command.

​​

​​

​​

Navigate to the table and download the latest Cinchy Connections.zip file from the Release Artifacts column.

If you have not already, navigate to the table and download the latest Cinchy Connections.zip file from the Release Artifacts column.

If you are running the CLI on a Mac or Linux machine: you must use the .dll command and have

If you are running the CLI on a Windows machine: you may choose to use the .dll (in conjunction with ) or the .exe based on personal preference.

Review the list of

Install .net core Hosting bundle Version 6.0
Cinchy Releases
Cinchy Releases
.NET 6.0 installed.
.NET 6.0
CLI commands here.
Overview
1. Downloading the Resources
2. Deploying Connections
Image 1: The Connections Applet