Cinchy v5.7

Repackage the data experience

This page outlines Step 5 of Deploying CinchyDXD: Repackaging the Data Experience

Introduction

After you have made any applicable changes to your DX, you must re-export the package out of your source environment.

1. Update the data experience table

If you have added or removed any of the following while updating your DX, you will need to update the Data Experience Definition table:

  • Name

  • Tables

  • Views

  • Integrated Clients

  • Data Sync Configurations

  • Listener Configurations

  • Secrets

  • Reference Data

  • User Defined Functions

  • Models

  • Groups

  • System Colours

  • Saved Queries

  • Pre-Install Scripts

  • Post-Install Scripts

  • Applets

  • Literal Groups

  • Webhooks

  • Builders

  • Builder Groups

  • Sync GUID

2. Update reference data table

If you have added or removed any of the following while updating your DX, you will need to update the Data Experience Reference Data table:

  • Name

  • Ordinal

  • Filter

  • New Records

  • Changed Records

  • Dropped Records

  • Table

  • Sync Key

  • Expiration Timestamp Field

  • Sync GUID

3. Re-run CinchyDXD export

Using PowerShell you will now export the Data Experience you have defined within Cinchy.

  1. Launch PowerShell and navigate to your CinchyDXD folder

You can launch PowerShell right from your file explorer window in the CinchyDXD file, saving you an extra step of navigating to the CinchyDXD folder manually in PowerShell.

2. In the PowerShell window type in cin and hit tab on your keyboard 3. In the PowerShell command line next to .\CinchyDXD.ps1 type in export 4. Hit Enter on your keyboard

If you don't remember the mandatory parameters, you can click the enter on your keyboard after typing in .\CinchyDXD.ps1 export, PowerShell will provide you with the required and optional components to export the data experience.

5. You must now enter your mandatory export parameters.

The parameters executed in PowerShell can exist on one line in PowerShell, but for legibility (below) the parameters are 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

You will need to update your version number

Sample: .\CinchyDXD.ps1 export ` -s "<source Cinchy url>" ` -u "<source user id>" ` -p "<source password>" ` -c "C:\Cinchy CLI v4.0.2" ` -d "C:\CLI Output Logs" ` -g "8C4D08A1-C0ED-4FFC-A695-BBED068507E9" ` -v "2.0.0" ` -o "C:\CinchyDXD_Output" `\

  1. Enter the export parameters into the PowerShell window (Image 1).

  1. Hit Enter on your keyboard to run the export command

PowerShell will begin to process the export. Once the export is complete, PowerShell will provide you with an export complete message (Image 2).

4. Validate the Export

  1. Ensure that the DXD Export Folder is populated (Image 3).

  1. Ensure that the Data Experience Release table is populated in the source environment (Image 4).

  1. Ensure that the Data Experience Release Artifacts table is populated in the source environment (Image 5).

PreviousUpdate the data experienceNextReinstall the data experience

Last updated