Skip to main content

Velox Data Knowledge Map

This repository owns the VxData / Velox Data Platform database scripts, integration schemas, JSON examples, demo data, and manual operational SQL notes. It is not an application code repository; the main "classes" are database objects and contract files.

Complexity is estimated from schema breadth, coupling to application code, upgrade risk, data migration risk, and number of dependent transaction models. When behavior is not visible from scripts alone, it is marked as unclear.

Database Build Scripts​

Purpose:

  • Creates the VxData database schema from SQL scripts.
  • Defines core tables, functions, views, triggers, indexes, and default setup data used by Velox products.

Main classes:

  • No source classes.
  • Primary artifacts are Table_*.sql, Function_*.sql, View_Core.sql, Trigger_Core.sql, Index_Core.sql, _Master.sql, and _Default Setup Script.sql.
  • Major object groups include application/reference tables, party/address/product tables, transaction tables, event/issue tables, and ASP.NET Identity tables.

Dependencies:

  • SQL Server.
  • SQLCMD or equivalent SQL execution tooling.
  • Application expectations from velox, velox-web, and velox-web2.
  • Install packaging in Install\ProgramData\install-veloxdb.

Important entry points:

  • 1. Database\_Master.sql
  • 1. Database\_Default Setup Script.sql
  • 1. Database\__run.bat
  • 1. Database\Table_*.sql

Important configuration:

  • Database name, server, and credentials are provided by the operator or wrapper command.
  • The scripts assume SQL Server behavior; the repository guidance says SQL Server 2025 is the target.
  • Exact customer-specific setup values are unclear unless supplied outside this repository.

Related documentation:

  • architecture.md
  • AGENTS.md
  • Find foreign key constraints.txt
  • Party Tables.docx

Estimated complexity: High

Schema Upgrade Scripts​

Purpose:

  • Captures incremental database changes after the base schema.
  • Provides versioned upgrade scripts for existing deployments.

Main classes:

  • No source classes.
  • Primary artifacts are Upgrade v1.*.sql scripts and zzz TO DO.sql.

Dependencies:

  • Existing VxData database state.
  • Correct execution order and compatible application binaries.
  • Manual operator discipline; no automated migration runner is visible in this repository.

Important entry points:

  • 2. Upgrades\Upgrade v1.1.sql
  • 2. Upgrades\Upgrade v1.18 - tidy.sql
  • 2. Upgrades\zzz TO DO.sql

Important configuration:

  • Target database connection context.
  • Current installed schema version; exact version tracking mechanism in VxData scripts is unclear from this repository alone.
  • Upgrade order appears filename-based.

Related documentation:

  • architecture.md
  • AGENTS.md

Estimated complexity: High

Core Reference and Platform Tables​

Purpose:

  • Defines shared reference/configuration data used across transactions and web applications.
  • Supports applications, interfaces, partners, sources, settings, statuses, users, roles, tallies, autonumbers, and Velox flow metadata.

Main classes:

  • No source classes.
  • Important table scripts include Table_Application.sql, Table_Interface.sql, Table_Partner.sql, Table_Source.sql, Table_Setting.sql, Table_Tally.sql, Table_User.sql, Table_VeloxFlow.sql, Table_ASPNetIdentity.sql, and Table_System_Version.sql.

Dependencies:

  • SQL Server relational constraints.
  • ASP.NET Identity models in velox-web and velox-web2.
  • Velox flow/API configuration from velox.
  • Web repository services and repositories.

Important entry points:

  • 1. Database\Table_Application.sql
  • 1. Database\Table_Interface.sql
  • 1. Database\Table_Setting.sql
  • 1. Database\Table_User.sql
  • 1. Database\Table_VeloxFlow.sql

Important configuration:

  • Default setup rows in _Default Setup Script.sql.
  • Identity and user-party relationships.
  • Application/interface codes must align with code constants and documentation; mismatches are a high-risk area.

Related documentation:

  • architecture.md
  • ..\velox-web\KNOWLEDGE_MAP.md
  • ..\velox-web2\KNOWLEDGE_MAP.md

Estimated complexity: Medium

Party, Address, Product, and Master Data​

Purpose:

  • Models reusable master data for parties, roles, addresses, regions, zones, cities, suburbs, products, units of measure, quantities, and pricing.
  • Provides the common lookup foundation for transaction processing and portal administration.

Main classes:

  • No source classes.
  • Important table scripts include Table_Party.sql, Table_Address.sql, Table_Country.sql, Table_Product.sql, Table_Tax.sql, and related lookup scripts.
  • Related JSON/XSD contracts include Party.xsd, Product.xsd, ProductQty.xsd, and ProductPrice.xsd.

Dependencies:

  • Transaction tables reference party/product/address data.
  • velox-web repositories/services expose CRUD and lookup UI for these objects.
  • velox-web2 EF models mirror many of these tables.
  • Excel import templates in Install and source install packages depend on these fields.

Important entry points:

  • 1. Database\Table_Party.sql
  • 1. Database\Table_Address.sql
  • 1. Database\Table_Product.sql
  • 3. Velox Schema\Party.xsd
  • 3. Velox Schema\Product.xsd

Important configuration:

  • Role/type/status codes.
  • Cross-reference and mapping tables.
  • Required/default fields for imports are partly implied by scripts and examples; some validation rules are implemented in application code outside this repository.

Related documentation:

  • architecture.md
  • Party Tables.docx
  • Creating data manually ie parties\Create Master Data.txt

Estimated complexity: High

Transaction Data Models​

Purpose:

  • Defines operational transaction tables for order, ASN, invoice, shipment, POD/tracking, remittance, adjustment, booking, pre-advice, container movement, and related lines/events/issues.
  • Provides the central data platform for integrations and portal workflows.

Main classes:

  • No source classes.
  • Important table scripts include Table_Order.sql, Table_ASN.sql, Table_Invoice.sql, Table_Shipment.sql, Table_Remittance.sql, Table_Adjustment.sql, Table_Booking.sql, Table_PreAdvice.sql, and Table_Container.sql.
  • Related contract files include Order.xsd, ASN.xsd, Invoice.xsd, Shipment.xsd, POD.xsd, Remittance.xsd, PreAdvice.xsd, Booking.xsd, and JSON examples.

Dependencies:

  • Master data subsystem.
  • Event/issue subsystem.
  • Velox mapping/file engines.
  • Web portal transaction screens and API surfaces.
  • External trading partners using schema contracts.

Important entry points:

  • 1. Database\Table_Order.sql
  • 1. Database\Table_ASN.sql
  • 1. Database\Table_Invoice.sql
  • 1. Database\Table_Shipment.sql
  • 3. Velox Schema\*.xsd
  • 4. Velox JSON\*.json

Important configuration:

  • Transaction type and status values.
  • Interface/application/source mappings.
  • Event/issue behavior is partly driven by application code and is unclear from SQL scripts alone.

Related documentation:

  • architecture.md
  • 3. Velox Schema\Shipment Specification v1.1.xlsx
  • 3. Velox Schema\POD Specification v1.xlsx

Estimated complexity: High

Events, Issues, Interchange, Mapping, and Web Hooks​

Purpose:

  • Captures processing events, integration interchanges, issue tracking, mapping data, uploads, cache state, and webhook delivery metadata.
  • Supports auditability and operational review across Velox integrations.

Main classes:

  • No source classes.
  • Important table scripts include Table_Events.sql, Table_Issue.sql, Table_Interchange.sql, Table_Mapping.sql, Table_Upload.sql, Table_WebHook.sql, and Table_Cache.sql.

Dependencies:

  • Transaction tables.
  • Velox log/action execution architecture.
  • velox-web webhook and administration services.
  • velox-web2 dynamic API/proxy models.

Important entry points:

  • 1. Database\Table_Events.sql
  • 1. Database\Table_Issue.sql
  • 1. Database\Table_Interchange.sql
  • 1. Database\Table_Mapping.sql
  • 1. Database\Table_WebHook.sql

Important configuration:

  • Event type/status/source codes.
  • Webhook endpoint/authentication data, if represented in database rows.
  • Exact retry and failure behavior is unclear from this repository alone.

Related documentation:

  • architecture.md
  • Deleting records\Deleting trans.txt
  • Deleting records\Clear config logs.txt

Estimated complexity: High

XML Schema Contracts​

Purpose:

  • Defines XML integration contracts for Velox messages and shared types.
  • Documents the structure expected by mapping, file definition, and partner integration flows.

Main classes:

  • No source classes.
  • Primary artifacts are .xsd files under 3. Velox Schema.
  • Key schemas include Common.xsd, Application.xsd, InterfaceSettings.xsd, transaction schemas, and demo schemas.

Dependencies:

  • Velox Designer XSD tooling and file definitions.
  • VxData table structure.
  • External systems exchanging XML with Velox.
  • Install packaging under Install\ProgramData\install-veloxschema.

Important entry points:

  • 3. Velox Schema\Common.xsd
  • 3. Velox Schema\Shipment.xsd
  • 3. Velox Schema\Order.xsd
  • 3. Velox Schema\Demo

Important configuration:

  • Namespace/versioning policy is unclear from the repository.
  • Schema field names must stay aligned with database and mapping logic.

Related documentation:

  • architecture.md
  • 3. Velox Schema\Shipment Specification v1.1.xlsx
  • 3. Velox Schema\POD Specification v1.xlsx

Estimated complexity: Medium

JSON Examples and Contracts​

Purpose:

  • Provides JSON examples or lightweight contracts for selected Velox transaction/API payloads.
  • Supports API/webhook development and partner-facing examples.

Main classes:

  • No source classes.
  • Primary artifacts are JSON files under 4. Velox JSON.

Dependencies:

  • VxData schema.
  • velox-web2 OpenAPI/API payload handling.
  • Install packaging under Install\ProgramData\install-veloxschemajson.

Important entry points:

  • 4. Velox JSON\Shipment.json
  • 4. Velox JSON\POD.json
  • 4. Velox JSON\ShipmentResponse.json
  • 4. Velox JSON\ShipmentTracking.json
  • 4. Velox JSON\MappingData.json

Important configuration:

  • JSON schema/versioning rules are unclear; files appear to be examples rather than formal JSON Schema documents.
  • Field meaning must be cross-checked with SQL and application code.

Related documentation:

  • architecture.md
  • ..\velox-web2\KNOWLEDGE_MAP.md

Estimated complexity: Medium

Demo Data and Manual Operations​

Purpose:

  • Provides demo setup, test data, date-rolling, log clearing, manual party creation, and delete/cleanup notes.
  • Helps developers/operators create known data states.

Main classes:

  • No source classes.
  • Primary artifacts are SQL scripts and text notes under Demo, Deleting records, and Creating data manually ie parties.

Dependencies:

  • Existing database schema.
  • Manual operator review before execution.
  • Demo partner/customer assumptions that are not fully explained in code.

Important entry points:

  • Demo\_MASTER DEMO.sql
  • Demo\Create demo data for Strait.sql
  • Demo\Create test data.sql
  • Demo\Roll demo transaction dates.sql
  • Deleting records\Deleting trans.txt
  • Creating data manually ie parties\Create Master Data.txt

Important configuration:

  • Target database connection and current data state.
  • Some scripts are destructive or data-shaping by nature; run only with explicit intent.

Related documentation:

  • architecture.md
  • AGENTS.md

Estimated complexity: Medium

Install Synchronization Scripts​

Purpose:

  • Copies or updates database/schema/JSON install assets into the Install repository.
  • Keeps source data contracts and deployment packages in sync.

Main classes:

  • No source classes.
  • Primary artifacts are update batch files at the repository root.

Dependencies:

  • Local checkout layout under C:\_GIT\Velox.
  • Install repository/folder availability.
  • Windows batch/copy behavior.

Important entry points:

  • _UPDATE DB INSTALL FOLDER.bat
  • _UPDATE SCHEMA INSTALL FOLDER.bat
  • _UPDATE JSON INSTALL FOLDER.bat
  • _Update VeloxDB to GIT.bat
  • _Update VeloxSchema to GIT.bat
  • _Update VeloxSchemaJSON to GIT.bat

Important configuration:

  • Hard-coded or assumed relative paths are likely; exact script behavior should be reviewed before execution.

Related documentation:

  • architecture.md
  • Install PKB documentation is not currently present under velox-kb\VeloxPKB\docs\

Estimated complexity: Medium