Use the Lightup app

Learn the basics of working in Lightup

The Lightup app has three main areas:

31763176
  1. The left pane lists workspaces and app-level commands (such Help or Logout).
  2. The top bar has tabs for working with data quality components.
  3. The main page takes up the rest of the app window and changes to reflect your choices on the left pane and the top bar

The left pane: app settings and workspaces

📘

Everyone can use the controls at the bottom of the left pane. Use the stack icon to collapse and expand the left pane. Use the gear icon to open a menu where you can:

  • Generate API credentials (for programmatic access to Lightup)
  • Open this Help content
  • Engage Lightup support
  • Log out

Your app role establishes what you can do. Look at the top of the left pane to see which app role you have.

  • ​If you're an App Admin, you'll notice an Admin menu right under the app logo. If you have this role, you can create and manage Lightup user accounts, roles, and workspaces.
206206
  • ​If you're an App Editor, you won't find an Admin button, but you will notice the Add New Workspace button. As a member of this role, you can create and manage your workspaces, and can invite other Lightup app users to your workspaces.
208208
  • If you don't have an Admin menu or an Add New Workspace button, you're an App Viewer. You can be invited to join a workspace. In the left pane, you'll see a list of workspaces where you're a member. Select the arrow at the right edge of a listed workspace to open a menu of commands for that workspace.

Get started in a workspace

​You do most of your data quality tasks inside a workspace. All the workspaces you can access appear in the left pane, listed under any app-level controls.

19021902

The top bar: navigation

The top bar offers a set of tabs you can select to focus on a specific quality monitoring process in a workspace.

📘

Everything that you do with the top bar tabs, you do inside the workspace that's selected in the left pane.

The main page: get stuff done

After you pick a workspace and a tab, data quality tools appear in the main page. All data quality work you do in the Lightup app, you do in the main page, which displays data quality tools for the workspace you selected, based on the tab you chose. For example, if you chose the Metrics tab, data quality tools specific to metrics appear on the main page.

Roles determine what you can do

The work you can do in each workspace depends on your workspace role. All Lightup data resides inside workspaces.

Everyone who uses Lightup has an app role, and each member of a workspace has a workspace role. Roles confer various abilities to the users who have them. For example, only an App Admin can invite new users to a Lightup instance.

Learn about App Roles

Your app role dictates what you can do at the app level, outside of a workspace. The following App roles are available:

  • ​App Admin - can invite users to Lightup, set their App roles, and create workspaces.
  • ​App Editor - can create workspaces but cannot invite new app users to Lightup.
  • ​App Viewer - can be invited to join any workspace but cannot create workspaces.

Most operations in Lightup occur within a workspace. Your App Role doesn't affect what you can do in a workspace.

Learn about Workspace Roles

Your workspace role dictates what you can do in a workspace, as follows:

  • Workspace Admin:
    • Add/remove users to/from the workspace
    • Set users' workspace roles in the workspace
    • Manage query governance policies for the workspace
    • Manage integrations and schedules for the workspace
    • Connect to datasources which will be used by the workspace
    • Perform any function accessible to a workspace editor
  • Workspace Editor:
    • Create, edit, view, delete, and search for metrics
    • Create, edit, view, delete, and search for monitors
    • View and search for incidents
    • Accept and reject incidents
    • Create, edit, view and delete dashboard charts
    • View queries executed on behalf of a workspace
  • Workspace Viewer:
    • View all objects created by or visible to a Workspace Editor
    • Cannot create or modify objects
  • Workspace Observer
    • View objects but not data values, e.g., a chart showing trends and incidents but not the legends that indicate values.
    • The observer role enables data quality monitoring by users who don't have permission to see the actual data.

Working in Workspaces

A workspace is a virtual space that enables team collaboration on data quality control. Every datasource, metric, monitor, incident, and dashboard, is part of a workspace. A team can have many workspaces, providing a way to separately track data quality for different domains and to iterate on design.

📘

You need at least the App Editor role to create workspaces.

📘

  • In multi-tenant mode, any user may be invited to join a workspace via email.
  • In single-tenant mode, only existing Lightup app users can be invited to a workspace.
  • A workspace may have one or more admins.
  • All of a workspace admins share responsibility for workspace management.

When a workspace is created, the workspace owner invites one or more existing Lightup app users to join the workspace as members. Only members of the workspace can access the workspace data. Each member also has a workspace role that determines what they can do in the workspace: admin, editor, viewer, and observer.

You can open any workspace you see listed in the left pane. Select a workspace to see what it contains and what actions you can perform there.

📘

Workspace menus

Each workspace has a menu that you open with a drop-down arrow to the right of the workspace's name. These menu options apply to the whole workspace.

Most operations in Lightup take place within a workspace, where your workspace role governs what you can do. You can have different roles in different workspace. For example, you might be a workspace admin of one workspace, a workspace editor of another, and a workspace viewer of yet another.

Note that your app role has no impact on your workspace roles. Your app role only dictates whether you can invite users to the Lightup Platform and whether you can create workspaces. Once you are a member of a workspace, your workspace role dictates what you can do in the workspace.


Did this page help you?