Here we install sample data to work with and we create the skeleton of our module, the three empty directories:
- queries - Holds SQL queries and views.
- reports - Holds R reports.
- views - Holds user interface files.
Set Up a Dev Machine
Complete the topics below. This will set up a machine that can build LabKey Server (and the proteomics tools) from source.
Install Sample Data
- Install the Proteomics sample data by following the instructions in these topics:
Create Directories
- Go to the externalModules/ directory, and create the following directory structure and standard.modules file:
reportDemo
│ module.properties
└───resources
├───queries
├───reports
└───views
Add the following contents to module.properties:
Module Class: org.labkey.api.module.SimpleModule
Name: ReportDemo
Build the Module
- Open the file module.properties and add the following line:
externalModules/reportDemo
- In a command shell, go to the 'server' directory, for example, 'cd C:\dev\labkey-src\trunk\server'.
- Call 'ant build' to build the module.
- Restart the server to deploy the module.
Enable Your Module in a Folder
To use a module, enable it in a folder.
- Go to the LabKey Server folder where you want add the module functionality.
- Select Admin -> Folder -> Management -> Folder Type tab.
- Under the list of Modules click on the check box next to ReportDemo to activate it in the current folder.
