Data Lab user guide

Follow

Learn how to use Data Lab to give your organization direct and flexible access to all of its data, so you can drive better security practices and business processes.


 

In this article


 

Overview

Use the power of Data Lab to query all of your TrackTik data. Your data is generated using Data Lab's query language, TrackTik Query Language (TQL), which is used to build customized reports and answer critical data requests.

Managers, administrators, and executives across an organization can track personalized key performance indicators in highly customizable, shareable dashboards to monitor business performance and health. In return, this helps you to make better-informed decisions at all levels of your organization.


 

Getting started with Data Lab

To sign in and start using Data Lab:

  1. Go to https://datalab.tracktik.app/#/.

    For the best experience, use Google Chrome.
  2. Choose or add a domain.

    If the authorization fails, you should see an error that says Data Lab isn't enabled.
  3. On the portal sign in page, authenticate your sign in:
      • You can authenticate your login by using a TrackTik Identity Provider (IDP); enter your email or employee ID and password. 
      • You can also authenticate your login using an external IDP; enter your third-party login credentials. 
    If the authorization fails, you should see an error that says your login details aren't correct.
  4. Depending on what you're using to login in step 3, select Secure Sign-in or Login with the third-party provider

You can now navigate around Data Lab. 

When you log out of Data Lab, it effects any open TrackTik products:

  • Logging out with TrackTik IDP
    When you log out of Data Lab and you previously logged in using a TrackTik IDP, you're logged out of all your TrackTik products, including the portal.
  • Logging out with an external IDP
    When you log out of Data Lab and you previously logged in using an external IDP, you're logged out of all your TrackTik products, but not the other apps and products you registered with your external IDP (Okta, for example).

 

Go back to the top


 

Navigating Data Lab

Explore Data Lab by selecting options from the navigation bar or navigation menu.

datalabnav.jpeg

 

Using the navigation bar

The navigation bar is at the top of Data Lab. In this bar, you can navigate to areas of Data Lab and start creating dashboards, widgets, and TQL queries.

datalabnavbar.jpeg

  • To expand or collapse the navigation menu, select the Menu icon.

    datalab-navbar-menu.jpeg
  • To create a new dashboard, widget, or TQL query, select + CREATE.

    datalab-navbar-create.jpeg
  • To search your insights, enter text into the Search insights box. A dropdown menu shows any related results that are in your Insights Collection or My Insights area.

    datalab-navbar-searchinsights.jpeg
    This search shows certain types of content:
    • Widgets
    • Dashboards

  • To switch from light mode to dark mode, select the Moon icon.

    datalab-navbar-moonicon.jpeg
  • To expand your view of Data Lab, select the Full screen icon.

    datalab-navbar-expandicon.jpeg
  • To set your preferred language or to sign out, select the Account icon.

    datalab-navbar-accounticon.jpeg

Go back to the top


 

Using the navigation menu

The navigation menu is to the left side in Data Lab. In this menu, you can go to the different areas of Data Lab.

datalabnavbar2.jpeg

  • To go to the main home view and navigate your workspaces, select Home.

    datalab-navmenu-home.jpeg
  • To see dashboards, widgets, or TQL queries you created in the past, select My Insights.

    To see your folder and its contents, select the Arrow icon.
    datalab-navmenu-insights.jpeg
  • To see any dashboards or widgets that are shared with you, select Shared with me.

    To learn more about sharing permissions, check out Sharing widgets and dashboards.
    datalab-navmenu-sharedwithme.jpeg
  • To see any archived dashboards or widgets, select Archive.

    datalab-navmenu-archive.jpeg

To navigate TQL features in Data Lab, in the navigation menu, select TQL-specific areas from the TQL menu.

datalab-navmenu-tql.jpeg

  • To go to the TQL library to see all available data models, functions, and relative dates, select Data Model Library.

    datalab-navmenu-datamodellibrary.jpeg
  • To use the command prompt to write, test, and save TQL queries, select TQL Playground.

    datalab-navmenu-tqlplayground.jpeg

To help you with problems you might be having with Data Lab, you can use the Support area.

datalabnavsupport.jpeg

  • To navigate to support documentation for Data Lab, select Documentation.

    datalabsupportdocs.jpeg
  • To send TrackTik your ideas for product improvements, select Feedback.

    datalabnavfeedback.jpeg

 

Go back to the top


 

Using the Home dashboard

Use the Home dashboard to navigate your insights and collections. When you log into Data Lab, the Home dashboard shows by default.

datalabnav3.jpeg

If you need to go back to your home dashboard, in the navigation menu, select Home.

datalab-navmenu-home.jpeg

The Home dashboard has different areas:

  • Insights Collection
    Select any of the predefined dashboard groups that are organized by business functions, so you can focus on the data that matters most.

    datalabinsights.jpeg

    By default, there are three dashboard groups:
    • HR
      This collection has four dashboards:
      • Employee Performance
      • Workforce Profile
      • Employee Compensation
      • Payroll and Worked Hours
    • Revenue
      This collection has three dashboards:
      • Revenue And Cost
      • Accounts And Contracts
      • Overtime Cost
    • Operations
      This collection has four dashboards:
      • Incidents
      • Dispatch
      • Checkpoint Scans And Tours
      • Schedules And Shifts
  • My Insights
    This area shows you any folders, widgets, and dashboards. Your most recently created projects are shown first.

    datalab-myinsights.jpeg
  • Create your first dashboard
    This area has a step by step guide about how to create your first dashboard.

    datalab-createyourfirstdashboard.jpeg
    Select + CREATE to get started.

    datalab-create-create.jpeg
  • Tutorials
    If you're not sure about widgets, dashboards, sharing, or TQL, select a video tutorial in this area to help you get started.

    datalab-tutorials.jpeg

 

Go back to the top


 

Creating and editing folders

Create and edit folders in Data Lab to better organize your projects.

datalab-goldercreation.jpeg

 

Create a folder

To create a folder in Data Lab:

  1. In the navigation menu, select My Insights.
  2. Select CREATE NEW FOLDER.
  3. In the New Folder Name box, enter a folder name.

    Name the folder something descriptive.
  4. Select SAVE.

Your folder is now available at the level you created it.

 

Go back to the top


 

Edit a folder

Before you start:

To edit a folder in Data Lab:

  1. In the navigation menu, select My Insights.
  2. Find the folder you want to edit and select the three dots icon.

    If you're using a PC , you can also right click with your mouse to open the Options menu.
    datalab-fileoptions.jpeg
  3. Select Edit.
  4. In the Edit Folder modal, make changes to your folder:
    • Rename the folder in the Name box.
    • Select Advanced options to change the folder icon, color, or enter an image URL.
  5. Select Save.

 

Go back to the top


 

Creating and configuring widgets

Widgets give you essential information about your business, and they can be used separately or added to a dashboard.

Create counters, charts, maps, gauges, lists, and tables to show your data in the most effective way possible. However, there are two ways you can effectively show your data using widgets: scalar records and aggregation:

  • Scalar data
    This means showing individual records of data rows, for example, a list of late shift records. It's recommended that you use a List or Data Table widget to show this information.
  • Aggregation data
    This means showing an aggregate measure of some characteristic (attribute) of your data, for example, the sum of the price for your billable items on every contract you have. You could use a Column Chart or Tree Map widget to show this information.

To create and configure a widget in Data Lab:

  1. In the navigation bar, select + CREATE.

    datalab-navbar-create.jpeg
  2. Select New Widget.
  3. Choose a widget type, or select COPY FROM EXISTING to select a widget that already exists and copy it to a destination folder.

    To learn more about widget types, check out Creating Widgets.
    datalab-newwidget-copy.jpeg
  4. In the Widget Title box, enter a descriptive name for your widget.
  5. Select a data source from the Data Source dropdown menu.
  6. In the Group By dropdown menu, select a group by clause that combines the results of your widget based on a common attribute.
  7. In the Measure dropdown menu, select a measure that is based on the action of your widget.

    To learn more about widget measures, check out List of Widget Measures.
  8. Select the OPTIONS and TOOLBAR tabs to change the color palette or your widget filters in the toolbar.

    To learn more about the OPTIONS tab, check out Creating Widgets.
    To learn more about the TOOLBAR tab settings, check out The Toolbar Tab.
    datalab-optionstoolbar.jpeg
  9. Select the DATA SOURCE tab to see and edit all customization options for your widget:
    • Common Filters
    • Include Archived / Inactive
    • Attribute Filters
    • WhereQL
    • HavingQL
    • Top Filters Binding

      To learn more about customizations, check out Standard Fields.
  10. Choose SAVE AND CLOSE or SAVE AND CONTINUE.

Your widget is now available by default in your My Insights area. If you created the widget in a folder, you can find it there.

 

Go back to the top


 

Creating dashboards

Dashboards have a selection of widgets that help you monitor and communicate the status of your key performance indicators.

To create a dashboard in Data Lab:

  1. In the navigation bar, select + CREATE.

    datalab-navbar-create.jpeg
  2. Select New Dashboard.
  3. Choose a dashboard template, or select COPY FROM EXISTING to select a dashboard that already exists and copy it to a destination folder.

    datalab-copydashboard.jpeg
  4. Name your dashboard and give it a description by selecting the Untitled Dashboard box.
  5. Select APPLY.
  6. Select SELECT A WIDGET and drag a widget into an available widget window.

    If you want to create a new widget, select NEW in any widget window. Any widget you create is saved to the dashboard and not in any other folder. To learn more about creating a widget, check out Creating and configuring widgets.
    datalab-selectawidget.jpeg
  7. Modify your dashboard to fit your needs:
    • To change the look of a row, use the Row Settings:

      datalab-rowsettings.jpeg
      • To add a column, select the Left or Right icon.

        datalab-leftrightarrrows.jpeg
      • To add a row, select the Up or Down icon.

        datalab-updownicons.jpeg
      • To delete a row, select the X icon.

        datalab-xicon.jpeg
      • To resize your widget windows, select from the Extra Small, Small, Medium, Large, and Extra Large icons.

        datalab-sizes.jpeg
    • To add a tab to a widget window, select the + icon. Create multiple tabs to stack widgets inside a single widget window.

      datalab-addmoretabs.jpeg
    • To delete a single widget window and all of its content, select the Trash icon.

      datalab-trashicon.jpeg
    • To edit the widget in a widget window, select the Gear icon.

      datalab-gearicon.jpeg
  8. To filter your dashboard data, select a filter. You can select from three filter types:
    • Date range
      To filter your dashboard by date, select the DATE RANGE dropdown menu. Choose from preset date ranges in the PRESETS tab, or create your own custom date range in the DATE RANGE tab. When you're done, select APPLY.

      datalab-daterange.jpeg
    • Region
      To filter your dashboard by region, select the REGION dropdown menu, and choose one or multiple regions from the list. You can also select the Tree icon to see your regional and sub-regional structure. When you're done, select APPLY.

      datalab-region.jpeg
    • Account
      To filter your dashboard by account, select the ACCOUNT dropdown menu, and choose one or multiple regions from the list. When you're done, select APPLY.

      To save your filter options as default, select SAVE AS DEFAULT. To see this option, you must use a new dashboard or widget. This option doesn't appear for existing dashboards or widgets, or if you make a copy of a dashboard or widget.
      datalab-accountdropdown.jpeg
  9. To save your changes, select SAVE AND CLOSE or SAVE AND CONTINUE.

Your dashboard is now available in the My Insights area.

 

Go back to the top


 

Copy a dashboard

Copying a dashboard helps to speed up your creation workflow. For example, if you have different stakeholders that are tracking similar key performance indicators with minor differences, you can create copies and edit them to fit stakeholder needs.

To copy a dashboard in Data Lab:

  1. From the navigation menu, select My Insights.
  2. If you're using a PC, right click on the item, or select the three dots icon in the same row as the item.

    datalab-copydashboardthreedots.jpeg
  3. Select COPY.
  4. Choose a destination folder.
  5. Select COPY.

The copied dashboard now appears in your My Insights area. If you copied the dashboard to a folder, you can find it there.

 

Go back to the top


 

Sharing widgets and dashboards

To help business leaders make more informed and strategic decisions, you and your team can give internal and external stakeholders insights and reports by using the Share With People And Groups feature in Data Lab.

To share a widget or dashboard in Data Lab:

  1. Go to My Insights.
  2. Select the widget or dashboard you want to share. You can do this from your folders and subfolders, too.

    If you're sharing a dashboard, you are sharing the widgets and not the data.
  3. Select SHARE.
  4. Enter a person or group in the Type to add people and groups box.
  5. From the CHOOSE ONE sharing permissions dropdown menu, choose if the contact is a Viewer or an Editor of the dashboard or widget you're sharing.
  6. Select SAVE CHANGES.
  7. Select DONE.

To find widgets, dashboards, and folders that were shared with you, in the navigation menu, select Shared with me.

datalab-navmenu-sharedwithme.jpeg

 

Go back to the top


 

Archiving widgets and dashboards

Archive your widgets and dashboards to help manage your Data Lab workspace more efficiently.

Archived widgets, dashboards, and TQL queries are removed from any shared folders and moved to the Archive area.

datalab-navmenu-archive.jpeg

After you archive a file, contacts that you shared the file with no longer have access to it, and the file no longer appears in the Shared with me area.

To archive a widget or dashboard in Data Lab:

  1. From the navigation menu, select My Insights.

    You can also archive a widget or dashboard from any select folder or subfolder.
  2. Find the item you want to archive.
  3. If you're using a PC, right click on the item, or select the three dots icon in the same row as the item.

    datalab-archive-threedots.jpeg
  4. Select Archive.
  5. Read the confirmation modal text, and if you agree, select ARCHIVE.

The archived item is now in your Archive area. To see your archive, go to the navigation menu and select Archive.

 

Go back to the top


 

Restoring an archived item

Mistakes happen and you might want to undo the archival of a widget or dashboard.

To restore an archived item:

  1. From the navigation menu, select Archive.
  2. Select the item from the Archive list.
  3. In the restoration modal, select the checkbox if you want to restore any shared permissions.
  4. Select RESTORE.

The restored item is now in your My Insights area.

 

Go back to the top


 

Learn and understand TQL

Query and manipulate your data using TrackTik Query Language (TQL) to return answers to your business questions. If you're familiar with Structured Query Language (SQL), a lot of the features and functions of TQL should look familiar. If you aren't, don't worry - we have references to help you out.

Next steps

 

Go back to the top


 

Using the Data Model Library

Explore your data and how it's structured in the Data Model Library. Navigate between data models, functions, and relative dates to help you create a dashboard that meets your business insight needs.


To start using the Data Model Library, from the navigation menu, select Data Model Library.

datalab-navmenu-datamodellibrary.jpeg

  • Data Models
    Expand the Data Models library to find all available TQL endpoints. Use the attributes that make up the objects to help answer your business questions.

    To learn more about data models, check out TQL Data Structure.
    datalab-datamodels.jpeg
  • Functions
    Expand the Functions collection to find all available functions that can be used with queries to do calculations. Functions are great because you can gather more valuable and comprehensive business intelligence from what is queried.

    To learn more about functions, check out Selected TQL Functions.
    datalab-functions.jpeg
  • Relative Dates
    Expand the Relative Dates collection to see the different ways you can simplify writing the date as a string. You can use relative dates for a where statement in your TQL query.

    To learn more about relative dates, check out Selected TQL Functions.
    datalab-relativedates.jpeg

 

Go back to the top


 

Using the TQL Playground

You can explore and test data models and how your data works together. In return, this gives you and your stakeholders the best business insights.

To start using the TQL Playground:

  1. In the navigation menu, select TQL Playground.

    datalab-navmenu-tqlplayground.jpeg
  2. Select the Data Models, Functions, or Relative Dates menu to explore the different ways you can query data.

    Enter text into the Search Objects box to find objects.
  3. Using the objects from step 2, enter your TQL query into the command prompt.

    To learn more about building a TQL query, check out Start Writing TQL Queries.
  4. If you write the TQL query with the correct syntax, select APPLY to see the results.
  5. To save your TQL query as a widget, select SAVE AS WIDGET.

The TQL query is now available as a widget in the My Insights area.

 

Go back to the top


 

Creating a TQL widget

Create a TQL widget to pull the information you need from different TrackTik API endpoints.

To create a TQL widget:

  1. In the navigation bar, select + CREATE.

    datalab-navbar-create.jpeg
  2. Select New TQL Query.
  3. Enter the query parameters in the command prompt.
    To learn more about writing queries, check out Using the Data Model Library.
  4. Select APPLY to make sure the query is correct.
  5. Select SAVE AS WIDGET.
  6. Enter a title.
  7. Select SAVE.

The TQL query is now available as a widget in the My Insights area.

 

Go back to the top


 

See also

Comments

0 comments
Article is closed for comments.