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
  • 1. Prerequisites
  • 2. Download the Resources
  • 3. Deployment Instructions
  • 4. Confirm your Installation

Was this helpful?

Export as PDF
  1. Meta Forms
  2. Meta-Forms Deployment Installation Guide

Deploying Meta-Forms (Kubernetes)

PreviousMeta-Forms Deployment Installation GuideNextDeploying Meta-Forms (IIS)

Last updated 2 years ago

Was this helpful?

1. Prerequisites

To install Cinchy Meta-Forms on Kubernetes you will need:

  • A deployed Cinchy platform. Note that these instructions are specific to a Kubernetes deployment; for instructions relevant to an IIS deployment please see here.

  • The Cinchy CLI. if you do not have this running.

2. Download the Resources

The Cinchy Meta-Forms code is For a Kubernetes deployment, you need to download the Meta-Forms-Data-Experience zip file.

Ensure that you download the latest version.

3. Deployment Instructions

  1. Navigate to the Meta-Forms-Data-Experience package.

  2. Open "\post-install\post-install-1.sql" and replace the below with your own URLs.

    SET @CinchyURL = 'https://pilot.cinchy.net/DXdemo/Cinchy'
    SET @MetaFormsURL = 'https://pilot.cinchy.net/DXdemo/dx/metaforms'
  3. Open an instance of Powershell or similar terminal.

  4. Run the below command, using the table as a guide and inputting your own parameters.

./CinchyDXD.ps1 install -s "cinchy.com/cincy" -h -sso "cinchy.com/sso" -u user -p pass -c "C:\Users\Downloads\Cinchy Connections v5.5.3\Cinchy Connections CLI\Cinchy Connections CLI (win-x64)" -d "C:\sometempdirectory" -e

Required Command

Description

-s, --Cinchy Server

Required. The full path to the Cinchy server without the protocol (e.g. cinchy.com/Cinchy).

-h, --https

Flag indicating connections to Cinchy should be over https.

-sso

The full path the the CinchySSO server without the protocol (e.g. cinchy.com/CinchySSO). This is only required if your CinchySSO server is different than /CinchySSO.

-u, --Username

Required. The user id for accessing Cinchy.

-p, --Password

Required. The clear text password (unencrypted) of the specified user.

-c, --CinchyCLI Directory

Required. The path to the Cinchy CLI.

-d, --CinchyCLI Temp Directory

Required. The path to the directory that the CLI can use for storing temporary files to support the sync (e.g. partitioned data).

-e

Required if you are running the CLI via exe instead of dll.

4. Confirm your Installation

Once you have installed the experience, your environment will be populated with these tables and queries:

  • Forms table

  • Forms Sections table

  • Form Fields table

  • Get Form Metadata query

  • Get Form Sections Metadata query

  • Get Form Fields Metadata

Forms Table: This table houses all of the existing forms in your environment. Adding an entry to this table, will add a form to the complete list of forms. The table is used to link form fields and form sections to one specific form, and it connects to the table which contains all of the form responses/data.

Form Sections Table: This table is used to create separation between parts of the form. For instance, when creating a quiz based on compliance, you can use this table to create a section for the technological questions, one for the policy based questions, and one for any possible quiz feedback. A new form section can be created by adding a new entry to this table. The form sections need to be connected to the form created in the Forms table.

Form Fields Table: This table is used to create all of the possible data entry fields associated with the form sections within the form. To create a new form field, simply add an entry to the table and connect it to the form section. In the example of the quiz, add an entry for every question and link it to the appropriate form section.

Get Form MetaData Query: This query will return the metadata of your form, using the form ID present in the Forms table. The results will show such data as whether a form field is mandatory or not, the choices present for each question, the column names and types present in the table containing your form data, the form fields and sections, the JSON data, and more.

Get Form Sections Query: This query uses the form ID, present in the Forms table, in order to return all of the form sections present within the form.

For any users who want to access forms/want forms to execute properly, they need to have access to all of the following tables and queries. These include the three tables and two queries shown above, as well as the Tables, Table Columns, and Domains tables within that user's specific environment.

Please see here
hosted on GitHub here.