SampleDB 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.