CBoard Documentation

website·Indexed 31 days ago

https://www.chuguotech.com/docs/

Documentation for CBoard, a business intelligence and data visualization platform. It covers a wide array of chart types (including Sankey, Radar, 3D Earth, and K-line charts), dataset configurations for Elasticsearch and other databases, unified calculation functions, form design, and integration methods via iframe or Vue2 components.

Tokens
113.1K
Snippets
316
Records
1K
Agent score
62%

What's inside CBoard

  1. Overview of Calculated Fields in Datasets

    Calculated fields allow users to add new fields to the original detailed data for analysis when the base data lacks necessary fields. They operate at the detail level (before final aggregation in the view) and are dynamically constructed only when used in an analysis to optimize performance. Common use cases include:

    • Type Conversion: Converting date strings to date formats or text to numeric types.
    • Arithmetic: Calculating values like Sales Amount = Unit Price * Quantity.
    • Logical Judgments: Using CASE WHEN for classification (e.g., Age >= 18 then 'Adult').
    • Aggregations: Using window functions for cumulative sums, rankings, or partitioned sums.
  2. Overview of Data Entry feature

    The Data Entry (数据填报) feature is used for data collection, primarily to assist in gathering and entering data that exists outside of data warehouses or business databases. It can also be utilized for questionnaire data collection.
  3. Overview of Aggregated Data Longitude and Latitude Map

    The Aggregated Data Longitude and Latitude Map maps summarized data onto a map based on coordinates. Unlike Area Maps, it ignores administrative boundaries and maps everything via longitude and latitude. Even if city names are provided, they are converted to coordinates for mapping. Note that this map type does not support regional drilling.
  4. Overview of Unified Calculation Functions

    Unified Calculation Functions act as a translation layer to shield users from SQL dialect differences across various underlying databases. These system-built functions can be used instead of native database functions when creating calculated fields or summary expressions.

    Supported Scenarios:

    • Dataset custom fields (including LOD FIX)
    • Dataset summary expressions (including dimensions and summary metrics defined in LOD INCLUDE / LOD EXCLUDE)
    • Script-type dimension derivative fields

    Unsupported Scenarios:

    • Direct use within dataset query definitions

    Supported Data Sources: Supported for all data sources except ElasticSearch and MongoDB (including Text and Http types). Supported relational databases include MySQL, Doris, H2, Clickhouse, Oracle, Dameng, PostgreSQL, SQLServer, and Presto.

  5. Overview of the RFM Customer Value Analysis Model

    RFM analysis is a marketing technique used to segment customers based on their purchasing behavior to identify high-value customers and optimize CRM strategies. It evaluates three key dimensions:

    1. Recency (R): Time elapsed since the customer's last purchase. Recent buyers are more likely to purchase again.
    2. Frequency (F): How often a customer makes a purchase within a specific period. High frequency indicates brand loyalty.
    3. Monetary (M): Total amount spent by the customer. High spenders contribute most to revenue.
  6. Overview of the pkg-puppeteer plugin

    The pkg-puppeteer plugin allows the server to simulate requests to dashboard pages to generate screenshots for features such as scheduled email delivery and big-screen exports. It is based on Google Chrome's Puppeteer and is packaged as a platform-specific executable via pkg, meaning users do not need to install a Node.js environment separately. The plugin comes bundled with Chromium.
  7. Overview of IBI Complex Report Designer

    The IBI Complex Report Designer is based on the open-source UReport2 project. It is specifically designed for 'Chinese-style' reports that require high precision in table formatting, such as financial statements and audit reports. These reports are characterized by complex structures, multi-level nested headers, and inter-cell calculations, making them more difficult to produce than standard BI self-service cross-tables.
  8. Overview of Dashboard Query Parameter Components

    Query Parameter Components (Filters) allow users to dynamically adjust and filter dashboard data for personalized views. Available input types include:

    • General Filter: Supports operators like =, ≠, >, <, range queries, and keyword searches.
    • Dropdown: Select one or more values from a predefined list.
    • Date Range: Select a time interval.
    • Date: Select a specific date.
    • Checkbox: Multi-select options.
    • Radio Button: Single-select option.
    • Range Query: Input numerical intervals.
    • Keyword Search: Fast lookup via text input.
  9. Overview of Waterfall Chart use cases

    The Waterfall Chart is used to visualize the cumulative change in numerical values. Common application scenarios include:

    • Financial Analysis: Tracking revenue to net profit, cost contribution analysis, and Budget vs. Actual variance.
    • Data Change Tracking: Analyzing incremental changes from an initial value to a final value over time.
    • Business Performance: Analyzing sales contributions by product/region or market share shifts.
    • Project Management: Tracking phase-based progress and resource allocation.
    • Inventory & Policy: Monitoring inventory fluctuations or the impact of policy changes on costs/revenue.
  10. Overview of 3D Map Widget

    The 3D Map is an out-of-the-box 3D map control based on ThreeJS. It provides superior visual effects and dynamic interactivity (rotation, zooming, tilting) compared to 2D maps. Note that it has higher hardware requirements (GPU) and a steeper learning curve for perspective adjustment.
  11. Use the new generation cache strategy for datasets

    Version v2.1 introduces a new generation cache strategy for datasets that utilizes lightweight columnar storage. This strategy is more stable than the previous H2 database implementation and offers significant performance improvements, enabling second-level loading and querying for millions of records. It includes field-level fault tolerance during data loading and supports numeric fields containing currency or thousand-separator symbols.
  12. Understand IBI's RBAC Permission Model

    IBI uses Role-Based Access Control (RBAC) consisting of Users, Roles, and Operations/Resources. Permissions are typically granted by assigning users to roles/groups, which in turn are granted access to resources. Starting from version 1.2, IBI also supports a hybrid mode where resources can be granted directly to users for greater flexibility in complex business scenarios.