Skip to content

Entity Management

Entities are the building blocks of master data in EntiHub: one YAML definition per business concept, deployed as real tables in your warehouse with optional approval and history.

What is an entity

  • An entity represents a single business concept such as Customer, Product, Supplier, or CostCenter.
  • It is described in a YAML document stored in the configuration schema and versioned through deploy history.
  • When you deploy, EntiHub materializes the definition into physical tables in EntityDataSchema.
  • System columns such as _sys_id, _sys_created_at, _sys_last_modified_at, and _sys_is_deleted are added automatically and are never declared in YAML.

YAML editor

The entity configuration page provides:

  • Syntax-highlighted YAML editor.
  • Fullscreen mode.
  • Built-in documentation panel.
  • Server-side validate action.
  • Dirty-check to prevent deploy until changes are saved.

Actions menu

Admin users can:

  • Validate
  • Deploy
  • Preview re-deploy
  • Re-deploy
  • Remove deployment
  • Delete archive tables
  • Delete entity
  • View deploy history
  • Open API reference

YAML structure

Metadata

name: customer
displayName: Customer
domain: Finance
access:
  mode: restricted
description: Master data for customers and business partners.
version: "1.0.0"

Features

approvalRequired: true
allowSameAuthorApproval: false
historyEnabled: true
deletedRetentionDays: 30

Sorting

sortColumns:
  - column: name
    direction: asc
displayRefColumn: name

Unique constraints

uniqueConstraints:
  - name: customer_code_unique
    columns: [code]

Consumption views

consumption:
  views:
    - schema: mdm_consume
      name: vw_customer
      apiName: customer
      includeDeleted: false
      includeSystemColumns: false
      columns: [code]

similarity:
  enabled: true
  topN: 10
  minScore: 0.3
  columns:
    - name: code
      weight: 0.6
      matchMode: fuzzy

Aliases

aliases:
  enabled: true

Columns

Supported column data types:

  • string
  • int
  • long
  • decimal
  • bool
  • date
  • datetime
  • guid

Typical column definition:

columns:
  - name: code
    displayName: Customer Code
    dataType: string
    nullable: false
    maxLength: 20

Deploy and redeploy

  • Deploy creates physical tables for edit, approved, and optional history data.
  • Re-deploy previews and then applies structural changes.
  • Removing columns or making incompatible type changes should be tested outside production first.