Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

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

When you create a workbook or add a new query tab, you’ll be prompted to select a starting point for the query. The All Views & Fields view will display the topics you have access to in the model that the workbook is based on.

​
Using topics in queries

Workbook queries can be used to create dashboard visualization tiles. If you intend to create and share a dashboard of your work with Restricted Queriers and Viewers, keep in mind that these users can only see dashboard tiles built on topics unless AccessBoost is enabled. Refer to the AccessBoost guide for more information.

​
Switching topics

To change topics in a query tab, use the topic switcher in the top left corner of the field browser. Select the topic you want to use, which will populate the field browser with the topic’s tables and fields. Example topics with labels, descriptions, and groups

​
Using multiple topics

A query can only use a single topic at a time. However, depending on your needs, there are a few workarounds that may be useful. Start your analysis in the topic that best matches your use case. Then:
  • Consider adding a new join path to data that isn’t included in the topic yet, or
  • If there isn’t a clear relationship, consider using XLOOKUPs or a spreadsheet tab to combine multiple queries into a final output
Note: While a query can only be tied to one topic, you can use multiple topics in a single document by adding multiple queries. The topics must exist in the model that the workbook is built on.

​
Querying with AI

If the Workbook Agent is enabled in your Omni instance, you can use the agent to query topics using natural language. Click the ✨ icon in the left navigation in the workbook to open the chat panel. Refer to the Building queries & filters with AI guide for more tips on using the Workbook Agent.

​
Editing topics in the workbook

To make changes to a query’s current topic, you can do either of the following:
  • Click Model > Edit topic
  • Click the icon and then select Edit topic from the context menu
Both of these options will open the topic in the topic editor. You can also use icon > Go to definition, which opens the topic’s YAML file in the model IDE in a new tab. Refer to the Creating topics guide for more information about the workbook-based topic editor.

​
Creating topics from queries

Queries created using All Views & Fields can be converted into topics to enable reuse. In a query tab, click Model > Save as topic. This will open the topic editor, where some information - such as in-use fields - will be automatically populated using metadata from the query. Refer to the Creating topics guide for more information about the workbook-based topic editor.