Account
Skip to main content

Getting Started in File Mode

A repository workspace is a BimlFlex workspace whose metadata is kept as files in a git repository. The File-Mode Metadata page explains the model behind it. This page covers the default settings of a repository workspace and the sample projects you can open from it.

Load the default settings​

When your repository workspace has no settings, BimlFlex tells you to load its defaults. The getting started recommendation on the dashboard says so, and so does the build readiness row for settings.

Load Defaults is offered in three places:

  • The More Actions menu on the dashboard
  • The getting started recommendation
  • The command palette

Load Defaults lists the eight platform Starting Points:

  • 00.01 - MSSQL SSIS Starting Point
  • 00.02 - MSSQL ADF Starting Point
  • 00.03 - Synapse SSIS Starting Point
  • 00.04 - Synapse ADF Starting Point
  • 00.05 - Azure SQLDB ADF Starting Point
  • 00.10 - Snowflake SSIS Starting Point
  • 00.11 - Snowflake ADF Starting Point
  • 00.15 - Databricks ADF Starting Point

The Sample Metadata page describes each Starting Point. The 00.02 - MSSQL ADF Starting Point is the default.

When you choose a Starting Point and confirm, BimlFlex seeds your workspace's settings from it. Every setting the Starting Point carries is written with the Starting Point's value, and only those settings are replaced. A sensitive setting is written without a value.

If you load defaults again, every setting the Starting Point carries is rewritten, and a value you entered on a sensitive setting is cleared.

Open a sample project​

In a repository workspace, the samples gallery lists the samples bundled with your installation of BimlFlex. Each sample is converted into a file-format repository of its own. The Sample Metadata page describes the sample sets.

When you open a sample from the gallery, the Open Sample confirmation asks for a parent folder, which is required. BimlFlex copies the sample into a new git repository of your own, in a folder named after the sample inside that parent folder. The new repository starts with one commit on main. BimlFlex connects it the way it connects any repository and opens it on Sample Home.

A sample is never written into the workspace you have open.

You can reach the samples from several places. The first-build checklist offers Open a sample project, the dashboard offers Open Sample Project, and the journey cards on the dashboard lead to the samples gallery.

Working in a database workspace​

A database workspace loads sample metadata into your selected version as the Sample Metadata page describes, and loads its defaults as the Dashboard page describes.

Next steps​