Skip to content

Commit

Permalink
Update Roadmap, XLMA Workaround & TMDL overview (#128)
Browse files Browse the repository at this point in the history
* Update the workaorund to include a specification of how to use TMDL instead of the .bim file

* Update roadmap and remove references to TMDL preview



---------

Co-authored-by: Daniel Otykier <[email protected]>
  • Loading branch information
mlonsk and otykier authored Nov 21, 2024
1 parent 3d1a195 commit b08d772
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 20 deletions.
15 changes: 4 additions & 11 deletions te3/features/tmdl.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,9 @@ applies_to:

**TMDL** is a model metadata file format [announced by Microsoft in April 2023](https://powerbi.microsoft.com/en-ie/blog/announcing-public-preview-of-the-tabular-model-definition-language-tmdl/). It aims to provide a human-readable, text-based alternative to the JSON-based model.bim file format. TMDL is inspired by YAML, and as such, is easy to read and write, with minimal use of string quotes and escape characters. It also serializes a model as several smaller files in a folder structure, and is therefore also better suited for version control integration.

> [!IMPORTANT]
> As of February 2024, TMDL is still a preview feature. It is currently only supported by community tools such as Tabular Editor and [pbi-tools](https://pbi.tools/). However, the format is fully documented and available through [Microsoft-provided nuget packages](https://www.nuget.org/packages/Microsoft.AnalysisServices.Tabular.Tmdl.retail.amd64/19.64.0-TmdlPreview).
## Enabling TMDL in Tabular Editor 3

> [!TIP]
> Since TMDL is a preview feature, breaking changes could be introduced between new releases of Tabular Editor. If you face any issues deserializing a model after upgrading Tabular Editor, rollback to the latest version of Tabular Editor, then temporarily save the model as a regular .bim file, before serializing it to TMDL again using the latest version of Tabular Editor.

## Enabling TMDL (Preview) in Tabular Editor 3

TMDL is only available as a preview feature in Tabular Editor 3. To enable TMDL (Preview) in Tabular Editor 3, go to **Tools > Preferences > File Formats > Save-to-folder**, and select "TMDL (preview)" in the **Serialization mode** dropdown. The legacy "save-to-folder" functionality will continue to exist side by side with TMDL, but is not a Microsoft supported format.
To enable TMDL in Tabular Editor 3, go to **Tools > Preferences > File Formats > Save-to-folder**, and select "TMDL" in the **Serialization mode** dropdown. The legacy "save-to-folder" functionality will continue to exist side by side with TMDL, but is not a Microsoft supported format.

After doing so, Tabular Editor 3 will use the TMDL format when saving a model as a folder (**File > Save to folder...**).

Expand All @@ -38,5 +31,5 @@ When saving a new model for the first time, Tabular Editor (since v. 3.7.0), wil

# Next steps

- [TMDL overview (Microsoft Learn)](https://learn.microsoft.com/en-us/analysis-services/tmdl/tmdl-overview?view=asallproducts-allversions).
- [Get started with TMDL (Microsoft Learn)](https://learn.microsoft.com/en-us/analysis-services/tmdl/tmdl-how-to?view=asallproducts-allversions)
- [TMDL overview (Microsoft Learn)](https://learn.microsoft.com/en-us/analysis-services/tmdl/tmdl-overview).
- [Get started with TMDL (Microsoft Learn)](https://learn.microsoft.com/en-us/analysis-services/tmdl/tmdl-how-to)
26 changes: 19 additions & 7 deletions te3/other/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ updated: 2024-09-06

Below is an overview of major new features to be shipped with Tabular Editor 3 updates in the short- to long term:



# [Planned 2024](#tab/PlannedQ4)

- More Daxscilla code refactoring options and automatic suggestions (for example, replace identical subexpressions with
a variable)
- TMDL GA Support
- Diagram Improvements
- GA of DAX Optimizer Integration
- Data Refresh View Improvements
- Power Query (M) Highlighting


## Shipped in 2024
✅ DAX Debugger Locals Enhancement
Expand All @@ -23,14 +23,26 @@ a variable)
✅ .Net 8 migration
✅ Pivot Grid Enhancement
✅ DAX Query Enhancement
✅ TMDL GA Support
✅ Code Actions
✅ GA of DAX Optimizer Integration

# [Planned 2025](#tab/Planned2025)

- Adding more Macro Actions
- Built in Best Practice Rules
- Built in Macros
- Power Query (M) Auto-Formatting

# [Future Features](#tab/FutureFeatures)

## Up Next
- Localization
- Power Query (M) Editing Enchantments
- Macro Actions improvements such as automatic application across model and preferences for which to apply.

## Non Planned Features
- Localization
- Built in Macros and Best Practice Rules

- Standalone CLI application
- Git integration
- DAX Debugger Filter Context visualizer
Expand Down
8 changes: 6 additions & 2 deletions te3/powerbi-xmla-pbix-workaround.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,14 @@ In Tabular Editor using _File > Save as..._, navigate to the Power BI Project fo

This will save the remote model into the Power BI Project that will now contain the model metadata.

If the .pbip folder is configured to store the model as [TMDL](xref:tmdl) files, you will need to use the Save To Folder option in Tabular Editor instead. Then navigate to the Power BI project folder for the semantic model (ModelName.SemanticModel), open the 'definition' folder and save your model there.

> [!NOTE]
> To enable TMDL go to **Tools > Preferences > File Formats > Save-to-folder**, and select "TMDL" in the **Serialization mode** dropdown. See [TMDL documentation for more information](xref:tmdl)
## Step 3.1: Remove incremental refresh partitions and create new (Optional)
Use the Convert Incremental Refresh script below to delete incremental refresh partitions and create a single partition for each table containing the expression used in the incremental refresh expression.


## Step 4: Save to .pbix and open this file in Power BI Desktop

![PBIP with Tables](~/images/power-bi/pbip-includes-tables.png)
Expand All @@ -60,7 +64,7 @@ Save it to a .pbix using _File > Save As..._ in Power BI Desktop.
The .pbix now contains the model that was published to the Fabric workspace. When you open the .pbix, you can _re-hydrate_ the file, meaning that you load the data based on the connections specified in the model.

## Convert Incremental Refresh partitions
The above step 4 will fail if the semantic model has incremental refresh enabled as a Power BI desktop model cannot contain multiple partitions.
The above step 4 will fail if the semantic model has incremental refresh enabled as a Power BI desktop model cannot contain multiple partitions.
In this case the following script should be run against the model to convert incremental refresh partitions into single partitions


Expand Down

0 comments on commit b08d772

Please sign in to comment.