An application to report any event that happen in your team

Description

You want to track events in your team? store them somewhere?  This is the purpose of this simple application.  You define some event that you want to measure/report and then, the application is giving you the UI to record a new event very fast.

In order to use these data later, there is also some CSV, XML and JSON format provided.

General presentation

In the left panel of application (if you have it!), you should find this logo.

Click on it to access the main page of the Event Recorder application.  If you don't have this application's panel, you can also navigate to the page KPI.WebHome.

The screen has 2 parts:

• Existing data
• New event

Record a new event

In the section 'New event', you will be able to record a new instance of an event.  You have 3 fields at your disposal:

• The event you want to record
• The quantity of this event
• A comment field

Choose the event you want to record and fill the corresponding quantity.  If you want to complete this record with any free text information, the comment field is for you.

Export existing data

On the main page of the application, you also have a list of links:

• CSV
• XML
• JSON

These links allow you to export the existing data to different format.  Click on them to see what's happening!

Create a new event type

To explain how to create a new kind of event, we will take an example.

Let's say you want to record each time your team is releasing a new extension to XWiki.  We will give an unique ID to this event k42.  To create this new kind of event, we have to create a new wiki page.  You can create this page with the following name KPI.k42.  Save it!

Now, you'll have to edit this page in object mode (click on Edit dropdown button and click 'object').

Now that you're in edit mode, you can add a new object.  You're looking for the class KPICode.KPIDescriptorClass.  Click Add button.  A new object should have been created below.  You can unfold it (if it's not already the case!) and fill the fields.

• id is the ID you'll give to your event, it must unique in your wiki so please choose it carefully
• name is a short description that will be shown to the user when recording an event
• unit is the unit of the number used in the event; for number of extension, it's not that important but if you try to measure time or money, you probably want this one to be filled in order to have any people of your team filling homogeneous data
• objectives is a comma-separated IDs of objectives; each event is a measure to evaluate specifics objectives
• description is a free text area to describe more in detail your new event

Once you save this page, your new event is on and will be used by the application.

Dependencies

Dependencies for this extension (jsimard:event-reporter-application ):

• org.xwiki.platform:xwiki-platform-sheet-ui 7.0.1
• org.xwiki.platform:xwiki-platform-uiextension-ui 7.0.1