Semantic models and BI tables

A semantic model is the layer that reports read from. Use this page to create a model, add tables from the Lake and the Warehouse, and set up their columns before you build reports on them.

Create a semantic model

  1. On the DataPrism home page, click New semantic model in the header. You can also click New > New semantic model in the workspaces panel, or right-click a folder and choose New semantic model here.
  2. Enter a Name, then choose an Owner role and a Data mode.
  3. Choose a Workspace, and optionally a Folder.
  4. Click Create.
SettingWhat it doesDefault
NameThe name of the model. Required.Empty
Owner roleThe role whose Lake and Warehouse tables the model's queries run against. The caption under the picker reads Queries run against this role's Lake and Warehouse tables. Required.None
Data modeClear Values reads original values, PII columns included. Tokenized PII reads tokenized stand-ins for PII columns.Clear Values
WorkspaceYour personal workspace or a role workspace. Required.The workspace you started from, otherwise your personal workspace
FolderA folder inside the workspace.Workspace root

While roles load, the picker reads Loading roles…; until you choose a role it keeps a Required chip. If none of your roles can own a model, the picker reads None of your roles can own a semantic model.

Note

Owner role and Data mode cannot be changed after creation. To query through another role or mode, create a new model.

To start from a file, choose Choose a .semanticModel file under Import from file. The submit button then reads Import semantic model, and the hint reads BI tables are matched by core table name in the owner role you pick; anything not found is skipped and listed. A picked file fills the Name only when you have not typed one, applies its data mode only when it carries Clear Values or Tokenized PII, and applies its owner role only when you can create models for that role. You see this field only with Edit DataPrism Semantic Model.

Add BI tables

A BI table is bound to one deployed Lake or Warehouse table that the owner role can see. You cannot write SQL for a BI table. To point it at another table, use Replace table with....

  1. Click Add BI table on the Diagram tab, or in the BI tables panel.
  2. Search with Search core tables.... The picker lists the Warehouse and Lake tables that the owner role can see. A table already in the model shows Added and cannot be picked again.
  3. Click a table, then click Add BI table.
  4. To add several tables, click Select multiple, tick the tables, and click Next. Each table gets a card marked Warehouse or Lake with its own name field. Fix any names in red, then click Add BI table or Add N BI tables.

If you pick a second table in single-table mode, Import more than one table? asks what to do: Select multiple keeps both tables and adds them together, and Replace selection keeps only the new table. The question appears at most once per attempt.

On the naming step, Only issues (N) narrows the list to tables with name problems, and Remove N with issues clears them. The footer counts N selected or Nothing selected. Names must be unique within the model; an error reads Name is required, Duplicate name in this selection or This model already has a table with this name, and the submit button stays disabled until every name is valid.

When you add several tables, some can succeed while others fail. A toast then reads Added N of M tables, and the picker stays open with only the tables that failed. If the request fails outright, you see Failed to add BI tables. A name that collides with a measure is refused: BI table name "<new>" collides with measure "<new>"; rename the measure first.

Inside a relationship dialog, Add new bi table starts the same picker for that model.

Find tables and columns in the panel

The BI tables panel lists every BI table with its columns. The search box Search BI tables, columns, or measures... matches a table's name, description or status, or a column's name or label. A matching table keeps all its columns; a match on a column alone prunes the table to the matching columns. Clear search empties the box.

Double-click a BI table to open it. Right-click a row for its menu (see below). A column turned off for reports appears faded, and its eye control reads Show in report or Hide from report. If you jump to a table or column from a report or from a suggestion, the panel expands to it and briefly pulses the row.

Select a BI table or a column on the diagram to see its details in the properties area under the panel: for a table, Source, Columns, Description, badges such as Core table, and a Relationships count; for a column, Type, DB type, Nullability, Summarization and the display fields. A description taken from the warehouse comment is marked (DWH comment).

Preview a BI table

Open the model's Preview tab, or select a BI table in the BI tables panel, to see its rows. A preview shows the first 100 rows and carries its own toolbar with search, column visibility and paging.

On the Preview tab each BI table has a card with a small preview that loads as you scroll to it; a card is a quick look and has no toolbar of its own. Until you select a table, the panel reads No BI table selected and Select a BI table from the side panel to preview it.

Manage a BI table

Right-click a BI table in the BI tables panel to open its menu. A table that is not published shows a Draft or Archived chip next to its name.

ItemWhat it does
OpenOpens the BI table.
Open and the table nameOpens the Lake or Warehouse table the BI table is bound to. Shown only when there is one.
PropertiesOpens the BI table on its Columns tab.
Replace table with...Points the BI table at another Lake or Warehouse table.
Add measureStarts a new measure on the model.
Copy nameCopies the BI table's name.
DeleteDeletes the BI table after you confirm.

A column has its own menu: Rename, Properties, Add measure, Copy name, and Copy label when it has a custom label.

Warning

Delete asks Delete BI table? and cannot be undone. Measures are not deleted with the table. A measure that can no longer run is marked invalid and left out of charts until you fix it. Check Health after you change tables.

In the model header, More actions offers Make a copy (if you can create models), Export .semanticModel, Update from file... and Type and version columns. For file workflows, see Model files and replacing a table. For column types and versions, see Check, document and trace a model.

Set up columns

Select a column in the BI tables panel. The column toolbar shows these controls.

ControlWhat it doesDefault
Display nameA label for the column. Clear it to show the column name again. You can also double-click a column's label in the panel to rename it; Enter saves and Escape cancels.The column name
SummarizeHow the column is aggregated. The options depend on its BI type. While it is unset the control reads Summarize by.The default for its BI type
Sort byOrders this column's values by another column, for example a month name by its month number. Only eligible columns are listed: not the column itself, and not one that already chains through another. Charts pick it up the next time they run a query.Its own values
In reportIncludes the column in reports. Turn it off to keep the column in the model but out of reports. Disabled for Rejected columns.On
FormatHow the values are displayed. The options depend on its BI type.The default format for its BI type

The Columns tab of the BI table popup shows the same settings for every column, including Label, Folder, Description, Summarization, Format and IR (Include in Report). Click Revert to discard unsaved changes in the popup.

Summarization by BI type

BI typeOptionsDefault
Whole Number, Decimal NumberSum, Average, Min, Max, Count, Count DistinctSum
Date, Date Time, TimeEarliest, Latest, Count, Count DistinctNone
DurationSum, Average, Min, Max, CountSum
BooleanCount, Count True, Count FalseCount
TextCount, Count Distinct, First, LastCount

None is available for every type. Rejected columns cannot be summarised.

Formats by BI type

BI typeFormats (default first)
Whole Number, Decimal NumberPlain; Currency; Percentage; Abbreviated
DateShort date; General; ISO; US; Medium; Long; Full; Month and year; Month and day; Quarter; Year; Custom
Date TimeShort date and time; Short date, no seconds; ISO; US, 12-hour; Medium; Long; Date only; Time only; Month and year; Quarter; Year; Custom
Time24-hour; 24-hour, no seconds; 12-hour; 12-hour, no seconds; Custom
BooleanTrue / False; Yes / No; On / Off; 1 / 0
DurationClock; Compact
Text, RejectedNo format. These columns cannot be formatted.

Some formats add options. Currency appears for the Currency format, with USD as the default currency. Decimals and Thousands separator apply to numbers, except that Decimals is hidden for Abbreviated. Pattern appears only for Custom.

Keep edits safe

Edits to a model carry the version you loaded. If someone else saved first, your change is refused and their work stays: This semantic model was changed by someone else. Choose Reload to see their version, or Overwrite to save yours.

The same check covers measures, BI tables, relationships and folders, each naming the object that changed.

Limits and edge cases

Permissions

PermissionWhat it allows
View DataPrism Semantic ModelsSee the semantic models you can reach.
Add DataPrism Semantic ModelCreate semantic models.
Edit DataPrism Semantic ModelChange BI tables and columns, and import a model from a file.

Which models you reach also depends on their workspace. See Who can do what in DataPrism.

Questions, answered

Can I write SQL for a BI table?

No. A BI table points at a Lake or Warehouse table. Shape the data there, or swap the source with Replace table with.... See Model files and replacing a table.

Why is a table I expect missing from the picker?

The table is not deployed, or the model's owner role cannot see it. Check the table in the Lake or the Warehouse, and check the role's access in Roles and permissions.

How do I add several tables at once?

Click Select multiple in the picker, tick the tables, and click Next. Give each table a name, then click Add N BI tables. If you pick a second table without multi-select on, Import more than one table? asks whether to keep both tables or replace the selection.

How do I sort month names in calendar order?

Select the month name column and set Sort by to the month number column. Charts pick this up the next time they run a query.

How do I hide technical columns from report authors?

Turn off In report for each column. The column stays in the model.

Why is the default summary of a date column None?

Date, Date Time and Time default to None. Choose Earliest, Latest or a count.

What happens to measures when I delete a BI table?

They are not deleted. A measure that can no longer run is marked invalid and left out of charts until you fix it. Check Health afterwards, and see Measures.

How do I change how a number is displayed?

Set Format in the column toolbar or on the Columns tab. Plain is the default for numbers. Choose Currency, Percentage or Abbreviated for other displays.

Where do I see the rows of a BI table?

Open the model's Preview tab, or select the table in the BI tables panel. The preview shows the first 100 rows; use its toolbar for search, column visibility and paging.

What does the Draft or Archived chip mean on a BI table?

It is the table's status. A table that is not published is marked Draft or Archived; a published table shows no chip.

Why can't I save a measure yet?

The model has no fact table yet: This semantic model has no fact table, so no measure can be saved yet. Set the fact table in the model editor first. Mark the core table, then save your measure. See Relationships and the core table.

Why did my edit fail with "This semantic model was changed by someone else."?

Someone else saved the model after you loaded it, so your change was not written and theirs was kept. Click Reload to see their version, or Overwrite to save yours.