What is a "project" in LabKey?
How can I add a sub-folder in a project or folder?
How to delete a project or folder?
How can I change the contents of a page?
How to report requirements?
How to delete an issue?
Where can I get further documentation about LabKey?

 

What is a "project" in LabKey?

A LabKey server installation is organised as a folder hierarchy, where the first and second ranks of folders have special names: site and projects. Lower ranks have no special name, so they are referred as folders and/or sub-folders.

The top of the hierarchy folder is called the site, the next level of folders are called projects. A project can contain any number of folders and sub-folders underneath.

Example:

In the screenshot below, there are three projects:

  1. "Home"
  2. "Public Datasets"
  3. "sciCORE Group"

When expanding the "Public Datasets" project, it can be seen that this project contains two folders:

  1. "Iris Dataset"
  2. "HIV-CD4 Study"

Detailed information can be found in the LabKey documentation Projects and Folders.

 

How can I add a sub-folder in a project or folder?

There are two ways:

(1) Shortcut:

  • Navigate to the project or folder in where you need to create the sub-folder (in the screenshot below it is the project "Shared").
  • Click on the "New Subfolder" icon.
  • For a general purpose folder type, select "Collaboration".

(2) General, for folder management:

  • Select the menu " --> Folder --> Management" on the top right-hand side of the page.
  • In the "Folder Tree" tab, navigate to the project or folder in where you need to create the sub-folder.
  • Click on the "Create Subfolder" button.
  • For a general purpose folder type, select "Collaboration".

 

How to delete a project or folder?

  • Select the menu " --> Folder --> Management" on the top right-hand side of the page and, in the tab "Folder Tree", select the project or folder to delete.
  • Hit the button "Delete" and confirm deletion.

 

How to change the contents of a page?

Administrators can make changes to the contents of a page (including web parts and wikis) by entering "Page Admin Mode".

How to enter "Page Admin Mode"

Select " --> Page Admin Mode". The option stays active until the user deactivates it by clicking on "Exit Admin Mode".

How to add web parts

Select the target web part from the "<Select Web Part>" dropdown box and click the "Add" button.

How to add a new tab or edit an existing one

  • To add a new tab, click the     mini tab on the right of the header bar.
  • To edit a current tab, pulldown the triangle menu on the right side of the tab.

Only when there is more than on tab, the tabs will be displayed across the header bar.

More infos

In the LabKey's documentation Page Admin Mode.

 

How to report requirements?

  • Navigate to the "Home" project.
  • Select the "Issues" tab and click the "New Issue" button.
  • Fill out the form with detailed requirements. It is possible to add files for documentation purposes using the "Attach a file" link.
  • Assign it to somebody in the sciCORE team.
  • Save the issue clicking the "Save" button.

 

How to delete an issue?

LabKey does not provide any possibility to delete an issue through the user interface.
The only way is to delete the record directly from the database. This is officially unsupported because of the risk to break the application.

See more detailed infos in the LabKey forum.

 

Where can I get further documentation about LabKey?

Select the menu " --> LabKey Documentation" on the top right-hand side of the page, to access tutorials, videos and other documentation.

Discussion