Skip to content

UI elements

This style guide reference page explains how to refer to UI elements in the Data Productivity Cloud when you are writing content for Matillion documentation. It can be used by the Matillion technical authors, other teams at Matillion, and external users who want to contribute to the docs.

How to use this reference page

This reference page lists the terms to use when writing about the Data Productivity Cloud and Matillion ETL. Each term will be listed, defined, and an example sentence will be provided. Unless alternative terms are given, the terms listed here are the only terms that should be used for each UI element.

The Do not use section of this reference page lists terms that should not be used when writing about the Data Productivity Cloud. Examples are not given for these terms.

Note

This reference page only specifies the terminology we use when writing about the Data Productivity Cloud. Where necessary, if describing a third-party website or platform, we can deviate from this. For example, we may refer to a page in the AWS console, even though page is not allowed for use when describing our own products.

This section refers to the elements that you use to navigate around the Data Productivity Cloud.

Homepage

The homepage is where you are taken if you click the Matillion logo in the top left of the Data Productivity Cloud. From the homepage, you can access recent pipelines, services, and quicklinks.

Example usage: To open a recent pipeline, click its tile on the Data Productivity Cloud homepage.

Note

Always use the full term "Data Productivity Cloud homepage" (never "homepage" alone), and do not use this term for any other areas of Matillion products.

Left navigation

The blue global navigation menu on the left of all areas in the Data Productivity Cloud is referred to as the left navigation.

Example usage: In the left navigation, click the Activity icon.

The secondary menu that appears when you click an icon in the left navigation is referred to as a menu.

Example usage: In the left navigation, click the Activity icon. Next, in the menu, click Lineage.

Icon

A clickable element in the left navigation is referred to as an icon.

Example usage: In the left navigation, click the Activity icon.

List of icons

The six white icons in the new left navigation will be referred to by the following names. When referring to these icons, use an article, e.g. "Click the Your projects icon."

  • Your projects
  • Data Loader
  • Activity
  • Agents & Instances
  • Custom connectors
  • Help

The icon in the top left is the Matillion logo. The icon in the bottom left is your profile icon.

Example 1: Click the Matillion logo to return to the Data Productivity Cloud homepage.

Example 2: Click your profile icon.

The screenshot below shows the different elements that make up the left navigation and menus.

Navigation terminology

UI element terminology

This section refers to UI elements in the Data Productivity Cloud that you interact with to create your pipelines, change settings, and perform actions.

Dialog

An element that appears on top of the content you are currently looking at, and requires interaction from the user. For example, the Add component dialog in Designer, or the Are you sure? dialog that appears when canceling some actions.

Example 1: In the Add component dialog, search for and click the component.

Example 2: In the Data Selection dialog, move the columns you want to collect from the left to the right.

Dual listbox

A component property type that is used to describe a dialog that contains two columns, in which you use arrow buttons to move items from one column to the other. For example, the Data Selection dual listbox when configuring the data to load from a data source. This term is only used when referring to the property type—when referring to the UI element, use dialog.

Example usage (property type in component documentation): Data Selection = dual listbox

Panel

An element that appears on the left or right, or on the canvas in Designer. Most panels appear in Designer, such as the component properties panel or the Files panel that opens on the canvas.

Example 1: The Push local changes panel will open.

Example 2: In the Files panel, select the pipeline you want to open.

Tab

A clickable element that is styled like a browser "tab"—multiple tabs can appear in a line next to one another. Examples include the Task history and Sample data tabs in Designer, and the tabs for branches, environments, etc. in your project.

Example usage: Click the Sample data tab.

A clickable element that displays a list of selectable items, for example, the list of providers when creating a new OAuth connection, or the list in the Authentication type field in many component properties panels. This term is also used to refer to a property type in component documentation.

Example 1: Use the drop-down menu to select the correct secret definition.

Example 2 (property type in component documentation): Database = drop-down

Note

When using this to refer to a UI element (not a component property type), always use the full term drop-down menu. Do not use drop-down alone, or drop-down list.

Tree view

The hierarchical organization structure that you can use to navigate your files or folders, for example, in the Files and Schemas panels.

Example usage: The Files panel displays your folders and pipelines in a tree view.

Checkbox

A box that a user can select or clear to activate or deactivate a setting.

Example usage: Select the Publish checkbox.

Note

Use select or clear to describe interacting with checkboxes. Do not use any of the following verbs: tick/untick, check/uncheck, mark/unmark, choose, click, deselect.

Notification

An element that appears on-screen with a message to inform the user. You can close these by clicking the close icon, but they will also disappear on their own after a certain time.

Example usage: A notification will appear to inform you that your changes have been committed.

Product terminology

These are the terms we use to refer to the products and services offered by Matillion. Always use the name in full. Do not use the word Matillion when you mean Matillion ETL. "Matillion" as a single word is the company itself. Note the capitalization of each term.

  • Matillion ETL
  • Data Loader
  • CDC
  • Matillion documentation
  • Matillion Support Center
  • Data Productivity Cloud
  • Designer

Note

We always refer to "the Data Productivity Cloud" as a noun, e.g. "in the Data Productivity Cloud". Never use "DPC".

You can only use the term "Data Productivity Cloud" without "the" when it is used as a descriptor, e.g. "Log in to your Data Productivity Cloud account."

Do not use

These terms should not be used when writing about the Data Productivity Cloud. All UI elements in the Data Productivity Cloud should be referred to using one of the terms listed above.

  • Overlay
  • Wizard
  • Toast notification
  • Accordion
  • Window
  • Screen
  • Page
  • Popup or pop-up
  • Tickbox
  • Gear or cog (to refer to an icon)
  • Pencil (to refer to an icon)
© Copyright 2024 Matillion Ltd | Legal | Privacy Policy | Disclaimer | Modern Slavery Statement