Skip to main content

Model File

Topics are not the only object in the model file, the model file also holds model-wide configuration for a given analytical environment.

Example Model File

Examples of model file metadata:

auto_run: true

ignored_schemas:
- dbt_test1
- dbt_test2

included_schemas:
- public
- core_data

ignored_schemas:

ignored_schemas:
- dbt_test1
- dbt_test2
  • This will exclude schemas that would be available in the workbook experience
  • Note ignored schemas will still be available to query in SQL
  • Omni expects a list either in brackets (comma delimited) or bulleted, tabbed list

included_schemas:

included_schemas:
- public
- core_data
  • This will explicit include only schemas listed in the workbook experience
  • Note schemas excluded from this list will still be available to query in SQL
  • Omni expects a list either in brackets (comma delimited) or bulleted, tabbed list

auto_run:

auto_run: false
  • This will force all queries to require a run click to return new results
  • This may be a good option is there are concerns on cost running queries as you build queries, but will reduce UI interactivity

week_start_day:

week_start_day: Sunday
  • This will set all weeks to start on the given day of week, rather than the default (Monday)
  • Will impact OMNI_WEEK() and OMNI_DAY_OF_WEEK_NUMBER()

fiscal_month_offset:

fiscal_month_offset: 11
  • This will set a fiscal calendar in Omni, enabling modelers to add fiscal time metrics to all time dimension groups and to the filter UX
  • Positive month offset will set a fiscal calendar in front of the Gregorian calendar date
    • For example: if your next fiscal year starts in February for Y+1, set the offset to 11 (ie first month of FY 2024 = Feb 2023)