Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lume.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
What are Workbooks?

A workbook represents a spreadsheet style view representing a single version of a project. When you create a new project and upload source data, Lume will start an initial run:
  1. Generate descriptions over the source data if none are provided
  2. Create mapping logic
  3. Validate the transformation
  4. Process your initial source data
A workbook contains model level metadata such as the status of the target model, number of mapped fields, test results, and current tracking of fields that have been reviewd. Workbook View

​
Components of the Workbook

  1. Target Field - The name of the field
  2. Source Table - The source tables that were used to transform to the target field
  3. Source Field - The source fields that were used to transform to the target field
  4. Type - The type of the target field
  5. Nullable - If the field can be nullable or not
  6. Description - The description of the target field
  7. Enums - The number of enum values for a target field
  8. Transform - The set of actions taken to transform the source data into the target field
  9. 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.
StatusDescription
NOT REVIEWEDThe field has not been confirmed
FLAGGEDThe field has been flagged to investigate deeper
PROPOSEDThe user proposes a set of actions for the AI to take but may not be final
APPROVEDThe user approves the set of actions that the AI took or user provides the final approval

​
Target Model Statuses

Each model can have one of the following statuses:
StatusDescription
successThe run completed successfully
errorThe run encountered errors during processing
skippedThe run was skipped due to an upstream dependency issue
partial successThe run completed with partial success
no opThe run had no action taken

​
Test Statuses

Each test for a field can have one of the following statuses:
StatusDescription
passThe test completed successfully
errorThe test encountered errors
failThe test failed the validation
warnThe run completed with partial success
skippedThe test was skipped due to an upstream dependency issue
If a run fails, crashes, or is incomplete, please contact support.