5️⃣
Cinchy Platform Documentation
Cinchy v5.8
Cinchy v5.8
  • Data Collaboration Overview
  • Release notes
    • Release notes
      • 5.9 release notes
      • 5.8 Release Notes
      • 5.7 Release Notes
      • 5.6 Release Notes
      • 5.5 Release Notes
      • 5.4 Release Notes
      • 5.3 Release Notes
      • 5.2 Release Notes
      • 5.1 Release Notes
      • 5.0 Release Notes
  • Support
  • Glossary
  • FAQ
  • Deployment guide
    • Deploying Cinchy
      • Plan your deployment
        • Deployment architecture
          • Kubernetes architecture
          • IIS architecture
        • Deployment prerequisites
          • Single Sign-On (SSO) integration
            • Enable TLS 1.2
            • Configure ADFS
            • AD Group Integration
      • Kubernetes
        • Disable your Kubernetes applications
        • Change your file storage configuration
        • Configure AWS IAM for Connections
        • Use Self-Signed SSL Certs (Kubernetes)
        • Deploy the CLI (Kubernetes)
      • IIS
  • Upgrade guide
    • Upgrade Cinchy
      • Cinchy Upgrade Utility
      • Kubernetes upgrades
        • v5.1 (Kubernetes)
        • v5.2 (Kubernetes)
        • v5.3 (Kubernetes)
        • v5.4 (Kubernetes)
        • v5.5 (Kubernetes)
        • v5.6 (Kubernetes)
        • v5.7 (Kubernetes)
        • v5.8 (Kubernetes)
        • Upgrade AWS EKS Kubernetes version
        • Update the Kubernetes Image Registry
        • Upgrade Azure Kubernetes Service (AKS)
      • 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)
        • v5.7 (IIS)
        • v5.8 (IIS)
      • Upgrading from v4 to v5
  • Guides for using Cinchy
    • User Guide
      • Data Browser overview
      • The Admin panel
      • User preferences
        • Personal access tokens
      • Table features
      • Data management
      • Queries
      • Version management
        • Versioning best practices
      • Commentary
    • Builder Guide
      • Best practices
      • Create tables
        • Attach files
        • Columns
        • Data controls
          • Data entitlements
          • Data erasure
          • Data compression
        • Formatting rules
        • Indexing & partitioning
        • Linking data
        • Table and column GUIDs
        • System tables
      • Delete tables
        • Restore tables, columns, and rows
      • Saved queries
      • CinchyDXD
        • Overview
        • DXD workflow
        • Package the data experience
        • Install the data experience
        • Release package
        • Changelog
        • References
          • Cinchy DXD CLI reference
          • Data Experience Definitions table
          • Data Experience Reference table
      • Multilingual support
      • Integration guides
    • Administrator Guide
    • Additional guides
      • Monitor and Log on Kubernetes
        • Grafana
        • OpenSearch dashboards
          • Set up Alerts
        • Monitor via ArgoCD
      • Maintenance
      • Cinchy Secrets Manager
      • GraphQL (Beta)
      • System properties
      • Enable Data At Rest Encryption (DARE)
      • Application experiences
        • Network map
          • Custom node results
          • Custom results in the Network Map
        • Set up experiences
  • API Guide
    • API overview
      • API authentication
      • API saved queries
      • ExecuteCQL
      • Webhook ingestion
  • CQL
    • Overview
      • CQL examples
      • CQL statements overview
        • Cinchy DML statements
        • Cinchy DDL statements
      • Cinchy supported functions
        • Cinchy functions
        • Cinchy system values
        • Cinchy User Defined Functions (UDFs)
          • 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
        • Math 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
    • CQL functions reference list
  • Meta-Forms
    • Introduction
    • Install Meta-Forms
      • Deploy Meta-Forms (Kubernetes)
      • Deploy Meta-Forms (IIS)
    • Forms data types
    • Meta-Forms Builder Guide
      • Create a dynamic meta-form with tables
      • Create a dynamic meta-form example with Form Designer
      • Add links to a form
      • Rich text editing in forms
  • Data syncs
    • Get started with data syncs
    • IIS installation
      • Install Connections
      • Install the Worker/Listener
      • Install the Connections CLI
    • Build data syncs
      • Data sync types
      • Design patterns
      • Sync actions
      • Columns and mappings
        • Calculated column examples
      • Advanced settings
        • Filters
        • Variables
        • Auth requests
        • Request headers
        • Post sync scripts
        • Pagination
      • Batch data sync example
      • Real-time sync example
      • Schedule a data sync
      • Connection functions
    • Data sync sources
      • Cinchy Event Broker/CDC
        • Cinchy Event Broker/CDC XML config example
      • Cinchy Table
        • Cinchy Table XML config example
      • Cinchy Query
        • Cinchy Query XML config example
      • Copper
      • DB2 (query and table)
      • Dynamics 2015
      • Dynamics
      • DynamoDB
      • File-based sources
        • Binary file
        • Delimited file
        • Excel
        • Fixed width file
        • Parquet
      • Kafka Topic
        • Kafka Topic example config
        • Apache AVRO data format
      • LDAP
      • MongoDB collection
        • MongoDB collection source example
      • Mongo event
      • MongoDB collection (Cinchy event)
      • MS SQL Server (query and table)
      • ODBC Query
      • Oracle (query and table)
      • Polling event
        • Polling event example config
      • REST API
      • REST API (Cinchy event)
      • SAP SuccessFactors
      • Salesforce Object (Bulk API)
      • Salesforce platform event
      • Salesforce push topic
      • Snowflake
        • Snowflake source example config
      • SOAP 1.2 web service
      • SOAP 1.2 web service (Cinchy Event Triggered)
    • Data sync destinations
      • Cinchy Table
      • DB2 table
      • Dynamics
      • Kafka Topic
      • MongoDB collection
      • MS SQL Server table
      • Oracle table
      • REST API
      • Salesforce
      • Snowflake table
      • SOAP 1.2 web service
    • Real-time sync stream sources
      • The Listener Config table
      • Cinchy Event Broker/CDC
      • Data Polling
      • Kafka Topic
      • MongoDB
      • Salesforce Push Topic
      • Salesforce Platform Event
    • CLI commands list
    • Troubleshooting
  • Other Resources
    • Angular SDK
    • JavaScript SQK
Powered by GitBook
On this page
  • Prerequisites
  • Download the resources
  • Deploy the App Experience
  • Update configurations
  • Additional changes
  • Deploy the data experience
  1. Meta-Forms
  2. Install Meta-Forms

Deploy Meta-Forms (IIS)

PreviousDeploy Meta-Forms (Kubernetes)NextForms data types

Last updated 1 year ago

Prerequisites

To install Cinchy Meta-Forms you will need:

  • A deployed Cinchy platform on IIS. These instructions are specific to an IIS deployment.

  • .

  • Ensure that the IIS extension "URL Rewrite" is installed on the server hosting IIS. The extension is available here:

Download the resources

The Cinchy Meta-Forms code is For an IIS deployment, you need to download the Meta-Forms-Data-Experience zip file and the Meta-Forms-App-Experience zip file.

Ensure that you download the latest version.

Deploy the App Experience

  1. Create a C:/Cinchy Applets folder if it doesn't exist and check in the App Experience code.

  2. If you have multiple instances, create a folder that corresponds to the name of your Cinchy instance (C:/CinchyApplets/DXdemo) and place the extracted App Experience folder here.

  1. Open your IIS Manager.

  2. Navigate to IIS Connections.

  3. Right Click the Cinchy Server name.

  1. Expand Sites such that “Default Web Site” is visible.

  2. Navigate to the site containing your Cinchy application and select Add Virtual Directory.

  3. Name the Alias of this directory DX.

  1. Input the path to Cinchy Applets directory in the Physical Path field.

  2. Right click on the meta-forms folder under the DX virtual directory and select Convert to Application.

Update configurations

  1. Locate "\assets\config.json" and input your Cinchy domain as specified below.

Additional changes

If you haven't deployed Cinchy at the root of your domain on IIS, then you need to complete the steps below.

  1. Specify the path to your 'meta-forms' application as instructed below.

  2. Locate the "C:\CinchyApplets\<Cinchy Environment>\Meta-Forms-App-Experience\index.html" file and update the base HREF to the path to your edit-form application on IIS and save.

Deploy the data experience

  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 from within the Meta-Forms-Data-Experience.

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

./CinchyDXD.ps1 install -s "cinchy.com/cinchy" -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 (cinchy.com/Cinchy).

-h, --https

Flag indicating connections to Cinchy should be over HTTPS.

-sso

The full path to the CinchySSO server without the protocol (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 (such as partitioned data).

-e

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

## 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 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: Use this table 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: Use this table to create all 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 resulting metadata shows whether a form field is mandatory or not, the choices present for each question, the column names and types in the table containing your form data, the form fields and sections, and the JSON data.

Get Form Sections Query: This query uses the form ID, present in the Forms table, to return all 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 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.

The Cinchy CLI
https://www.iis.net/downloads/microsoft/url-rewrite
on GitHub.