Cinchy Platform Documentation
Cinchy v5.0 - v5.5
Cinchy v5.0 - v5.5
  • Data Collaboration Overview
  • Other Wiki Spaces
    • Cinchy Data Sync
    • Angular SDK
    • JavaScript SQK
  • Release Notes
    • Release Notes
      • 5.0 Release Notes
      • 5.1 Release Notes
      • 5.2 Release Notes
      • 5.3 Release Notes
      • 5.4 Release Notes
      • 5.5 Release Notes
      • 5.6 Release Notes
  • Getting Help
  • Frequently Asked Questions
  • Deployment Guide
    • Deployment Installation Guides
      • Deployment Planning Overview and Checklist
        • Deployment Architecture Overview
          • Kubernetes Deployment Architecture
          • IIS Deployment Architecture
        • Deployment Prerequisites
          • Single Sign-On (SSO) Integration
            • Enabling TLS 1.2
            • Configuring ADFS
            • AD Group Integration
      • Kubernetes Deployment Installation
        • Disabling your Kubernetes Applications
        • Changing your File Storage Configuration
        • Using Self-Signed SSL Certs (Kubernetes Deployments)
        • Deploying the CLI (Kubernetes)
      • IIS Deployment Platform Installation
        • Deploying Connections and the CLI (IIS)
        • Deploying the Event Listener/Worker (IIS)
    • Upgrade Guides
      • Upgrading Cinchy Versions
        • Cinchy Upgrade Utility
        • Kubernetes Upgrades
          • v5.1 (Kubernetes)
          • v5.2 (Kubernetes)
          • v5.3 (Kubernetes)
          • v5.4 (Kubernetes)
          • v5.5 (Kubernetes)
          • v5.6 (Kubernetes)
          • Updating the Kubernetes Image Registry
          • Upgrading AWS EKS Kubernetes Version
          • Upgrading AKS (Azure Kubernetes Service)
        • IIS Upgrades
          • v4.21 (IIS)
          • v4.x to v5.x (IIS)
          • v5.1 (IIS)
          • v5.2 (IIS)
          • v5.3 (IIS)
          • v5.4 (IIS)
          • v5.5 (IIS)
          • v5.6 (IIS)
      • Upgrading from v4 to v5
  • Guides for Using Cinchy
    • User Guides
      • Overview of the Data Browser
      • The Admin Panel
      • User Preferences
        • Personal Access Tokens
      • Table Features
      • Data Management
      • Queries
      • Version Management
        • Versioning Best Practices
      • Commentary
    • Builder Guides
      • Best Practices
      • Creating Tables
        • Attaching Files
        • Columns
        • Data Controls
          • Data Entitlements
          • Data Erasure
          • Data Compression
        • Restoring Tables, Columns, and Rows
        • Formatting Rules
        • Indexing and Partitioning
        • Linking Data
        • Table and Column GUIDs
        • System Tables
      • Saved Queries
      • CinchyDXD Utility
        • Building the Data Experience (CinchyDXD)
        • Packaging the Data Experience (CinchyDXD)
        • Installing the Data Experience (CinchyDXD)
        • Updating the Data Experience (CinchyDXD)
        • Repackaging the Data Experience (CinchyDXD)
        • Reinstalling the Data Experience (CinchyDXD)
      • Multi-Lingual Support
      • Integration Guides
    • Administrator Guide
    • Additional Guides
      • Monitoring and Logging on Kubernetes
        • Grafana
        • Opensearch Dashboards
          • Setting up Alerts
        • Monitoring via ArgoCD
      • Maintenance
      • GraphQL (Beta)
      • System Properties
      • Enable Data At Rest Encryption
      • MDQE
      • Application Experiences
        • Network Map
          • Custom Node Results
          • Custom Results in the Network Map
        • Setting Up Experiences
  • API Guide
    • API Overview
      • API Authentication
      • API Saved Queries
      • ExecuteCQL
      • Webhook Ingestion
  • CQL
    • The Basics of CQL
      • CQL Examples
      • CQL Functions Master List
      • CQL Statements Overview
        • Cinchy DML Statements
        • Cinchy DDL Statements
      • Cinchy Supported Functions
        • Cinchy Functions
        • Cinchy System Values
        • Cinchy User Defined Functions
          • Table-Valued Functions
          • Scalar-Valued Functions
        • Conversion Functions
        • Date and Time Types and Functions
          • Return System Date and Time Values
          • Return Date and Time Parts
          • Return Date and Time Values From Their Parts
          • Return Date and Time Difference Values
          • Modify Date and Time Values
          • Validate Date and Time Values
        • Logical Functions
        • Mathematical Functions
        • String Functions
        • Geometry and Geography Data Type and Functions
          • OGC Methods on Geometry & Geography Instances
          • Extended Methods on Geometry & Geography Instances
        • Full Text Search Functions
        • Connections Functions
        • JSON Functions
  • Meta Forms
    • Introduction to Meta-Forms
    • Meta-Forms Deployment Installation Guide
      • Deploying Meta-Forms (Kubernetes)
      • Deploying Meta-Forms (IIS)
    • Creating a Dynamic Meta-Form (Using Tables)
    • Creating a Dynamic Meta-Form Example (Using Form Designer)
    • Forms Data Types
    • Adding Links to a Form
    • Rich Text Editing in Forms
Powered by GitBook
On this page
  • Table of Contents
  • 1. Introduction
  • 2. Install the Data Experience
  • 3. Validate the Install

Was this helpful?

Export as PDF
  1. Guides for Using Cinchy
  2. Builder Guides
  3. CinchyDXD Utility

Installing the Data Experience (CinchyDXD)

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

PreviousPackaging the Data Experience (CinchyDXD)NextUpdating the Data Experience (CinchyDXD)

Last updated 2 years ago

Was this helpful?

Table of Contents

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

2. In the folder path URL for the exported data experience type in powershell to launch Powershell for that path (Image 2).

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

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

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

6. Hit Enter on your keyboard (Image 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).

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

3. Validate the Install

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

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

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

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

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

#1.-introduction
#2.-install-the-data-experience
#3.-validate-the-install
Image 1: Step 1
Image 2: Step 2
Image 3: Step 3
Image 4: Step 4
Image 5: Step 5
Image 6: Step 6
Image 7: Step 8
Image 8: Step 9
Image 9: Step 1
Image 10: step 2
Image 11: Step 3
Image 12: Step 4
Image 13: Step 5