Cinchy Platform Documentation
Cinchy v4.0
Cinchy v4.0
  • Dataware Overview
  • Release Notes
    • 4.1 Release Notes
    • 4.2 Release Notes
    • 4.4 Release Notes
    • 4.5 Release Notes
    • 4.6 Release Notes
    • 4.7 Release Notes
    • 4.8 Release Notes
    • 4.10 Release Notes
    • 4.11 Release Notes
    • 4.12 Release Notes
    • 4.13 Release Notes
    • 4.14 Release Notes
    • 4.15 Release Notes
    • 4.16 Release Notes
    • 4.17 Release Notes
    • 4.18 Release Notes
    • 4.19 Release Notes
    • 4.20 Release Notes
    • 4.21 Release Notes
  • Cinchy Guides
    • User
      • My Network
      • User Preferences
      • Table Features
      • Data Management
      • Commentary
      • Query
    • Builder
      • Best Practices
        • Multi-Lingual Support
      • Tables
        • Creating your first table
        • System Columns
        • Column Types
        • Linking Data
        • Indexing and Partitioning
        • Formatting Rules
        • Data Controls (formerly Design Controls)
          • Table Level Entitlements
          • Column Level Entitlements
          • Row Level Entitlements
          • Erasure
          • Compression
      • Building Forms
      • Saved Queries
        • Creating your first query
        • Displaying Query Results
      • Integration
        • BI Integrations
          • Excel
          • Power BI
          • Tableau
        • Other Integrations
          • SAS
      • Data Experience Deployment
    • Frequently Asked Questions
  • API Guide
    • APIs
      • Authentication
      • Saved Queries
      • ExecuteCQL
      • Webhook Ingestion
  • Deployment Guide
    • Planning
      • Deployment Planning Guide
      • Pre-Requisites
    • Installation
      • Maintenance
      • Migration from 1.x
      • Single Sign-On (SSO) Integration
        • Configuring ADFS
        • AD Group Integration
        • High Number of Groups in ADFS
      • Application Experiences
        • Setting Up Experiences
        • My Data Network
        • Custom Data Network Visualizer
      • Advanced Settings
        • Enable Data At Rest Encryption
        • System Properties
  • Other Resources
    • Cinchy Data Sync
    • Cinchy Meta-Forms
    • Cinchy Meta Reports
    • Cinchy Query Language
    • Angular SDK
    • JavaScript SDK
Powered by GitBook
On this page
  • Naming Convention
  • Domains
  • Descriptions

Was this helpful?

Export as PDF
  1. Cinchy Guides
  2. Builder

Best Practices

PreviousBuilderNextMulti-Lingual Support

Last updated 5 years ago

Was this helpful?

Naming Convention

‌Cinchy is built as a simple, business user friendly application. This means that you should use business friendly terms to name your tables and columns. For example, you want to name a column “Full Name” rather than full_name, fullName, fName etc.‌‌

Domains

‌Domains essentially act as folders to be able to organize your data. Generally you will want to split domains by business lines (ex. Sales, Marketing, Human Resources, Product Development). The key thing is to keep it consistent so users have a general idea where to go to find information.‌‌

Descriptions

‌You can add descriptions to your tables and columns. Descriptions allow other users to use data in a more self-serve fashion, and also helps prevent misunderstandings of the meaning of your data.‌‌

Table descriptions are shown in the My Network screen, and will show up in search as well.‌‌

Column descriptions show up when you hover on the column in the Manage Data screen.​