v5 Connections and CLI Installation Guide
This page details the steps for installing the Connections Experience (for Cinchy v5) used in creating data syncs.
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 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.
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\
- 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:
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.
- 3.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”
- 4.Within the Cinchy platform, navigate to the [Cinchy].[Applets] table. Update the column “Application URL” to “<url>/connections” on the record where name=“Connections”.
- 5.Configure the Connections applets as follows:
- Update the C:\Connections\appsettings.json properties to match your environment:
- Update the C:\Connections\ClientApp\dist\assets\config.json as follows:
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'
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
- 2.Extract the CLI.zip folder to your machine.
- 3.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.