Install the data experience


This section covers everything you need to install a release package from a data experience for CinchyDXD 2.0.


Before you start an installation, you must make sure that your source and target environment version of Cinchy are the same. For example, Source Version 5.5, Target Version 5.5.

Installation overview

The installation for a release package typically proceeds in the following steps:

  1. Build Data Experience from repository artifacts.

  2. Prepare connections for Cinchy Tables.

  3. Prepare CSVs.

  4. Prepare Models.

  5. Prepare reference data.

  6. Prepare pre/post-install scripts.

  7. Initialize the target Cinchy instance.

  8. Execute pre-install scripts.

  9. Load Cinchy Table Connections.

  10. Load the Data Experience and Reference Data CLIs.

  11. Install the Data Experience Model.

  12. Continue installation of Data Experience metadata.

  13. Install the Reference Data.

  14. Execute post-install scripts

  15. Record the Release.

  16. Clean up install.


CinchyDXD uses version arguments for installations. These

Install the release package

  1. Open PowerShell and navigate to the location of the release package created from your CinchyDXD export.

  2. Run .\CinchyDXD.ps1 install with the required and optional parameters.

  3. The installation will run through the steps listed above.

Install arguments

Use the following arguments to create your installation with CinchyDXD.

-s "<target Cinchy url>" 
-u "<target user name>" 
-p "<target user password>" 
-d "C:\CLI Output Logs"
-v "Data Experience Definition Version"

For a list of the available parameters, see the Install section of the CinchyDXD commands reference page for more information.


The following example shows the use of arguments for a data package export in Cinchy.

.\CinchyDXD.ps1 install -s "" -u "JohnDoe" -p "123456" -d "C:\Logs\CLI-Output-Logs" -v "1.0.0"

Validate install

To validate the install:

  1. Make sure all entities that were present were installed on the target environment. For example, make sure your tables, data sync configurations, and saved queries are present.

  2. Make sure that the Data Experience Definitions table has the DX parameters from the source environment.

Last updated