The features mentioned in this article require a Data Governance license.
Pages extend documentation beyond the object level with rich text full-length content, embedded objects, styling, and formatting. Pages allow teams to maintain project-level overviews of things like metrics and KPI definitions, business terms, and operational outlines.
To create, edit, or modify Pages, a user requires a Governance role to be assigned. Without the Governance role, users, including modelers, are given read-only access to Pages.
Pages can be found in SqlDBM's left-hand menu. Click on the text icon ("Data governance pages") to access the Pages screen. The screen is divided into the following sections
Navigation - all pages are visible here, organized in a parent/child format.
Top bar - provides formatting and styling options for the content in the body
Body - contains the page content for viewing or editing
Properties - panel containing the page name and dynamic summaries and references to page contents
Creating and organizing pages
From the navigation pane, users can create, remove, and clone their pages.
Create - create a top-level page by clicking the plus (+) icon next to "Pages". To create a child page, click on the three-dot icon next to the desired page in the navigation and click "Add child page"
Clone - Click on the three-dot icon next to the page you wish to clone and select "Clone page"
Delete - Click on the three-dot icon next to the page you wish to delete and select "Delete". Alternatively, highlight the page by clicking on it and click the trash icon at the bottom of the navigation pane. Make sure you save and exit the editor to delete a page.
Editing a page
Create shareable project documentation by editing pages. Create a new page or click the "Edit page" button at the top of an existing page. The following styling and content options are available:
The following buttons and their functionality are described below:
Page name - editable from the first line of a page, and, alternatively, from the properties panel.
Text styles - format selected or new text size and appearance using the formatting dropdown. Choose from plain text and heading 1-3 sizes.
Text formatting (bold, italic, strikethrough, underline) - format selected or new text using the formatting buttons on the top bar. Choose from bold, italics, strikethrough, and underline using the corresponding buttons.
Highlight - highlight selected or new text using the dropdown options in the droplet icon.
Create bulleted or numbered lists using the corresponding "Bullet" or "Numbers" list buttons.
Bullets - select an unordered set of text or create a new one using this option
Numbers - select an ordered set of text or create a new one using this option
Numbered lists can be specified to start at numbers other than one. Click on the numbers in a list to bring up the "Start at" prompt. This gives users a convenient way to embed related objects like links and code snippets between numbered entries.
Embed project object references, user mentions, and code using the following options:
Links - use the chain icon ("Link") to embed project objects or external URLs
User mentions - mention project users using the @ symbol button or typing the @ symbol on the page. Select the desired user to embed the mention.
Code - add snippets of code by clicking the </> icon
Divider - add a divider line by clicking the line icon
Lock & unlock
A governance user locks a page when entering edit mode. While this user is making changes, the page will be locked for editing for the other governance users.
Just like the projects themselves, admins and alternate admins can unlock pages for editing. From the Account menu, navigate to "User projects" and unlock pages as required.
Import & Export
Pages support import and export in widely-used formats. Content can be exported to PDF and imported from Microsoft Word.
Export - click the page icon on the top-right of the screen to export a page as a PDF file
Import - click the upload icon on the top-right of the screen to import a Word document. Compatible styling and formatting will be preserved
Users can edit the Page name and description as well as review dynamically generated content summaries in the right-hand properties panel.
Name - page name, also editable from the top line of the page body
User mentions - dynamically generated reference of user mentions from the page body
Linked objects - dynamically generated reference of linked project objects from the page body
Links - dynamically generated reference of linked URLs from the page body
Description - a (metadata) description of the page
In addition to the buttons on the top bar, users can access the formatting options using dedicated keyboard shortcuts. When in doubt, hover over a button to display its shortcut. (For Mac users, "Ctrl" is the "Command" key)
Ctrl + Alt + 0
Ctrl + Alt + 1
Ctrl + Alt + 2
Ctrl + Alt + 3
Ctrl + B
Ctrl + I
Alt + Shift + U
Ctrl + U
Ctrl+ Shift + 8
Ctrl+ Shift + 7
Ctrl + K
Code: Ctrl +
Shift + M