Package the data experience
This page outlines Step 2 of Deploying CinchyDXD: Packaging the Data Experience
Last updated
This page outlines Step 2 of Deploying CinchyDXD: Packaging the Data Experience
Last updated
The CinchyDXD utility takes all the components (tables, queries, views, formatting rules) of a DX and package them up so they can be moved from one environment to another.
Remember that all objects need to be created in one source environment (ex: DEV). From there, DXD will be used to push them into others (ex: SIT, UAT, Production).
The CinchyDXD utility is only required (made accessible) for the environment that's packing up the data experience. It's not required for the destination (or target) environment.
For CinchyDXD to work, you must have CinchyCLI installed. For further installation instructions please refer to CLI (https://cli.docs.cinchy.com/) documentation
To access the Data Experience Deployment utility please contact Cinchy support (support@cinchy.com).
To download the Utility:
Login to Cinchy
Navigate to the Releases Table
Select the Experience Deployment Utility View
Locate and download the utility (Cinchy DXD v1.7.0.zip)
The CinchyDXD utility is only upwards compatible with Cinchy version 4.6+
Unzip the utility and place the folder at any location on a computer that also has CinchyCLI installed
Create a new folder in the same directory that will hold all of the DX exports generated (CinchyDXD*Output) *(Image 1)._
This folder will then hold all your deployment packages.
Launch a PowerShell console window
From the console, navigate to the CinchyDXD directory (Image 2 and 3).
From within your file explorer window, type “PowerShell” into the file path. It will launch a PowerShell window already at the folder path
PowerShell requires an initial setup when using CinchyDXD.
From your PowerShell window type cin
Hit Tab on your keyboard (Image 4).
Hit Enter on your keyboard (Image 5).
You will get an error message (above) that CinchyDXD.ps1 can't be loaded because the running script is disabled.
To resolve this error:
From your start menu, search for PowerShell and select Run as Administrator (Image 6).
When prompted if you want to allow this app to make changes on your device, select Yes.
In your PowerShell Administrator window enter Set-ExecutionPolicy RemoteSigned (Image 7).
Hit Enter on your keyboard (Image 8).
When prompted with the Execution Policy Changes, enter A for “Yes to All”
Close the PowerShell Administrator window
Navigate back to your PowerShell window for the CinchDXD window
From your PowerShell window type cin
Hit Tab and then Enter on your keyboard (Image 9).
The basic CinchyDXD instructions will be displayed. You will be able to execute commands such as exporting and installing a Data Experience.
Cinchy uses four tables for packing up and deploying a Data Experience (Image 10).
The Data Experience is defined and packed in what will be referred to moving forward as the Source Environment. Where the environment that the Data Experience will be deployed to will be referenced to as the Target Environment.
Data Experience Definition Table: Where the data experience is defined (tables, queries, views, formatting rules, UDF’s etc.)
Data Experience Reference Data Table: Where we define any data that needs to move with the Data Experience for the experience to work (lookup values, static values that may need to exist in tables - it typically would not be the physical data itself)
Data Experience Releases Table: Once a Data Experience is exported, an entry is created in this table for the export containing:
Version Number
Release Binary is the location where you can archive/backup your release history in Cinchy Please Note: if you have your own release management system, you do have the option to opt out of archiving the releases in Cinchy and check the release into your own source control
Release Name
Data Experience
Data Experience Release Artifact Table: Stores all of the files that are part of the Data Experience package as individual records along with all of the binary for each record
When setting up a Data Experience definition, you will need one definition for each Data Experience you wish to package and deploy to a given number of Target Environments.
Locate and open the Data Experience Definitions table (Image 11).
2. Complete the following (Image 12):
If you make changes to the DX in the future, you aren't required to build a new Data Experience Definition in this table, you will update the existing definition. If you need to review what the definition looked like historically, you can view it via the Collaboration log.
When setting up a Data Experience Reference Data definition, you will need one (1) definition for each Reference Data table you wish to package and deploy with your Data Experience to the Target Environment.
This table set up is similar to setting up a CLI.
Locate and open the Data Experience Reference Data table (Image 13).
Based on the configuration set up in this table, Cinchy will export the data and create CSV and CLI files.
This example doesn't have Reference Data as part of the Data Experience.
Using PowerShell you will now export the Data Experience you have defined within Cinchy.
Launch PowerShell and navigate to your CinchyDXD folder (Image 14).
Reminder: you can launch PowerShell right from your file explorer window in the CinchyDXD folder by entering in the folder path “PowerShell” and hitting enter on your keyboard. Saving you an extra step of navigating to the CinchyDXD folder manually in PowerShell (Image 15).
In the PowerShell window type in cin and hit Tab on your keyboard (Image 16).
Hit Enter on your keyboard, you will see a list of commands that are available to execute (Image 17).
In the PowerShell command line hit your “up” arrow key to bring back the last command and type export next to it (Image 18).
Hit Enter on your keyboard (Image 19).
The PowerShell window will provide you with the required and optional components to export the data experience.
You must now set up any mandatory export 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.
Please ensure that you are using the sample below as a sample. You will be required to provide values that correspond to:
the URL of the source environment
the User ID for the user who is performing the export
the Password for the user who is performing the export
your folder path for where CLI is stored
your folder path for where the CLI output files are written to
the GUID for the Data Experience that's generated in the Data Experience Definition table
your own version naming convention
your folder path for where your CinchyDXD output files are written to
Sample: .\CinchyDXD.ps1 export `
-s "<cinchy source url>" `
-u "<source user id>" `
-p "<source passsword>" `
-c "C:\Cinchy CLI v4.0.2" `
-d "C:\CLI Output Logs" `
-g "8C4D08A1-C0ED-4FFC-A695-BBED068507E9" `
-v "1.0.0" `
-o "C:\CinchyDXD_Output" `\
Enter the export parameters into the PowerShell window (Image 20).
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 21).
Ensure that the DXD Export Folder is populated (Image 22).
2. Ensure that the Data Experience Release table is populated in the source environment (Image 23).
3. Ensure that the Data Experience Release Artifacts table is populated in the source environment (Image 24).
| Column | Definition |
|---|---|
| Column | Value |
|---|---|
| Column | Definition |
|---|---|
GUID
This value is calculated, please note this value will be required as one of your export parameters in PowerShell
Name
This is the Name of your Data Experience
Tables
Select all tables that are part of the Data Experience
Views
Select all views (in the data browser) that are a part of the Data Experience
Integrated Clients
Select any integrated clients (For example: Tableau, PowerBI, custom integrations) that are part of the Data Experience
Data Sync Configurations
Select any data syncs (CLI’s experience needs to work) that are part of the Data Experience
Listener Configurations
Select any Listener Config rows that refer to a Data Sync Configuration which is a part of the Data Experience
Reference Data
Select any reference data that's part of the Data Experience. Please note that the setup of the reference data is done in the table called Data Experience Reference Data (see step 2 below for setup details)
Secrets
Select any Secrets you'd like to include that are used Data Sync Configurations or Listener Configs which are a part of this Data Experience.
Webhooks
Select any Webhooks that are a part of this data experience
User Defined Functions
Select any user defined functions (For example: validate phone, validate email) that are part of the Data Experience
Models
Select any custom models that override columns or tables in your Data Experience, if there are none - leave blank
Groups
Select any groups that are part of the Data Experience (when moving groups, it will also move all table access [design] controls)
System Colours
Select a system colour (if defined) for the Data Experience
Saved Queries
Select any queries that are part of the Data Experience
Applets
Select any applets that are part of the Data Experience
Pre-install Scripts
Select any Pre-install Scripts (Saved Queries) that should run before the installation of this Data Experience.
Post-install Scripts
Select any Post-install Scripts (Saved Queries) that should run after to the installation of this Data Experience. A common use-case is to rectify data that may be different between environments.
Formatting Rules
Select any formatting rules that are part of the Data Experience
Literal Groups
Select any literals associated to the Data Experience (For example: key values with English and French definitions)
Builders
Select the builder(s) who have permission to export the Data Experience
Builder Groups
Select the builder group(s) that have permission to export the Data Experience
Note: Best Practice is to use a Group over a User. Users within groups can fluctuate, where the Group (or Role) will remain. This will require less maintenance moving forward
Sync GUID
Leave this column blank
Name
Currency Converter
Tables
Currency Exchange Rate (Sandbox)
Saved Queries
Currency Converter
Builder Groups
Currency Converters
Name
This is the Name of your Reference Data Table, note this name can be anything and doesn't have to replicate the actual table name
Ordinal
The ordinal number assigned will identify the order in which the data is loaded and required based on dependencies within the data experience. For example if you have tables that have hierarchies in them, you will need to load the parent records first and then load your child records which would then resolve any links in the table.
Filter
This is where a WHERE clause would be required. For example, if you have a table that has hierarchies, you would require two rows within the Data Experience Reference Data table. One to load the parent data and one to load the children data. In the parent record a filter WHERE clause would be needed to filter all parent records. In the second record in the filter column a WHERE clause in another in the second record that would be needed to filter the children records.
New Records
Identify the behaviour of a new record (INSERT, UPDATE, DELETE, IGNORE)
Change Records
Identify the behaviour of a changed record (INSERT, UPDATE, DELETE, IGNORE)
Dropped Records
Identify the behaviour of a dropped record (INSERT, UPDATE, DELETE, IGNORE)
Table
Identify the table that you are exporting data from
Sync Key
Required (need definition)
Expiration Timestamp Field
If Dropped Records is set to “Expire” then a timestamp column is required
