Projects:Require Heartbeat in Module Management Console/Functional Specification
Contents
|
Require Heart Beat in Module Management Console - Functional Specifications
Overview
Purpose
Currently Openbravo ERP contains a very valuable feature called the Heart Beat that enables the Openbravo development team to receive anonymous data about live installations of the products.
This data is very valuable to the development of the project as it allows to gain valuable insight on the product dissemination.
Unfortunately the practice shows that there are not enough incentives for users to enable this mechanism - which has been designed as a voluntary opt-in - and very few systems activate the heart beat.
In order to provide further incentives to the activation of the beat, this project intends to:
- convert the heart beat to an opt-out feature
- require users to enable the heart beat before they can download modules from the Central Repository using the Module Management Console.
References
Functional Requirements
User roles & profiles
This project affects implementation consultants and system administrators installing and configuring Openbravo. We assume that these users are experienced computer users and that have a high degree of understanding of Openbravo ERP as a system.
Business process definition
- The first time the system administrator logs in a small pop-up window displays. The window welcomes and explains the heartbeat and registration process (see below the explanation). The user can accept enabling heart beat (Ok button) or cancel the configuration of the heartbeat (Cancel button):
- If system administrator accepts enabling heart beat the heart beat background process is launched and the first beat is sent at that moment. If the beat is properly received by heart beat server the window is closed and the flow continues as usual. If the beat is not received by heart beat server the system forwards the flow to heart beat configuration window where system administrator can add additional configuration to heartbeat (proxy, etc.) or disable it.
- If system administrator cancels heart beat configuration then the pop-up window will be displayed again next time system administrator logs in. To stop this pop-up window system administrator can go to heart beat configuration window and disable it.
- Users of Openbravo ERP should enable the heart beat before they can download and install modules from the Central Repository
- In case the heart beat is not enabled, they are prompted with a message inviting them to enable the heart beat at that point. If they accept, they can proceed with the module installation; if they refuse the installation is aborted.
- In all cases, users should be able to install modules from the file system.
User stories
Story 1
John is the system administrator of an Openbravo ERP system. Upon installation of the system, John enables the heart beat. At a later stage, he navigates to the Module Management Console, search for a particular module he is interested in and installs it.
Story 2
Mary is the system administrator of an Openbravo ERP system. Upon installation of the system, Mary skips enabling the heart beat. At a later stage, she navigates to the Module Management Console, search for a particular module she is interested in and clicks on Install Now. Before the installation flow begins she is prompted to enable the heartbeat. As she chooses to do so, the heart beat is automatically enabled for her system and she can proceed to the installation flow. From this moment on, her system will continue to send regular beats to Openbravo.
Story 3
Joan is the system administrator of an Openbravo ERP system. Upon installation of the system, Joan skips enabling the heart beat. At a later stage, she navigates to the Module Management Console, search for a particular module she is interested in and clicks on Install Now. Before the installation flow begins she is prompted to enable the heartbeat. As she chooses not to do so, the installation is canceled and she returns back to the Module Management window.
Story 4
Joan is the system administrator of an Openbravo ERP system. Upon installation of the system, Joan skips enabling the heart beat. At a later stage, she navigates to the Module Management Console, and installs a number of modules from the local file system. Since the files she has are very old, she would like to verify if newer versions are available on line and she presses the Scan for update button. After the scan several updates are available in her system. She clicks on update all. Before the update flow begins she is prompted to enable the heartbeat. As she chooses to do so, the heart beat is automatically enabled for her system and she can proceed to the update flow. From this moment on, her system will continue to send regular beats to Openbravo.
Functional requirements based on business processes
| Num | Requirement | Importance | Status |
| 1.1 | The first time the system administrator logs in a small pop-up window displays. The window welcomes and explains the heartbeat and registration process (see below the explanation). The user can accept enabling heart beat (Ok button) or cancel the configuration of the heartbeat (Cancel button):
See screenshot below | Must Have | Done |
| 1.2 | From heart beat configuration window system administrator can:
-If heart beat is enabled, disable it -If heart beat is disabled, enable it -If heart beat configuration was cancelled in the pop-up window, enable heartbeat or disable it
| Must Have | Done |
| 1.3 | When system administrator disables heart beat in an instance where it was previously enabled it sends a last beat to heart beat server. To be able to classify the heartbeat data the 'beat' will have and additional field: 'type of beat' with this possible values: enabling beat, scheduled beat, disabling beat.
| Must have | Done |
| 1.4 | When Openbravo ERP users press Install Now in the Module Management window, verify if the heartbeat is enabled in the system.
If so, proceed to the installation flow as usual. If not, present users with a window where they can choose to enable the heartbeat and then continue to installation or cancel the installation process. | Must Have | Done |
| 1.5 | When Openbravo ERP users press Update modules after a Scan for Updates in the Module Management window, verify if the heartbeat is enabled in the system.
If so, proceed to the update flow as usual. If not, present users with a window where they can choose to enable the heartbeat and then continue with the update process or cancel it. | Must Have | Done |
| 1.6 | Registration process launched from Openbravo ERP includes system id so it is possible to track for registered instances their heartbeat log
| Nice to Have | Done |
User Interface Mockups
Welcome pop-up
The following picture illustrates the popup window that appears when system administrator logs in first time
Heart beat configuration window
The following picture illustrates the heart beat configuration window in case system admin cancels enabling it in previous pop-up
Before install module pop-up
The following picture illustrates the popup window that appears when users try to install or update a module from an Openbravo ERP instance with the heartbeat disabled.
Open Discussion Items
- None
Closed Discussion Items
- Should user be able to even navigate to the Module Management window if the heartbeat is disabled?
- Yes, for two reasons: 1) we want users to be able to see which modules are available as an incentive to enable the heartbeat; 2) they need to access the Module Management console to install modules or to update from the file system.
- What if the system is not connected to the Internet and cannot send beats?
- In this case, users are not able to connect to the Central Repository in any case so nothing is lost.
- Should users of an active Professional Subscription instance be required to enable the heart beat? It should be answered by Product Marketing
- There in no restriction from Product Marketing in this regard, so all instances are required to enable Heartbeat in order to install modules from Central Repository