Timeline App

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

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 timeline events for projects, categories, objects and site-wide actions. Also included is 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
• Django API Documentation
  • Backend API
    • TimelineAPI
  • Models
    • ProjectEvent
    • ProjectEventManager
    • ProjectEventObjectRef
    • ProjectEventStatus