Table Creation

Create your data experience (DX) in a virtual data network.

1. Log in to Cinchy: URL: <Cinchy source URL> User ID: <source user id> Password: <source password>

2. From the Homepage, select Create

3. Select Table > From Scratch

4. Create the table with the following properties (Image 1).

1. Click Columns in the left hand navigation to create the columns for the table

2. Click the “Click Here to Add” a column tab to add a column

8. Click the Save button to save your table

Enter sample data

1. In your newly created table, enter the following sample data (Image 2).

Create the query

Create a simple query that pulls information from the Currency Exchange Rate table that will allow a simple currency exchange calculation.

1. From the Homepage, select Create.

2. Select Query.

3. In the query builder locate the Currency Exchange Rate table and drag it to the “FROM” line (Image 3).

1. In the “SELECT” line drag and drop the “Rate” column and enter in the following (Image 4): SELECT [Rate] * @Amount AS 'Converted Amount'

1. Enter in the following for the WHERE clause (Image 5):

WHERE [Deleted] IS NULL AND [Currency 1] = @Currency_1 AND [Currency 2] = @Currency_2

1. Click the Execute (or play) icon to run the query (Image 6):

1. Test the query by entering in the following and clicking the submit button (Image 7):

@Amount: 100 @Currency_1: CAD @Currency_2: USD

1. Save the Query by clicking on the Info tab (Left Navigation)\

2. Enter in the following details for the query (Image 8):

1. Click the Save button (Image 9).

Introduction to CinchyDXD

CinchyDXD is a downloadable utility used to move Data Experiences (DX) from one environment to another. This includes any and all objects and components that have been built for, or are required in, support of the Data Experience.

The following sections in this document will outline the basics of how to build, export**,** and install a DX’s.

Items of note moving forward in this document:

• Source Environment is the environment in which the DX is built.

• Target Environment is the environment in which the DX will be installed.

• The example DX is a simple Currency Converter DX that consists of

  • One (1) table

  • One (1) query

• This example doesn't include the following:

  • NO applets

  • NO integrated clients

  • NO Data Sync Configurations

  • NO Reference Data

  • NO Models

  • NO Groups

  • NO System Colours

  • NO Formatting Groups

  • NO Literal Groups

Future iterations of this document will add to this example's complexity level.

Steps

The general steps to deploying the CinchyDXD Utility are as follows:

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

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

5. You must now enter your mandatory export parameters.

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).

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 (For example, 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>

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).

1. In the folder path URL of the exported data experience type in PowerShell to launch PowerShell for that path (Image 2).

1. Hit Enter on your keyboard, the PowerShell window will appear (Image 3).

1. In the PowerShell window, type in cin and hit tab on your keyboard (Image 4).

1. In the PowerShell command line, type install (Image 5).

1. Hit Enter on your keyboard (Image 6).

The PowerShell window will provide you with the required and optional components to install the DX.

1. You must now set up your mandatory install parameters

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" `

1. Enter the install parameters into the PowerShell window (Image 7).

1. 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).

3. Validate the Install

1. Ensure that the Models Table is populated in the target environment with the model that was installed (Image 9).

1. Ensure that the Currency Exchange Rate table exist in the target environment (Image 10).

1. Ensure that the Currency Converter query exist in the target environment (Image 11).

1. Ensure that the Data Experience Definitions table is populated with the DX parameters that were set up in the source environment (Image 12).

1. Ensure that the Data Experience Releases table in the target environment is populated (Image 13).

Introduction

The Data Experience has required updates you must create in your source environment. You don't want to have to repeat the updates in both the source and target environments. The upcoming section will show how to update the data experience in the source environment so that you can then re-package and reinstall in the target environment.

Table updates

1. Log back into your source environment using the following: URL: <Cinchy source url> User ID: <source user id> Password: <source password>

2. Make the following changes to the Currency Exchange Rate table:

3. Save your changes before leaving the table.

Query updates

1. Update the Currency Converter query to reflect column name changes that were made in the Table Updates section above (Image 1).

1. Test the query to validate that it's still functioning (Image 2 and 3).

1. Save your query.

Re-run CinchyDXD install

Using PowerShell, you must now install the Data Experience you have exported out of Cinchy.

1. Open File Explorer and navigate to your exported folder (Image 1).

1. In the folder path URL of the exported data experience, type in PowerShell to launch PowerShell for that path.

2. Hit Enter on your keyboard (Image 2).

1. In the PowerShell window, type cin and hit Tab on your keyboard. Type install (Image 3).

1. Enter the install parameters into the PowerShell window:

Sample (Image 4): .\CinchyDXD.ps1 install -s "<taget Cinchy url>" ` -u "<target user id>" ` -p "<target password>" ` -c "C:\Cinchy CLI v4.0.2" ` -d "C:\CLI Output Logs" `

1. 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 5).

Validate Install

1. Ensure that the Models Table is populated in the target environment with the model that was installed (Image 6).

1. Ensure that the Currency Exchange Rate table exists in the target environment with the new column names (Image 7).

1. Ensure that the Currency Converter query exists in the target environment with the new column names and labels (Image 8).

1. Ensure that the Data Experience Definitions table hasn't changed, unless you have added or removed column details within this table (Image 9).

1. Ensure that the Data Experience Releases table in the target environment is populated with the new release version number from the install (For example: 2.0.0) (Image 10).

Download the CinchyDXD utility

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.

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 () documentation

To access the Data Experience Deployment utility please contact Cinchy support (support@cinchy.com).

To download the Utility:

1. Login to Cinchy

2. Navigate to the Releases Table

3. Select the Experience Deployment Utility View

4. Locate and download the utility (Cinchy DXD v1.7.0.zip)

1. Unzip the utility and place the folder at any location on a computer that also has CinchyCLI installed

2. 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.

1. Launch a PowerShell console window

2. From the console, navigate to the CinchyDXD directory (Image 2 and 3).

Initial setup: PowerShell

PowerShell requires an initial setup when using CinchyDXD.

1. From your PowerShell window type cin

2. Hit Tab on your keyboard (Image 4).

1. 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:

1. From your start menu, search for PowerShell and select Run as Administrator (Image 6).

1. When prompted if you want to allow this app to make changes on your device, select Yes.

2. In your PowerShell Administrator window enter Set-ExecutionPolicy RemoteSigned (Image 7).

1. Hit Enter on your keyboard (Image 8).

1. When prompted with the Execution Policy Changes, enter A for “Yes to All”

2. Close the PowerShell Administrator window

3. Navigate back to your PowerShell window for the CinchDXD window

4. From your PowerShell window type cin

5. 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 DXD tables overview

Cinchy uses four tables for packing up and deploying a Data Experience (Image 10).

1. Data Experience Definition Table: Where the data experience is defined (tables, queries, views, formatting rules, UDF’s etc.)

2. 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)

3. 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

4. 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

Define the data experience

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.

1. Locate and open the Data Experience Definitions table (Image 11).

2. Complete the following (Image 12):

Define the reference data

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.

1. 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.

Export the data experience

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

1. Launch PowerShell and navigate to your CinchyDXD folder (Image 14).

1. In the PowerShell window type in cin and hit Tab on your keyboard (Image 16).

1. Hit Enter on your keyboard, you will see a list of commands that are available to execute (Image 17).

1. In the PowerShell command line hit your “up” arrow key to bring back the last command and type export next to it (Image 18).

1. Hit Enter on your keyboard (Image 19).

The PowerShell window will provide you with the required and optional components to export the data experience.

1. You must now set up any mandatory export parameters

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" `\

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

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 21).

Validate export

1. 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).