v5 Connections and CLI Installation Guide
This page details the steps for installing the Connections Experience (for Cinchy v5) used in creating data syncs.
Last updated
This page details the steps for installing the Connections Experience (for Cinchy v5) used in creating data syncs.
Last updated
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.
Windows Server 2012+
Cinchy Platform
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\
On a Windows Server machine, launch an instance of PowerShell as the Administrator.
Run the below commands to create the IIS application pool and set its properties:
Steps 3 and 4 are only needed if you deployed your Cinchy instance along a base path.
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”
Within the Cinchy platform, navigate to the [Cinchy].[Applets] table. Update the column “Application URL” to “<url>/connections” on the record where name=“Connections”.
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:
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
If you have not already, navigate to the Cinchy Releases table and download the latest Cinchy Connections.zip file from the Release Artifacts column.
Extract the CLI.zip folder to your machine.
From the CLI folder, either:
Run the Cinchy.Connections.CLI.exe; or
Run the Cinchy.Connections.CLI.dll using the "dotnet Cinchy.Connections.CLI.dll" command.
If you are running the CLI on a Mac or Linux machine: you must use the .dll command and have .NET 6.0 installed.
If you are running the CLI on a Windows machine: you may choose to use the .dll (in conjunction with .NET 6.0) or the .exe based on personal preference.
Review the list of CLI commands here.
