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
  • Overview
  • B
  • C
  • D
  • Data Experience
  • E
  • L
  • M
  • N
  • Q
  • R

Glossary

PreviousSupportNextFAQ

Last updated 1 year ago

Overview

Becoming comfortable with the Cinchy terms and verbiage is an essential step to broaden your understanding of the platform and data collaboration as a whole. We've created this handy guide featuring to help you better understand the words and phrases you may see appear throughout this wiki space.

B

Batch Sync

A Batch Sync is one of the two types of Data Syncs that you can perform using Cinchy. by processing a group or a ‘batch’ of data all together rather than each piece of data individually. When the data sync is triggered it will compare the contents of the source to the target. The Cinchy Worker will decide if data needs to be added, deleted or updated. Batch sync can either be run as a one-time data load operation, or it can be scheduled to run periodically using an external Enterprise Scheduler

C

Cinchy Administrator

The is a user or user group with special within the Cinchy platform. An administrator can be either an or a

A Builder Admin can:

  • Modify all table data (including system tables), all schema, and all data controls

    • This includes setting up and configuring users, assigning them to groups, and assigning which users have builder access

  • View all tables (including system tables) and queries in the platform

A Non-Builder Admin can:

  • View all tables (including system tables) and queries in the platform

  • Modify data controls for tables

Cinchy Builder

The “Cinchy Builder” has access to perform the following capabilities:

  • Change Table Schema (use Cinchy’s “Design Table” functionality)

  • Grant access (use Cinchy’s “Design Controls” functionality)

  • Edit Cinchy Data in Cinchy System Tables

  • Create, Save, and Share Cinchy Queries

  • Perform specific Cinchy Queries on the Cinchy data network

  • Import/export packaged business capabilities (such as deployment packages)

  • Build Cinchy Experiences

  • Perform integration with Cinchy (Cinchy Command Line Interface [CLI] operations)

  • Create and Deliver an unlimited number of Customer Use Cases within Cinchy

Cinchy CLI

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.

Cinchy ID

Cinchy ID is a unique identifier assigned automatically to all records within a normal table. The Cinchy ID is associated with the record permanently and is never reassigned even if the record is deleted.

Cinchy Query Language (CQL)

Cinchy Query Language can be used in many ways, including but not limited to:

  • ​Building queries through the query editor that can return, insert, delete, and otherwise manage your data.

  • ​Creating, altering or dropping views for tables​

  • ​Creating, altering or dropping indexes​

Cinchy Upgrade Utility

Cinchy End-User

  • Direct Users log into Cinchy via the data browser

  • Indirect Users (also commonly referred to as "external users") view/edit data via a third-party application/page that connects to Cinchy via API

Cinchy End-Users are able to:

  • Create and save personal queries. Unlike traditional saved queries made by builders, personal saved queries can't be shared and aren't auto exposed as APIs.

  • Track version history for the full lifecycle of data

  • Bookmark and manage data

  • Access data through application experiences

Connections Experience

D

Data Browser

Data Collaboration

Data collaboration entails the collection, exchange and use of data from different origins within an organization. This interaction creates data products with data owners acting as experts for their specific data domains. The interaction of these various data set domains also results in dramatically informed insights that are solely driven by the interactions of the data itself.

Data Destination(s)

Data Experience

A data experience is a deployable package in Cinchy consisting of tables, queries, groups, and data sync configurations designed for a specific business workflow.

Data Source(s)

Data Synchronizations

E

Entitlements

Entitlements refers to the set of permissions that you are granted for any piece of data. Cinchy allows entitlements to be set at a granular level, meaning you can give individual users or user groups access to things like:

  • Viewing a data sync

  • Running a job

  • Viewing a specific table row or column

  • Editing a specific table cell

  • Etc.

Experiences

L

Listener configuration

M

MDQE

MDQE, which stands for Metadata Quality Exceptions, can send out notifications based on a set of rules and the “exceptions” that break them. This powerful tool can be used to send notifications for exceptions such as:

  • Healthchecks returning a critical status

  • Upcoming Project Due Dates/Timelines

  • Client Risk Ratings reaching a high threshold

  • Tracking Ticket Urgency or Status markers

  • Unfulfilled and Pending Tasks/Deliverables

  • Etc.

MDQE monitors for specific changes in data, and then pushes out notifications when that change occurs.

Meta Forms

It lives on top of the data collaboration platform, allowing builders to create forms with custom configurations and users to access this data outside of the tabular view that's native to Cinchy.

N

Network Map

Each node represents a table you have access to within Cinchy, and each edge is one link between two tables. The size of the table is determined by the number of links referencing that table. The timeline on the bottom allows you to check out your data network at a point in the past and look at the evolution of your network.

Q

Queries/Saved Queries

R

Real Time Sync

use the Cinchy platform to build an unlimited number of business capabilities and use-cases.

A builder can be part of the

The is a tool that offers utilities for syncing data in and out of Cinchy via

is the data collaboration version of common query languages such as SQL. With a robust set of functions and commands, you can use CQL to retrieve and manage/modify data and metadata from tables in your network. While data can reside across many tables, a query can isolate it to a single output, making the possibilities of CQL endlessly powerful.

is an easy to use tool that can help you deploy important changes and upgrades to your Cinchy environment when upgrading versions. Note that not every major or minor release version will require the Utility to be run, however this will be clearly noted in the release notes and upgrade guide.

of the Cinchy platform are those that apply the functionalities created by the “Cinchy Builders” to their business objectives. This can be employees, customers, partners, or systems. Cinchy has two types of end-user: direct and indirect.

Use Tables, Saved Queries, and Experiences created by

An end-user can be part of the

The Connections Experience is an integral part of Cinchy . Serving as the front-end UI for performing, the Connections Experience can be accessed natively in your Cinchy browser to create, configure, and manage the data being synced in and out of the platform. The user friendly interface makes synchronizing your data across a range of apps easy.

The is the homepage of your Cinchy platform. From here you can view any , , or that you have access to. You can also use it to search and review any bookmarks that you have saved.

When setting up a Data Sync, you must define which destination to push data to. Cinchy maintains of Data Destination connectors and is always working on adding more into the .

When setting up a Data Sync, you must define which source to pull data from. Cinchy maintains of Data Source connectors and is always working on adding more into the

Data Synchronizations ("Data Syncs") are a powerful and important aspect of the Cinchy platform. Using a Data Sync allows you to bidirectional push and pull data between various and , including Salesforce, Snowflake, REST APIs, and more. Built with keeping the core tenants of data collaboration in mind, Data Syncs adhere to your set and can be configured using the intuitive to enable a myriad of use-cases for your business.

Entitlements can persist across the platform when using features such as link columns or the

Rather than traditional code-centric applications which creates data silos, you can build directly on the Cinchy platform. These look and feel like regular applications, but persists its data on the data network autonomously, rather than managing its own persistence. These experiences automatically adapt as your data evolves. An Org Chart is an example of a metadata driven Experience you can create using the power of on Cinchy.

Real-time data syncs need to for so that it knows what data to pull/push through your sync. As of 5.7, this can now be done under the Sources section in the Listener tab. Each stream source has different variables and parameters that you can use to refine your sync. The Listener only needs to be configured for , not for

is a combination of Angular code packaged as an App Experience and a Data Model packaged as a Data Experience that enables users to interact with Cinchy data in a User-Friendly manner.

Cinchy comes out of the box with a system applet called , which is a visualization of your data on the platform and how everything interconnects; it's another way to view and navigate the data you have access to within Cinchy.

It uses your for viewable tables and linked columns.

Queries are the fundamental calculations that allow data to be pushed, pulled, and manipulated across a range of Cinchy features. A query can be used to call data, change data, delete data, or whatever functionality your use case requires. Cinchy comes out of the box with a native Query Builder and works with our proprietary

A Saved Query is merely a query that has been saved for reuse. These can be accessed via the Saved Queries table in Cinchy, and you have access to view or run them based on your

is one of the two types of Data Syncs that you can perform using Cinchy. In real-time syncs, the Cinchy Listener picks up changes in the source immediately as they occur. These syncs don't need to be manually triggered or scheduled using an external scheduler. Setting up a real-time sync does require an extra step of defining a listener configuration to execute properly.

“Cinchy Builders”
Administrators group
Cinchy Command Line Interface (CLI)
various commands.
Cinchy Query Language (CQL)
The Cinchy Upgrade Utility
The “End-Users”
Administrators group
The Meta-Forms experience
Network Map
Batch syncs work
Cinchy Administrator
Entitlements
End-User
Builder.
data collaboration
Data Syncs
Data Browser
Tables
Queries
Experiences
a robust list
Connections Experience
a robust list
Connections Experience.
Data Sources
Data Destinations
Entitlements
Connections Experience
Network Map.
metadata driven application experiences
data collaboration
set up a Cinchy listener configuration
event stream sources
real-time syncs
batch syncs.
Entitlements
Cinchy Query Language.
entitlements.
“Builders"
A Real-Time Sync