Timeline App

The timeline app enables the developer of a SODAR Core based site to log project related user events and link objects (both existing and deleted) to those events.

NOTE: When viewing this document in GitLab critical content will by default be missing. Please click “display source” if you want to read this in GitLab.

Unlike the standard Django object history accessible in the admin site, these events are not restricted to creation/modification of objects in the Django database, but can concern any user-triggered activity.

The events can also have multiple temporal status states in case of e.g. events requiring async requests.

The app provides front-end views to list project timeline events, as well as a backend API for saving desired activity as timeline events. For details on how to use these, see the timeline usage documentation.

Contents:

• Installation
  • Django Settings
  • Optional Settings
  • URL Configuration
  • Migrate Database and Register Plugin
• Usage
  • Timeline UI
  • Backend API for Event Logging
    • Invoking the API
    • Adding an Event
    • Linking an Object
    • Defining Object References
    • Displaying Object Links
    • Defining Status States
    • Extra Data
    • Classified Events
• API Documentation
  • Backend API
  • Models