Publishing a Data Block in Assette is a crucial step in making it usable within Data Objects and other components. This process ensures that the block is complete, structurally sound, and all required fields and dependencies are in place. This article provides a detailed guide to publishing Data Blocks successfully, including mandatory fields, validation logic, and how to handle dependency relationships.
Prerequisites for Publishing #
Before a Data Block can be published, several fields and configurations must be completed. The following are mandatory:
| Requirement Area | Field | Required | Description |
|---|---|---|---|
| Basic Metadata | Name | Yes | Unique identifier for the Data Block. |
| Block Category | Yes | Defines the purpose of the block (e.g., Configuration, Transform, Interface). | |
| Block Type | Yes | Execution type or logic method (e.g., Python, Constant, API Call). | |
| Output Type | Yes | Defines the data output format (e.g., table, text, variable). | |
| Columns (if added) | Column Name | Yes | Technical name of the column used in logic or output. |
| Data Type | Yes | Type of data (e.g., string, number, date). | |
| Display Name | Yes | User-friendly label shown in output and interfaces. | |
| Request Parameters (if added) | Name | Yes | Identifier for the input parameter. |
| Data Type | Yes | Type of value expected (e.g., string, boolean, number). | |
| Display Name | Yes | Label displayed when configuring or using the parameter. | |
| Output Variables (if added) | Name | Yes | Identifier for the output variable. |
| Data Type | Yes | Expected data type (e.g., number, string). | |
| Display Name | Yes | Label used in documentation and display. | |
| Definition | Data Block Definition | Optional* | Not required to publish, but essential for execution and functional output. |
Saving vs. Publishing #
- Saving: Always save your Data Block before previewing it. If you fail to save before preview, any recent edits will not be captured or reflected during preview.
- Previewing: You may preview a Data Block after saving, even if it has not yet been published.
- Publishing: Required to make the Data Block usable in Data Objects. Unpublished blocks are invisible to the Data Object configuration interface.
Working with Data Blocks #
To ensure stable and valid references, any Data Block being used as a dependency must already have at least one published version. This ensures that only tested and stable blocks are available for reference.
When selecting dependencies while creating or editing a Data Block, the dependency selection list will only show blocks that meet this requirement. This helps maintain data integrity and prevents referencing incomplete or untested components.
Dependency Validation #
- Only published Data Blocks can be used as dependencies. When adding a dependency, the selection list will only show blocks that already have at least one published version.
- Publishing will not proceed if a referenced block is unpublished. This validation helps ensure that all dependencies are fully functional and stable.
Note: A Data Block must be published before it can be used in a Data Object or referenced by another Data Block. Be sure to publish any dependent blocks first.