Installing Connections

1. 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).

Image 1: The Connections Applet

In a Kubernetes deployment of the Cinchy Platform, Connections is automatically installed. The below steps refer only to an IIS deployment of the Cinchy Platform.

Before proceeding, ensure that you have read the Prerequisites section.

2. Downloading the Resources

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

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\

3. 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

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

4. Within the Cinchy platform, navigate to the [Cinchy].[Integrated Clients] table (Image 2).

Image 2: Integrated Clients table

4. Navigate to the row where the Client ID column is "cinchy_connections_experience" (Image 3).

Image 3: Navigate to the row where the Client ID column is " cinchy_connections_experience"

4. In that same row, update the columns “Permitted Login Redirect URLs” and “Permitted Logout Redirect URLs” to “<url>/connections” (Image 4).

Image 4: Update Permitted Redirects

5. Within the Cinchy platform, navigate to the [Cinchy].[Applets] table (Image 5).

Image 5: The Applets table

5. Navigate to the row where the Name column is "Connections" (Image 6).

Image 6: Navigate to the row where the Name column is "Connections"

5. Update the column “Application URL” to “<baseurl>/connections” (Image 7).

Image 7: Update the Application URL column

5. Navigate to C:\Connections\appsettings.json and update the below properties to match your environment:

Parameter	Description
"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)

6. Navigate to C:\Connections\ClientApp\dist\assets\config.json update the below properties to match your environment:

Parameter	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://”

7. Create the IIS Application by running the following command in an instance of Powershell:

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