The Admin Console provides site management services including the following:
- View detailed information about the system configuration and installed modules.
- Audit user activity including who is logged in and when.
- Customize the LabKey site, including configuration and testing of LDAP settings.
- View information about the JAR files and executable files shipped with LabKey.
- View information about memory usage and errors.
Access the Admin Console
The Admin Console can be accessed by
Site Administrators:
- At the top right of your screen, select (Admin) > Site > Admin Console.
- The version of LabKey Server that you are running is prominently displayed at the top of the Server Information panel, open by default.
Admin Console Settings
A variety of tools and information resources are provided on the Admin Console. Click the
Settings tab to see several categories of links to administration resources.
Premium Features
The section for
Premium Features will include some or all of the following features, depending on the edition you are running.
Learn more about premium editions
Configuration
- Analytics Settings. Add JavaScript to your HTML pages to enable Google Analytics or add other custom script to the head of every page.
- Authentication. View, enable, disable and configure authentication providers (e.g. Database, LDAP, CAS, Duo). Configure options like self sign-up and self-service email changes.
- Change User Properties. Edit fields in the Users table.
- Email Customization. Customize auto-generated emails sent to users.
- Experimental Features. Offers the option to enable experimental features. Proceed with caution as no guarantees are made about the features listed here.
- External Redirect Hosts. Configure a list of allowable external targets of redirect URLs.
- Files. Configure file system access by setting site file root and configuring file and pipeline directories.
- Flow Cytometry. Settings for the flow module.
- Folder Types. Select which folder types will be available for new project and folder creation. Disabling a folder type here will not change the type of any current folders already using it.
- Look and Feel Settings. Customize colors, fonts, formats, and graphics.
- Mascot Server. Set up integration with a Mascot server.
- Missing Value Indicators. Manage indicators for datasets.
- Project Display Order. Choose whether to list projects alphabetically or specify a custom order.
- Short URLs. Define short URL aliases for more convenient sharing and reference.
- Site Settings. Configure a variety of basic system settings, including the name of the default domain and the frequency of system maintenance and update checking.
- System Maintenance. These tasks are typically run every night to clear unused data, update database statistics, perform nightly data refreshes, and keep these server running smoothly and quickly. We recommend leaving all system maintenance tasks enabled, but some of the tasks can be disabled if absolutely necessary. By default these tasks run on a daily schedule. You can change the time of day which they run if desired. You can also run a task on demand by clicking one of the links. Available tasks may vary by implementation but could include:
- Database Maintenance.
- Defragment ParticipantVisit Indexes.
- Master Patient Index Synchronization.
- Purge Expired API Keys.
- Purge Unused Participants.
- Refresh Study Snapshot Specimen Data. Refreshes the specimen data inside of published studies.
- Report Service Maintenance.
- Search Service Maintenance.
- Targeted MS. Journal groups. Manage journal groups used in conjunction with the "publication protocol" implemented for the targetedms (Panorama) module.
- Views and Scripting. Allows you to configure different types of scripting engines.
Management
- Audit Log. View the audit log; many category-specific logs are available.
- ETL-All Job Histories. (Premium Feature) View a history of all ETLs that have run on the site.
- ETL-Run Site Scope ETLs. ETLs that are "site scoped" (not scoped to a particular folder/container) can be run from here.
- Full-Text Search. Configure and view both primary and external search indexing.
- MS2. Administrative information for the mass spectrometry module.
- Notification Service Admin: Enable or disable the notification service at the site level. Active notifications are listed.
- Ontology. Admin console for defining types, such as SampleSets or Forms.
- Pipeline. Administrative information for the pipeline module.
- Pipeline Email Notification. Enable pipeline notification emails.
- Protein Databases. Protein Database Administration interface.
- Site-Wide Terms of Use. Require users to agree to a terms of use whenever they attempt to login to any project on the server.
Diagnostics
Links to diagnostic pages and tests that provide usage and troubleshooting information.
- Actions. View information about the time spent processing various HTTP requests.
- Attachments. View attachment types and counts, as well as a list of unknown attachments (if any).
- Caches. View information about caches within the server.
- Check Database. Check database table consistency, validate that domains match tables, and generate a database schema in XML format.
- Credits. Jar and Executable files distributed with LabKey Server modules.
- Data Sources. A list of all the data sources defined in labkey.xml that were available at server startup and the external schemas defined in each.
- Dump Heap. Write the current contents of the server's memory to a file for later analysis.
- Dump Pipejob Serialize Info. Dumps serialization information to labkey.log.
- Environment Variables. A list of all the current environment variables and their values, for example, JAVA_HOME = C:Program FilesJavajdk-12
- ETL- View Scheduler Summary. (Premium Feature) Shows a summary of jobs and triggers for any scheduled ETLs.
- Loggers. Log4j loggers. Set the level (info, warn, error, etc.). Use the text box to enter filters.
- Memory Usage. View current memory usage within the server.
- Profiler. Configure development tools like stack trace capture and performance profiling.
- Queries. View the SQL queries run against the database, how many times they have been run, and other performance metrics.
- Reset Site Errors. Reset the start point in the labkey-errors.log file. See View All Site Errors Since Reset below.
- Running Threads. View the current state of all threads running within the server.
- Site Validation. Runs any validators that have been registered. (Validators are registered with the class SiteValidationProvider.)
- SQL Scripts. Provides a list of the SQL scripts that have run, and have not been run, on the server. Includes a list of scripts with errors, and "orphaned" scripts, i.e., scripts that will never run because another script has the same "from" version but a later "to" version.
- Suspicious Activity. Records any activities that raise 404 errors, including things like attempts to access the server from blacklisted URLs, paths containing "../..", or POST requests not including CSRF tokens.
- System Properties. A list of current system properties and their values, for example, devmode = true.
- Test Email Configuration. View and test current SMTP settings. See labkey.xml Configuration File Reference for information about setting them.
- View All Site Errors. View the current contents of the labkey-errors.log file from the <CATALINA_HOME>/logs directory, which contains critical error messages from the main labkey.log file.
- View All Site Errors Since Reset. View the contents of labkey-errors.log that have been written since the last time its offset was reset through the Reset Site Errors link.
- View Primary Site Log File. View the current contents of the labkey.log file from the <CATALINA_HOME>/logs directory, which contains all log output from LabKey Server.
More Admin Console Pages
The other tabs in the admin console offer grids of detailed information:
- Server Information: Core database configuration and runtime information.
- The version of the server is displayed prominently above the core database configuration.
- Premium edition users can also export diagnostics from this page.
- Module Information: Detailed version information for installed modules.
- Active Users: See which users have been active in the last hour
Error Code Reporting
If you encounter an error or exception, it will include a unique
Error Code that can be matched with more details about the error on mothership. When reporting an issue to LabKey support, include this error code. In many cases LabKey can use this code to track down more information about the issue in mothership reports.
