Optional, Deprecated, or Experimental Features

Documentation
When features are not in widespread use, but can be made available if needed, they will be available on one of these pages on the > Site > Admin Console under Configuration:
  • Optional Features: Optional features are not typically used; discuss with your Account Manager before enabling any optional feature.
  • Deprecated Features: Features that have been deprecated, but administrators may need to temporarily enable in order to migrate customizations to supported features.
  • Experimental Features: Features under development or otherwise not ready for production use.
Note that some features listed here are only available when specific modules are included. Proceed with discretion and please contact LabKey if you are interested in sponsoring further development of anything listed here. Enabling or disabling some features will require a restart of the server.

Optional Features

Optional features are disabled by default. Review the description for each feature before enabling it, and discuss with your Account Manager if you have questions.

  • Select > Site > Admin Console
  • Under Configuration, click Optional Features.
  • Use checkboxes to enable desired optional features. Uncheck the box to disable the feature.

AI-backed product features are available

Enables AI-backed product features embedded in LabKey applications, such as the Expression AI Assistant available when defining calculated columns.

On-premise deployments must also supply a Gemini API key to use these features. See On-Premise AI Feature Setup for full setup instructions.

Enable the MCP Server

Enable external access to the MCP server. See LabKey MCP Server (Model Context Protocol) for setup and usage details.

Forward CSP reports to https://www.labkey.org

In addition to logging Content Security Policy (CSP) violation reports to this server (csp-reports.log), forward the reports and user information to https://www.labkey.org. This allows the LabKey Services Team to assist in clearing violations from your server content.

No Guest Account

Disable the guest account. When this feature is enabled, all users will have to create accounts in order to see any server content.

Send extended metrics information to LabKey

Send additional usage information to https://www.labkey.org along with standard usage metrics. This information includes a list of unique, active users registered on the server. Providing this information is not necessary in most cases. Clients with multi-server contracts and user-based pricing may be asked to enable this feature to help comply with their licensing terms.

Stage file uploads and downloads to temporary local file

When using a non-local file system, using a specific API that requires a locally staged copy of the file as the source can sometimes be significantly faster than streaming the file directly to/from storage

Stage SKYD files to a temporary local file for import purposes

When using a non-local file system, the latency for random access requests can be significantly slower than first copying to local storage.

Deprecated Features

WARNING: Deprecated features will be removed very soon, most likely for the next major release. If you enable one of these features you should also create a plan to stop relying on it.

  • Select > Site > Admin Console
  • Under Configuration, click Deprecated Features.
  • Carefully read the warnings before enabling any deprecated feature, and make a plan to migrate away from it before it is removed.
  • Use checkboxes to enable a deprecated feature temporarily. Uncheck the box to disable it.

Allow assay transform scripts at arbitrary file system paths

Transform scripts configured on an assay design are normally required to reside in that design's container's @scripts directory, which only platform developers can write to. Enable this to allow assay designs to reference scripts anywhere on the server's file system. This option will be removed in a future release of LabKey Server.

Allow GET requests to execute mutating SQL

We strongly recommend leaving this off since it bypasses a critical security check (CSRF). This option will be removed in LabKey Server 26.11.

Derive Samples in LabKey Server UI

Enables the UI for deriving samples in LabKey Server UI from either the samples grids or a sample lineage page. This option will be removed in LabKey Server 26.11.

Disable enforce Content Security Policy

Stop sending the Content-Security-Policy header to browsers, but continue sending the Content-Security-Policy-Report-Only header. This turns off an important layer of security for the entire site, so use it as a last resort only on a temporary basis (e.g., if an enforce CSP breaks critical functionality).

Enabling this deprecated feature displays a warning to administrators for as long as it remains enabled.

Require that ExtJS v3.4.1 is loaded on every page

This option will be removed in LabKey Server 26.11.

Require that ExtJS v3.x-based Client API is loaded on every page

This option will be removed in LabKey Server 26.11.

Experimental

WARNING: Experimental features may change, break, or disappear at any time. We make absolutely no guarantee about what will happen if you turn on any experimental feature.

  • Select > Site > Admin Console
  • Under Configuration, click Experimental Features.
  • Carefully read the warnings and descriptions before enabling any features.
  • Use checkboxes to enable desired experimental features. Uncheck the box to disable the feature.

Allow gap with withCounter and rootSampleCount expression

Check this option if gaps in the count generated by withCounter or rootSampleCount name expression are allowed.

A restart is required after toggling this feature.

Allow query based dataset snapshots

Allow unprovisioned, query-based dataset snapshots to be created.

Allow RowId to be accepted when merging samples or data class data

If the incoming data includes a RowId column, it will be allowed but its values will be ignored.

Assay linked to study consistency check

Flags rows in assay-linked datasets where the subject and timepoint may be different from the source assay. When enabled, if rows in the linked study dataset are not consistent with the source assay, you'll see them highlighted. For example, if an assay result row was edited after being linked (in this case to change the visit ID), the dataset would alert the user that there was something to investigate:

Recalling and relinking the affected rows should clear the inconsistency.

Block Malicious Clients

Reject requests from clients that appear malicious. Turn this feature off if you want to run a security scanner.

Data Region Async Total Rows

Enable asynchronous calculation of total rows for data regions. This can improve performance for large datasets.

Disable managed columns in query triggers

By default LabKey enforces managed columns for triggers and errors when the data does not align. Enabling this feature will result in these mismatches only being logged as warnings.

Include Last-Modified header on query metadata requests

For schema, query, and view metadata requests, enabling this will include a Last-Modified header such that the browser can cache the response. The metadata is invalidated when performing actions such as creating a new list or modifying the columns on a custom view.

Less restrictive product folder lookups

Allow for lookup fields in product folders to query across all folders within the top-level folder.

Manage Unreferenced Sample Files

Enable the "Unreferenced Sample Files" table to view and delete sample files that are no longer referenced by samples.

Media Data Folder Export and Import

Enable inclusion of a subset of Media data for folder export and processing of data for folder import. This does not yet provide a full-fidelity transfer of data.

Media Ingredient read permissions

Enforce media ingredient read permissions.

Notebook Custom Fields

Enable Custom Fields on Notebooks. Available in Biologics LIMS only. Learn more in this topic:

Notebook Folder Export and Import

Enable inclusion of a subset of ELN data for folder export and processing of data for folder import. This does not yet provide a full-fidelity transfer of data.

Notifications Menu

Notifications 'inbox' count display in the header bar with click to show the notifications panel of unread notifications.

Product folders display folder-specific data

Only list folder-specific data within product folders.

Quantity column suffix testing

If a column name contains a "__<unit>" suffix, this feature allows for testing it as a Quantity display column.

R Docker Sandbox

Run R reports in a Docker container.

Reject controller-first URLs

Require standard path-first URLs.

Requests Menu in Biologics

Display a "Requests" section in the menu to all Biologics users.

Resolve Property URIs as Columns on Experiment Tables

If a column is not found on an experiment table, attempt to resolve the column name as a Property URI and add it as a property column.

Short-circuit robots

Save resources by not rendering pages marked as 'noindex' for robots. This is experimental as not all robots are search engines.

SQL syntax: 'FROM EXPANCESTORS()'

Support for querying lineage of experiment objects.

TCR Region Detection in Biologics Classification

Detect TCR Regions when classifying Protein Sequences in Biologics.

Use QuerySelect for row insert/update form

This feature will switch the query based select inputs on the row insert/update form to use the React QuerySelect component. This will allow for a user to view the first 100 options in the select but then use typeahead search to find the other select values.

Use row-by-row update

For Query.updateRows api, do row-by-row update, instead of using a prepared statement that updates rows in batches.

Use strict protocol match for redirects for dockerized RStudio with ALB

A workaround is added for dockerized RStudio in AWS ALB. Check this checkbox to remove the workaround. This should be used for debugging AWS configuration only.

Use Sub-schemas in Study

Separate study tables into three groups: Datasets, Specimens, and Design.

Was this content helpful?

Log in or register an account to provide feedback


previousnext
 
expand allcollapse all