An introduction to the Timeline behaviour
The Timeline behaviour is not currently available with SpringBot. If you would like to register interest in prioritising this behaviour, please contact us via the feedback form. For more information on the bot plans, please see our Codebots Roadmap.
What is Timelines?
A timeline is a visual tool which allows users to view information on entities within their application. This log of information includes actions such as creating, updating, and deleting, following the rules laid out by the security model.
Use cases could include an audit trail, booking history, or a log of bot actions.
Timeline can be viewed as an interactive horizontal timeline or a chronological list view. They both display logged actions which have occurred, along with the corresponding times. Timelines can display information across an entire entity or be filtered down to look at changes made to a single record.
Using Codebots protected regions, Timelines can be customised to include:
Custom security considerations; showing a specific set of information that is not configurable with the default options.
Timelines is not suitable for:
Versions - cannot see a snapshot of the entity at a point on the timeline.
Timelines is suitable for:
Data comparison – ability to filter and view information in a certain amount of time and compare it to one another.
Viewing entity changes – ability to view entity changes throughout time.
Activity of your application – ability to view how often your application is being used and how often items are being logged.
Adding the behaviour into your application
Adding the Timelines behaviour to your application is like adding the CRUD behaviour. You will have to go to the Entity diagram, create a New Entity, and click on the New behaviour button and add the Timelines behaviour to your Entity. Build your application and then pull your project for the new changes. You can now run your application and go to the Admin section and see that there a Timeline behaviour icon on the left side in the navigation. Click on that and you can view the timelines behaviour in the Admin section. To view the Timelines Behaviour in the Frontend, navigate yourself to the page of the where you added the behaviour.
Timelines view - Admin
This is a screen in the Admin end which shows all the entities attached to the Timelines behaviour. The Timelines behaviour is attached to the entity in the model like the CRUD behaviour.
Timelines view - Frontend
In the Frontend view of timelines, the behaviour is viewed by accessing an entity that has the Timelines behaviour attached to it by using the model. The view is similar to the Admin Timelines except the ability to filter entities.
Both Frontend and Admin users can access record-level timelines from within the entity list view. This view is recommended for a detailed version of change logs and to see every single change made in the entity at every second.
Configuring and using Timelines
Below is the screenshot of the following buttons and inputs that are shared across both the timelines view and the record-level view.
You can search logs within the timeline such as the ID, to view changes made with the Entity.
If you want to view broader changes but still keep it somewhat limited, you can filter the logs by instances, start date and end date, and the type of change: ‘Created’, ‘Deleted’, ‘Updated’.
Swapping between timelines view and record-level view
The top right button will swap between the timelines or the record-level views.
Timelines view features
The right sidebar of the timelines view consists of two types of information, Recent Activities and the Legend. Under recent activity, it consists of 7 timelines logs that has happened recently; this is to inform users on what has been happening with the entity lately. Underneath that is the Legend, this explains what the shapes and colours stand for. Note that you can change the shapes and colours within the protected region in your application.
The icons with a magnifying glass consisting a plus and minus signs are the zoom in and out buttons. These buttons allow you to view the Timeline at a certain date range. Zooming in will display a view of the time being more specific whereas zooming out does the opposite.
At the top right, next to the zoom in/out buttons there are left and right buttons, note that these buttons are also the left and right chevron icons of the view. These buttons will show the dates after, or before the current view. Clicking on the left button will bring you backwards and the right will bring you forwards.
Jump to today
The button with the clock will jump you to Today of the timelines view.
The reset button looks like a square icon that will allow you to reset your view to its original state in case you have lost where you left off.
The record-level view consists of a list view information on the left side that displays log information of the entity. You can scroll upwards to the latest timelines log or continue to scroll down to view past logs.
The quick jump is filterable by months and weeks on the right side. On the left, there are links of dates that you can quickly jump to in the list if you prefer not to scroll.
To help gain an understanding of how Timeline works, see the interactive prototype.
NOTE: This is a prototype of what Timelines is going to be – please refer to the walkthrough video in this article to understand how Timelines functions currently.
Last updated: 19 August 2020