5️⃣
Cinchy Platform Documentation
Cinchy v5.8
Cinchy v4.0Cinchy v5.0 - v5.5Cinchy v5.6Cinchy v5.7Cinchy v5.8Cinchy v5.9+
Cinchy v5.8
Cinchy v4.0Cinchy v5.0 - v5.5Cinchy v5.6Cinchy v5.7Cinchy v5.8Cinchy v5.9+
  • 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
  • Architecture
  • CinchyDXD 2.0 example release package
  • Visual representation
  • Additional resources
  1. Guides for using Cinchy
  2. Builder Guide
  3. CinchyDXD

Release package

Overview

This page details the architecture of the release package for CinchyDXD 2.0.

Architecture

The architecture of a release package in CinchyDXD 2.0 separates into a folder for each entity you exported from the source environment. Each folder has the respective data relevant to that entity.

CinchyDXD 2.0 example release package

The following list is an example of the release package folder architecture and their respective files.

└───Release package
    └───install
        ├───cli
        │       DXDF - Cinchy - DXDATA - Applets.xml
        │       DXDF - Cinchy - DXDATA - Data Experience Definitions.xml
        │       DXDF - Cinchy - DXDATA - Data Experience Reference Data.xml
        │       DXDF - Cinchy - DXDATA - Data Experience Releases.xml
        │       DXDF - Cinchy - DXDATA - Data Sync Configurations.xml
        │       DXDF - Cinchy - DXDATA - Domains.xml
        │       DXDF - Cinchy - DXDATA - External Secrets Manager.xml
        │       DXDF - Cinchy - DXDATA - Formatting Rules.xml
        │       DXDF - Cinchy - DXDATA - Groups.xml
        │       DXDF - Cinchy - DXDATA - Integrated Clients.xml
        │       DXDF - Cinchy - DXDATA - Listener Config.xml
        │       DXDF - Cinchy - DXDATA - Literal Groups.xml
        │       DXDF - Cinchy - DXDATA - Literal Translations.xml
        │       DXDF - Cinchy - DXDATA - Literals.xml
        │       DXDF - Cinchy - DXDATA - Models.xml
        │       DXDF - Cinchy - DXDATA - Saved Queries.xml
        │       DXDF - Cinchy - DXDATA - Secrets.xml
        │       DXDF - Cinchy - DXDATA - System Colours.xml
        │       DXDF - Cinchy - DXDATA - Table Access Control.xml
        │       DXDF - Cinchy - DXDATA - User Defined Functions.xml
        │       DXDF - Cinchy - DXDATA - View Column Link Graph.xml
        │       DXDF - Cinchy - DXDATA - View Columns.xml
        │       DXDF - Cinchy - DXDATA - Views.xml
        │       DXDF - Cinchy - DXDATA - Webhooks.xml
        │       DXDF - Release Package- REFDATA - 00000001 - Release Package Nested DXD Link Target.xml
        │       DXDF - Release Package- REFDATA - 00000003 - Release Package All Data.xml
        │       DXDF - Release Package- REFDATA - 00000004 - Release Package All Data Types Link Target new.xml
        │
        ├───csv
        │       DXDF - Release Package- DXDATA - Applets.csv
        │       DXDF - Release Package- DXDATA - Data Experience Definitions.csv
        │       DXDF - Release Package- DXDATA - Data Experience Reference Data.csv
        │       DXDF - Release Package- DXDATA - Data Sync Configurations.csv
        │       DXDF - Release Package- DXDATA - Domains.csv
        │       DXDF - Release Package- DXDATA - External Secrets Manager - Copy.csv
        │       DXDF - Release Package- DXDATA - External Secrets Manager.csv
        │       DXDF - Release Package- DXDATA - Formatting Rules.csv
        │       DXDF - Release Package- DXDATA - Groups.csv
        │       DXDF - Release Package- DXDATA - Integrated Clients.csv
        │       DXDF - Release Package- DXDATA - Listener Config.csv
        │       DXDF - Release Package- DXDATA - Literal Groups.csv
        │       DXDF - Release Package- DXDATA - Literal Translations.csv
        │       DXDF - Release Package- DXDATA - Literals.csv
        │       DXDF - Release Package- DXDATA - Models.csv
        │       DXDF - Release Package- DXDATA - Saved Queries.csv
        │       DXDF - Release Package- DXDATA - Secrets.csv
        │       DXDF - Release Package- DXDATA - System Colours.csv
        │       DXDF - Release Package- DXDATA - Table Access Control.csv
        │       DXDF - Release Package- DXDATA - User Defined Functions.csv
        │       DXDF - Release Package- DXDATA - View Column Link Graph.csv
        │       DXDF - Release Package- DXDATA - View Columns.csv
        │       DXDF - Release Package- DXDATA - Views.csv
        │       DXDF - Release Package- DXDATA - Webhooks.csv
        │       DXDF - Release Package- REFDATA - 00000001 - Release Package Nested DXD Link Target.csv
        │       DXDF - Release Package- REFDATA - 00000003 - Release Package All Data.csv
        │       DXDF - Release Package- REFDATA - 00000004 - Release Package All Data Types Link Target new.csv
        │
        ├───models
        │       DXDF - Release Package- MODEL - DX50.Release Package All Data Types Link Target new.xml
        │       DXDF - Release Package- MODEL - DX50.Release Package All Data.xml
        │       DXDF - Release Package- MODEL - DX50.Nested Release Package Link Target.xml
        │
        ├───post-install
        │       PostInstall - DX50.sql
        │
        └───pre-install
                PreInstall - DXD.sql

Visual representation

The example below is a simplified visual representation of the folder structure.

Additional resources

PreviousInstall the data experienceNextChangelog

Last updated 1 year ago

CinchyDXD workflow
Package the data experience