Control Framework Registration (v2)
Purpose
Section titled “Purpose”Generates a deployment script that registers data logistics processes with the DIRECT Framework, using a structured registration pattern that supersedes the v1 Control Framework Registration.
Motivation
Section titled “Motivation”The v1 registration template emits a flat list of RegisterBatch / RegisterModule calls. The v2 template wraps those in a richer structure designed for larger projects:
- Project-level Batch hierarchy — A root Batch represents the project, with child Batches per data flow.
- Result-table tracking — All registration calls write their
@SuccessIndicatorand message log into an in-memory@ResultTable, making it straightforward to audit which registrations succeeded after the script completes. - Per-table module pairs — For each table participating in the load, the template registers two paired modules — one for the SQL extract pipeline, one for the notebook-driven PSA persistence step. This pattern is aimed at hybrid SQL + PySpark deployments.
Applicability
Section titled “Applicability”- All design metadata.
- SQL Server family (the registration calls target the DIRECT
omdschema on SQL Server / Azure SQL). - Use when your data flow involves both pipeline-driven extracts and notebook-driven processing — most commonly a Microsoft Fabric deployment.
Design Pattern
Section titled “Design Pattern”N/A — operational metadata registration.
Schema Type
Section titled “Schema Type”- All Metadata
Output Type
Section titled “Output Type”- SQL
Implementation guidelines
Section titled “Implementation guidelines”This template is intended to be assigned to the project as a whole rather than to a particular Data Object. It walks the project’s ordered list of Data Objects and emits the matching registration calls for each.
Considerations and consequences
Section titled “Considerations and consequences”- The registration logic is idempotent at the call level — re-running the generated script will refresh registrations, not duplicate them. Verify by inspecting the
@ResultTableoutput after the run. - The template assumes a Project / Batch / Module hierarchy. If your DIRECT installation uses a flatter model, prefer the v1 template.
- This template currently ships with the Microsoft Fabric PSA sample.
Extensions
Section titled “Extensions”The template uses the standard control-framework conventions (controlFrameworkDatastore, controlFrameworkLocation). It also reads datastore and location extensions on the Data Connection of each Data Object to qualify executable names.