Skip to main content

Business Data Dictionary

Business-focused documentation explaining the purpose and usage of each table and field in Axiom Genesis.


Tenant & User Management

app_tenants

Purpose: Defines organizations/companies using the platform. Each tenant is completely isolated from others.

Business Context: A tenant represents a customer organization. All data within the platform is segregated by tenant to ensure privacy and security.

FieldBusiness Purpose
tnt_tenant_codeUnique identifier used in URLs and API calls (e.g., "acme-corp")
tnt_tenant_nameDisplay name shown in UI (e.g., "Acme Corporation")
tnt_app_settingsTenant-specific configuration including theme colors, enabled features, and usage limits
tnt_statusWhether the tenant is active (1), temporarily disabled (0), or archived (-1)

Relationships:

  • Parent of all tenant-specific data
  • Referenced by {table}_tenant_id in every table

app_users

Purpose: Stores user accounts that can log into the platform.

Business Context: Users belong to a tenant and are assigned roles that determine their permissions.

FieldBusiness Purpose
usr_email_idLogin identifier and contact email
usr_first_name, usr_last_nameUser's display name
usr_app_settingsPersonal preferences (theme, language, notification settings)
usr_statusWhether user can login (1=Active, 0=Suspended)

Relationships:

  • Belongs to one tenant via usr_tenant_id
  • Can have multiple roles via role assignment table

Status Values:

ValueMeaningUser Experience
1ActiveCan login and access system
0InactiveCannot login, account suspended

app_roles

Purpose: Defines permission sets that can be assigned to users.

Business Context: Roles control what features and data users can access. A tenant can have custom roles beyond system defaults.

FieldBusiness Purpose
rol_codeIdentifier used in code and configuration (e.g., "admin", "viewer")
rol_permissionsJSON array of permitted actions (e.g., ["read:users", "write:users"])
rol_tenant_idNULL for system roles, tenant_id for custom roles

Common System Roles:

CodePurpose
super_adminFull system access
tenant_adminFull tenant access
userStandard user access
viewerRead-only access

Object & Configuration

app_object_registries

Purpose: Defines entity metadata - what tables exist and how to interact with them.

Business Context: The registry enables a metadata-driven architecture where new entities can be added through configuration rather than code changes.

FieldBusiness Purpose
obj_codeEntity identifier used in APIs (e.g., "users", "projects")
obj_type_codeWhether entity is a TABLE, VIEW, or FUNCTION
obj_connection_codeWhich database contains this entity's data
obj_payloadField definitions, relationships, and validation rules
obj_payload_object_nameActual database table name (e.g., "app_users")
obj_payload_column_prefixColumn naming prefix (e.g., "usr_")

Use Cases:

  1. Frontend reads registry to build forms dynamically
  2. API uses registry to validate requests
  3. DataView uses registry for grid column definitions

app_object_profiles

Purpose: Defines field-level security and data transformation rules.

Business Context: Profiles enable fine-grained access control - different users see different fields based on their role.

FieldBusiness Purpose
prf_codeProfile identifier used in API URLs
prf_obj_codeWhich entity this profile applies to
prf_mode_codeAccess mode (FULL, READ, WRITE, EXECUTE)
prf_policySecurity rules for projection, masking, and filtering

Policy Examples:

Policy TypeExampleResult
Projection (exclude)["password_hash", "salt"]Hide sensitive fields
Masking{"email": "partial"}Show "j***@example.com"
Row Filter{"department": "@user.department"}Only see own department

app_value_set

Purpose: Stores dropdown/picklist values for reuse across the application.

Business Context: Centralizes enum values so they can be updated in one place and reflected everywhere.

FieldBusiness Purpose
vst_codeValue set identifier (e.g., "status_codes", "priority_levels")
vst_valuesArray of value objects with value, label, and display order

Example Value Sets:

CodeValues
status_codesActive, Inactive, Archived
priority_levelsLow, Medium, High, Critical
task_typesBug, Feature, Enhancement, Task

UI/UX Configuration

app_page_configs

Purpose: Stores page/form layouts created in Page Designer.

Business Context: Enables no-code form building - business users can create and modify forms without developer involvement.

FieldBusiness Purpose
pgc_codePage identifier for URL routing
pgc_typePage type: form, dashboard, report, or content
pgc_obj_codeWhich entity this page displays/edits
pgc_configComplete page layout including fields, sections, and actions
pgc_versionVersion number for change tracking

Page Types:

TypePurposeExample
formData entryUser registration form
dashboardData visualizationSales KPI dashboard
reportFormatted outputInvoice template
contentStatic/dynamic contentHelp documentation

app_dataview_configs

Purpose: Stores data grid configurations for list/table views.

Business Context: Enables configurable data grids with filtering, sorting, and row actions.

FieldBusiness Purpose
dvc_codeDataView identifier for navigation
dvc_obj_codeWhich entity to display
dvc_configColumn definitions, filters, row actions, and styling

Configuration Options:

  • Column visibility and order
  • Default sorting and filtering
  • Row actions (view, edit, delete, custom)
  • Bulk actions
  • Export options

app_navigation_configs

Purpose: Defines the menu structure and navigation items.

Business Context: Controls what appears in the sidebar menu and where navigation leads.

FieldBusiness Purpose
nvc_codeNavigation item identifier
nvc_descriptionMenu item label shown to users
nvc_target_typeWhat type of target: DATAVIEW, PAGE, SECTION, document_renderer
nvc_target_codeWhich configuration to load when clicked
nvc_parent_codeParent menu item for hierarchy
nvc_iconIcon to display in menu
nvc_display_orderSort order within parent

Target Types:

TypeBehavior
DATAVIEWOpens data grid
PAGEOpens form/page
SECTIONExpandable menu group
document_rendererOpens document viewer
DASHBOARDOpens dashboard

Workflow Engine

app_workflow_configs

Purpose: Stores workflow definitions created in Workflow Designer.

Business Context: Enables visual workflow design for automating business processes.

FieldBusiness Purpose
wfc_codeWorkflow identifier
wfc_nameDisplay name
wfc_configWorkflow graph: nodes, edges, triggers, variables
wfc_versionVersion number (immutable after publish)
wfc_status1=Published, 0=Draft

Workflow Components:

  • Triggers: What starts the workflow (manual, scheduled, event)
  • Nodes: Actions to perform (API call, approval, notification)
  • Edges: Connections between nodes with conditions
  • Variables: Data passed between nodes

wft_instances

Purpose: Tracks running workflow executions.

Business Context: Every time a workflow runs, an instance is created to track its progress and state.

FieldBusiness Purpose
wfi_instance_codeUnique execution identifier
wfi_statusCurrent state of execution
wfi_current_nodeWhich node is currently executing
wfi_input_dataData provided when workflow started
wfi_output_dataResults produced by workflow
wfi_error_messageError details if workflow failed

Status Values:

StatusMeaning
pendingQueued, waiting to start
runningCurrently executing
pausedWaiting for external input (approval)
completedSuccessfully finished
failedError occurred
cancelledManually stopped

wft_logs

Purpose: Records detailed execution logs for debugging and audit.

Business Context: Provides visibility into what happened during workflow execution.

FieldBusiness Purpose
wfl_instance_idWhich instance this log belongs to
wfl_node_idWhich node generated this log
wfl_messageHuman-readable log message
wfl_levelSeverity: INFO, WARN, ERROR, DEBUG
wfl_dataAdditional structured data

Collaboration

apt_projects

Purpose: Organizes work into project containers.

Business Context: Projects can represent document collections, work initiatives, or any grouping of related items.

FieldBusiness Purpose
prj_codeProject identifier
prj_nameDisplay name
prj_slugURL-friendly version for routing
prj_doc_configDocument tree structure for documentation projects

Project Uses:

  • Document management (knowledge bases, wikis)
  • Task tracking
  • File organization
  • Team collaboration spaces

apt_files

Purpose: Stores metadata for uploaded files.

Business Context: Tracks files uploaded to the system, with actual file content stored in blob storage.

FieldBusiness Purpose
fst_project_idWhich project owns this file
fst_filenameOriginal uploaded filename
fst_mime_typeFile type (image/png, application/pdf, etc.)
fst_size_bytesFile size for quota tracking
fst_blob_urlURL to retrieve file from storage

Enum Reference

Status Codes (Universal)

ValueNameDescription
1ActiveNormal operational state
0InactiveTemporarily disabled
-1ArchivedHistorical, read-only

Workflow Instance Status

ValueNameNext States
pendingPendingrunning, cancelled
runningRunningpaused, completed, failed, cancelled
pausedPausedrunning, cancelled
completedCompleted(terminal)
failedFailed(terminal)
cancelledCancelled(terminal)

Page Types

ValueNameUse Case
formFormData entry/editing
dashboardDashboardVisualizations
reportReportFormatted output
contentContentStatic pages
ValueNameOpens
DATAVIEWData ViewData grid
PAGEPageForm/page
SECTIONSectionMenu group
document_rendererDocumentDocument viewer
DASHBOARDDashboardDashboard page

See Also