Documentation

User Guide

User Guide

• Users
  • Authentication
  • Preferences
  • Notifications
  • Bot Users
  • Readonly Users
  • Hidden Users
  • Deactivated Users
  • User Aliases
  • Federated Identities
  • Federated Login
• Basic Groups
• Project Groups
• Group Categories
• Instruments
  • Instrument Scientists
  • Instrument Log
  • Topics
• Actions
  • Action Types
  • Topics
  • Custom Actions
• Metadata and Schemas
  • Data types
  • Conditional Properties
  • Recipes
  • Query Placeholder
• Objects
  • Metadata
  • Files
  • Comments
  • Activity Log
  • Location Log
  • Permissions
  • Data Export
  • Labels
• Search
  • Simple Search
  • Advanced Search
• Locations
  • Location Types
  • Location Permissions
  • Location Log
  • Storage Capacities
• Topics
• Export and Import
  • Importing .eln Files
• Citation Guide
  • Code
  • JOSS article
  • Objects

Tutorials

Tutorials

• Understanding Core Concepts
• Entering Data
• Managing Object Permissions
• Finding Objects
• Sharing Data with Other Databases
• Using the HTTP API

Administrator Guide

Administrator Guide

• Getting Started
• Configuration
• TLS Termination
• OpenID Connect (OIDC)
• Backup and Restore
• Upgrading
• Administration Scripts
• JupyterHub Support
• Dataverse Export
• SciCat Export
• Info Pages
• Languages
• Federation
• Monitoring Dashboard
• Download Service
• Customization
• Deprecated Features
• Label Paper Formats
• External Links

Developer Guide

Developer Guide

• HTTP API
  • Authentication
  • Objects
  • Object Permissions
  • Instruments
  • Instrument Log Entries
  • Actions
  • Action Types
  • Users
  • Basic Groups
  • Project Groups
  • Locations
  • Location Types
  • Files
  • Comments
  • Object Data Diff Syntax
  • Access Tokens
  • Object Log Entries
• Webhooks
  • Handling Webhook Messages
• Contributing

Note

Both SampleDB and this documentation are still a work in progress. If you come across any issues or want to request a feature, please let us know.

Versions

develop
latest
0.33.1 , 0.33.0
0.32.0
0.31.1 , 0.31.0
0.30.0
0.29.1 , 0.29.0
0.28.2 , 0.28.1 , 0.28.0
0.27.0
0.26.0
0.25.3 , 0.25.2 , 0.25.1 , 0.25.0
0.24.1 , 0.24.0
0.23.1 , 0.23.0
0.22.1 , 0.22.0
0.21.5 , 0.21.4 , 0.21.3 , 0.21.2 , 0.21.1 , 0.21.0
0.20.0
0.19.3 , 0.19.2 , 0.19.1 , 0.19.0
0.18.0
0.17.0
0.16.1 , 0.16.0
0.15.0
0.14.1 , 0.14.0
0.13.1 , 0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.1 , 0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.1 , 0.3.0
0.2.0