Difference between revisions of "User Experience/OpenOffice.org User Feedback Extension"

From Apache OpenOffice Wiki
< User ExperienceRedirect page
Jump to: navigation, search
(New page: Please do not edit this page without explicit permission from Christian Jansen, or Bjoern Michaelsen. Your comments are welcome on the Discussion page. {| border="2" cellpadding="4" cells...)
 
m (redirect)
 
(27 intermediate revisions by one other user not shown)
Line 1: Line 1:
Please do not edit this page without explicit permission from Christian Jansen, or Bjoern Michaelsen. Your comments are welcome on the Discussion page.
+
#REDIRECT [[User Experience/OpenOffice.org User Feedback Program]]
 
+
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
+
 
+
|- align="left"
+
| colspan="2" bgcolor="#cccccc"  | '''Specification Status'''
+
|-
+
|-
+
| width="150" | '''Author''' || Christian Jansen (UX), Bjoern Michaelsen (DEV)
+
|-
+
| width="150" | '''Last Change''' || [[User:Cj|Cj]]
+
|-
+
| width="150" | '''Status''' || Preliminary
+
|-
+
|}
+
 
+
 
+
The OpenOffice.org Usage Feedback Extension is an extension that collects anonymously data about how OpenOffice.org is used. This information is used to better understand how people use OpenOffice.org. Especially with regards to the user interface.
+
 
+
 
+
== Development ==
+
The extension is devided into two components, a core component and an extension.
+
 
+
* The core component provides the technology for collecting data.
+
* The extension enables, respectively disables the core component. In addition the extension is responsible to send out the collected data by using SOAP.
+
* Core Component has been itegrated with cws logger2
+
* The extension extension will be integrated with cws oooimprovement. The source code can be found in the new module oo_extensions in project extensions: http://extensions.openoffice.org/source/browse/extensions/oo_extensions/source/oooimprovement/
+
== User Interface ==
+
=== Query Dialog ===
+
After installation of the extension, the following dialog is shown:
+
 
+
///UI-MOCKUP OF DIALOG///
+
 
+
'''Options:'''
+
 
+
* Yes:
+
** Actives the extension.
+
** Usage tracking starts immediately until the user disables, or de-installs the extension.
+
 
+
* No:
+
** Does not active the extension.
+
** The extension will not ask again for participating the program.
+
 
+
* Info Icon
+
** The icon Points to ///URL
+
 
+
'''Strings used'''
+
 
+
OpenOffice.org Improvement Program
+
 
+
Help Optimize the Quality of OpenOffice.org
+
 
+
We invite you to join our OpenOffice.org Improvement Program to help optimize the quality of OpenOffice.org.
+
 
+
If you are willing to participate, we will collect anonymous statistics about how you use OpenOffice.org. The data is used to identify usage patterns.
+
 
+
The OpenOffice.org Improvement Program will not collect any personal data, or document content.
+
 
+
Yes, I am willing to participate in the OpenOffice.org Improvement Program
+
 
+
No, I do not wish to participate
+
 
+
Get more information about the $PRODUCTNAME Improvement Program
+
 
+
=== Tools Options Dialog ===
+
 
+
///UI-MOCKUP OF DIALOG///
+
 
+
'''Strings used'''
+
 
+
Tracked data
+
Number of reports send:
+
 
+
Number of tracked actions:
+
 
+
Show Data
+
 
+
== Configuration ==
+
A configuration entry in the '''Logging.xcu''' allows administrators to switch the extension globally OFF. The configuration entry in can be found in:
+
 
+
org.openoffice.Office.Logging.UiEventslogger.LogPath (File: Logging.xcu)
+
 
+
== Usage Data Collected ==
+
The collected data is stored in a human readable CSV File at a location set in /org.openoffice.Office.Logging.UiEventslogger.LogPath (File: Logging.xcu)
+
 
+
* The data will get packed in a zip-file before upload.
+
* When the data was packed successfully, the uncompressed CSV-File is
+
deleted to save disc space. If the upload attempt fails, only the zipped
+
file will be kept for retries.
+
 
+
=== Types of Data Collected ===
+
 
+
The following types of data are collected:
+
 
+
* Toolbar Buttons
+
** Including Add-Ons
+
* Menu Items
+
** Including Add-Ons
+
* Context Menu Items
+
* Fonts applied by using the menu
+
* Font sizes applied by using the menu
+
* Buttons, like Ok, Cancel, etc.
+
* Document - , Paragraph language applied by using the menu or status bar
+
 
+
* Each item call provides a:
+
** Time stamp
+
** An information from which module the item has been called
+
 
+
=== Example Log ===
+
~ 150 kByte uncompressed / 20 kBytes compressed in 30 min. while creating a short document
+
 
+
<pre>
+
event no,thread,timestamp,eventtype,origin,uno url,parent id,window type,id,method,parameter
+
1,1,2008-06-11T10:58:05.85,vcl,,,40368,326,.HelpId:StartCenter:WriterButton,Click,
+
2,1,2008-06-11T10:58:05.85,dispatch,unknown origin,private:factory/swriter,,,,,
+
3,1,2008-06-11T10:58:07.88,dispatch,unknown origin,.uno:close,,,,,
+
4,1,2008-06-11T10:58:16.59,vcl,,,.HelpId:textobjectbar,369,0,TearOff,
+
5,1,2008-06-11T10:58:20.82,vcl,,,.HelpId:textobjectbar,340,33900,Select,2
+
6,1,2008-06-11T10:58:25.60,vcl,,,,0,52821,TypeKeys,1
+
7,1,2008-06-11T10:58:27.17,vcl,,,,0,52821,TypeKeys,1
+
8,1,2008-06-11T10:58:27.34,vcl,,,,0,52821,TypeKeys,1
+
9,1,2008-06-11T10:58:27.42,vcl,,,,0,52821,TypeKeys,1
+
...
+
2439,1,2008-06-11T11:25:08.52,vcl,,,,0,52821,TypeKeys,2
+
2440,1,2008-06-11T11:25:08.52,dispatch,unknown origin,.uno:SwBackspace,,,,,
+
2441,1,2008-06-11T11:25:08.66,vcl,,,,0,52821,TypeKeys,2
+
2442,1,2008-06-11T11:25:08.66,dispatch,unknown origin,.uno:SwBackspace,,,,,
+
2443,1,2008-06-11T11:25:10.17,vcl,,,,0,52821,TypeKeys,2
+
2444,1,2008-06-11T11:25:10.17,dispatch,unknown origin,.uno:SwBackspace,,,,,
+
2445,1,2008-06-11T11:25:12.31,vcl,,,,0,52821,TypeKeys,2
+
2446,1,2008-06-11T11:25:12.31,dispatch,unknown origin,.uno:GoDown,,,,,
+
2447,1,2008-06-11T11:25:17.47,dispatch,MenuBarManager,.uno:SaveAs,,,,,
+
2448,1,2008-06-11T11:25:26.63,dispatch,unknown origin,vnd.sun.star.help://swriter/33368?Language=en-US&System=UNIX#bm_id3159242,,,,,
+
2449,1,2008-06-11T11:25:33.31,vcl,,,,0,52821,TypeKeys,1
+
2450,1,2008-06-11T11:25:33.63,vcl,,,,0,52821,TypeKeys,1
+
2451,1,2008-06-11T11:25:34.00,vcl,,,,0,52821,TypeKeys,1
+
2452,1,2008-06-11T11:25:34.29,vcl,,,,0,52821,TypeKeys,1
+
</pre>
+
 
+
 
+
== Meta Data ==
+
The following Meta Data will be transferred:
+
 
+
* Office Version
+
* Build ID
+
* Office Locale
+
* Platform (Windows XP, Windows Vista, Linux + Desktop Info, Mac, Solaris + Desktop Info)
+
* First time sender (used to count total number of participant)
+
* Report number
+
 
+
=== Flags and Meta Data for QA Usage ===
+
 
+
The following Meta Data will be transferred:
+
 
+
*  Sent for testing purposes
+
 
+
The test data used is the same as the Metadata provided by the ReportMail.
+
 
+
== Transferring Data ==
+
* The data will be transfered by using SOAP over HTTP
+
* The data will be transmitted:
+
** 30 seconds after startup, compressed (ZIP-format)
+
** OpenOffice.org sends one send request per tracked session
+
 
+
* If sending of usage data was not successful the tracking extension retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the usage tracking extension disables themselves. The so far tracked data will be deleted.
+
 
+
== Storing Data ==
+
Data will be stored under:
+
file://($user)/temp/Feedback
+
(see http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Predefined_Variables)
+
 
+
== Privacy ==
+
//TODO//
+
The dialogs offer an information button in form of an (i) icon. This button points to a web site (one for OOo and another for SO) to give the user background about the Improvement Program. The SO page points to the Sun privacy statements page, the OOo page to a statement of the community council.
+
 
+
-> //TODO// define Links
+
 
+
== Web Site ==
+
//TODO// (Ideas, Comments are welcome)
+
 
+
 
+
== License ==
+
The extension will be available under:
+
* LGPLv3
+
 
+
== Extension Data ==
+
 
+
Extension Title:
+
$PRODUCTNAME Usage Feedback Extension
+
 
+
Version:
+
1.0
+
 
+
Publisher:
+
Sun Microsystems, Inc
+
 
+
Description:
+
The $PRODUCTNAME Improvement Program Extension collects anonymous statistics about how you use $PRODUCTNAME. The collected data is used to optimize the quality of $PRODUCTNAME. The extension will not collect any personal data, or document content.
+
 
+
== Implementation Details ==
+
=== Office Configuration Entries ===
+
==== Core ====
+
* org.OpenOffice.Office.Logging.OOoImprovement.LogPath (string)
+
* org.OpenOffice.Office.Logging.OOoImprovement.IdleTimeout (int)
+
* org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed (boolean)
+
==== Extension ====
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.OfficeStartCountdown (int)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.InvitationAccepted (boolean)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.ShowedInvitation (boolean)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.DeliveredPrebundled (boolean)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Counters.UploadedReports (int)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Counters.LoggedEvents (int)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapUrl (string)
+
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapIdAdditions (string)
+
 
+
=== UNO Services ===
+
* com.sun.star.oooimprovement.Core (com.sun.star.comp.extensions.oooimprovecore.Core)
+
** property: readonly bool UiEventsLoggerEnabled
+
** property: readonly long SessionLogEventCount
+
** method: inviteUser()
+
* com.sun.star.oooimprovement.CoreController (com.sun.star.comp.extensions.oooimprovement.CoreController)
+
** method: bool enablingEventsLoggerAllowed(short Version)
+
** method: bool showBuiltinOptionsPage(short Version)
+
* com.sun.star.logging.CsvFormatter (com.sun.star.comp.extensions.CsvFormatter)
+
 
+
=== Jobs ===
+
* asynchronous Job in the extension compressing and uploading data triggered by onOOoImprovementLogRotated, 30 seconds after Startup
+
* Job in the extension that invites the user to take part on startup
+
 
+
=== Protocol Handler/UI ===
+
* Extension UI (implemented in directly in OpenOffice.org currently, not in the Extension)
+
* There is currently no protocol handler implemented. It would be needed
+
when the UI elements are moved into the extension.
+
 
+
=== Filenames ===
+
* $LOGPATH/Current.csv (created by core)
+
* $LOGPATH/OOoImprove-ISOTIMESTAMP.csv (created by core)
+
* $LOGPATH/OOoImprove-ISOTIMESTAMP.zip (created by extension)
+
* OOoImprovement.oxt (contains liboooimprovementXX.xxx)
+
* liboooimprovecoreXX.xxx
+
 
+
==References==
+
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
+
* [http://Ingimp.org ingimp.org]
+
* [http://wiki.mozilla.org/Spectator Mozilla Spectator]
+
* [http://wiki.mozilla.org/Browser_Metrics Mozilla Spectator Metrics]
+
* [http://labs.mozilla.com/2008/03/introducing-test-pilot/ Spectator Test Pilot]
+
* [http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/Example Example Extension]
+
* [http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/File_Format Extension File Format]
+

Latest revision as of 16:21, 16 July 2009

Personal tools