Release Notes

• What's New in 18.3 - Highlights of the 18.3 release.
• Release Notes 18.3 - Detailed feature list of the 18.3 release.
• Upcoming Features in 19.1 - Features in development for the 19.1 release.

Getting Started

• Trial Servers - Create your own trial server and try the core functionality.
• Explore LabKey Server - Hosted Trial
• Virtual Machine Trial Server
• Explore LabKey Biologics - Hosted Trial
• Tutorials - Hands-on explorations.

LabKey Server Documentation

• Introduction to LabKey Server - An overview of key features.
• Data Basics - Build applications from user interface panels and views on underlying data.
• Assay Data - Work with instrument-derived data.
• Longitudinal Studies - Integrate heterogeneous data in longitudinal/cohort studies.
• Collaboration - Set up file repositories, message boards, and issue trackers.
• Development - Developer resources.
• Administration - Create projects, configure security, advanced installation.

Biologics Documentation

• LabKey Biologics - Biologics overview and tutorials.
• Entity Registration
• Biologics: Sample Management
• Biologics: Assay Management
• Media Registration
• Biologics: Workflow Management
• Biologics: Experiments

Premium Resources

• Premium Resources - Premium documentation, code samples, and best practices.

Community Resources

• Videos - Video resources for beginners and experts.
• LabKey User Conference Resources - Presentation slides and videos.
• LabKey Terminology/Glossary - Definitions for common terms.
• Documentation Archive

Feature Highlights of Version 18.3

• Multiple R Engines - Integration with Multiple R engines allows users to select an alternative to the default R engine for individual projects as well as declare an R engine as a sandbox environment, isolating it for security purposes. (docs)
• Integration with RStudio Pro - Allows users to view, edit, and export LabKey Server data in the RStudio Pro interface. (docs)
• Antivirus scanning - Automatically check all file uploads, attachments, archives and other content for viruses during import. (docs)
• Visualization Enhancements - Enhancements to visualization tools allow users to specify multiple y axes for scatter and line plots, hide trend lines and data points on time charts, and include visualizations in study participant views. (docs)
• New QC Plot Types Additional QC Trend reports including moving range and cumulative sum plots have been made available for GPAT/file-based assays. (docs)
• ETL Enhancements - ETL definition editor enhancements provide automatic code completion and allow administrators to define a new ETL using an existing definition as a template. (docs)
• Java 11 - Support for Java 11 allows LabKey to run on both Oracle Java SE 11 and Oracle OpenJDK 11. (docs)
• Premium Resources - New topics for Premium clients include:
• Premium Resource: Configuring LabKey for GDPR Compliance
• Premium Resource: Best Practices for Security Scanning
• Premium Resource: Invoke JavaScript from Custom Buttons
• Premium Resource: Python API Demo
• Premium Resource: Git Branch Naming
• Premium Resource: ETL Best Practices
• Premium Resource: Sample Management Demo

See the full Release Notes 18.3

The symbol indicates a feature available in a Premium Edition of LabKey Server. Learn more here.

Feature Highlights of Version 18.3

• Multiple R Engines - Integration with Multiple R engines allows users to select an alternative to the default R engine for individual projects as well as declare an R engine as a sandbox environment, isolating it for security purposes. (docs)
• Integration with RStudio Pro - Allows users to view, edit, and export LabKey Server data in the RStudio Pro interface. (docs)
• Antivirus scanning - Automatically check all file uploads, attachments, archives and other content for viruses during import. (docs)
• Visualization Enhancements - Enhancements to visualization tools allow users to specify multiple y axes for scatter and line plots, hide trend lines and data points on time charts, and include visualizations in study participant views. (docs)
• New QC Plot Types Additional QC Trend reports including moving range and cumulative sum plots have been made available for GPAT/file-based assays. (docs)
• ETL Enhancements - ETL definition editor enhancements provide automatic code completion and allow administrators to define a new ETL using an existing definition as a template. (docs)
• Java 11 - Support for Java 11 allows LabKey to run on both Oracle Java SE 11 and Oracle OpenJDK 11. (docs)
• Premium Resources - New topics for Premium clients include:
• Premium Resource: Configuring LabKey for GDPR Compliance
• Premium Resource: Best Practices for Security Scanning
• Premium Resource: Invoke JavaScript from Custom Buttons
• Premium Resource: Python API Demo
• Premium Resource: Git Branch Naming
• Premium Resource: ETL Best Practices
• Premium Resource: Sample Management Demo

See the full Release Notes 18.3

R Integration

• Integrate with RStudio Pro - Use RStudio Pro to view, edit, and export LabKey Server data. (docs)
• RStudio Data Browser - View data from the LabKey schemas within RStudio or RStudio Pro. (docs)
• Docker-based R Engines (Experimental Feature) - Connect the server to a Docker-based R engine. (docs)
• Per-Project R Engines - Configure multiple R engines. Individual projects can choose alternative R engines other than the site default engine. (docs)
• Sandboxed R Engines - Declare an R engine as sandboxed to isolate it for security purposes. (docs)
• Rlabkey Helper Functions - Two new functions have been added to the Rlabkey package: labkey.transform.getRunPropertyValue and labkey.transform.readRunPropertiesFile. Use these helper functions within an assay's R transform script to load the run data and properties. Available in Rlabkey version 2.2.4. (docs | docs)
• Rlabkey: Set and Get Module Properties - New Rlabkey functions, setModuleProperty and setModuleProperty, allow developers to set and get a module property for a specific LabKey Server project. Available in Rlabkey version 2.2.4. (docs)

Administration

• Antivirus Scanning - Automatically scan uploaded files for viruses using ClamAV. (docs)
• Analyst and Trusted Analyst Roles - New site-wide roles provide different levels of access for developers writing R scripts and other code. Analysts can write code that runs on the server under their own user account. Trusted Analysts can write code to be run by other users, including custom SQL queries. (docs)
• Platform Developer Role - A new site-wide role allows trusted users to write and deploy code. Platform developers can create and edit code and queries in folders where they have edit permission. The Platform Developer role replaces and provides the same permissions that the "Site Developers" group previously provided. (docs)
• LDAP User/Group Synchronization - Synchronize LabKey Server user accounts with an external LDAP system. (docs)
• Export Diagnostic Information - Download diagnostics to assist LabKey Client Services in resolving problems you encounter. (docs)
• Connect to Existing Amazon S3 Directories - Connect to an existing S3 directory or create a new one for each LabKey folder. (docs)
• Custom HTML Header - Add an HTML header to your site for a more custom look. Also available in 18.2. (docs)
• Diagnostic Logs - Easily bundle and download server logs for diagnostic purposes. (docs)
• Improved Navigation Menu - The project menu and any custom menus you define have a more consistent interface, and each contain graphical elements signaling that they are interactive elements. You can also access the project menu from the admin console. (docs)
• Subfolder Web Part - This web part shows the subfolders of the current location; included in new collaboration folders by default. Also available in the 18.2 release. (docs)

LabKey Server Trial Instances

• Biologics Trial Servers Available - Create a web-based server instance to explore LabKey Biologics. (docs)
• Virtual Machine Trial Servers - Download a virtual machine image of LabKey Server for on-premise evaluation. (docs | download)

Biologics

• Experiment Framework - Manage experiments, associated samples and assay data. Add and remove samples from an existing experiment. View the assay data linked to samples in an experiment. (docs)
• Lineage Grid - View sample lineage in a grid format. (docs)
• Import Constructs from GenBank Files - Import Constructs using the GenBank file format (.gb, .genbank). (docs)
• Custom Views - Administrators can define and expose multiple views on Biologics grid data, allowing end users to select from the list of views. (docs)
• Tutorials - Use these tutorials as a guided tour of LabKey Biologics:
• Biologics Tutorial: Navigate and Search the Registry
• Biologics Tutorial: Add Sequences to the Registry

Reporting and Visualization

• Scatter and Line Plot Enhancements - Specify multiple Y axes. Show all data on a single plot or display separate plots per measure. (docs | docs)
• Time Chart Enhancements - Hide the trend line or the data points on a time chart. (docs)
• Add Charts to Participant Views - Include visualizations in participant views within a study. (docs)
• QC Trend Report Options - In addition to Levey-Jennings plots, apply Moving Range and Cumulative Sum plots to GPAT and file-based assay data. (docs)

Electronic Data Capture (Survey)

• Date & Time Question Type - An additional question type combining a date picker and time selector has been added. (docs)

Document Abstraction and Annotation

• Document Abstraction: Multiple Result Set Review - Reviewers can now simultaneously see all abstracted results for a given document and select among differing value assignments. (docs)
• Transfer Results between Servers - Batches of abstraction/annotation results can be encrypted and transferred between servers. (docs)

Adjudication

• Adjudication Improvements - Compare determinations regarding HIV-1 and HIV-2 infection separately and raise alerts to infection monitors when there is consensus about a positive diagnosis for any strain. (docs)

Panorama

• Normalized Y-axes in QC Plots - Support for normalizing Levey-Jennings and Moving Range plots using percent of mean or standard deviation as the zero point on the Y-axis. (docs)
• Improved Figures of Merit performance - Rendering performance for the Figures of Merit report has been improved. (docs)
• Read Chromatograms Directly from SKYD files - An experimental feature allows you to read chromatograms directly from SKYD files instead of storing them in the database. (docs)

Development and APIs

• Improvements to Experiment.saveBatch - The Experiment.saveBatch action has been modified to support non-assay backed runs. This allows developers to import assay data not associated with a particular assay design. In earlier versions of the API, identifying a specific assay design was required. This change has been incorporated into both the JavaScript API and the R package Rlabkey. (JS docs | R docs)
• Modal Dialogs in JS API - A new JavaScript function in the LabKey.Utils API displays modal dialogs on the page that can have dynamic content. (docs)
• Display PNG Images in Grids - Use a displayColumnFactory to override the display properties of a column to display images and thumbnails. (docs)
• NaN and Infinity Values - LabKey SQL supports constants NaN, INF, and -INF. (docs)
• Domain APIs - The Python and R APIs have been updated to allow for the inference, creation, and update of dataset and list schemas. Also available in 18.2. (Python docs | R docs)

Potential Backwards Compatibility Issues

• Transition to Jackson Serialization - XStream serialization of pipeline jobs has been replaced with Jackson serialization. Modules that currently depend on XStream should transition to Jackson. XStream serialization has also been removed from the API. While it is always recommended to let running pipeline jobs complete prior to upgrading the server, this is especially true for the 18.3 upgrade as any jobs in progress cannot be restarted automatically. (docs)

• Redshift Driver Upgrade - If you are using Redshift with LabKey, download the latest JDBC 4.2 driver and replace the existing driver in your Tomcat lib directory. (docs)
• Changes to CSRF Setting - At 18.3 upgrade time, the CSRF checking setting on all servers will be set to "All POST requests". Site administrators will have the ability to revert back to "Admin requests" for deployments that still need to make their external modules or custom pages compatible with this setting. For release 19.1, we plan to remove the setting entirely and check CSRF tokens on every POST (except for specially annotated actions). (docs)
• ETL Functionality Shipping with Premium Editions - The ETL module is no longer be distributed with the Community Edition. This functionality is now included with Premium Editions of LabKey Server. (docs)
• Return URL Handling - By default, servers will reject return URL values that are not identified as being to the local server, either by being a relative path, or because the hostname matches the server's configured base server URL in Site Settings. Rejected URLs will be logged to labkey.log with the message "Rejected external host redirect" along with URL details. Administrators may enable an experimental feature in the Admin Console to allow these URLs through again. This is a stopgap to allow for backwards compatibility, if required. In the future, we will either remove the experimental feature and always reject external URLs, or allow admins to whitelist the sites that should be allowed.

Operations

• Support for Java 11 - We recommend upgrading your server installation to Java 11. Oracle is expected to end public support for Java 8 in January 2019, and, as a result, LabKey Server will no longer support Java 8 for the 19.1 release. For details see Supported Technologies.
• Support for PostgreSQL 11 - PostgreSQL 11.1 and above is supported (not the initial PostgreSQL 11.0 release). For details, see Supported Technologies.
• Remove support for PostgreSQL 9.3 - PostgreSQL 9.3 reached end-of-life in November 2018. We recommend upgrading your PostgreSQL installation to version 10 or later. For details, see Supported Technologies.

Extract-Transform-Load (ETLs)

• ETL Definition Editor Enhancements - Define a new ETL using an existing one as a template. Autocomplete while entering XML. (docs)

Premium Resources

Premium Resources Available - Expanded documentation and code examples are available with premium editions of LabKey Server, including

• Premium Resource: Configuring LabKey for GDPR Compliance
• Premium Resource: Best Practices for Security Scanning
• Premium Resource: Invoke JavaScript from Custom Buttons
• Premium Resource: Python API Demo
• Premium Resource: Git Branch Naming
• Premium Resource: ETL Best Practices
• Premium Resource: Sample Management Demo

The symbol indicates a feature available in a Premium Edition of LabKey Server. Learn more here.

Extract-Transform-Load (ETL)

The ETL module has been removed from the Community Edition and the functionality has migrated to the dataintegration module, available with all Premium Editions. Premium clients will not experience any change in functionality or interruption in service.

The announcement made on the Developer Forum about this change can be found here.

Developers with premium clients who have enlisted in the version control project and will be using ETLs in 18.3 and beyond will need to take the following steps in order to continue to use the premium 'dataintegration' module from Git. (Learn more about working with Git modules here).

1. To obtain access, you will need to provide your LabKey Account Manager with the username of your GitHub account if you have not already done so.
2. Clone the dataintegration module into your optionalModules directory.
3. Sync your svn enlistment to remove the old svn module.
4. Add a line like this to your settings.gradle file:

include ":server:optionalModules:dataintegration"

1. Execute these two commands in this order to ensure that you clear out the old copy and are solely building and running the module from Git:

gradlew cleanBuild
gradlew deployApp

Create Chart View

The deprecated chart creation tool will be removed in 18.3 and existing chart views created by users will be automatically migrated to the updated implementation.

Premium subscribers have access to a variety of LabKey features outside of the community edition as well as professional support. Learn more about LabKey Premium Editions.

Windows Installer Decommission

The LabKey Server Windows-only Graphical Installer will be decommissioned as part of the 18.3 release in November 2018. Moving forward, virtual machine images will be provided with each release as an alternate method for evaluating LabKey Server on-premise. We encourage new users looking to evaluate LabKey Server to take advantage of the cloud-hosted trial version of LabKey Server.

Upgrading Servers Installed with the Graphical Installer

If you used the Windows graphical installer in the past and want to update your LabKey Server, first use the last release of the installer to upgrade it to 18.2. Find it in the archives here:

• https://www.labkey.org/Documentation/Archive/18.2/wiki-page.view?name=prevReleasesDetails&release=18.2

1. Backup your database to be safe and notify any users that the server will be down for a period of time.
2. Delete the uninstaller, uninst.exe, that was bundled with the windows installer. You can find it in your $<LabKey_Home> directory.
3. If you are upgrading any component, such as Tomcat, Postgres, or Java, you should also delete the LabKey tomcat service LabKeyTomcat7 using the registry editor (regedit).
4. Follow the upgrade process documented for any local manual installation:

• Upgrade LabKey

Upcoming Features

Some features we are currently working on for the 19.1 release of LabKey Server:

• Release Notes 19.1

Recent Documentation Updates

Click the links below to see the most recent changes to the LabKey Server documentation.

Sample Management

• Updated Sample Import - The sample set import page has been standardized and streamlined. Selecting columns to generate sample ids is no longer available. Use name expressions in generate sample ids. Selecting a parent field is no longer available. Use field names to indicate parent columns. For details see Parent Samples: Derivation and Lineage.

Security

• Enforce CSRF checking on all POST requests - This is no longer a configurable option. (docs)
• Antivirus scanning for cloud-based file repositories

Reporting

• QC Trend Report Workflow Improvements - (docs)
• Premium Docs: Example Code for Embedding Spotfire Visualizations: (docs)
• Premium Resource: Three Methods for QC Trend Reporting - TBD
• Legacy JFree Chart Views can be rendered as JavaScript charts in dev mode. (docs)

Development

• PERL API updates
• ETL definitions included in folder export/import: (docs)
• Docs: Java Module Tutorial
• Docs: Configuring IntelliJ for XML File Editing
• LabKey SQL: If you use a HAVING clause without a GROUP BY, all selected rows are treated as a single group for aggregation. (docs)
• Remote ETL: modifiedSinceFilterStrategy - Use this filter strategy to only update rows that have changed on the source. (docs)

Biologics

• Include "unknowns" in bulk registration of Mixtures and Batches. Also available in 18.3. (docs)
• Tabbed Assay Results. When a sample has multiple associated assays, the assay results are displayed on different tabs on the sample's details page. (docs)
• Add Ingredient - Add an ingredient during the creation of a batch. (docs)
• Bulk Upload Ingredients and Raw Materials. Also available in 18.3. (docs)
• Attach files to Experiments. Also available in 18.3. (docs)
• Display charts and custom grids within Biologics. (docs)

Operations

• Support for Java 12 - We recommend upgrading your server installations to Java 12 as soon as possible. Oracle ended public support for Java 11 in March 2019, and, as a result, LabKey will remove support for Java 11 in the 19.2 release. For details see Supported Technologies.
• Remove support for Java 8 - Oracle ended public support for Java 8 in January 2019, and, as a result, LabKey Server no longer supports Java 8. For details, see Supported Technologies.
• Web Application Firewall (WAF) - We have enabled a Web Application Firewall for all cloud and trial customers to improve protection against web attacks.
• xstream removal

Administration

• Support for Milliseconds - Date and time formats can now include milliseconds. (docs)

Assays

• Multiple file upload for GPAT

Potential Backwards Compatibility Issues

• Remote API Date Format Change - The date format for JSON responses has been changed to "yyyy-MM-dd HH:mm:ss.SSS". In past releases it used a different format ("yyyy/MM/dd HH:mm:ss").
• Deprecated Chart API has been removed. Instead, use the JavaScript vis API.
• Active Sample Sets - This feature has been removed.
• Unique Suffixes for Sample Sets - This feature has been removed.
• Legacy MS2 Views - The Grouping views (Peptides, Protein, ProteinProphet) and Comparison views (Peptide and ProteinProphet) have been removed.

Premium Resources

New resources available to users of premium editions of LabKey Server include:

• Premium Resource: Best Practices for Writing Automated Tests
• Premium Resource: Embed Spotfire Visualizations
• Premium Resource: QC Report Demo
• Premium Resource: Bulk Editing
• Electronic Health Records (EHR) Documentation: The data collection and management system as well as the EHR billing module are documented. Find the full list of topics here.

The symbol indicates a feature available in a Premium Edition of LabKey Server. Learn more here.

The LabKey platform provides an integrated data environment for biomedical research. This section will help you get started using LabKey Server or LabKey Biologics.

• Try it Now: Data Grids
• Trial Servers: Create your own LabKey instance for evaluation of how our solutions meet your needs.
• Explore LabKey Server - Hosted Trial
• Virtual Machine Trial Server
• Explore LabKey Biologics - Hosted Trial
• Tutorials

Additional Topics

• LabKey Server
• Navigate Server
• Visualizations
• R Reports
• My Account
• LabKey Biologics
• LabKey Biologics - Videos
• Biologics Tutorial: Navigate and Search the Registry
• Biologics Tutorial: Add Sequences to the Registry

LabKey Solutions

• LabKey Server Editions
• Custom Development

• Securely share your data with colleagues through interactive grid views
• Collaboratively build and explore interactive visualizations
• Drill down into de-identified data for study participants
• Combine related datasets using data integration tools

Cloud-Based LabKey Server Trial - Recommended

LabKey Server Trial instances contain a core subset of features, and sample content to help get you started. Upload your own data, try tutorials, and even create a custom site tailored to your research and share it with colleagues. Your trial lasts 30 days and we're ready to help you with next steps toward incorporating LabKey Server into your research projects.

Start here: Explore LabKey Server - Hosted Trial

Virtual Machine LabKey Server Trial - On-Premise Evaluation

Virtual machine trial servers run on your local machine inside a virtual environment (Oracle VirtualBox). VM instances contain a core subset of features, and some basic content to get you started. Import your own data, try tutorials, and even create a custom site tailored to your research and share it with colleagues.

Start here: Virtual Machine Trial Server

Cloud-Based Biologics Trial

Try the core features of LabKey Biologics using our sample data and tutorial walkthroughs. Your trial lasts 30 days and we're ready to help you with next steps toward incorporating LabKey Biologics into your work.

Start here: Explore LabKey Biologics - Hosted Trial

To get started using LabKey Server and understanding the core functionality, you can create a hosted LabKey Server - Trial instance. Go here to Start Your Free Trial, enter some basic contact information, then go!

In the hosted account manager, select the product LabKey Server - Trial and click Create Site.

Trial server instances contain a subset of features, and some basic content to get you started. Upload your own data, try tutorials, and even create a custom site tailored to your research and share it with colleagues. Your trial lasts 30 days and we're ready to help you with next steps toward incorporating LabKey Server into your research projects.

Tours & Tutorials

Step by step introductions to key functionality of LabKey Server.

Welcome to LabKey Server!

• Navigation and User Interface
• Security Model
• Tools for Working Together
• Tools for Data Analysis
• Tools for Research Studies
• What's Next?

Navigation and User Interface

• Projects and Folders
• Tabs
• Web Parts
• Header Menus

Projects and Folders

The project and folder hierarchy is like a directory tree and forms the basic organizing structure inside LabKey Server. Everything you create or configure in LabKey Server is located in some folder. Projects are the top level folders, with all the same behavior, plus some additional configuration options; they typically represent a separate team or research effort.

The Home project is a special project. On your Trial server, it contains the main welcome banner. To return to the home project at any time, click the LabKey logo in the upper left corner.

The project menu is on the left end of the menu bar and includes the display name of the current project.

Hover over the project menu to see the available projects, and folders within them. Click any project or folder name to navigate there.

Any project or folder with subfolders will show / buttons for expanding and contracting the list shown. If you are in a subfolder, there will be a clickable 'breadcrumb' trail at the top of the menu for quickly moving up the hierarchy. The menu will scroll when there are enough items, with the current location visible and expanded by default.

The project menu always displays the name of the current project, even when you are in a folder or subfolder. A link with the Folder Name is shown near the top of page views like the following, offering easy one click return to the main page of the folder.

For more about projects, folders, and navigation, see Project and Folder Basics.

Tabs

Using tabs within a folder can give you new "pages" of user interface to help organize content. For an example of tabs in action, see the Research Study within the Example Project.

When your browser window is too narrow to display tabs arrayed across the screen, they will be collapsed into a pulldown menu showing the current tab name and a (chevron). Click the name of the tab on this menu to navigate to it.

For more about adding and customizing tabs, see Use Tabs.

Web Parts

Web parts are user interface panels that can be shown on any folder page or tab. Each web part provides some type of interaction for users with underlying data or other content.

There is a main "wide" column on the left and narrower column on the right. Each column supports a different set of web parts. By combining and reordering these web parts, an administrator can tailor the layout to the needs of the users.

For a hands-on example to try right now, explore the Collaboration Workspace project on your Trial Server.

To learn more, see Add Web Parts and Manage Web Parts. For a list of the types of web parts available in a full installation of LabKey Server, see the Web Part Inventory.

Header Menus

In the upper right, icon menus offer:

• (Search): Click to open a site-wide search box
• (Admin): Shown only to Admins: Administrative options available to users granted such access. See below.
• (User): Login and security options; help links to documentation and the trial support forum.

(Admin) Menu

The "first user" of this trial site will always be an administrator and have access to the menu. If that user adds others, they may or may not have the same menu of options available, depending on permissions granted to them.

• Site >: Settings that pertain to the entire site.
• Admin Console: In this Trial edition of LabKey Server, some fields are not configurable and may be shown as read-only. See Admin Console for details about options available in the full installation of LabKey.
• Site Users, Groups, Permissions: Site-level security settings.
• Create Project: Creates a new project (top-level folder) on the server.
• Folder >: Settings for the current folder.
• Permissions: Security configuration for the current folder.
• Management: General configuration for the current folder.
• Project Users and Settings: General configuration for the current project.
• Page Admin Mode: Used to change page layout and add or remove UI elements.
• Manage Views, Lists, Assays: Configuration for common data containers.
• Manage Hosted Server Account: Return to the site from which you launched this trial server.
• Go To Module >: Home pages for the currently enabled modules.

Security Model

LabKey Server has a group and role-based security model. Whether an individual is authorized to see a resource or perform an action is checked dynamically based on the groups they belong to and roles (permissions) granted to them. Learn more here: Security. Try a walkthrough using your Trial Server here: Exploring LabKey Security

Tools for Working Together

Collaborating with teams within a single lab or around the world is made easier when you share resources and information in an online workspace.

• Message Boards: Post announcements and carry on threaded discussions. LabKey uses message boards for the Support Forums. Learn more here.

• Issue Trackers: Track issues, bugs, or other workflow tasks (like assay requests) by customizing an issue tracker. LabKey uses an issue tracker to manage development issues. Learn more here.

• Wikis: Documents written in HTML, Markdown, Wiki syntax, or plain text; they can include images, links, and live content from data tables. You're reading a Wiki page right now. Learn more here.

• File Repositories: Upload and selectively share files and spreadsheets of data; connect with custom import methods. You can see an example here. Learn more here.

Tools for Data Analysis

Biomedical research data comes in many forms, shapes, and sizes. LabKey integrates directly with many types of instruments and software systems and with customization can support any type of tabular data.

• Uploading Data: From dragging and dropping single spreadsheets to connecting a data pipeline to an outside location for incoming data, your options are as varied as your data. Learn about the options here: Import Data.

• LabKey Data Grids: LabKey data grids show a configurable view of the underlying database table. To learn more, try a quick online tour of data grids.

• Interpreting Instrument Data: Using assay designs and pipeline protocols, you can direct LabKey Server to correctly interpret complex instrument data during import. Learn more here: Assay Data.

• Statistics and Queries: Add summary statistics to your data grids and write SQL queries within the UI. Learn more here: Column Summary Statistics and SQL Queries.

• Visualizations: Create easy charts and plots backed by live data. Learn more here: Visualizations.

• Reporting: Generate reports and query snapshots of your data. Use R, JavaScript, and LabKey plotting APIs to present your data in many ways. Learn more here: Reports and Charts.

Tools for Research Studies

Study folders organize research data about participants over time. There are many different ways to configure and use LabKey studies. Learn more here: Longitudinal Studies.

• Study Schedules and Navigation: Dashboards for seeing at a glance what work is completed and what is scheduled helps coordinators manage research data collection. Learn more here: Study Navigation.

• Participant and Date Alignment: By aligning all of your data based on the participant and date information, you can integrate and compare otherwise disparate test results. Explore the breadth of data for a single study subject, or view trends across cohorts of similar subjects. Learn more here: Study User Guide.

• Publishing and Sharing: Select who should see which parts of your study data and analysis. Choose how to publish results, including many options for obscuring and protecting PHI (protected health information) and aggregating results. Learn more here: Study Administrator Guide and Publish a Study: Protected Health Information / PHI.

What's Next?

Explore the example content on your Trial Server using one of these walkthroughs.

• Exploring LabKey Collaboration
• Exploring Laboratory Data
• Exploring LabKey Studies

• LabKey Server Documentation

• Tour
• Try It Now
• What Else Can I Do?
• More Tutorials

Tour

The "Collaboration Workspace" folder in the "Example Project" shows three web parts on its main dashboard. Web parts are user interface panels and can be customized in many ways.

• 1. Learn About LabKey Collaboration Folders: a panel of descriptive information (not part of a default Collaboration folder).
• 2. Messages: show conversations or announcements in a messages web part
• 3. Task Tracker: LabKey's issue tracker tools can be tailored to a variety of uses.

To help show some of the collaborative options, this project also includes a few sample users with different roles. You can see a message from the "team lead" and there is also a task called "Get Started" listed as a "Todo".

Try It Now

• Messages
• Task Tracker

Messages

A message board is a basic tool for communication; LabKey Message Boards can be customized to many use cases: from announcements to developer support and discussion.

• Notice the first message, "Hello World".
• Click View Message or Respond below it.
• Click Respond.
• Enter any text you like in the Body field. If you also change the Title, your response will have a new title but the main message thread will retain the existing title.
• Notice that you can select other options for how your body text is rendered. Options: Plain Text, HTML, Markdown, or Wiki syntax.
• Notice you could attach a file if you like.
• Click Submit.

• You are now viewing the message thread. Notice links to edit or delete. Since you an administrator on this server, you can edit messages others wrote, which would not be true for most users.
• You may have also received an email when you posted your response. By default, you are subscribed to any messages you create or comment on. Click unsubscribe to see how you would reset your preferences if you don't want to receive these emails.
• Click the Collaboration Workspace link near the top of the page to return to the main folder dashboard. These links are shown any time you are viewing a page within a folder.
• Notice that on the main folder dashboard, the message board does not show the text of your reply, but just the note "(1 response)".

• Click New to create a new message.
• You will see the same input fields as when replying; enter some text and click Submit.
• When you return to the main folder dashboard, you will see your new message.

• An administrator can control many display aspects of message boards, including the level of detail, order of messages, and even what "Messages" are called.
• The (triangle) menu in the upper right corner includes several options for customizing.

• New: Create a new message.
• View List: See the message board in list format.
• Admin: Change things like display order, what messages are called, security, and what options users have when adding messages.
• Email: Control when and how email notifications are sent about messages on this board.
• Customize: Select whether this web part shows the "full" information about the message, as shown in our example, or just a simple preview.

More details about using message boards can be found in this topic: Use Message Boards. You can also learn more about configuring message boards here: Tutorial: Collaboration Tools.

Task Tracker

LabKey provides flexible tools for tracking tasks with multiple steps done by various team members. Generically referred to as "issue trackers" the example project includes a simple "Task Tracker".

The basic life cycle of any task or issue moves through three states:

• Open: someone decides something needs to be done; various steps and reassignments can happen, including prioritization and reassignments
• Resolved: someone does the thing
• Closed: the orginal requestor confirms the solution is correct

• Navigate to the Collaboration Folder.
• Scroll down to the Task Tracker and click the title of the task, Get Started to open the detail view.
• The status, assignment, priority, and other information are shown here. You can see that the team leader opened this task and added the first step: assign this task to yourself.

• Click Update. Used when you are not "resolving" the issue, merely changing assignment or adding extra information.

• Select your username from the Assigned To pulldown.
• You could also change other information and provide an optional comment about your update.
• Click Save.
• Note: You may receive an email when you do this. Email preferences are configurable. Learn more here.
• The task is now assigned to you. You can see the sequence of changes growing below the current issue properties.

• Click Collaboration Folder to return to the main page.
• Notice the task is assigned to you now.

• Click New Task to create a new task.
• Enter your choice of title, notice that the default status "Open" cannot be changed, but you can change the priority, and enter other information. Note that setting the priority field is required.
• Assign the task to the "lab technician" user.
• Click Save to open the new issue.
• When you return to the task list on the Collaboration Workspace page, you will see it listed as issue 2.

To show how the resolution process works, you are an administrator and can use impersonation to take on another user's identity. Learn more here.

• Select (Your Username) > Impersonate > User.
• Choose "lab_technician" and click Impersonate. You are now seeing the page as the lab technician would.
• Click the title of the new task you assigned to the lab technician to open it.
• Click Resolve.
• Notice that by default, the resolved task will be assigned to the original user who opened it - in this case you!
• Select a value for the Resolution field, such as "Fixed".
• Enter a comment saying you've completed the task, then click Save.
• Click Stop Impersonating.
• Open the task again and close it as yourself.
• Enter a few more tasks to have more data for viewing.
• When finished, return to the Collaboration Folder main page.

The Task Tracker grid offers many options.

• Search the contents by ID number or search term using the search box.
• Sort and filter the list of tasks using the header menu for any column. Learn more here.
• Create custom grid views (ways to view tasks), such as "All assigned to me" or "All priority 1 issues for the current milestone". Use (Grid Views) > Customize Grid and add filters and sorts here. Learn more here.
• You could also customize the grid to expose other columns if helpful, such as the name of the user who originally opened the issue. Learn more here.

Another walkthrough using issue trackers can be found in the Collaboration Tutorial.

What Else Can I Do?

• Add New Web Parts
• Add a Wiki
• Add a List
• Add a File Repository

Add New Web Parts

Web parts are panels of user interface that display content to your users. As an administrator, you can customize what is shown on the page by using page admin mode. To add a new web part to any folder page:

• Select (Admin) > Page Admin Mode. Note that if you do not see this option, make sure you are logged in as an administrator and not impersonating another user.

• Notice that <Select Web Part> pulldown menus appear at the bottom of the page. There is a wider "main" column on the left and a narrow column on the right; each column supports a different set of web parts.
• Note: If both pulldown menus are stacked on the right, make your browser slightly wider to show them on separate sides.

• Select the type of web part you want to create on the desired side. For example, to create a main panel wiki like the welcome panel shown in the Collaboration Workspace folder, select Wiki on the left.
• Click Add.
• The new web part will be added at the bottom of the column. You can reposition it on the page using the (triangle) menu in the web part header. Move up or down as desired.

• Click Exit Admin Mode in the upper right.

If you later decide to remove a web part from a page, the underlying content is not deleted. The web part only represents the user interface.

For more about web part types and functionality, see Add Web Parts.

Add a Wiki

Wiki documents provide an easy way to display content. They can contain any text or visual information and be formatted in HTML, Markdown, Wiki syntax, or plain text by using "Wiki" format but not including formatting syntax. To create our first wiki, we use a wiki web part.

• Add a Wiki web part on the left side of the page. If you followed the instructions above, you already did so.
• Click Create a new wiki page. Note that if a page named "default" already exists in the folder, the new web part will display it. In this case, create a new one by selecting New from the (triangle) menu in the header of the web part.

• The Name must be unique in the folder.
• The Title is displayed at the top of the page.
• Choosing a Parent page lets you organize many wikis into a hierarchy. The table of contents on the right of the page you are reading now shows many examples.
• Enter the Body of the wiki. To change what formatting is used, use the Convert to... button in the upper right. A short guide to the formatting you select is shown at the bottom of the edit page.
• Notice that you can attach files and elect whether to show them listed at the bottom of the wiki page.
• Click Save & Close.
• Scroll down to see your new wiki web part.

• To reopen for editing, click the (pencil) icon.

More details about using wikis can be found in the Collaboration Tutorial.

Add a List

A list is a simple table of data. For example, you might store a list of labs you work with.

• Select (Admin) > Manage Lists.
• You will see a number of preexisting lists related to the task tracker.
• Click Create New List.
• Name: Enter a short name (such as "labs"). It must be unique in the folder.
• Primary Key: Enter "Name" in this field. If you leave the Primary Key default "Key", the new list will contain a "Key" column. In this example, we will use a column called "Name" as the key.
• Primary Key Type: Select "Text (String)". The default is "Auto-Increment Integer", but in our example we use a text name.
• Leave the box to import from file unchecked for this first list.

• Click Create List.
• Review the list properties available; for this first example, leave them unchanged.
• Scroll down to List Fields and notice that "Name" was created and shows a (key) icon. You could give it a new label, like "Lab Name" if you like. Notice a (wrench) icon marks rows with unsaved changes.
• Click Add Field and enter the name and label for each column you want in your list. In this example, we have added an address and contact person.

• Click Save, then click Done to create the "labs" list. You will see it in the grid of "Available Lists".

To populate this new empty list:

• Click the list name ("labs") in the grid. There is no data to show.
• Select (Insert data) > Insert new row.
• Enter any values you like.
• Click Submit.
• Repeat the process to add a few more rows.

• Click the Collaboration Workspace link to return to the main folder page.
• Add a List - Single web part on the left side of the page.
• Give it the title you like, and select the new list you just created.
• Click Submit.

Now your collaboration workspace shows quick contact information on the front page.

Learn more about creating and using lists here and in the Tutorial: Lists.

Add a File Repository

• Add a Files web part on the left side of the page.
• Drag and drop files and folders into the window to upload them.

• Each file can then be downloaded by other users of the collaboration workspace.

See the Tutorial: File Repository for a walkthrough of using file repositories.

More Tutorials

Other tutorials using "Collaboration" folders that you can run on your LabKey Trial Server:

• Tutorial: Collaboration Tools
• Tutorial: File Repository
• Tutorial: Lists
• Tutorial: Security

Explore More on your LabKey Trial Server

• Exploring Laboratory Data
• Exploring LabKey Studies
• Exploring LabKey Security

• Tour
• Try It Now
• What Else Can I Do?
• More Tutorials

Tour

The "Laboratory Data" folder is an Assay folder. You'll see four web parts in our example:

• 1. Learn About LabKey Assay Folders: a panel of descriptive information (not part of a default Assay folder).
• 2. Assay List: a list of assays defined in the folder. Here we have "Blood Test Data."
• 3. Blood Test Data Results: A query web part showing a grid of data.
• 4. Files: a file repository where you can browse files in this container or upload new ones.

The folder includes a simple assay design created from the "General Purpose Assay Type" (GPAT) representing some blood test results. A single run (spreadsheet) of data has been imported using it. Continue below to try out the assay tools.

Try It Now

• Assay List: Assay designs for data and metadata
• Blood Test Data Results: Reviewing and analyzing data in grids
• Files: Uploading and importing files

Assay List

Using an Assay List web part, you can browse existing assay designs and as an administrator, add new ones. An assay design tells the server how to interpret uploaded data. Click the name of the design in this web part to see the run(s) that have been uploaded.

• Click the name Blood Test Data in the Assay List to see the "Runs" imported using it.

• In this case, a single run (spreadsheet) "BloodTest_Run1.xls" has been imported. Click the Assay ID (in this case the file name) to see the results.

• This example shows blood data for 3 participants over a few different dates. White blood counts (WBC), mean corpuscular volume (MCV), and hemoglobin (HGB) levels have been collected in an Excel spreadsheet.

• To see the upload process, we can simulate importing the existing run by clicking Re-Import Run above the grid. We will cancel the import before any reimporting actually happens.
• The first page shows:
• Assay Properties: These are fixed properties, like the assay design name, that are read only for all imports using this design.
• Batch Properties: These properties will apply to a set of files uploaded together. For example, here they include specifying how the data is identified (the Participant/Visit setting) and selecting a target study to use if any data is to be copied. Select /Example Project/Research Study (Research Study).

• Click Next.
• On the next page, notice the batch properties are now read only.
• Below them are Run Properties to specify; these could be entered differently for each run in the assay, such as the "Assay ID". If not provided, the name of the file is used, as in our example.
• Here you also provide the data from the assay run, either by uploading a data file (or reusing the one we already uploaded) or entering your own new data.
• Click Show Expected Data Fields. You will see the list of fields expected to be in the spreadsheet. When you design the assay, you specify the name, type, and other properties of expected columns.

• Click Download Spreadsheet Template to generate a blank template spreadsheet. It will be named "data_<datetimestamp>.xls". By opening it in Excel and populating it, you can upload your own data to this server as a new run. Save this file and use it when you get to the Files section below.

• Since we are just reviewing the process right now, click Cancel after reviewing this page.

Next, review what the assay design itself looks like. You need to be an administrator to perform this step.

• From the Blood Test Data Runs page, select Manage Assay Design > Edit assay design to open it.

The sections correspond to how a user will set properties as they import a run.

• Assay Properties: Values that do not vary per run or batch.
• Batch Fields: Values set once for each batch of runs.
• Run Fields: Values set per run; in this case none are defined, but as you saw when importing the file, some built in things like "Assay ID" are defined per run.
• Data Fields: This is the heart of the assay design and where you would identify what columns are expected in the spreadsheet, what labels to use, what their datatype is. If you click a row, you can also set other properties of each column--including things like whether a value can be used as a "measure" in reporting, as shown here for the WBC field.

• Review the contents of this page, but make no changes and click Cancel.
• Return to the main folder page by clicking the Laboratory Data link near the top of the page.

Blood Test Data Results

The assay results are displayed in a web part on the main page. Explore some general features of LabKey data grids here:

Column Header Menus: Each column header has a menu of options to apply to the grid based on the values in that column.

Sort: Click the header of the WBC column and select Sort Descending. Notice the (sort) icon that appears in the column header.

Filter: Click the header of the Participant ID column and select Filter... to open a popup.

• Use the checkboxes to "Choose Values". For this example, uncheck the box for "202". Switching to the filtering tab in this popup would let you use filter expressions instead. The option to choose values is only available when there are a limited number of distinct values.

• Click OK to apply the filter. Notice the (filter) icon shown in the column header. There is also a new entry in the filter panel above the grid - you can clear this filter by clicking the for the "Participant <> 202" filter.

• Select the statistics you would like to show (the values are previewed in the popup.) In this case, Mean might be most interesting. Click Apply.

• Notice the new row at the bottom of the grid showing the Mean for this column.

Notice the message "This grid view has been modified" was added when you added the summary statistic. The grid you are now seeing is not the original default. You have not changed anything about the underlying imported data table, merely how you see it in this grid. Click Save to make this changed grid view persistent and sharable with others.

• Select Named and give the new grid a name (such as "Grid with Statistic").
• Check the box for "Make this grid view available to all users."
• Click Save.
• Notice that the grid now has Grid With Statistic shown above it.
• To switch between grid views, use the (Grid Views) menu in the grid header. Switch between "default" and "Grid With Statistic" to see the difference.

• Return to the "default" view before proceeding with this walkthrough.

There is not enough data in this small spreadsheet to make meaningful visualizations or reports, but you can see how the options work:

• Column Visualizations: Each column header menu has a set of visualizations available that can be displayed directly in the grid view. Options vary based on the data type. For example, from the "WBC" column header menu, choose Box and Whisker.

• Quick Charts: Choose Quick Chart from the header menu of any column to see a quick best guess visualization of the data from that column. The default is typically a box and whisker plot.

• While similar to the column chart above, this chart creates a stand alone chart that is named and saved separately from the grid view.
• It also opens in the "Chart Wizard", described next, which offers many customization options.
• Note that a chart like this is backed by the "live" data in the source table. If you change the underlying data (either by editing or by adding additional rows to the table) the chart will also update automatically.

• Plot Editor: More types of charts and many more configuration options are available using the common plot editor, the "Chart Wizard".
• Return to the grid view if you navigated away.
• Select (Charts) > Create Chart above the grid.
• Select the type of chart you want using the options along the left edge.

Learn more about creating and customizing each chart type in the documentation. You can experiment with this small data set or use the more complex data when Exploring LabKey Studies.

• Bar Charts
• Box Plots
• Line Plots
• Pie Charts
• Scatter Plots

Files

The Files web part lists the single assay run as well as the log file from when it was uploaded.

To explore the abilities of the file browser, we'll create some new assay data to import.

• Open the template you downloaded earlier. It is an Excel file named "data_<datetimestamp>.xls"
• Enter some values. Some participant ID values to use are 101, 202, 303, 404, 505, and 606, though any integer values will be accepted. You can ignore the VisitID column and enter any dates you like. The WBC and MCV columns are integers, HGB is a double. The more rows of data you enter, the more "new" results you will have available to "analyze."
• Save the spreadsheet with the name "data_run2.xls" if you want to match our instructions.
• You can also click here to download ours if you want your data to match our screenshots: data_run2.xls

• Return to the Example Project > Laboratory Data folder.
• Drag and drop the "data_run2.xls" file into the Files web part to upload it.

• Select it using the checkbox and click Import Data.
• By default, the "Blood Test Data" assay design we predefined is selected. Leave this choice, but notice you could create a new "General Purpose" assay design by clicking that option.
• Click Import.

• You will see the Assay Properties and be able to enter Batch Properties; select "Example Project/Research Study" as the Target Study.
• Click Next.
• On the Run Properties and Data File page, notice your "data_run2.xls" file listed as the Run Data. You don't need to make any changes on this page.
• Click Save and Finish.
• Now you will see the runs grid, with your new run added to our original sample.

• Click the file name to see the data you created.
• Notice the (Grid Views) menu includes the custom grid view "Grid with Statistic" we created earlier - select it.
• Notice the grid also shows a filter "Run = 2" because you clicked the run name to view only results from that run. Click the for the filter to delete it.
• You now see the combined results from both runs.

• If you saved any visualizations earlier using the original spreadsheet of data, view them now from the (Charts/Reports) menu, and notice they have been updated to include your additional data.

What Else Can I Do?

• Define a New Assay for a data spreadsheet of your own.
• Understand Copy to Study, which was done already for our sample spreadsheet

Define a New Assay

LabKey can help you create a new assay design from a spreadsheet of your own. Choose something with a few columns of different types, or simply add a few more columns to the "data_run2.xls" spreadsheet you used earlier. If you have existing instrument data that is in tabular format, you can also use that to complete this walkthrough. Here we use the name "mydata.xls" to represent your own spreadsheet of data.

• Navigate to the main page of the Laboratory Data folder.
• Drag and drop your "mydata.xls" file to the Files web part.
• Select the file and click Import Data.

• In the popup, choose "Create New General Assay Design" and click Import.
• Give your new assay design a Name, such as "MyData".
• Notice the default Location is the current project. Select instead the "Current Folder (Laboratory Data)".
• The Columns for Assay Data section shows the columns imported from your spreadsheet and the data types the server has inferred from the contents of the first few rows of your spreadsheet.
• If you see a column here that you do not want to import, simply uncheck it. If you want to edit column properties, you can do that using the (triangle) button next to the column name.

• You can change the inferred data types as necessary. For example, if you have a column that happens to contain whole number values, the server will infer it is of type "Integer". If you want it to be "Number (Double)" instead, select that type after clicking the (caret) button next to the type. If a column happens to be empty in the first few rows, the server will guess "Text (String)" but you can change that as well.
• Column Mapping below these inferrals is where you would map things like Participant ID and Date information. For instance, if you have a column called "When" that contains the date information, you can tell the server that here. It is not required that you provide mappings at all.

• When you are satisfied with how the server will interpret your spreadsheet, scroll back up and click Begin Import.
• You will be simultaneously creating the assay design (for this and future uses) and importing this single run. Enter batch properties if needed, then click Next.
• Enter run properties if needed, including an Assay ID if you want to use a name other than your file name.
• Click Show Expected Data Fields to review how your data will be structured. Notice that if you didn't provide mappings, new columns will be created for Specimen, Participant, Visit ID, and Date.
• Click Save and Finish.

• You now see your new run in a grid, and the new assay design has been created.

• Click the filename to see your data.
• Select Manage Assay Design > Edit assay design to review the assay design.
• Click Laboratory Data to return to the main folder page.
• Notice your new assay design is listed in the Assay List.

• You can now upload and import additional spreadsheets with the same structure using it. When you import .xls files in the future, your own assay design will be one of the options for importing it.

Understand Copy to Study

You may have noticed the Copied to Research Study column in the Blood Test Data Results web part. The sample assay design includes copying data automatically to the Example Project/Research Study folder on your Trial Server.

"Copying" data to a study does not literally copy the data. What is created is a dynamic link so that the assay data can be integrated with other data in the study about the same participants. When data changes in the original container, the "copied" set in the study is also updated.

Click the View Copy-to-Study History link in the Blood Test Data Results web part.

You will see at least one copy event from the original copy that occurred when our sample data was copied during the startup of your server (shown as being created by the "team lead"). If you followed the above steps and uploaded a second "data_run2.xls" spreadsheet, it will also be listed, created by you.

• Click View Results to see the result rows.
• Click one of the links in the Copied to Research Study column. You see what appears to be the same grid of data, but notice by checking the project menu or looking at the URL that you are now in the "Research Study" folder. You will also see the tabs present in a study folder.

• Click the Clinical and Assay Data tab.
• Under Assay Data you will see the "Blood Test Data" copied dataset. In the topic Exploring LabKey Studies we will explore how that data can now be connected to other participant information.

• Using the project menu, return to the Laboratory Data folder.

More Tutorials

Other tutorials using "Assay" folders that you can run on your LabKey Trial Server:

• Tutorial: Design a General Purpose Assay Type (GPAT)
• Tutorial: Electronic Lab Notebook

Explore More on your LabKey Trial Server

• Exploring LabKey Collaboration
• Exploring LabKey Studies
• Exploring LabKey Security

• Tour
• Try It Now
• What Else Can I Do?
• More Tutorials

Tour

The "Research Study" folder contains a simple fictional study. There are 5 tabs in the default LabKey study folder; the main landing page is the Overview tab where you will see three web parts:

• 1. Learn About LabKey Study Folders: a panel of descriptive information (not part of a default Study folder)
• 2. Study Data Tools: commonly used tools and settings.
• 3. Study Overview: displays study properties and quick links to study navigation and management options.

A study has five tabs by default. Each encapsulates functions within the study making it easier to find what you need. Click the tab name to navigate to it. Returning to the Research Study folder returns you to the Overview tab.

Participants: View and filter the participant list by cohort; search for information about individuals

Clinical and Assay Data: Review data and visualizations available; create new joined grids, charts, charts and reports.

The Data Views web part lists several datasets, joined views, and reports and charts.

• Hover over a name to see a preview and some metadata about it.
• Click a name or use the (Details) link to open an item.
• The Access column indicates whether special permissions have been set for an item. Remember that only users granted "Read" access to this folder can see any content here, so seeing "public" means only that it is shared with all folder users. Other options are "private" (only visible to the creator) and custom (shared with specific individuals). See Manage Study Security (Dataset-Level Security) for more information.

• Demographic datasets contain a single row per participant for the entire study.
• Clinical datasets can contain many rows per participant, but only one per participant and date combination.
• Assay datasets, typically results from instrument tests, can contain many rows per participant and date.

Manage: Only administrators can access this dashboard for managing the study.

Try It Now

This example study includes a simplified research scenario. Let's explore some key feature areas on each tab:

• Change Study Properties
• Track Overall Progress
• View Participant Data: Get the picture for a specific study subject.
• Integrate Data Aligned by Participant and Date: Aggregate cross-study information to see broader trends.
• Customize Visualizations and Reports
• Manage Your Study

Display Study Properties

The Study Overview web part shows properties and introductory information about your study.

• Click the Overview tab.
• Click the (pencil) icon.
• Review and change study properties:

• Label: By default, the folder name, here "Research Study," is used. You can edit to make it more descriptive, such as "HIV Study".
• Investigator: Enter your own name to personalize this example.
• Grant/Species: If you enter the grant name and/or species under study, they will be displayed. These fields also enable searches across many study folders to locate related research. Enter a grant name to see how it is shown.
• Description/Render Type: Our example shows some simple HTML formatted text. You can include as much or as little information here as you like. Select a different Render Type to use Markdown, Wiki syntax, or just plain text.
• Protocol Documents: Attach documents if you like - links to download will be included in the web part.
• Timepoint Type: Studies can use several methods of tracking time; this decision is fixed at the time of study creation and cannot be modified here. See Visits and Dates to learn more.
• Start/End Date: See and change the timeframe of your study if necessary. Note that participants can also have individual start dates. Changing the start date for a study in progress should be done with caution.
• Subject Noun: By default, study subjects are called "participants" but you can change that here to "subject," "mouse," "yeast," or whatever noun you choose. Try changing these nouns to "Subject" and "Subjects".
• Subject Column Name: Enter the name of the column in your datasets that contains IDs for your study subjects. You do not need to change this field to match the subject nouns you use.
• When finished, click Submit and see how this information is displayed. Notice the "Participants" tab name is changed.

• Reopen the editor and change the subject noun back to "Participant[s]" to restore the original tab and tool names for this walkthrough.

Track Overall Progress

• Return to the Overview tab if you navigated away.
• Click the Study Navigator link or the small graphic in the Study Overview web part.
• The Study Navigator shows you at a glance how much data is available in your study and when it was collected.
• Rows represent datasets, columns represent timepoints.

• Use the Participant's current cohort dropdown to see collection by cohort.
• Use the checkboxes to switch between seeing counts of participants or rows or both.
• Click the number at the intersection of any row and column to see the data. For example, Lab Results in month two look like this:

View Participant Data

Within a study you can dive deep for all the information about a single participant of interest.

• Click the Participants tab.
• If you know the participant ID, you can use the search box to find their information.
• The Participant List can be quickly filtered using the checkboxes on the left.
• Use the Filter box to narrow the list if you know part of the participant ID.
• Hover over a label to see the group member IDs shown in bold. Click a label to select only that filter option in that category. Here we see there are 8 participants enrolled receiving ARV treatment.

• Click any participant ID to see all the study data about that participant.
• The details of any dataset can be expanded/collapsed using the and icons.

• Click the Search For link above the report to search the entire site for other information about that participant. In this case, you will also see results from the "Laboratory Data" folder in this project.

Integrate Data Aligned by Participant and Date

Study datasets can be combined to give a broad picture of trends within groups over time.

• Click the Clinical and Assay Data tab.
• There are three primary datasets here: Demographics, Physical Exam, and Lab Results.
• Click "Joined View: Physical Exam and Demographics" to open an integrated custom grid.

This grid includes columns from two datasets. To see how it was created:

• Select (Grid Views) > Customize Grid.
• Scroll down on the Available Fields side to Datasets and click the to expand it. Listed are the two other datasets.
• Expand the "Demographics" node by clicking the .

• Scroll down and notice the checked fields like Country and Group Assignment which appear in our joined view.
• Scroll down on the Selected Fields side to see these fields shown.
• You can use checkboxes to add more fields to what is shown in the grid, drag and drop to rearrange columns in your view, and use the and icons for selected fields to edit display titles or delete them from the view.
• Click View Data when finished to see your changes.

• Notice the message indicating you have unsaved changes. Click Revert to discard them.

Customize Visualizations and Reports

In Exploring Laboratory Data we show you how to create charts and plots based on single columns or tables. With the integration of diverse data in a study, you can easily create visualization and reports across many tables, backed by live data. Our example study includes a few examples.

• On the Clinical and Assay Data tab, click Bar Chart: Blood Pressure by Cohort and Treatment.
• Here we see plotted a measure from the "Physical Exam" dataset (Systolic Blood Pressure) against cohort and treatment group data from the "Demographics" dataset.

• Click Edit in the upper right to open the plot for editing.
• Click Chart Type to open the chart wizard.

• Columns on the right can be dragged and dropped into the plot attribute boxes in the middle.
• Select a different plot type using the options to the left. The plot editor will make a best effort to retain plot attribute column selections, though not all attributes apply to each chart type.
• Click Box.
• Notice that the X and Y axis selections are preserved.
• Drag the column "Study: Cohort" to the "Color" box.
• Drag the column "Gender" to the "Shape" box.

• Click Apply to see the new box plot. At present, only the outliers make use of the color and shape selections.

• Click Chart Layout.
• Give the plot a new title, like "Systolic - Box Plot"
• Change Show Points to All.
• Check the box to Jitter Points; otherwise points will be shown in a single column.
• Scroll down to see the controls for plot line and fill colors.
• Choose a different Color Palette from which the point colors will be selected. Shown here, "Dark".

• Click Apply to see the revised box plot.

• Click Save As to save this as a new visualization and preserve the original bar chart.
• Give the new report a name and click Save in the popup.

Manage Your Study

On the Manage tab, you can control many aspects of your study. For example, click Manage Cohorts to review how cohorts were assigned and what the other options are:

• Assignment Mode: Cohorts can be simple (fixed) or advanced, meaning they can change during the study.
• Assignment Type: You can manually assign participants to cohorts, or have assignments made automatically based on a dataset.
• Automatic Participant/Cohort Assignment: Choose the dataset and column to use for assigning cohorts.

What Else Can I Do?

• Manage Dataset Security
• Learn about Protecting PHI
• Publish the Study

Manage Dataset Security

Access to read and edit information in folders is generally controlled by the LabKey role based security model. Within a study, you gain the additional option of dataset level security.

• On the Manage tab, click Manage Security.
• Review the Study Security Type: Datasets can be read-only or editable, under either type of security:
• Basic security: folder permissions determine access to all datasets
• Custom security:
• Change the type to Custom security with editable datasets. Notice the warning message that this can change who can view and modify data.
• Click Update Type.
• When using custom security, there are two additional web parts on the page:
• Study Security: Use radio buttons to grant access to groups. Click Update after changing. In the screenshot below, we're changing the "Study Team" and "Example Team Members" groups to "Per Dataset" permissions.

• Per Dataset Permissions: Once any group is given per-dataset permissions using the radio buttons, you will have the option to individually set permission levels for each group for each dataset.
• Click Save when finished, or to revert to the configuration before this step, set all for "Example Team Members" to read, and set all for "Study Team" to edit.

Learn About Protecting PHI

When displaying or exporting data, Protected Health Information (PHI) that could be used to identify an individual can be protected in several ways.

Alternate Participant IDs and Aliases

If you want to share data without revealing participant IDs, you can use a system of alternates or aliases so that you can still show a consistent ID for any set of data, but it is not the actual participant ID.

Mark Data as PHI

There are four levels to consider regarding protection of PHI, based on how much information a user will be authorized to see. For PHI protection to be enforced, you must BOTH mark data as PHI and implement viewing and export restrictions on your project. Data in columns can be marked as:

• Restricted: The most sensitive information not shared with unauthorized users, even those authorized for Full PHI.
• Full PHI: Only shared when users have permission to see all PHI. The user can see everything except restricted information.
• Limited PHI: Some information that is less sensitive can be visible here.
• Not PHI: All readers can see this information.

To mark a column's PHI level:

• On the Clinical and Assay Data tab, open the dataset of interest. Here we use the Demographics dataset.
• Above the grid, click Manage.

• Click Edit Definition.

• Scroll down to the dataset fields and select the field of interest, here "Status of Infection."
• In the properties panel, click the Advanced tab.
• The default PHI Level is "Not PHI". Make another selection from the dropdown to change; in this example, we choose "Full PHI".

• Adjust PHI levels for as many fields as necessary.
• Scroll up and click Save.
• Click View Data to return to the dataset.

Publish the Study

Publishing a LabKey study allows you to select all or part of your results and create a new published version.

• Click the Manage tab.
• Click Publish Study (at the bottom).
• The Publish Study Wizard will guide you through selecting what to publish.
• By default, the new study will be called "New Study" and placed in a subdirectory of the current study folder.
• Select the participants, datasets, timepoints, and other objects to include. On the Datasets step, you can elect to have the study refresh data if you like, either manually or nightly.
• The last page of the publish wizard offers Publish Options including excluding PHI or randomizing other information that could identify individuals.
• Click Finish at the end of the wizard to create the new study folder with the selected information.

Explore the new study, now available on the projects menu.

More Tutorials

Other tutorials using "Study" folders that you can run on your LabKey Trial Server:

• Tutorial: Cohort Studies
• Tutorial: Set Up a New Study
• Tutorial: Specimen Request System

Explore More on your LabKey Trial Server

• Exploring LabKey Collaboration
• Exploring Laboratory Data
• Exploring LabKey Security

• Tour
• Try It Now
• What Else Can I Do?
• Learn More

Tour

Our Example Project contains three subfolders, intended for different groups of users:

• Collaboration Workspace: The entire team communicates here and shares project-wide information.
• Laboratory Data: A lab team performs tests and uploads data here, perhaps performing basic quality control.
• Research Study: A team of researchers is exploring a hypothesis about HIV.

Project Groups

Groups at the project level allow you to subdivide your project team into functional subgroups and grant permissions on resources to the group as a whole in each folder and subfolder. While it is possible to assign permissions individually to each user, it can become unwieldy to maintain in a larger system.

• Navigate to the Example Project. You can be in any subfolder.
• Select (Admin) > Folder > Permissions.
• Click the tab Project Groups.

• There are 5 predefined project groups. See at a glance how many members are in each.
• Click the name to see the membership. Click Example Team Members and see the list of all our example users.

• Click Done in the popup.
• Click the Lab Team to see that the two members are the team lead and the lab technician.
• Click the Study Team to see that the two members are the team lead and the study researcher.

Next we'll review how these groups are assigned different permissions within the project's subfolders.

Permission Roles

Permission roles grant different types of access to a resource. Read, Edit, and Admin are typical examples; there are many more permission roles available in LabKey Server. Learn more here.

• If you navigated away after the previous section, select (Admin) > Folder > Permissions.
• Click the Permissions tab.
• In the left column list of folders, you will see the entire project hierarchy. The folder you are viewing is shown in bold. Click Example Project to see the permissions in the project itself.

• The "Admin Team" is both project and folder administrator, and the "Example Team Members" group are Editors in the project container.

• Click Collaboration Workspace and notice that the "Example Team Members" are editors here, too.
• Click Laboratory Data. In this folder, the "Lab Team" group has editor permissions, and the "Example Team Members" group only has reader permission.
• Note that when users are members of multiple groups, like in the case of our sample "lab_technician@local.test", they hold the sum of permissions granted through the groups they belong to. This lab_technician has read access with example team membership, but also editor access because of lab team membership, so that user will be able to edit contents here.
• To see the user membership of any group, click the group name in the permissions UI.
• To see all permissions granted to a given user, click the Permissions link in the group membership popup.

• This example lab technician can edit content in the example project, the collaboration workspace folder, and the laboratory data folder. They can read but not edit content in the research study folder.

• Close any popups, then click Cancel to exit the permissions editing UI.

Try It Now

• Impersonate a User
• Impersonate a Group
• Audit Logging

Impersonation

Using impersonation, an admin can see what another user would be able to see and do on the server.

• Navigate to the Example Project/Research Study folder using the project menu.
• Notice that as yourself, the application admin on this server, you can see a (pencil) icon in the header of the Study Overview web part. You would click it to edit study properties. You also see the Manage tab.
• Select (User) > Impersonate > User.

• Select "lab_technician@local.test" from the dropdown and click Impersonate.
• Now you are the lab technician with permission to read the content here, but cannot change it as we saw when reviewing permissions above.
• Notice the (pencil) icon and Manage tabs are no longer visible. You also no longer have access to the (Admin) menu in the header.
• Click Stop Impersonating to return to your own "identity".

Impersonate a Group

Impersonation of a group can help you better understand permissions and access. In particular, when configuring access and deciding what groups should include which users, group impersonation can be very helpful.

• Navigate to the Example Project/Research Study folder using the project menu.
• Select (User) > Impersonate > Group.
• Choose the "Study Team" and click Impersonate.
• Hover over the project menu and notice that the only folder in "Example Project" that members of the "Study Team" can read is this "Research Study" folder.

• Click Stop Impersonating.
• To see an error, select (User) > Impersonate > Group, choose the "Lab Team" and click Impersonate. This group does not have access to this folder, so the error "User does not have permission to perform this operation" is shown.
• Click Stop Impersonating.

Impersonate a Role

You can also directly impersonate roles like "Reader" and "Submitter" to see what access those roles provide.

To learn more about impersonation, see Test Security Settings by Impersonation.

Audit Logging

Actions on LabKey Server are extensively logged for audit and security review purposes. Impersonation is among the events logged.

• Select (Admin) > Site > Admin Console.
• Click Admin Console Links.
• Under Management, click Audit Log.
• Using the pulldown, select User Events.

• You will see the impersonation events you just performed. Notice these are paired events - both the action taken by the user to impersonate, and the action performed "on" the impersonatee.
• Explore other audit logs to see other kinds of events tracked by the server.

What Else Can I Do?

The Security Tutorial walks you through more security features. You can create a new project for tutorials on your trial server, then run the security tutorial there.

• Tutorial: Security

Learn More

• Security
• Compliance

Explore More on your LabKey Trial Server

• Exploring LabKey Collaboration
• Exploring Laboratory Data
• Exploring LabKey Studies

• Create a Project
• Add Some Content
• Share With Others
• What Else Can I Do?

Create a Project

To open the project creation wizard you can:

• Click the "Create" button on the Trial Server home page.
• OR: Select (Admin) > Site > Create Project.
• OR: Click the "Create Project" icon at the bottom of the project menu as shown:

The project creation wizard includes three steps.

1. Give the project a Name and choose the folder type.
2. Configure users and permissions (or accept the defaults and change them later).
3. Choose optional project settings (or configure them later).

• Select (Admin) > Site > Create Project.
• Step 1: Create Project:
• Enter the Name: "Tutorials". Project names must be unique on the server.
• Leave the box checked to use this as the display title. If you unchecked it, you could enter a different display title.
• Folder Type: Leave the default selection of "Collaboration". Other available folder types are listed. On a trial server, there are a few basic options. Hover to learn more about any type; click Folder Help for the list of folder types available in a full LabKey installation.

• Click Next.

• Step 2: Users / Permissions: Choose the initial security configuration. As the admin, you can also change it later.
• The default option "My User Only" lets you set up the project before inviting additional users.
• The other option "Copy From Existing Project" is a helpful shortcut when creating new projects to match an existing one.
• Leave "My User Only" selected and click Next.

• Step 3: Project Settings:
• On a LabKey Trial Server, you cannot Choose File Location, so this option is grayed out.
• Advanced Settings are listed here for convenience, but you do not need to set anything here.
• Simply click Finish to create your new project.

• You'll now see the landing page of your new project and can start adding content.

Add Some Content

Let's customize the landing page and make it easier to use.

• In the Wiki web part, click Create a new wiki page to display in this web part.
• Leave the Name as "default"
• Enter the Title "Welcome"
• In the body field, enter: "Feel free to make a new subfolder and run a tutorial in it."
• Click Save & Close.

• Customize the page layout:
• Select (Admin) > Page Admin Mode.
• In the web part header menu for your new "Welcome" wiki, select (triangle) > Move Up.
• In the web part header menu for both "Messages" and "Pages", select (triangle) > Remove From Page.

• Click Exit Admin Mode.

You can now use this project as the base for tutorials.

Subfolders Web Part

Most LabKey tutorials begin with creation of a new subfolder of a specific type, which you can add by clicking Create New Subfolder here. There are no subfolders to display yet, but once you add a few, this web part will look something like this, giving you a one click way to return to a tutorial folder later.

Tutorials for your LabKey Trial Server

Try one of these:

• Tutorial: Collaboration Tools
• Tutorial: File Repository
• Tutorial: Design a General Purpose Assay Type (GPAT)
• Tutorial: Cohort Studies

Share With Others

Now that you have created a new project and learned more about LabKey Server, consider sharing with a colleague. To invite someone to explore the Trial Server you created, simply add them as a new user:

What Else Can I Do?

Change the Color Scheme

The color scheme, or theme, is a good way to customize the look of a given project. To see what the other themes look like, see Web Site Theme.

To change what your Tutorials project looks like:

You can also change the theme for the site as a whole by selecting (Admin) > Site > Site Console. Click Admin Console Links, then under Configuration, choose Look and Feel Settings. The same options are available for the Theme setting.

What's Next?

You can create more new projects and folders on your LabKey Trial Server to mock up how it might work for your specific solution. Many features available in a full LabKey installation are not shown in this trial version; you can learn more in our documentation.

Feel free to contact us and we can help you determine if LabKey is the right fit for your research.

Related Topics

• Explore LabKey Server - Hosted Trial
• Upgrade Options

• Announcements: Message Board and Discussion Service
• API: Internal API classes
• Audit: Audit Log Service
• CAS: CAS SSO Authentication Service
• Core: Administration and Essential Services
• Docker: Docker Module
• EvaluationContent: Evaluation Server Content Module
• Experiment: Experiment Service
• FileContent: File Content Service
• Internal: Internal Classes and Resources
• Issues: Issue Tracking Service
• List: List Service
• Pipeline: Pipeline Service
• Query 18.10: Query Service
• rstudio: Integrate RStudio Functionality
• Search: Search Service
• Study: Study and Assay Service
• Visualization: Visualization Service
• Wiki: Wiki Service

Community Edition

• List of modules available in the Community Edition of LabKey Server.

Premium Editions

To learn about additional features and modules available with LabKey Premium Editions, review this chart or contact us.

To get started using LabKey Server and understanding how it can improve your research workflows, you can create a hosted LabKey Server - Trial instance. Go here to Start Your Free Trial, enter some basic contact information, then go!

In the hosted account manager, select the product LabKey Server - Trial and click Create Site.

Trial server instances contain key functionality available and come preloaded with some basic content to get you started. Upload your own data, try tutorials, explore features only available in premium editions, and even create a custom site to share with colleagues. Your trial lasts 30 days and we're ready to help you with next steps toward incorporating LabKey Server into your research projects.

• Learn the Basics of LabKey Server
• Preview Premium Features
• Explore More Data Analysis Options
• Learn about Developer Extensibility

Learn the Basics: Tours & Tutorials

Step by step introductions to getting started with key functionality of LabKey Server.

• Learn About LabKey Server: Trial
• Exploring LabKey Collaboration
• Exploring Laboratory Data
• Exploring LabKey Studies
• Exploring LabKey Security
• Exploring Project Creation

Premium Features

Some advanced functionality is available only in premium editions of LabKey Server, which also include professional support. Your 30 day trial includes a few of these features so you can see them in action prior to subscribing.

• Extract Transform Load (ETL)
• Quality Control Trend Reporting
• Compliance Features
• File Watcher

Explore More Data Analysis Options

Once you are familiar with the basics of LabKey, you can explore some of the built-in data analysis options using your trial server:

• Instrument Data: A range of plate-based and non-plate-based assays.
• Flow Cytometry
• Proteomics

Development with LabKey Server

• Using R with LabKey
• Using LabKey SQL
• JavaScript API
• Customizing the UI (TBD): Button bars,

Trial Support Forum

If you have questions or need guidance, please reach out in the Trial Support Forum.

Set Up the VM Instance

• Download and install VirtualBox 5.2. Accept the default options.
• Register with LabKey at {https://www.labkey.com/forms/register-to-download-labkey-server}
• Download the LabKey Server VM image by clicking Download VM Image.

• In VirtualBox, select File > Import Appliance. In the Virtual Machine Appliance popup dialog, browse to and select the downloaded virtual machine file. Click Next. Accept the defaults and click Import.
• Once the VM has been added to the list, select it, and click Start > Normal Start.
• VirtualBox will startup the server VM. (This may take a few minutes to complete.)
• When the server VM is ready, you will see a new VirtualBox window requesting an ubuntu login. Ignore but do not close this window; you do not need to log in here.

Launch LabKey Server

• When startup has finished, open a new web browser window or tab (such as Chrome) outside the vm. Go to the following URL location to find the LabKey Server instance running. If you do not see a server running there, wait a few more minutes for startup to complete.

  http://localhost:8000/

• When you first invoke the server, you will be prompted to set up an account by entering your email address and password. (This first user account created is the Site Administrator for this LabKey installation.)
• LabKey Server is now available to use.
• To begin, see next steps below.

Add External Users / Collaborators

If you want to add other users to your VM instance so they can explore and collaborate, you must first do the following so that the auto-generated email will direct them to the machine and port where your server is running:

• Select (Admin) > Site > Admin Console.
• Click Admin Console Links.
• Under Configuration, click Site Settings.

• Set the Base Server URL field to your machine or ip address. You will need to keep the port (:8000) on the name (example http://MyMachineOrIPAddress:8000).

• Click Save. The value in this field will now be included in any invite emails that are sent out.
• Proceed to add users.

Next Steps

• Explore basic features using the the built-in example project:
• Click the LabKey logo in the upper left to return to the home page of your server.
• Click the Example Project icon.
• Use the introductory topics here to explore the examples: Explore LabKey Server - Hosted Trial

• The following tutorials provide step by step instructions for exploring even more key functionality:
• Tutorials

Troubleshooting

On Windows, if you receive the following error, you need to disable Hyper-v.

VT-x is not available (VERR_VMX_NO_VMX)

To ensure that Hyper-v is disabled, click the Start menu, then type "Turn Windows features on or off". Select this option in the search results. In the popup dialog box, unselect Hyper-V and click OK. You may need to restart your host machine for the changes to take effect.

Biologics trial instances contain some example data and you can run tutorials to explore using LabKey Biologics and adding your own research data. Your trial lasts 30 days and we're ready to help you understand how LabKey Biologics can work for you.</p>

Biologics Tours

Trial Support Forum

If you have questions or need guidance, please reach out in the Trial Support Forum.

Welcome to LabKey Biologics

• Navigation and Getting Started
• Biologics Trial Tours

Navigation and Getting Started

Your new Biologics Trial includes the Biologics application populated with sample data. To launch the application and explore the sample, click Explore Sample Project on your biologics trial.

The home page for Biologics includes a search box and tiles for different aspects of the data.

For more details about each of these options, see Navigate the Registry.

You can also watch the Biologics videos here: LabKey Biologics - Videos.

Biologics Trial Tutorials

Highlights to explore in your biologics trial server:

• Biologics Tutorial: Navigate and Search the Registry
• Biologics Tutorial: Add Sequences to the Registry
• Biologics Tutorial: Create a New Biologics Project

What's Next?

• Explore more about your trial of LabKey Biologics

Tutorials provide a "hands on" introduction to the core features of LabKey Server, giving step-by-step instructions for building solutions to common problems. They are listed roughly from simple to more complex, and you can pick and choose only those that interest you.

In order to run any tutorial, you will need:

• An account on a running LabKey Server.
• A project where you are an admin and can create a new folder. If you don't have one, set up a Hosted trial or a Virtual Machine trial server.
• Familiarity with some basics of navigating and using LabKey Server.

This icon indicates whether the tutorial can be completed on a Hosted trial server or a Virtual Machine trial server.

New User Tutorials

Title Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Description Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on Hosted Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on VM Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Data Grid Tutorial Take a quick tour of data grids and visualizations. No trial server necessary.     Tutorial: Security Learn how to organize and secure your data using LabKey Server. Tutorial: File Repository Manage, search, and share file resources. Tutorial: Collaboration Tools Learn how to use LabKey Server's secure, web-based collaboration tools. Tutorial: Lists Work with data tables. Tutorial: Electronic Lab Notebook Set up a basic electronic lab notebook and sample inventory system.

Study Tutorials

Title Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Description Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on Hosted Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on VM Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Tutorial: Cohort Studies Analyze longitudinal study data. Tutorial: Set Up a New Study Design a new longitudinal study. Tutorial: Specimen Request System Create a specimen tracking system for a study. Request Specimens Search and request specimens from a repository.

Assay Tutorials

Title Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Description Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on Hosted Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on VM Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Tutorial: Design a General Purpose Assay Type (GPAT) Import, manage, and analyze assay data. Add assay data to a study. Tutorial: NAb Assay Work with NAb experiment data from 96-well or 384-well plates   Tutorial: ELISA Assay Import and analyze ELISA experiment data.   Tutorial: ELISpot Assay Tutorial Import and analyze ELISpot experiment data.   Discovery Proteomics Tutorial Storage and analysis for high-throughput proteomics and tandem mass spec experiments.   Tutorial: Import a Flow Workspace Learn about using LabKey for management, analysis, and high-throughput processing of flow data.   Tutorial: Perform a LabKey Flow Analysis Analyze flow data.   Tutorial: Import Flow Data from FCS Express     Tutorial: Set Flow Background Learn about setting metadata and using backgrounds with flow data.   Luminex Assay Tutorial Level I Manage, quality control, analyze, share, integrate and export Luminex immunoassay results.   Luminex Assay Tutorial Level II Use advanced features for quality control and analysis.   Microarray Assay Tutorial Work with sample microarray data.   Expression Matrix Assay Tutorial Try an example expression matrix assay.

Developer Tutorials

Title Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Description Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on Hosted Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on VM Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart LabKey SQL Tutorial     Tutorial: Create Applications with the JavaScript API     Tutorial: Use URLs to Pass Data and Filter Grids     Tutorial: Visualizations in JavaScript     Adding a Report to a Data Grid with JavaScript     Tutorial: Extract-Transform-Load (ETL) Create and use a simple ETL.   Tutorial: Hello World Module       Modules: Queries, Views, and Reports       Tutorial: Hello World Java Tutorial       Workflow Tutorial Incorporate business process management workflows.     Tutorial: Define an Assay Type in a Module

Biologics Tutorials

Title Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on Hosted Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on VM Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Works on a Biologics Trial Server? Sort Ascending Sort Descending Clear Sort Filter... Clear Filter Remove Column Summary Statistics... Bar Chart Pie Chart Quick Chart Biologics Tutorial: Navigate and Search the Registry     Biologics Tutorial: Add Sequences to the Registry     Biologics Tutorial: Register Samples and Experiments     Biologics Tutorial: Work with Recipes and Batches     Biologics Tutorial: Create a New Biologics Project

LabKey Trial Server

To run the LabKey Tutorials, you need three things:

1. An account on a running LabKey Server instance. It only takes a few minutes to create your own LabKey Trial Server:

• Start Your Free Trial

• Learn About LabKey Server: Trial

Finished

Congratulations, you can now begin running tutorials in this workspace on your trial server.

I'm Ready for the Tutorial List

To run the LabKey Tutorials you need:

1. An account on a running LabKey Server instance.
2. A tutorial workspace project on that server where you are an administrator and can create new folders.
3. A basic familiarity with navigation, folder creation, and utilities like web parts.

• Local VM Installation
• Existing Installations
• Full Local Installation

Local VM Installation

1. You can download and install your own server on a local machine using VM image of the server. Follow the instructions in this topic to register, download, install, and start using LabKey Server.

• Virtual Machine Trial Server

3. Learn the navigation and UI basics in this topic:

• Navigation and UI Basics

Existing Installations

1. & 2. If your organization is already using LabKey server, contact your administrator about obtaining access as an administrator to a project or folder to use. For example, they might create and assign you a "Tutorials-username" project or subfolder. They will provide you the account information for signing in, and the URL of the location to use.

3. Learn the navigation and UI basics in this topic:

• Navigation and UI Basics

Full Local Installation

1. If none of the above are suitable, you may need to complete a full manual installation of LabKey Server. Detailed instructions are provided here:

• Install LabKey Manually

2. You will be the site administrator on this server. To create a tutorials project:

3. Learn the navigation and UI basics in this topic:

• Navigation and UI Basics

Finished

Congratulations, you can now log in, navigate to your workspace, and begin running tutorials.

Learn More

I'm Ready for the Tutorial List

Welcome to LabKey Server!

This topic helps you get started using LabKey Server, understanding the basics of navigation and the user interface.

• Projects and Folders
• Tabs
• Web Parts
• Header Menus and URLs
• Security Model

Projects and Folders

The project and folder hierarchy is like a directory tree and forms the basic organizing structure inside LabKey Server. Everything you create or configure in LabKey Server is located in some folder. Projects are the top level folders, with all the same behavior, plus some additional configuration options; they typically represent a separate team or research effort.

The Home project is a special project. It is the default landing page when users log in and cannot be deleted. You can customize the content here to suit your needs. To return to the home project at any time, click the LabKey logo in the upper left corner.

The project menu is on the left end of the menu bar and includes the display name of the current project.

Hover over the project menu to see the available projects, and folders within them. Click any project or folder name to navigate there.

Any project or folder with subfolders will show / buttons for expanding and contracting the list shown. If you are in a subfolder, there will be a clickable 'breadcrumb' trail at the top of the menu for quickly moving up the hierarchy. The menu will scroll when there are enough items, with the current location visible and expanded by default.

The project menu always displays the name of the current project, even when you are in a folder or subfolder. A link with the Folder Name is shown near the top of page views like the following, offering easy one click return to the main page of the folder.

For more about projects, folders, and navigation, see Project and Folder Basics.

Tabs

Using tabs within a folder can give you new "pages" of user interface to help organize content. LabKey study folders use tabs as shown here:

When your browser window is too narrow to display tabs arrayed across the screen, they will be collapsed into a pulldown menu showing the current tab name and a (chevron). Click the name of the tab on this menu to navigate to it.

For more about adding and customizing tabs, see Use Tabs.

Web Parts

Web parts are user interface panels that can be shown on any folder page or tab. Each web part provides some type of interaction for users with underlying data or other content.

There is a main "wide" column on the left and narrower column on the right. Each column supports a different set of web parts. By combining and reordering these web parts, an administrator can tailor the layout to the needs of the users.

For a hands-on example, try the Tutorial: Collaboration Tools.

To learn more, see Add Web Parts and Manage Web Parts. For a list of the types of web parts available in a full installation of LabKey Server, see the Web Part Inventory.

Header Menus and URLs

In the upper right, icon menus offer:

• (Search): Click to open a site-wide search box
• (Admin): Shown only to Admins: Administrative options available to users granted such access. See Admin Console for details about options available.
• (User): Login and security options; help links to documentation and support forums.

Watch the URL at the top of the page as you navigate LabKey Server and explore features on your server. Many elements are encoded in the URL and programmatic access via building URLs is possible with APIs. Learn more here: LabKey URLs.

Security Model

LabKey Server has a group and role-based security model. Whether an individual is authorized to see a resource or perform an action is checked dynamically based on the groups they belong to and roles (permissions) granted to them. Learn more here: Security.

What's Next?

• Set Up for Tutorials - Non-Trial
• Tutorials

LabKey Server Editions

• Community Edition: Free to download and use forever. Best suited for technical enthusiasts and evaluators in non-mission-critical environments. LabKey provides community forums and documentation to help users support each other.
• Premium Editions: Paid subscriptions that provide additional functionality to help teams optimize workflows, manage complex projects, and explore multi-dimensional data. Premium Editions also include professional support services for the long-term success of your informatics solutions.

Other Products and Modules

• Training
• LabKey Client Support Portals
• LabKey Biologics
• LabKey NLP
• Panorama Partners Program
• Modules in LabKey Server Editions

Administrator Training

LabKey's administrator training course, LabKey Fundamentals, is included in the Professional and Professional Plus Editions. It provides an introduction to the following topics:

• LabKey Server Basics: Explains the basic anatomy/architecture of the server and its moving parts. It outlines the basic structures of folders and data containers, and the modules that process requests and craft responses. Best practices for configuring folders is included. The role of Administrators is also described.
• Security: Describes LabKey Server's role-based security model--and how to use it to protect your data resources. General folder-level security is described, as well as special security topics, such as dataset-level security and Protected Health Information (PHI) features. Practical security information is provided, such as how to set up user accounts, assigning groups and roles, best practices, and testing security configurations using impersonation.
• Collaboration: Explains how to use the Wiki, Issues, and Messages modules. Branding and controlling the look-and-feel of your server are also covered.
• Files and the Database: Explains the two basic ways that LabKey Server can hold data: (1) as files and (2) as records in a database. Topics include: full-text search, converting tabular data files into database tables, special features of the LabKey database (such as 'lookups'), the role of SQL queries, adding other databases as external data sources.
• Instrument Data: Explains how LabKey Server models and captures instrument-derived data, including how to create a new assay "design" from scratch, or how to use a prepared assay design. Special assay topics are covered, such as transform scripts, creating new assay design templates ("types") from simple configuration files, and how to replace the default assay user interface.
• Clinical/Research Study Data Management: Explains how to integrate heterogeneous data, such as instrument, clinical, and demographic data, especially in the context of longitudinal/cohort studies.
• Reports: Explains the various ways to craft reports on your data, including R reports, JavaScript reports, and built-in visualizations, such as Time Charts, Box Plots, and Scatter Plots.
• Specimens: Explains the ways that LabKey Server can model and manage specimen/sample data.
• Development: A high-level overview of how to extend LabKey Server. The Professional Edition includes support for users writing custom SQL and R scripts. The Professional Plus Edition provides support for users extending LabKey Server with JavaScript/HTML client applications, user-created file modules, and more (see Developer Training below).
• Operations: Describes best practices from an IT point-of-view, including installing a server, hardware requirements, logging, and how to debug and track down problems with the server.

Developer Training

LabKey's developer training is included in the Professional Plus Edition. It is tailored to your project's specific needs and can cover:

• Server-to-server integrations
• Client APIs
• ETLs
• Assay transform scripts
• Remote pipeline processing servers
• Custom LabKey-based pipelines
• Module development assistance

LabKey Premium Edition clients are provided with a custom support portal page giving them easy access to professional services and support directly from LabKey specific to their project. This portal provides quick links to contact information, builds, documentation, support tickets, announcements, and an easy way to share files with LabKey as required.

To find your own support portal:

Features:

• Build Content Reporting

Build Content Reporting

Client support portals also include a report on the content of each new build detailing changes since the prior build released to that client.

• From your main support portal, click Server Builds.

• In the Download the Latest LabKey Server Release web part, Click here for the latest Bug Fix updates included in this build.

The list of issues closed since your prior build is shown, sorted by module. Verified issues listed are those that have been resolved, confirmed, and closed. If "unverified" issues are listed, they have been marked as resolved, but confirmation and closing has not yet been completed. If there are no issues for a given module, it will not be shown on the list.

Click any listed issue to see details in the issue tracker.

This topic provides the list of modules included in each edition of LabKey Server. For a complete list of features available in each LabKey Server Edition, see LabKey Server Edition Comparison.

Related Topics

• Community Edition Modules
• Additional Source Modules

LabKey Server is an open-source software platform designed to help research organizations integrate, analyze, and share complex biomedical data. Adaptable to varying research protocols, analysis tools, and data sharing requirements, LabKey Server couples the flexibility of a custom solution with enterprise-level scalability to support scientific workflows.

Introduction

• Navigate Server
• Data Basics

Solutions

• Assay Data Integration
• Longitudinal Study Data Management
• Clinical Document Abstraction
• Targeted Mass Spectrometry

• What is LabKey Server?
• How Does it Work?
• The Basic Workflow
• Additional Topics

What is LabKey Server?

LabKey Server's features can be grouped into three main areas:

1. Data Repository

LabKey Server lets you bring data together from multiple sources into one repository. These sources can be physically separated in different systems, such as data in Excel spreadsheets, different databases, FreezerPro, REDCap, etc. Or the data sources can be separated "morphologically", having different shapes. For example, patient questionnaires, instrument-derived assay data, medical histories, and specimen inventories all have different data shapes, with different columns names and different data types. LabKey Server can bring all of this data together to form one integrated whole that you can browse and analyze together.

2. Data Showcase

LabKey Server lets you securely present and highlight data over the web. You can present different profiles of your data to to different audiences. One profile can be shown to the general public with no restrictions, while another profile can be privately shared with selected individual colleagues. LabKey Server lets you collaborate with geographically separated teams, or with your own internal team members. In short, LabKey Server lets you create different relationships between data and audiences, where some data is for general viewing, other data is for peer review, and yet other data is for group editing and development.

3. Electronic Laboratory

LabKey Server provides many options for analyzing and inquiring into data. Like a physical lab that inquires into materials and natural systems, LabKey Server makes data itself the object of inquiry. This side of LabKey Server helps you craft reports and visualizations, confirm hypotheses, and generally provide new insights into your data, insights that wouldn't be possible when the data is separated in different systems and invisible to other collaborators.

The LabKey Server Platform

LabKey Server is a software platform, as opposed to an application. Applications have fixed use cases targeted on a relatively narrow set of problems. As a platform, LabKey Server is different: it has no fixed use cases, instead it provides a broad range of tools that you configure to build your own solutions. In this respect, LabKey Server is more like a car parts warehouse and not like any particular car. Building solutions with LabKey Server is like building new cars using the car parts provided. To build new solutions you assemble and connect different panels and analytic tools to create data dashboards and workflows.

The following illustration shows how LabKey Server takes in different varieties of data, transforms into reports and insights, and presents them to different audiences.

How Does LabKey Server Work?

LabKey Server is a web server, and all web servers are request-response machines: they take in requests over the web (typically as URLs through a web browser) and then craft responses which are displayed to the user.

Modules

Modules are the main functionaries in the server. Modules interpret requests, craft responses, contain all of the web parts, and application logic. The responses can take many different forms:

• a web page in a browser
• an interactive grid of data
• a report or visualization of underlying data
• a file download
• a long-running calculation or algorithm

• PostgreSQL
• MS SQL Server
• Oracle
• My SQL
• SAS

The illustration below shows the relationships between web browsers, LabKey Server, and the underlying databases. The modules shown are not a complete set; many other modules are included in LabKey Server.

User Interface

You configure your own user interface by adding panels, aka "web parts", each with a specific purpose in mind. Some example web parts:

• The Wiki web part displays text and images to explain your research goals and provide context for your audience. (The topic you are reading right now is displayed in a Wiki web part.)
• The Files web part provides an area to upload, download, and share files will colleagues.
• The Query web part displays interactive grids of data.
• The Report web part displays the results of an R or JS based visualization.

The illustration below shows a data dashboard formed from tabs and web parts.

Folders and Projects

Folders are the "blank canvases" of LabKey Server, the workspaces where you organize dashboards and web parts. Folders are also important in terms of securing your data, since you grant access to audience members on a folder-by-folder basis. Projects are top level folders: they function like folders, but have a wider scope. Projects also form the center of configuration inside the server, since any setting made inside a project cascades into the sub-folders by default.

Security

LabKey uses "role-based" security to control who has access to data. You assign roles, or "powers", to each user who visits your server. Their role determines how much they can see and do with the data. The available roles include: Administrator (they can see and do everything), Editors, Readers, Submitters, and others. Security is very flexible in LabKey Server. Any security configuration you can imagine can be realized: whether you want only a few select individual to see your data, or if you want the whole world to see your data.

The server also has extensive audit logs built. The audit logs record:

• Who has logged in and when
• Changes to a data record
• Queries performed against the database
• Server configuration changes
• File upload and dowload events
• And many other activities

The Basic Workflow: From Data Import to Reports

To build solutions with LabKey Server, follow this basic workflow: import or synchronize your data, apply analysis tools and build reports on top of the data, and finally share your results with different audiences. Along the way you will add different web parts and modules as needed. To learn the basic steps, start with the tutorials, which provide step-by-step instructions for mastering the basic building blocks available in the server.

Ready to See More?

• You don't need to download or install anything to try a few basic features right now: Try it Now: Data Grids.
• Explore LabKey Server - Hosted Trial
• Learn to navigate the server: Navigate Server
• Learn about the user interface: Build User Interface
• To further explore LabKey Server, try a step-by-step tutorial.

• Project and Folder Menu
• Navigation
• Context Sensitive Help

In the upper right, icon menus offer:

• (Search): Click to open a site-wide search box
• (User): Login and security options; context-sensitive help.
• (Admin): Shown only to Admins: Administrative options available to users granted such access.

Project and Folder Menu

Hover over the project menu to see the available projects and folders within them. Note that only projects and folders to which you have at least "Read" access are shown.

Any project or folder with subfolders will show and buttons for expanding and contracting the list shown. The menu will scroll when there are enough items, and the current location will be visible and expanded by default.

• (Permalink URL): Click for a permalink to the current location.
• Administrators have additional options shown in the bottom row of this menu.

Navigation

Click the name of any project or folder in the menu to navigate to that location. When you are in a folder or subfolder, you will see a "breadcrumb" path at the top of the projects menu, making it easy to step back up one or more levels.

Notice that from within a folder or subfolder, the project menu still displays the name of the project. A link with the Folder Name is shown next to the title offering easy one click return to the main page of the folder.

Context Sensitive Help

Click the (User) icon in the upper right to open the user menu. Options for help include:

• Support: Opens the community discussion forums where you can search for an already-answered question or ask your own. If you are a Premium Edition client, you will also have access to your own professional services support portal.
• LabKey Documentation: Opens the relevant documentation for the resource you are currently viewing, or the default main LabKey documentation page.

Related Topics

• Project and Folder Basics - Administrator options for projects and folders

Topics

• Data Grids
• Lists
• Visualizations
• Reports and Charts
• SQL Queries
• External Schemas and Data Sources
• LabKey Data Structures
• Preparing Data for Import
• Data Quality Control
• Search

A scatter plot visualization of the same data:

LabKey Server provides sophisticated tools for customizing data grids, including sorting and filtering your data, creating tabular and graphical reports, and exporting your data to other file types.

Data Grid Topics

The following topics explain how to work with data grids:

• Data Grids: Basics - Learn the basic anatomy of a data grid.
• Import Data
• Sort Data
• Filter Data
• Select Rows - Select individual data records and groups of records.
• Customize Grid Views - Create custom grid views for your data.
• Saved Filters and Sorts - Save filters and sorts with as named or default grid views.
• Join Columns from Multiple Tables - Join columns from multiple tables together in a single grid view.
• Field Properties Reference - Use the field properties editor to customize column display and behavior.
• Export Data Grid - Export your grid data to Excel files, text files, and scripts.
• Export Data Grid as a Script - Export your data to an R, SAS or JavaScript script.
• Customize Participant Views - Use a specialized form of data grid found in LabKey Studies.
• Query Scope: Filter by Folder - Control which data folders are included in a grid view.

• Anatomy of a Data Grid
• Button Bar
• Paging Through Data
• Examples

Anatomy of a Data Grid

The following image shows a typical data grid.

• Data grid title: The name of the data grid.
• QC State filter: Within a LabKey study, when one or more dataset QC states are defined, the button bar will include a menu for filtering among them. The current status of that filter is shown above the grid.
• Folder location: The folder location. Click to navigate to the home page of the folder.
• Grid view indicator: Shows which view, or perspective, on the data is being shown. Custom views are created to show a joined set of tables or highlight particular columns in the data. Every dataset has a "default" view that can also be customized if desired.
• Filter bar: When filters are applied, they appear here. Click the X to remove a filter. When more than one is present, a Clear all button is also shown.
• Button bar: Shows the different tools that can be applied to your data. A triangle indicates a menu of options.
• Column headers: Click a column header for a list of options
• Data records: Displays the data as a 2-dimensional table of rows and columns.
• Page through data: Control how much data is shown per page and step through pages.

Column Header Options

• Sort and Filter
• Remove the Column
• Summary Statistics: Click for options available for the given column.
• Column Visualizations: Depending on the type of data, different kinds of single column visualizations can be shown above the grid.
• Quick Charts

See an interactive example grid on labkey.org.

Button Bar

The button bar tools available may vary with different types of data grid. Study datasets can provide additional functionality, such as filtering by cohort, that are not available to lists. Assays and proteomics data grids provide many additional features.

Hover over icon buttons to see a tooltip with the text name of the option. Common buttons and menus include:

• (Filter): Click to open a panel for filtering by participant groups and cohorts.
• (Grid Views): Pull-down menu for creating, selecting, and managing various grid views of this data.
• (Charts/Reports): Pull-down menu for creating and selecting charts and reports.
• (Export): Export the data grid as a spreadsheet, text, or in various scripting formats.
• (Insert Data): Insert a new single row, or bulk import data.
• (Delete): Delete one or more rows selected by checkbox. This option is disabled when no rows are selected.
• Design/Manage: with appropriate permissions, change the structure and behavior of the given list ("Design") or dataset ("Manage").
• Groups: Select which cohorts, participant groups, or treatment groups to show. Also includes options to manage cohorts and create new participant groups.
• View Specimens: If one or more rows are selected using the checkboxes, clicking View Specimens will open a grid view of specimens corresponding to the same participant and visit.
• Print: Generate a printable version of the dataset in your browser.

Page Through Data

In the upper right corner, you will see how your grid is currently paginated. In the above example, there are 484 rows in the dataset and they are shown 100 to a "page", so the first page is rows 1-100 of 484. To step through pages, in this case 100 records at a time, click the arrow buttons. To adjust paging, hover over the row count message (here "1-100 of 484") and it will become a button. Click to open the menu:

• Show First/Show Last: Jump to the first or last page of data.
• Show All: Show all rows in one page.
• Click Paging to see the currently selected number of rows per page. Notice the > caret indicating there is a submenu to open. On the paging submenu, click another option to change pagination.

Examples

The following links show different views of a single data grid:

• Grid View: Physical Exam: default grid
• Joined View: Physical Exam: Physical + Demographics grid
• Chart: Diastolic vs. Systolic Pressures: All Visits
• Participant Details: Physical Exam: Participant details view

Related Topics

• Customize Grid Views
• Visualizations
• Field Properties Reference
• Conditional Formats

• LabKey Data Structures
• Preparing Data for Import

• Populate a List
• Import Assay Runs
• Create and Populate Datasets
• Import Specimen Spreadsheet Data
• Import a Specimen Archive
• Import Sample Sets
• Import a XAR.xml

• Sort Data in a Grid
• Clear Sorts
• Understand Sorting URLs

Sort Data in a Grid

To sort data in a grid view, click on the header for a column name. Choose either:

• Sort Ascending: Show the rows with lowest values (or first values alphabetically) for this column at the top of the grid.
• Sort Descending: Show the rows with the highest values at the top.

Once you have sorted your dataset using a particular column, a triangle icon will appear in the column header: for an ascending sort or for a descending sort.

You can sort a grid view using multiple columns at a time as shown above. Sorts are applied in the order they are added, so the most recent sort will show as the primary way the grid is sorted. For example, to sort by date, with same-date results sorted by temperature, you would first sort on temperature, then on date.

Clear Sorts

To remove a sort on an individual column, click the column caption and select Clear Sort.

Advanced: Understand Sorting URLs

The sort specifications are included on the page URL. You can modify the URL directly to change the sorted columns, the order in which they are sorted, and the direction of the sort. For example, the following URL sorts the Physical Exam grid first by ascending ParticipantId, and then by descending Temp_C:

https://www.labkey.org/study/home/Study/demo/dataset.view?datasetId=5004&Dataset.sort=ParticipantId%2C-Temp_C

Note that the minus ('-') sign in front of the Temp_C column indicates that the sort on that column is performed in descending order. No sign is required for an ascending sort, but it is acceptable to explicitly specify the plus ('+') sign in the URL.

The %2C hexadecimal code that separates the column names represents the URL encoding symbol for a comma.

Related Topics

• Saved Filters and Sorts

• Filter Column Values
• Filter by Value
• Filtering Expressions
• Filter Value Variables
• Persistent Filters
• Faceted Filtering
• Understand Filter URLs
• Filter By Group

Filter Column Values

• Click on a column name and select Filter.

Filter by Value

In cases where there are fewer than 250 unique values, the filter popup will open on the Choose Values tab by default. Here, you can directly select one or more individual values using checkboxes. Click on a label to select only a single value, add or remove additional values by clicking on checkboxes.

Filtering Expressions

Filtering expressions available in dropdowns vary by datatype and context. Possible filters include, but are not limited to:

• Presence or absence of a value for that row
• Equality or inequality
• Comparison operators
• Membership or lack of membership in a named semicolon separated set
• Starts with and contains operators for strings
• Between (inclusive) or Not Between (exclusive) two comma separated values

• Switch to the Choose Filters tab, if available.
• Specify a filtering expression (such as "Is Greater Than"), and value (such as "57") and click OK.

You may add a second filter if desired - the second filter is applied as an AND with the first. Both conditions must be true for a row to be included in the filtered results.

Once you have filtered on a column, the filter icon () appears in the column header. Current filters are listed above the grid, and can be removed by simply clicking the X in the filter panel.

When there are multiple active filters, you can remove them individually or use the link to Clear All that will be shown.

Filter Value Variables

Using filter value variables can help you use context-sensitive information in a filter. For example, use the variable "~me~" (including the tildes) on columns showing user names from the core.Users table to filter based on the current logged in user.

Persistent Filters

Some filters on some types of data are persistent (or "sticky") and will remain applied on subsequent views of the same data. For example, some types of assays have persistent filters for convenience; these are listed in the active filter bar above the grid.

Use Faceted Filtering

When applying multiple filters to a data grid, the options shown as available in the filter popup will respect prior filters. For example, if you first filter our sample demographics dataset by "Country" and select only "Uganda", then if you open a second filter on "Primary Language" you will see only "French" and "English" as options - our sample data includes no patients from Uganda who speak German or Spanish. The purpose is to simplify the process of filtering by presenting only valid filter choices. This also helps you avoid unintentionally empty results.

Understand Filter URLs

Filtering specifications are included on the page URL. The following URL filters the demo study "Physical Exam" dataset to show only rows where weight is greater than 57. The column name, the filter operator, and the criterion value are all specified as URL parameters.

https://www.labkey.org/study/home/Study/demo/dataset.view?datasetId=5004&Dataset.sort=ParticipantId&Dataset.Weight_kg~gt=57

To specify that a grid should be displayed using the user's last filter settings, set the .lastFilter URL parameter to true, as shown:

https://www.labkey.org/Issues/home/Developer/issues/list.view?.lastFilter=true

Filter by Group

Within a study dataset, you may also filter a data grid by participant group. Click the (Filter) icon above the grid to open the filter panel. Select checkboxes in this panel to further filter your data. Note that filters are cumulatively applied and listed in the active filter bar above the data grid.

Related Topics

• Saved Filters and Sorts
• Filtering Expressions

Boolean Filtering Expressions

Expressions available for data of type boolean (true/false values):

• Has Any Value
• Is Blank
• Is Not Blank
• Equals
• Does Not Equal

Date Filtering Expressions

Date and DateTime data can be filtered with the following expressions:

• Has Any Value
• Is Blank
• Is Not Blank
• Equals
• Does Not Equal
• Is Greater Than
• Is Less Than
• Is Greater Than or Equal To
• Is Less Than or Equal To

Numeric Filtering Expressions

Expressions available for data of any numeric type, including integers and double-precision numbers:

• Has Any Value
• Is Blank
• Is Not Blank
• Equals
• Does Not Equal
• Is Greater Than
• Is Less Than
• Is Greater Than or Equal To
• Is Less Than or Equal To
• Between, Inclusive
• Not Between, Exclusive
• Equals One Of
• Does Not Equal Any Of

String Filtering Expressions

String type data, including text and multi-line text data, can be filtered using the following expressions:

• Has Any Value
• Is Blank
• Is Not Blank
• Equals
• Does Not Equal
• Is Greater Than
• Is Less Than
• Is Greater Than or Equal To
• Is Less Than or Equal To
• Contains
• Does Not Contain
• Starts With
• Does Not Start With
• Between, Inclusive
• Not Between, Exclusive
• Equals One Of
• Does Not Equal Any Of
• Contains One Of
• Does Not Contain Any Of

To create a persistent filter or sort, you can save it as part of a custom grid view. If this saved grid view is shared with all users, the saved filters and sorts defined on it are also available to those users.

• Define a Saved Sort
• Define a Saved Filter
• Apply View Filter
• Interactions Among Filters and Sorts

Define a Saved Sort

• Navigate to the grid you'd like to modify.
• Select (Grid Views) > Customize Grid
• Click the Sort tab.
• In the left panel, click the checkbox(es) for fields on which you want to sort.
• In the right panel, specify whether the sort order should be ascending or descending for each sort applied.
• Click Save.

• You may save as a new named grid view or as the default and select whether to make it available to all users.

You can also create a saved sort by first sorting your grid directly using the column headers, then opening the grid customizer panel to convert the local sort to a saved one.

• In the grid view with the saved sort applied above, sort on a second column, in this example we chose 'Lymphs'.
• Open (Grid Views) > Customize Grid.
• Click the Sort tab. Note that it shows (2), meaning two sorts are now defined. Until you save the grid view with this additional sort included, it will remain as temporary as sorts usually are.

• Drag and drop if you want to change the order in which sorts are applied.
• Remember to Save your grid to save the additional sort.

Define a Saved Filter

The process for defining saved filters is very similar. You can filter locally first or directly define saved filters. An important advantage of using the saved filters interface is that when filtering locally, you are limited to two filters on a given column. Saved filters may include any number of separate filtering expressions for a given column, which are all ANDed together.

• Select (Grid Views) > Customize Grid.
• Click the Filter tab.
• In the left panel, check boxes for the column(s) on which you want to filter.
• Drag and drop filters in the right panel to change the filtering order.
• In the right panel, specify filtering expressions for each selected column. Use pulldowns and value entry fields to set expressions, add more using the (Add) buttons.
• Use the buttons to delete individual filtering expressions.

• Save the grid; select whether to make it available to other users.

Apply Grid Filter

When viewing a data grid, you can enable and disable all saved filters and sorts using the Apply Grid Filter checkbox in the (Grid Views) menu. All defined filters and sorts are applied at once using this checkbox - you cannot pick and choose which to apply. If this menu option is not available, no saved filters or sorts have been defined.

Interactions Among Filters and Sorts

Users can still perform their own sorting and filtering as usual when looking at a grid that already has a saved sort or filter applied.

• Sorting: Sorting a grid view while you are looking at it overrides any saved sort order. In other words, the saved sort can control how the data is first presented to the user, but the user can re-sort any way they wish.
• Filtering: Filtering a grid view which has one or more saved filters results in combining the sets of filters with an AND. That is, new local filters happen on the already-filtered data. This can result in unexpected results for the user in cases where the saved filter(s) exclude data that they are expecting to see. Note that these saved filters are not listed in the filters bar above the data grid, but they can all be disabled by unchecking the (Grid Views) > Apply View Filter checkbox.

Related Topics

• Filter Data
• Sort Data

[ Video Overview: Adding Summary Statistics to Data Grids ]

Add Summary Statistics to a Column

• Click a column header, then select Summary Statistics.

• The popup will list all available statistics for the given column, including their values for the selected column.
• Check the box for all statistics you would like to display.

• Click Apply. The statistics will be shown at the bottom of the column.