Project Guides
Understanding Workbooks
Project Guides
Understanding Workbooks
Learn about workbooks, their statuses, and how they work in Lume
What are Workbooks?
A workbook represents a spreadsheet style view representing a single execution of a project with specific source data. When you create a new project and upload source data, Lume will start an initial run:
- Generate descriptions over the source data if none are provided
- Create mapping logic
- Validate the transformation
- Process your initial source data
A workbook contains model level metadat such as the status of the target model, number of mapped fields, test results, and current tracking of fields that have been reviewd.
Components of the Workbook
- Target Field - The name of the field
- Source Table - The source tables that were used to transform to the target field
- Source Field - The source fields that were used to transform to the target field
- Type - The type of the target field
- Nullable - If the field can be nullable or not
- Description - The description of the target field
- Current Transform - The set of actions taken to transform the source data into the target field
- Review Status - The user review status of the workbook
Workbook Review Status
A workbook has a review status to track the fields that have been manually checked. By default, the status will be NOT_REVIEWED.
| Status | Description |
|---|---|
NOT_REVIEWED | The field has not been confirmed |
FLAGGED | The field has been flagged to investigate deeper |
USER_APPROVED | The user provides a set of actions for the AI to take |
AI_APPROVED | The user approves the set of actions that the AI took to transform the data |
Target Model Statuses
Each model can have one of the following statuses:
| Status | Description |
|---|---|
success | The run completed successfully |
error | The run encountered errors during processing |
skipped | The run was skipped due to an upstream dependency issue |
partial success | The run completed with partial success |
no op | The run had no action taken |
Test Statuses
Each test for a field can have one of the following statuses:
| Status | Description |
|---|---|
pass | The test completed successfully |
error | The test encountered errors |
fail | The test failed the validation |
warn | The run completed with partial success |
skipped | The test was skipped due to an upstream dependency issue |
If a run fails, crashes, or is incomplete, please contact support.