Cinchy Platform Documentation
Cinchy v5.6

Installing the Data Experience (CinchyDXD)

This page outlines Step 3 of Deploying CinchyDXD: Installing the Data Experience

Table of Contents

1. Introduction

The install of a Data Experience is executed in a different environment than that of the export. Please ensure that before moving forward with the following instructions you have an environment to install the data experience into.The install of a data experience MUST be done in the same version. Your source and target environment version MUST be the same (e.g. Source Version = 4.11 | Target Version = 4.11)
Below are the details that will be required for the installation environment:
  • Source: <cinchy target url>
  • UserID: <target user id>
  • Password: <target password>

2. Install the Data Experience

Using Powershell you will now install the Data Experience you have exported out of Cinchy.
1. Open the File Explorer and navigate to your DX exported folder (Image 1).
Image 1: Step 1
2. In the folder path URL for the exported data experience type in powershell to launch Powershell for that path (Image 2).
Image 2: Step 2
3. Hit Enter on your keyboard, the powershell window will appear (Image 3).
Image 3: Step 3
4. In the Powershell window, type in cin and hit tab on your keyboard (Image 4).
Image 4: Step 4
5. In the Powershell command line, type install (Image 5).
Image 5: Step 5
6. Hit Enter on your keyboard (Image 6).
Image 6: Step 6
The Powershell window will provide you with the required and optional components to install the DX.
7. You must now set up your mandatory install parameters
The parameters executed in Powershell can exist on one line in powershell, however for legibility (below) the parameters have been put on separate lines. If you are putting your parameters on separate lines you will be required to have backticks quote ` for the parameters to execute
Sample: .\CinchyDXD.ps1 install` -s "<target Cinchy url>" ` -u "<target user id>" ` -p "<target password>" ` -c "C:\Cinchy CLI v4.0.2" ` -d "C:\CLI Output Logs" `
Be sure that the user(s) and group(s) required to install a DX are existing in your target environment. If they are not, Powershell will generate an error message when you attempt to install the DX.
8. Enter the install parameters into the Powershell window (Image 7).
Image 7: Step 8
9. Hit Enter on your keyboard to run the install command. Once the Data Experience has been installed you will get a message in Powershell that the install was completed (Image 8).
Image 8: Step 9

3. Validate the Install

  1. 1.
    Ensure that the Models Table is populated in the target environment with the model that was installed (Image 9).
Image 9: Step 1
2. Ensure that the Currency Exchange Rate table exist in the target environment (Image 10).
Image 10: step 2
3. Ensure that the Currency Converter query exist in the target environment (Image 11).
Image 11: Step 3
4. Ensure that the Data Experience Definitions table is populated with the DX parameters that were set up in the source environment (Image 12).
Image 12: Step 4
5. Ensure that the Data Experience Releases table in the target environment is populated (Image 13).
Image 13: Step 5