Table of Contents |
guest 2020-09-18 |
Set Up for Tutorials: Trial
Set Up for Tutorials - Non-Trial
Navigation and UI Basics
Tutorials
Tutorials provide a "hands on" introduction to the core features of LabKey Server, giving step-by-step instructions for building solutions to common problems. They are listed roughly from simple to more complex, and you can pick and choose only those that interest you.
In order to run any tutorial, you will need:
- An account on a running LabKey Server.
- A project where you can create a new folder. If you don't have one, set up a cloud-hosted trial or a Virtual Machine evaluation server.
- Familiarity with some basics of navigating and using LabKey Server.
If you are starting a cloud-hosted trial of LabKey Server, this video will show you around:
This icon indicates whether the tutorial can be completed on a Hosted server trial or a Virtual Machine evaluation version.
New User Tutorials
Study Tutorials
Assay Tutorials
Developer Tutorials
Biologics Tutorials
Set Up for Tutorials: Trial
This topic covers the quickest and easiest way to set up to run LabKey tutorials using a free trial of LabKey Server. If you want to run tutorials not supported in the trial environment, or already have access to LabKey Server, see Set Up for Tutorials - Non-Trial.
Tutorials you can run using a free trial of LabKey Server are marked with this badge.
LabKey Trial Server
To run the LabKey Tutorials, you need three things:1. An account on a running LabKey Server instance. It only takes a few minutes to create your own LabKey Trial Server: 2. A basic familiarity with navigation, folder creation, and utilities like web parts. Use this topic alongside your new instance: 3. A tutorial workspace project where you are an administrator and can create new folders.- On the home page of your trial server, click Create.
- Enter the Name "Tutorials".
- If you plan to share this trial server with other users, consider using "Tutorials-Username" so you can each have your own workspace.
- Leave the default folder type selection, "Collaboration," and click Next.
- Leave the default permission selection, "My User Only," and click Next.
- Skip the advanced settings and click Finish.
- (Optional): To enhance this project, you can add some custom content making it easier to use.
Finished
Congratulations, you can now begin running tutorials in this workspace on your trial server.I'm Ready for the Tutorial List
Set Up for Tutorials - Non-Trial
This topic explains how to set up for the LabKey Tutorials on a non-trial instance of the server. If your tutorial will work on a hosted trial server, use this topic instead: Set Up for Tutorials: Trial.
To run the LabKey Tutorials you need:
- An account on a running LabKey Server instance.
- A tutorial workspace project on that server where you are an administrator and can create new folders.
- A basic familiarity with navigation, folder creation, and utilities like web parts.
Local VM Installation
1. You can download and install your own server on a local machine using VM image of the server. Follow the instructions in this topic to register, download, install, and start using LabKey Server. 2. You will be the site administrator on this server. To create a tutorials project:- Select (Admin) > Site > Create Project.
- Enter the name "Tutorials" and choose folder type "Collaboration".
- Accept all project wizard defaults.
Existing Installations
1. & 2. If your organization is already using LabKey server, contact your administrator about obtaining access as an administrator to a project or folder to use. For example, they might create and assign you a "Tutorials-username" project or subfolder. They will provide you the account information for signing in, and the URL of the location to use.
LabKey Server installations in active use may have specialized module sets or other customizations which cause the UI to look different than tutorial instructions. It's also possible that you will not have the same level of admin access that you would have if you installed a local demo installation.
3. Learn the navigation and UI basics in this topic:
The location given to you by your administrator is your tutorial workspace where you can create a subfolder for each tutorial that you run.
Full Local Installation
1. If none of the above are suitable, you may need to complete a full manual installation of LabKey Server. Detailed instructions are provided here: If you encounter difficulty during this installation, you may find help in our Installation Forum.2. You will be the site administrator on this server. To create a tutorials project:- Select (Admin) > Site > Create Project.
- Enter the name "Tutorials" and choose folder type "Collaboration".
- Accept all project wizard defaults.
Finished
Congratulations, you can now log in, navigate to your workspace, and begin running tutorials.Learn More
I'm Ready for the Tutorial List
Navigation and UI Basics
Welcome to LabKey Server!
This topic helps you get started using LabKey Server, understanding the basics of navigation and the user interface.
If you are using a LabKey Trial Server, use this topic instead: LabKey Server - Hosted Trial.
Projects and Folders
The project and folder hierarchy is like a directory tree and forms the basic organizing structure inside LabKey Server. Everything you create or configure in LabKey Server is located in some folder. Projects are the top level folders, with all the same behavior, plus some additional configuration options; they typically represent a separate team or research effort.The Home project is a special project. It is the default landing page when users log in and cannot be deleted. You can customize the content here to suit your needs. To return to the home project at any time, click the LabKey logo in the upper left corner.The project menu is on the left end of the menu bar and includes the display name of the current project.
Hover over the project menu to see the available projects, and folders within them. Click any project or folder name to navigate there.Any project or folder with subfolders will show / buttons for expanding and contracting the list shown. If you are in a subfolder, there will be a clickable 'breadcrumb' trail at the top of the menu for quickly moving up the hierarchy. The menu will scroll when there are enough items, with the current location visible and expanded by default.
The project menu always displays the name of the current project, even when you are in a folder or subfolder. A link with the Folder Name is shown near the top of page views like the following, offering easy one click return to the main page of the folder.
For more about projects, folders, and navigation, see Project and Folder Basics.
Tabs
Using tabs within a folder can give you new "pages" of user interface to help organize content. LabKey study folders use tabs as shown here:
When your browser window is too narrow to display tabs arrayed across the screen, they will be collapsed into a pulldown menu showing the current tab name and a (chevron). Click the name of the tab on this menu to navigate to it.
For more about adding and customizing tabs, see Use Tabs.
Web Parts
Web parts are user interface panels that can be shown on any folder page or tab. Each web part provides some type of interaction for users with underlying data or other content.
There is a main "wide" column on the left and narrower column on the right. Each column supports a different set of web parts. By combining and reordering these web parts, an administrator can tailor the layout to the needs of the users.To learn more, see Add Web Parts and Manage Web Parts. For a list of the types of web parts available in a full installation of LabKey Server, see the Web Part Inventory.
Header Menus and URLs
In the upper right, icon menus offer:
- (Search): Click to open a site-wide search box
- (Admin): Shown only to Admins: Administrative options available to users granted such access. See Admin Console for details about options available.
- (User): Login and security options; help links to documentation and support forums.
Watch the URL at the top of the page as you navigate LabKey Server and explore features on your server. Many elements are encoded in the URL and programmatic access via building URLs is possible with APIs. Learn more here: LabKey URLs.