User Guide

Welcome to the SimpleELN documentation! Here, you will find comprehensive information on how to utilize SimpleELN for creating, sharing, and organizing your daily works, documents, and files. You can try out all the functionalities online at http://simpleeln.com.

Contents

Installation

• 1. Introduction
  • 1.1. Users
  • 1.2. Editions
• 2. Installation
  • 2.1. Personal Edition
    • 2.1.1. Install SimpleELN Personal Edition as Desktop Application
    • 2.1.2. Install SimpleELN Personal Edition as Web Server
  • 2.2. Team Edition
    • 2.2.1. Install SimpleELN Team Edition as Web Server with External Database
      • 2.2.1.1. Installing External Database and Web Server Application Manually by Executing Commands
        • 2.2.1.1.1. Installing MySQL Server and Create the Application Database
        • 2.2.1.1.2. Installing and Running the SimpleELN Web Server
      • 2.2.1.2. Installing External Database and Web Server Application Automatically Using Docker
    • 2.2.2. Install SimpleELN Team Edition as Web Server with Embedded Database
  • 2.3. MultiTeam Edition
    • 2.3.1. Install SimpleELN MultiTeam Edition as Web Server with External Database
      • 2.3.1.1. Installing External Database and Web Server Application Manually by Executing Commands
        • 2.3.1.1.1. Installing MySQL Server and Create the Application Database
        • 2.3.1.1.2. Installing and Running the SimpleELN Web Server
      • 2.3.1.2. Installing External Database and Web Server Application Automatically Using Docker
    • 2.3.2. Install SimpleELN MultiTeam Edition as Web Server with Embedded Database
• 3. SimpleELN Initialization
  • 3.1. User Account Initialization
    • 3.1.1. User Account Initialization for Personal Edition
    • 3.1.2. User Account Initialization for Team Edition
    • 3.1.3. User Account Initialization for MultiTeam Edition
  • 3.2. License File Initialization
    • 3.2.1. License File Initialization for Personal Edition
      • 3.2.1.1. Get the License File
      • 3.2.1.2. Install the License File
        • 3.2.1.2.1. Option 1: Manually Install the License File
        • 3.2.1.2.2. Option 2: Automatically Install the License File
    • 3.2.2. License File Initialization for Team Edition
      • 3.2.2.1. Get the License File
      • 3.2.2.2. Install the License File
    • 3.2.3. License File Initialization for MultiTeam Edition
      • 3.2.3.1. Get the License File
      • 3.2.3.2. Install the License File

Usage

• 1. Notebook Management
  • 1.1. Overview
  • 1.2. Notebook Structure
  • 1.3. Notebook Creation
    • 1.3.1. Create Notebook Structure
      • 1.3.1.1. Create New Project
      • 1.3.1.2. Create New Chapter
      • 1.3.1.3. Create New Section
      • 1.3.1.4. Create New Experiment
    • 1.3.2. Enter Experimental Data
      • 1.3.2.1. Create New Protocol
      • 1.3.2.2. Create New Result
      • 1.3.2.3. Create New Attachment
    • 1.3.3. Screenshots of Creating a Demo Notebook
      • 1.3.3.1. Create New Project
      • 1.3.3.2. Create New Chapter
      • 1.3.3.3. Create New Section
      • 1.3.3.4. Create New Experiment
      • 1.3.3.5. Create New Protocol
      • 1.3.3.6. Create New Result
      • 1.3.3.7. Create New Attachment
      • 1.3.3.8. A Demo Experiment Page
  • 1.4. Notebook Edit
    • 1.4.1. Edit Annotation Data
      • 1.4.1.1. Modify Project Title and Tags
      • 1.4.1.2. Modify Chapter Title and Tags
      • 1.4.1.3. Modify Section Title and Tags
      • 1.4.1.4. Modify Experiment Title and Tags
      • 1.4.1.5. Modify Protocol Title and Tags
      • 1.4.1.6. Modify Result Title and Tags
      • 1.4.1.7. Modify Attachment Filename
    • 1.4.2. Edit Experimental Data
      • 1.4.2.1. Append Protocol Data
      • 1.4.2.2. Append Result Data
      • 1.4.2.3. Append Attachment Data
    • 1.4.3. Editing Logs of Annotation Data
      • 1.4.3.1. Editing Logs of Project Title and Tags
      • 1.4.3.2. Editing Logs of Chapter Title and Tags
      • 1.4.3.3. Editing Logs of Section Title and Tags
      • 1.4.3.4. Editing Logs of Experiment Title and Tags
      • 1.4.3.5. Editing Logs of Protocol Title and Tags
      • 1.4.3.6. Editing Logs of Result Title and Tags
      • 1.4.3.7. Editing Logs of Attachment Filename
    • 1.4.4. Screenshots of editing project data
      • 1.4.4.1. Modify Project Title and Tags
      • 1.4.4.2. Modify Chapter Title and Tags
      • 1.4.4.3. Modify Section Title and Tags
      • 1.4.4.4. Modify Experiment Title and Tags
      • 1.4.4.5. Modify Protocol Title and Tags
      • 1.4.4.6. Modify Result Title and Tags
      • 1.4.4.7. Modify Attachment Filename
      • 1.4.4.8. Append Protocol Data
      • 1.4.4.9. Append Result Data
      • 1.4.4.10. Append Attachment Data
      • 1.4.4.11. Editing Logs of Project Title and Tags
      • 1.4.4.12. Editing Logs of Chapter Title and Tags
      • 1.4.4.13. Editing Logs of Section Title and Tags
      • 1.4.4.14. Editing Logs of Experiment Title and Tags
      • 1.4.4.15. Editing Logs of Protocol Title and Tags
      • 1.4.4.16. Editing Logs of Result Title and Tags
      • 1.4.4.17. Editing Logs of Attachment Filename
  • 1.5. Notebook Share
    • 1.5.1. Personal Edition
    • 1.5.2. Team Edition
      • 1.5.2.1. Overview
      • 1.5.2.2. Create and Share a Non-Shared Project
        • 1.5.2.2.1. Create a Non-Shared Project
        • 1.5.2.2.2. Share a Non-Shared Project
      • 1.5.2.3. Create and Share a Shared Project
        • 1.5.2.3.1. Create a Shared Project
        • 1.5.2.3.2. Share a Shared Project
      • 1.5.2.4. Edit Sharing Permissions for an Existing Project
        • 1.5.2.4.1. Add Sharing Permissions for an Existing Project
        • 1.5.2.4.2. Remove Sharing Permissions for an Existing Project
      • 1.5.2.5. Screenshots of Sharing a Demo Notebook
        • 1.5.2.5.1. Create a Non-Shared Project
        • 1.5.2.5.2. Share an Existing Non-Shared Project
        • 1.5.2.5.3. Create a Shared Project
        • 1.5.2.5.4. Share an Existing Shared Project
        • 1.5.2.5.5. Add Sharing Permissions for an Existing Project
        • 1.5.2.5.6. Remove Sharing Permissions for an Existing Project
        • 1.5.2.5.7. Overview of Projects for A Demo Team
          • 1.5.2.5.7.1. Overview of Projects by Team User1, a Team User
          • 1.5.2.5.7.2. Overview of Projects by Team User2, a Team User
          • 1.5.2.5.7.3. Overview of Projects by Team User3, a Team User
          • 1.5.2.5.7.4. Overview of Projects by Team User4, a Team User
          • 1.5.2.5.7.5. Overview of Projects by Team Admin1, the Team Admin
    • 1.5.3. MultiTeam Edition
      • 1.5.3.1. Overview
      • 1.5.3.2. Notebook Sharing Among Members of the Same Team
      • 1.5.3.3. Notebook Sharing Among Members of Different Teams
        • 1.5.3.3.1. Create and Share a Non-Shared Project
          • 1.5.3.3.1.1. Create a Non-Shared Project
          • 1.5.3.3.1.2. Share a Non-Shared Project
        • 1.5.3.3.2. Create and Share a Shared Project
          • 1.5.3.3.2.1. Create a Shared Project
          • 1.5.3.3.2.2. Share a Shared Project
        • 1.5.3.3.3. Edit Sharing Permissions for an Existing Project
          • 1.5.3.3.3.1. Add Sharing Permissions for an Existing Project
          • 1.5.3.3.3.2. Remove Sharing Permissions for an Existing Project
      • 1.5.3.4. Screenshots of Sharing a Demo Notebook
        • 1.5.3.4.1. Create a Non-Shared Project
        • 1.5.3.4.2. Share an Existing Non-Shared Project
        • 1.5.3.4.3. Create a Shared Project
        • 1.5.3.4.4. Share an Existing Shared Project
        • 1.5.3.4.5. Add Sharing Permissions for an Existing Project
        • 1.5.3.4.6. Remove Sharing Permissions for an Existing Project
        • 1.5.3.4.7. Overview of Shared Projects for Two Demo Teams
          • 1.5.3.4.7.1. Overview of Projects by Team User1, a Team User of Team1
          • 1.5.3.4.7.2. Overview of Projects by Team User2, a Team User of Team1
          • 1.5.3.4.7.3. Overview of Projects by Team User5, a Team User of Team2
          • 1.5.3.4.7.4. Overview of Projects by Team User6, a Team User of Team2
          • 1.5.3.4.7.5. Overview of Projects by Team User7, a Team User of Team2
          • 1.5.3.4.7.6. Overview of Projects by Team Admin1, the team administrator of Team1
          • 1.5.3.4.7.7. Overview of Projects by Team Admin2, the team administrator of Team2
  • 1.6. Notebook Comment
    • 1.6.1. Comment on a protocol record
      • 1.6.1.1. Comment on a protocol record by its project creator
      • 1.6.1.2. Comment on a protocol record by a user with shared access privileges
    • 1.6.2. Comment on a result record
      • 1.6.2.1. Comment on a result record by its project creator
      • 1.6.2.2. Comment on a result record by a user with shared access privileges
    • 1.6.3. Screenshots of Notebook Comment
      • 1.6.3.1. Comment on a protocol record
      • 1.6.3.2. Comment on a result record
• 2. User Management
  • 2.1. Create User Accounts
    • 2.1.1. Create User Accounts for Personal Edition
    • 2.1.2. Create User Accounts for Team Edition
      • 2.1.2.1. Option 1. Create New Team User Account Directly
      • 2.1.2.2. Option 2. New User Signup and Approval
      • 2.1.2.3. Screenshots of Creating User Accounts for Team Edition
        • 2.1.2.3.1. Create New Team User Account Directly
        • 2.1.2.3.2. Create New Lab Manager Account
        • 2.1.2.3.3. Complete Team User Signup Form
        • 2.1.2.3.4. Approve Team User Signup Account
    • 2.1.3. Create User Accounts for MultiTeam Edition
      • 2.1.3.1. Create New Super User Account
      • 2.1.3.2. Create New Team Admin Account
      • 2.1.3.3. Create New Team User Account
      • 2.1.3.4. New User Signup and Approval
      • 2.1.3.5. Screenshots of Creating User Accounts for MultiTeam Edition
        • 2.1.3.5.1. Create New Super User Account
        • 2.1.3.5.2. Create New Team Admin Account
        • 2.1.3.5.3. Create New Team User Account
        • 2.1.3.5.4. Complete User Signup Form
        • 2.1.3.5.5. Approve User Signup Account by Super User
        • 2.1.3.5.6. Approve Team User Signup Account by Team Admin or Lab Manager
  • 2.2. Edit User Accounts
    • 2.2.1. Edit User Accounts for Personal Edition
    • 2.2.2. Edit User Accounts for Team Edition
      • 2.2.2.1. Edit Login User Account
      • 2.2.2.2. Edit Non-Login User Account
        • 2.2.2.2.1. Edit Registered User Account
        • 2.2.2.2.2. Edit Signup User Account
      • 2.2.2.3. Enable/Disable Non-Login User Account
        • 2.2.2.3.1. Enable/Disable Registered User Account
        • 2.2.2.3.2. Enable/Disable Signup User Account
        • 2.2.2.3.3. Enable/Disable Lab Manager Account
    • 2.2.3. Edit User Accounts for MultiTeam Edition
      • 2.2.3.1. Edit Login User Account
      • 2.2.3.2. Edit Non-Login User Account
        • 2.2.3.2.1. Edit Registered User Account
        • 2.2.3.2.2. Edit Signup User Account
      • 2.2.3.3. Enable/Disable Non-Login User Account
        • 2.2.3.3.1. Enable/Disable Registered User Account
        • 2.2.3.3.2. Enable/Disable Signup User Account
        • 2.2.3.3.3. Enable/Disable Lab Manager Account
  • 2.3. Reset User Password
    • 2.3.1. Reset User Password for Personal Edition
    • 2.3.2. Reset User Password for Team Edition
      • 2.3.2.1. Reset Login User Password
      • 2.3.2.2. Reset Registered User Password
    • 2.3.3. Reset User Password for MultiTeam Edition
      • 2.3.3.1. Reset Login User Password
      • 2.3.3.2. Reset Registered User Password by Super User
      • 2.3.3.3. Reset Registered User Password by Team Admin

Appendix

• 1. Zip and Unzip Files on Windows
• 2. Change Folder Permission
• 3. Folder Structure

Acknowledgements

• Acknowledgements