Example Modules: /Documentation

Example Modules

Documentation

Example Modules

Use the modules listed below as examples for developing your own modules.

To acquire the source code for these modules, enlist in the LabKey Server open source project: Set Up a Development Machine. Many can be downloaded from github or our wiki topics.

Module Location	Description / Highlights
https://github.com/LabKey	Public modules on GitHub.
https://github.com/LabKey/platform	The core modules for LabKey Server are located here, containing the core server action code (written in Java).
https://github.com/LabKey/testAutomation	The test module runs basic tests on the server. Contains many basic examples to clone from.

Other Resources

Set Up a Development Machine
Tutorial: File Based Module Resources - An example file-based module with step by step instructions.
Tech Talk: Custom File-Based Modules
Tutorial: Hello World Java Module - Using a Gradle target, create a template Java module that you can build out from.
Trigger Scripts - Module-based trigger scripts, schemas created by SQL scripts.
LabKey Modules - Descriptions of the modules in the standard distribution of LabKey Server.

Docs & Product Feedback

Was this content helpful?

Log in or register an account to provide feedback

Pages

Documentation Home

Getting Started

Introduction to LabKey Server

Navigate the Server

Panorama: Targeted Mass Spectrometry

Set Up a Development Machine

Run in Development Mode

LabKey Client APIs

Develop Modules

Tutorial: Hello World Module

Map of Module Files

Module Loading Using the Server UI

Module Editing Using the Server UI

Example Modules

Tutorial: File Based Module Resources

Modules: JavaScript Libraries

Modules: Assay Types

Modules: Folder Types

Modules: Query Metadata

Modules: Report Metadata

Modules: Custom Header

Modules: Custom Banner

Modules: Custom Footer

Modules: SQL Scripts

Modules: Domain Templates

Modules: Custom Login Page

Modules: Custom Site Welcome Page

ETL: Extract Transform Load

Deploy Modules to a Production Server

Main Credits Page

Module Properties

module.properties Reference

Common Development Tasks

LabKey Open Source Project

Developer Reference

Troubleshoot LabKey Server

Premium Resources

Community Resources

expand all collapse all