Apache OpenOffice Wiki - User contributions [en]

User Experience/OpenOffice.org User Feedback Program

2009-01-28T15:20:54Z

Cj: /* Types of Data IS being Collected */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* For details refer to http://www.sunsource.net/TUPPCP.html

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be collected or transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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.

=== What data is IS being collected ===

The following types of data are collected:

* Tool bar 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

=== What data is NOT being collected ===

* User names and passwords
* Any type of document content
* Paths, filenames
* User's source code

=== 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The tracked data will be deleted.

== Storing Data ==
The data will be stored on client-side (Office itself) and on server-side.

=== Storing Data Office ===
Data will be stored under:
file://($user)/temp/Feedback
(see http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Predefined_Variables)

=== Storing Data server side ===
The sent data via SOAP will be received by an OpenOffice.org server and stored in an OpenOffice.org version-related database. So each OpenOffice.org version will have an own database for the user feedback. The collected data will be available for data-mining later. Currently we are in a draft modus.

To guarantee user privacy we won't collect any IP-addresses or customer data. The report-data has '''no''' personal data inside.

== 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)
* 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.Counters.FailedAttempts (int)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapUrl (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapIdAdditions (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.ReporterEmail (string)

=== UNO Services ===
==== com.sun.star.oooimprovement.Core (com.sun.star.comp.extensions.oooimprovecore.Core) ====
* property: readonly bool UiEventsLoggerEnabled
Is true, if the logger is enabled.
* property: readonly long SessionLogEventCount
The number of events logged in the current Office session (since start).
* method: inviteUser()
Present the user with the invitation to take part in usage tracking.
==== com.sun.star.oooimprovement.CoreController (com.sun.star.comp.extensions.oooimprovement.CoreController) ====
* method: bool enablingEventsLoggerAllowed(short Version)
The Eventlogger will only enable itself when this method returns true. The method checks the
configuration keys in org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.
* method: bool showBuiltinOptionsPage(short Version)
If this returns true, the usage tracking options and statistics show up in Tools->Options.

==== com.sun.star.logging.CsvFormatter (com.sun.star.comp.extensions.CsvFormatter) ====
This service allows formatting logs with the com.sun.star.logging-framework in CSV-Format.

=== Packages ===
The code/configuration for the user feedback program can be found in the following modules:
* module officecfg for configuration keys
* module svx for configuration dialogs
* module comphelper for the eventlogger
* module framework for the dispatch-event hooks
* modules tools/automation for VCL-event hooks
* module extensions for:
** '''liboooimprovecore''' ''(packed in ooobasis*-core01-*.rpm on unix)''
*** the UNO-API (com.sun.star.oooimprovement.Core) to the eventlogger
** '''liboooimprovement''' ''(packed in ooobasis*-core03-*.rpm on unix)''
*** the uploading/invitation implementation
*** the UNO-API to the uploading/invitation implementation (com.sun.star.oooimprovement.CoreController)
** '''FOR SUN-BUILDS ONLY (BUILD_SPECIAL):''' '''Jobs.xcu''' needed to enable the user feedback program ''( packed in ooobasis*-oooimprovement-*.rpm on unix)''

The code was introduced with the following cws: logger2, oooimprovementcorefixes, oooimprovement2.

=== Jobs ===
Triggered by '''onFirstVisibleTask''':
* 30 seconds after startup an asynchronous job compresses and uploads data.
* on the second start the invitation to the User Feedback Program gets displayed.

=== 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) (now part of OOo)
* liboooimprovecoreXX.xxx

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://www.netbeans.org/about/usage-tracking.html NetBeans Usage Tracking]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-28T15:20:09Z

Cj: /* Types of Data Collected */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* For details refer to http://www.sunsource.net/TUPPCP.html

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be collected or transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 IS being Collected ===

The following types of data are collected:

* Tool bar 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

What data is NOT being collected

* User names and passwords
* Any type of document content
* Paths, filenames
* User's source code

=== 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The tracked data will be deleted.

== Storing Data ==
The data will be stored on client-side (Office itself) and on server-side.

=== Storing Data Office ===
Data will be stored under:
file://($user)/temp/Feedback
(see http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Predefined_Variables)

=== Storing Data server side ===
The sent data via SOAP will be received by an OpenOffice.org server and stored in an OpenOffice.org version-related database. So each OpenOffice.org version will have an own database for the user feedback. The collected data will be available for data-mining later. Currently we are in a draft modus.

To guarantee user privacy we won't collect any IP-addresses or customer data. The report-data has '''no''' personal data inside.

== 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)
* 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.Counters.FailedAttempts (int)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapUrl (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapIdAdditions (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.ReporterEmail (string)

=== UNO Services ===
==== com.sun.star.oooimprovement.Core (com.sun.star.comp.extensions.oooimprovecore.Core) ====
* property: readonly bool UiEventsLoggerEnabled
Is true, if the logger is enabled.
* property: readonly long SessionLogEventCount
The number of events logged in the current Office session (since start).
* method: inviteUser()
Present the user with the invitation to take part in usage tracking.
==== com.sun.star.oooimprovement.CoreController (com.sun.star.comp.extensions.oooimprovement.CoreController) ====
* method: bool enablingEventsLoggerAllowed(short Version)
The Eventlogger will only enable itself when this method returns true. The method checks the
configuration keys in org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.
* method: bool showBuiltinOptionsPage(short Version)
If this returns true, the usage tracking options and statistics show up in Tools->Options.

==== com.sun.star.logging.CsvFormatter (com.sun.star.comp.extensions.CsvFormatter) ====
This service allows formatting logs with the com.sun.star.logging-framework in CSV-Format.

=== Packages ===
The code/configuration for the user feedback program can be found in the following modules:
* module officecfg for configuration keys
* module svx for configuration dialogs
* module comphelper for the eventlogger
* module framework for the dispatch-event hooks
* modules tools/automation for VCL-event hooks
* module extensions for:
** '''liboooimprovecore''' ''(packed in ooobasis*-core01-*.rpm on unix)''
*** the UNO-API (com.sun.star.oooimprovement.Core) to the eventlogger
** '''liboooimprovement''' ''(packed in ooobasis*-core03-*.rpm on unix)''
*** the uploading/invitation implementation
*** the UNO-API to the uploading/invitation implementation (com.sun.star.oooimprovement.CoreController)
** '''FOR SUN-BUILDS ONLY (BUILD_SPECIAL):''' '''Jobs.xcu''' needed to enable the user feedback program ''( packed in ooobasis*-oooimprovement-*.rpm on unix)''

The code was introduced with the following cws: logger2, oooimprovementcorefixes, oooimprovement2.

=== Jobs ===
Triggered by '''onFirstVisibleTask''':
* 30 seconds after startup an asynchronous job compresses and uploads data.
* on the second start the invitation to the User Feedback Program gets displayed.

=== 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) (now part of OOo)
* liboooimprovecoreXX.xxx

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://www.netbeans.org/about/usage-tracking.html NetBeans Usage Tracking]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-28T15:17:25Z

Cj: /* Privacy */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* For details refer to http://www.sunsource.net/TUPPCP.html

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be collected or transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The tracked data will be deleted.

== Storing Data ==
The data will be stored on client-side (Office itself) and on server-side.

=== Storing Data Office ===
Data will be stored under:
file://($user)/temp/Feedback
(see http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Predefined_Variables)

=== Storing Data server side ===
The sent data via SOAP will be received by an OpenOffice.org server and stored in an OpenOffice.org version-related database. So each OpenOffice.org version will have an own database for the user feedback. The collected data will be available for data-mining later. Currently we are in a draft modus.

To guarantee user privacy we won't collect any IP-addresses or customer data. The report-data has '''no''' personal data inside.

== 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)
* 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.Counters.FailedAttempts (int)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapUrl (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapIdAdditions (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.ReporterEmail (string)

=== UNO Services ===
==== com.sun.star.oooimprovement.Core (com.sun.star.comp.extensions.oooimprovecore.Core) ====
* property: readonly bool UiEventsLoggerEnabled
Is true, if the logger is enabled.
* property: readonly long SessionLogEventCount
The number of events logged in the current Office session (since start).
* method: inviteUser()
Present the user with the invitation to take part in usage tracking.
==== com.sun.star.oooimprovement.CoreController (com.sun.star.comp.extensions.oooimprovement.CoreController) ====
* method: bool enablingEventsLoggerAllowed(short Version)
The Eventlogger will only enable itself when this method returns true. The method checks the
configuration keys in org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.
* method: bool showBuiltinOptionsPage(short Version)
If this returns true, the usage tracking options and statistics show up in Tools->Options.

==== com.sun.star.logging.CsvFormatter (com.sun.star.comp.extensions.CsvFormatter) ====
This service allows formatting logs with the com.sun.star.logging-framework in CSV-Format.

=== Packages ===
The code/configuration for the user feedback program can be found in the following modules:
* module officecfg for configuration keys
* module svx for configuration dialogs
* module comphelper for the eventlogger
* module framework for the dispatch-event hooks
* modules tools/automation for VCL-event hooks
* module extensions for:
** '''liboooimprovecore''' ''(packed in ooobasis*-core01-*.rpm on unix)''
*** the UNO-API (com.sun.star.oooimprovement.Core) to the eventlogger
** '''liboooimprovement''' ''(packed in ooobasis*-core03-*.rpm on unix)''
*** the uploading/invitation implementation
*** the UNO-API to the uploading/invitation implementation (com.sun.star.oooimprovement.CoreController)
** '''FOR SUN-BUILDS ONLY (BUILD_SPECIAL):''' '''Jobs.xcu''' needed to enable the user feedback program ''( packed in ooobasis*-oooimprovement-*.rpm on unix)''

The code was introduced with the following cws: logger2, oooimprovementcorefixes, oooimprovement2.

=== Jobs ===
Triggered by '''onFirstVisibleTask''':
* 30 seconds after startup an asynchronous job compresses and uploads data.
* on the second start the invitation to the User Feedback Program gets displayed.

=== 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) (now part of OOo)
* liboooimprovecoreXX.xxx

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://www.netbeans.org/about/usage-tracking.html NetBeans Usage Tracking]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-26T08:01:03Z

Cj: /* References */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* The start-up dialog offers an information button in form of an (i) icon. This button points to the User Feedback Program site to give the user background about the Feature. From there a link will point to the Privacy statement (TODO)

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be collected or transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The tracked data will be deleted.

== Storing Data ==
The data will be stored on client-side (Office itself) and on server-side.

=== Storing Data Office ===
Data will be stored under:
file://($user)/temp/Feedback
(see http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Predefined_Variables)

=== Storing Data server side ===
The sent data via SOAP will be received by an OpenOffice.org server and stored in an OpenOffice.org version-related database. So each OpenOffice.org version will have an own database for the user feedback. The collected data will be available for data-mining later. Currently we are in a draft modus.

To guarantee user privacy we won't collect any IP-addresses or customer data. The report-data has '''no''' personal data inside.

== 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)
* 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.Counters.FailedAttempts (int)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapUrl (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.SoapIdAdditions (string)
* org.OpenOffice.Ofiice.OOoImprovement.Settings.Upload.ReporterEmail (string)

=== UNO Services ===
==== com.sun.star.oooimprovement.Core (com.sun.star.comp.extensions.oooimprovecore.Core) ====
* property: readonly bool UiEventsLoggerEnabled
Is true, if the logger is enabled.
* property: readonly long SessionLogEventCount
The number of events logged in the current Office session (since start).
* method: inviteUser()
Present the user with the invitation to take part in usage tracking.
==== com.sun.star.oooimprovement.CoreController (com.sun.star.comp.extensions.oooimprovement.CoreController) ====
* method: bool enablingEventsLoggerAllowed(short Version)
The Eventlogger will only enable itself when this method returns true. The method checks the
configuration keys in org.OpenOffice.Ofiice.OOoImprovement.Settings.Participation.
* method: bool showBuiltinOptionsPage(short Version)
If this returns true, the usage tracking options and statistics show up in Tools->Options.

==== com.sun.star.logging.CsvFormatter (com.sun.star.comp.extensions.CsvFormatter) ====
This service allows formatting logs with the com.sun.star.logging-framework in CSV-Format.

=== Packages ===
The code/configuration for the user feedback program can be found in the following modules:
* module officecfg for configuration keys
* module svx for configuration dialogs
* module comphelper for the eventlogger
* module framework for the dispatch-event hooks
* modules tools/automation for VCL-event hooks
* module extensions for:
** '''liboooimprovecore''' ''(packed in ooobasis*-core01-*.rpm on unix)''
*** the UNO-API (com.sun.star.oooimprovement.Core) to the eventlogger
** '''liboooimprovement''' ''(packed in ooobasis*-core03-*.rpm on unix)''
*** the uploading/invitation implementation
*** the UNO-API to the uploading/invitation implementation (com.sun.star.oooimprovement.CoreController)
** '''FOR SUN-BUILDS ONLY (BUILD_SPECIAL):''' '''Jobs.xcu''' needed to enable the user feedback program ''( packed in ooobasis*-oooimprovement-*.rpm on unix)''

The code was introduced with the following cws: logger2, oooimprovementcorefixes, oooimprovement2.

=== Jobs ===
Triggered by '''onFirstVisibleTask''':
* 30 seconds after startup an asynchronous job compresses and uploads data.
* on the second start the invitation to the User Feedback Program gets displayed.

=== 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) (now part of OOo)
* liboooimprovecoreXX.xxx

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://www.netbeans.org/about/usage-tracking.html NetBeans Usage Tracking]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-23T14:09:32Z

Cj: /* Query Dialog */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* The start-up dialog offers an information button in form of an (i) icon. This button points to the User Feedback Program site to give the user background about the Feature. From there a link will point to the Privacy statement (TODO)

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be collected or transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The 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)

== 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)
* 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 ===

Needs to be updated -> Todo
<pre>
* 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)
</pre>

=== Packages ===
Needs to be updated -> Todo

=== Jobs ===
* asynchronous Jobs compress and uploads data triggered by onOOoImprovementLogRotated, 30 seconds after Startup

=== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://netbeans.org NetBeans]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-23T14:09:23Z

Cj: /* Query Dialog */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* The start-up dialog offers an information button in form of an (i) icon. This button points to the User Feedback Program site to give the user background about the Feature. From there a link will point to the Privacy statement (TODO)

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be, collected or transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The 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)

== 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)
* 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 ===

Needs to be updated -> Todo
<pre>
* 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)
</pre>

=== Packages ===
Needs to be updated -> Todo

=== Jobs ===
* asynchronous Jobs compress and uploads data triggered by onOOoImprovementLogRotated, 30 seconds after Startup

=== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://netbeans.org NetBeans]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-23T14:01:47Z

Cj: /* UNO Services */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* The start-up dialog offers an information button in form of an (i) icon. This button points to the User Feedback Program site to give the user background about the Feature. From there a link will point to the Privacy statement (TODO)

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The 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)

== 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)
* 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 ===

Needs to be updated -> Todo
<pre>
* 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)
</pre>

=== Packages ===
Needs to be updated -> Todo

=== Jobs ===
* asynchronous Jobs compress and uploads data triggered by onOOoImprovementLogRotated, 30 seconds after Startup

=== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://netbeans.org NetBeans]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Program

2009-01-23T14:00:05Z

Cj: /* Motivition */

The OpenOffice.org User Feedback Program is a feature 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.

== Motivation ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* The start-up dialog offers an information button in form of an (i) icon. This button points to the User Feedback Program site to give the user background about the Feature. From there a link will point to the Privacy statement (TODO)

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The 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)

== 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)
* 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 ===

Needs to be updates -> Todo
<pre>
* 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)
</pre>

=== Jobs ===
* asynchronous Jobs compress and uploads data triggered by onOOoImprovementLogRotated, 30 seconds after Startup

=== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://netbeans.org NetBeans]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Extension

2009-01-23T13:59:47Z

Cj: Replacing page with 'This page has move to http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program'

This page has move to http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

User Experience/OpenOffice.org User Feedback Program

2009-01-23T13:54:49Z

Cj: New page: The OpenOffice.org User Feedback Program is a feature that collects anonymously data about how OpenOffice.org is used. This information is used to better understand how people use OpenOffi... (checkpoint save)

The OpenOffice.org User Feedback Program is a feature 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.

== Motivition ==
With regards to the [http://wiki.services.openoffice.org/wiki/Renaissance Renaissance] project it is important to judge on user interface changes based on data instead of gut feelings.
In the past, too many decisions have been made without having data which reflect the impact of a changes to a specific user group.

The User Feedback program helps to answers on the following questions:

* Which commands are used frequently?
* Which are not?
* How often are they used?
* Are these commands called from the:
** menu, context menu, tool bar, keyboard shortcut
* In which order are these commands used?

== Privacy ==
* The data is collected anonymously
* The feature does not collect any document related keyboard input
* The feature does not send any user specific type of data
* No relation ship between IP Address and sent report by SOAP request
* No data will be collected if users do not apply to this program
* The start-up dialog offers an information button in form of an (i) icon. This button points to the User Feedback Program site to give the user background about the Feature. From there a link will point to the Privacy statement (TODO)

== Analysis ==
* The Results will be published on http://wiki.services.openoffice.org/wiki/Renaissance:Phase_1

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.1, Release: Integration in OpenOffice.org

== User Interface ==
=== Query Dialog ===

The dialog occurs after the '''second start''' of OpenOffice.org

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Activates the feature.
** Data collection starts immediately until the user disables the feature in "Tools->Options->Improvement Program"

* No:
** Does not activate the feature. '''No data will be transmitted'''
** The feature will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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:

* Tool bar 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 data collecting feature retries sending the data on each start up of OOo again. If sending was no success after 25 attempts the data collecting feature disables it selves. The 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)

== 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)
* 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 ===

Needs to be updates -> Todo
<pre>
* 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)
</pre>

=== Jobs ===
* asynchronous Jobs compress and uploads data triggered by onOOoImprovementLogRotated, 30 seconds after Startup

=== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==References==
* [http://qa.openoffice.org/issues/show_bug.cgi?id=90370 OpenOffice.org Issue]
* [http://netbeans.org NetBeans]
* [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]

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

User Experience/OpenOffice.org User Feedback Extension

2009-01-23T11:04:45Z

Cj: /* Query Dialog */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]

* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''Options:'''

* Yes:
** Actives the extension.
** Usage tracking starts immediately until the user disables, or de-installs the extension.

* No:
** Does not activate the extension.
** The extension will not ask again for participating the program.

* Info Icon
** The icon Points to
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Extension

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==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]

Renaissance

2009-01-21T08:26:45Z

Cj: /* Project Action Items */

{{User Experience Community}}
__NOTOC__
{| style="border: thin dashed #CC2222; padding:5px"
|-
| '''Please do not edit this page unless you are on the Renaissance team.''' Your feedback and comments are welcomed on the [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] mailing list.
|}

[[Image:Renaissance-Logo-Proposal-Final2.png|400px|center]]

'''Welcome''' to the wiki of the OpenOffice.org Renaissance Project.

== Our Mission ==

“Create
a User Interface so that
OpenOffice.org becomes the
users' choice not only out of need,
but also out of desire”

== Project Charter ==
* [[Renaissance:The_Challenge|The problem statement]] - What are the challenges of the current User Interface?
* [[Renaissance:The_Mission|The mission statement]] - What is our mission?
* [[Renaissance:The_Goal|The goal statement]] - What we plan to achieve.
* [[Renaissance:The Scope|The scope]] - What is the focus of this project?
* [[Renaissance:The_Roadmap|The roadmap]] - How do we plan to proceed?

== Project Phases ==
* [[Renaissance:Phase_1|Research]] - Know and understand OpenOffice.org users to better meet their needs.
* [[Renaissance:Phase_2|Design]] - Generate and accumulate design ideas to create prototypes based on valid data.
* [[Renaissance:Phase_3|Evaluate]] - Evaluate promissing solutions.
== Project Action Items ==
{|style="background:white; border:0; cellspacing:1; cellpadding:1"
|+
|- bgcolor="lightgrey "
! width="45%" | Phase item / Description
! width="5%" | Owner
! width="10%" | Status
! width="10%" | Results
! width="5%" | Outcome
! width="5%" | Complete
! width="20%" | Due Date
|-
| OpenOffice.org User Survey 2008. || FL/CJ || in progress || [[Renaissance:Phase_1:OOoUser_Survey|- Survey Results]] || || 90% || January 2009
|- bgcolor="#ECF2FD"
| IsoMetrics-S Survey at VBG. || AB || in progress || [[Renaissance:IsoMetrics_Results|- IsoMetrics Results]] || || 75% || End of January 2009
|-
| ODF document analysis with ODFTOOLKIT || AB || in progress || [[Renaissance:ODFToolkit|- First java hack]] || || 10% ||
|- bgcolor="#ECF2FD"
| OpenOffice.org User Survey 2009: Focus on tasks || FL || in progress || || || 20% || End of January 2009
|-
| Usage tracking (3.0.1 release) || CJ || in progress || || || 80% || End of January 2009
|- bgcolor="#ECF2FD"
| Usage tracking (3.1 release) || CJ || in progress || || || 50% || same as OOo 3.1 release
|-
| Ethnogrphic research || AB || new || || || || Mid of April 2009
|- bgcolor="#ECF2FD"
| CA (Competitive Analysis) || BH || in progress || || || 20% || Mid of March 2009
|-
| Community feedback || || in progress || unsorted Feedback on mailing list [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] || || ||
|- bgcolor="#ECF2FD"
| Customer feedback || open || || || || ||
|-
| Focus groups || open || || || || ||
|- bgcolor="#ECF2FD"
| RFE's || || || || || ||
|-
| Site visits, user and customer satisfaction || || || || || ||
|}

== General Information ==
* [[Renaissance:Team|The Team]] - The People Behind Project Renaissance
* [[Renaissance:Presentations|Presentations]] - Presentations
* [[Renaissance:Status_Meetings|Status Meetings]] - Renaissance Status Meetings
* [[Renaissance:Press_Coverage|Press Coverage]] - Project Renaissance Press Coverage
* [[Renaissance:UX_Books|User Experience Books]] - Valuable literature on User Experience topics
* [[Renaissance:UX_Sites|User Experience Sites]] - Valuable links to User Experience sites

== FAQ (Frequently Asked Questions) ==
* [[Renaissance:FAQ|Frequently Asked Questions]] - Answers on Frequently Asked Questions

== How You Can Help ==

=== Get Involved ===

* Join the UX project! Just have a look at [[User_Experience/Community/How_To_Join|How To Join]].
* Come chat at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
* Join the weekly status meetings. The meeting takes place on IRC at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net. The meeting is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

=== Share Ideas ===
Join our project mailing list [mailto:ui@ux.openoffice.org ui@ux.openoffice.org]

=== Fix bugs ===

* Actual [http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=usability&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query '''Requests For Enhancements''' or '''Bugs'''] with the keyword Usability.

[[Category:Effort]]

Renaissance

2009-01-21T08:25:53Z

Cj: /* Project Action Items */

{{User Experience Community}}
__NOTOC__
{| style="border: thin dashed #CC2222; padding:5px"
|-
| '''Please do not edit this page unless you are on the Renaissance team.''' Your feedback and comments are welcomed on the [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] mailing list.
|}

[[Image:Renaissance-Logo-Proposal-Final2.png|400px|center]]

'''Welcome''' to the wiki of the OpenOffice.org Renaissance Project.

== Our Mission ==

“Create
a User Interface so that
OpenOffice.org becomes the
users' choice not only out of need,
but also out of desire”

== Project Charter ==
* [[Renaissance:The_Challenge|The problem statement]] - What are the challenges of the current User Interface?
* [[Renaissance:The_Mission|The mission statement]] - What is our mission?
* [[Renaissance:The_Goal|The goal statement]] - What we plan to achieve.
* [[Renaissance:The Scope|The scope]] - What is the focus of this project?
* [[Renaissance:The_Roadmap|The roadmap]] - How do we plan to proceed?

== Project Phases ==
* [[Renaissance:Phase_1|Research]] - Know and understand OpenOffice.org users to better meet their needs.
* [[Renaissance:Phase_2|Design]] - Generate and accumulate design ideas to create prototypes based on valid data.
* [[Renaissance:Phase_3|Evaluate]] - Evaluate promissing solutions.
== Project Action Items ==
{|style="background:white; border:0; cellspacing:1; cellpadding:1"
|+
|- bgcolor="lightgrey "
! width="45%" | Phase item / Description
! width="5%" | Owner
! width="10%" | Status
! width="10%" | Results
! width="5%" | Outcome
! width="5%" | Complete
! width="20%" | Due Date
|-
| OpenOffice.org User Survey 2008. || FL/CJ || in progress || [[Renaissance:Phase_1:OOoUser_Survey|- Survey Results]] || || 90% || January 2009
|- bgcolor="ECF2FD"
| IsoMetrics-S Survey at VBG. || AB || in progress || [[Renaissance:IsoMetrics_Results|- IsoMetrics Results]] || || 75% || End of January 2009
|-
| ODF document analysis with ODFTOOLKIT || AB || in progress || [[Renaissance:ODFToolkit|- First java hack]] || || 10% ||
|- bgcolor="ECF2FD"
| OpenOffice.org User Survey 2009: Focus on tasks || FL || in progress || || || 20% || End of January 2009
|-
| Usage tracking (3.0.1 release) || CJ || in progress || || || 80% || End of January 2009
|- bgcolor="ECF2FD"
| Usage tracking (3.1 release) || CJ || in progress || || || 50% || same as OOo 3.1 release
|-
| Ethnogrphic research || AB || new || || || || Mid of April 2009
|- bgcolor="ECF2FD"
| CA (Competitive Analysis) || BH || in progress || || || 20% || Mid of March 2009
|-
| Community feedback || || in progress || unsorted Feedback on mailing list [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] || || ||
|- bgcolor="ECF2FD"
| Customer feedback || open || || || || ||
|-
| Focus groups || open || || || || ||
|- bgcolor="ECF2FD"
| RFE's || || || || || ||
|-
| Site visits, user and customer satisfaction || || || || || ||
|}

== General Information ==
* [[Renaissance:Team|The Team]] - The People Behind Project Renaissance
* [[Renaissance:Presentations|Presentations]] - Presentations
* [[Renaissance:Status_Meetings|Status Meetings]] - Renaissance Status Meetings
* [[Renaissance:Press_Coverage|Press Coverage]] - Project Renaissance Press Coverage
* [[Renaissance:UX_Books|User Experience Books]] - Valuable literature on User Experience topics
* [[Renaissance:UX_Sites|User Experience Sites]] - Valuable links to User Experience sites

== FAQ (Frequently Asked Questions) ==
* [[Renaissance:FAQ|Frequently Asked Questions]] - Answers on Frequently Asked Questions

== How You Can Help ==

=== Get Involved ===

* Join the UX project! Just have a look at [[User_Experience/Community/How_To_Join|How To Join]].
* Come chat at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
* Join the weekly status meetings. The meeting takes place on IRC at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net. The meeting is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

=== Share Ideas ===
Join our project mailing list [mailto:ui@ux.openoffice.org ui@ux.openoffice.org]

=== Fix bugs ===

* Actual [http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=usability&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query '''Requests For Enhancements''' or '''Bugs'''] with the keyword Usability.

[[Category:Effort]]

User Experience/OpenOffice.org User Feedback Extension

2009-01-19T21:04:27Z

Cj: /* Query Dialog */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]

* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Extension

'''Strings used'''

<pre>
$PRODUCTNAME Improvement Program

Help Optimize the Quality of $PRODUCTNAME

We invite you to join our $PRODUCTNAME Improvement Program
to help optimize the quality of $PRODUCTNAME.

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 $PRODUCTNAME Improvement Program will not collect any personal
data, or document content.

Yes, I am willing to participate in the $PRODUCTNAME Improvement Program

No, I do not wish to participate

Get more information about the $PRODUCTNAME Improvement Program
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==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]

User Experience/OpenOffice.org User Feedback Extension

2009-01-19T21:03:17Z

Cj: /* Query Dialog */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]

* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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
http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Extension

'''Strings used'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==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]

User Experience/OpenOffice.org User Feedback Extension

2009-01-13T15:50:16Z

Cj: /* Roadmap */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_User_Feedback Beta Builds available for public testing]

* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==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]

Renaissance:Phase 1:OOoUser Survey

2009-01-12T17:47:31Z

Cj: /* OpenOffice.org User Survey */

= OpenOffice.org User Survey =

Survey Data from November 1 - December 19, 2008: 
160981 responses for this survey (116313 full responses, 44668 responses not completely filled out)

[[Image:Joe Average.png|thumb|600px|left]]
 

===Results===
* [http://wiki.services.openoffice.org/w/images/6/62/Results_OpenOffice.org_User_Survey_2008.odp Presentation]
* [http://wiki.services.openoffice.org/w/images/a/ab/OOoUserSurvey2008.ods OpenOffice.org Calc Spreadsheet]

= Aspects to be considered during data analysis =

1 Who are our users as revealed by the survey? 
1.1 Do the users represent people we have/had in mind? 
1.2 Are these the users we actually design and develop for? 

2 What value these users most in OOo? 
2.1 Is that something we have expected? 
2.2 Is that something we were hoping for? 
2.3 Is that something we actively worked for? 

3 For what purposes is OOo used? 
3.1 Is that something that we anticipated? 
3.2 Is that something we have worked for? 
3.3 Is that something OOo is really made for? 
3.4 To what extent does that usage cover the functionality of OOo? 

4 What makes OOo so popular among these users? 
4.1 Is that a quality we have expected? 
4.2 Is that a quality we worked/work for? 
4.3 Is that a measurable quality? 

5 How does the distribution of the users look like? 
5.1 Do we have some peaks e.g. in age, usage, language etc.? 

6 To which questions did we hope to collect answers by this survey? 
6.1 Did we get the data we were looking for? 
6.2 Can we get the answers to all our questions from the data? 
6.3 Did this survey meet our own quality criteria in terms of objectivity, reliability and validity?

File:Joe Average.png

2009-01-12T17:34:44Z

Cj: uploaded a new version of "Image:Joe Average.png"

Renaissance:Phase 1:OOoUser Survey

2009-01-12T17:27:45Z

Cj: /* OpenOffice.org User Survey */

= OpenOffice.org User Survey =

Survey Data from November 1 - December 19, 2008: 
160981 responses for this survey (116313 full responses, 44668 responses not completely filled out)

[[Image:Joe Average.png|thumb|600px|left]]
 

===Results===
* [http://wiki.services.openoffice.org/w/images/6/62/Results_OpenOffice.org_User_Survey_2008.odp Presentation]
* [http://wiki.services.openoffice.org/w/images/a/ab/OOoUserSurvey2008.ods| OpenOffice.org Calc Spreadsheet]

= Aspects to be considered during data analysis =

1 Who are our users as revealed by the survey? 
1.1 Do the users represent people we have/had in mind? 
1.2 Are these the users we actually design and develop for? 

2 What value these users most in OOo? 
2.1 Is that something we have expected? 
2.2 Is that something we were hoping for? 
2.3 Is that something we actively worked for? 

3 For what purposes is OOo used? 
3.1 Is that something that we anticipated? 
3.2 Is that something we have worked for? 
3.3 Is that something OOo is really made for? 
3.4 To what extent does that usage cover the functionality of OOo? 

4 What makes OOo so popular among these users? 
4.1 Is that a quality we have expected? 
4.2 Is that a quality we worked/work for? 
4.3 Is that a measurable quality? 

5 How does the distribution of the users look like? 
5.1 Do we have some peaks e.g. in age, usage, language etc.? 

6 To which questions did we hope to collect answers by this survey? 
6.1 Did we get the data we were looking for? 
6.2 Can we get the answers to all our questions from the data? 
6.3 Did this survey meet our own quality criteria in terms of objectivity, reliability and validity?

User Experience/OpenOffice.org User Feedback Extension

2009-01-12T15:30:59Z

Cj: /* Filenames */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_Feedback_Windows Windows Build Available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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

= Project Bugs and Enhancements =
[http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=OpenOffice+Improvement+program%3A&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=%27Importance%27&Submit+query=Submit+query Query for Bugs and Features]

==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]

File:Joe Average.png

2009-01-12T13:56:38Z

Cj:

Renaissance:Status Meetings

2009-01-12T12:46:09Z

Cj:

[[Renaissance:Home_Page|<< Back to Renaissance Home Page]]

We hold regular weekly meetings, with agenda / notes pages here.
 
From Monday, December 15, 2008 the meeting will take place on at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
 
The meetings is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

'''Agenda for next Meeting'''
 (Place items here you want to raise in next meeting.)

* When is the first Milestone and what will be included?
* Results User Survey Results
* Iso Metrics Results

'''Meeting Minutes / IRC Logs'''

* [[Renaissance:Status_Meetings:2009-01-05|January 05, 2009]]
* [[Renaissance:Status_Meetings:2008-12-15|December 15, 2008]]
* [[Renaissance:Status_Meetings:2008-12-08|December 08, 2008]]
* [[Renaissance:Status_Meetings:2008-12-01|December 01, 2008]]

User Experience/OpenOffice.org User Feedback Extension

2008-12-19T14:55:41Z

Cj: /* Roadmap */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: [http://extensions.services.openoffice.org/project/OOo_Feedback_Windows Windows Build Available for public testing]
* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

Renaissance:Status Meetings:2008-12-15

2008-12-15T16:31:33Z

Cj:

__NOTOC__
<<[[Renaissance:Status Meetings:2008-12-08| Previous Meeting]] | [[Renaissance:Status Meetings|Index]] | [[Calendar:Status Meetings:2009-01-05| Next Meeting >>]]

'''Meeting Details'''
* 4:00 PM CET
* IRC details: irc.freenode.net #ux.openoffice.org

== In Attendance ==
clu_sun, chris-j, mprove, Frankl, mdamboldt

== Agenda ==
# Nothing special for today
# Next Meeting

== Meeting Log ==

'''<chris-j>''' Hi
'''<chris-j>''' So, meeting time :-)
'''<clu_sun>''' o.k.
'''<chris-j>''' I've not prepared any special agenda, because this is our first meeting on IRC.
'''<chris-j>''' Ivan prepared a pretty good logo for the project
'''<chris-j>''' please find it here:
'''<chris-j>''' http://wiki.services.openoffice.org/wiki/Art/Gallery/Rennaissance_Logo
'''<clu_sun>''' i like jens habermanns third suggestion, too
'''<chris-j>''' From my point of view it is too techical....
'''<clu_sun>''' yes, but if you would combine it with stellas tag ..
'''<mprove>''' none of them looks like Florence (a nearly anonymous lurker)
'''<clu_sun>''' Florence is overrated ..
'''<chris-j>''' Agreed ... anyhow, I suggest to move on.
'''<mprove>''' clu_sun: I liked it - I was there for CHI in April
'''<chris-j>''' I'll give a short update on what's happened last week
'''<clu_sun>''' .. means: don't we have anything more important to discuss (anonymous matthias?)
'''<clu_sun>''' i prefer sienna (i have seen both about two years ago on a motorcycle tour)
'''<chris-j>''' Andreas published some results of the first survey. The data can be found here:
'''<mprove>''' I guess chris-j wants to say something
'''<chris-j>''' http://wiki.services.openoffice.org/wiki/Renaissance:IsoMetrics_Results
'''<mprove>''' chris-j: does this match the results that we got from our usability study some years ago?
'''<chris-j>''' Dave offered that some people of the City of Largo would also participate. So, the plan is to run a second survey in January.
'''<chris-j>''' mprove: yes, it matches with our results, but this time we had 171 responses
'''<mprove>''' chris-j: a nice validation for our 1st approach then.
'''<chris-j>''' that's true :-)
'''<chris-j>''' I can also give an short update on the usage feedback extension
'''<chris-j>''' It will be bundled with ooo starting with ooo 3.1
'''<mprove>''' is OOo3.1 required? And can I download the xtension right now?
'''<FrankL>''' Baseline for the extension is 3.0.1.
'''<chris-j>''' the ext. will be available for testing purposes end of this week.
'''<chris-j>''' http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Extension
'''<FrankL>''' I can provide a short update on the OOo User Survey
'''<FrankL>''' We have 149k responses so far. 107600 are full responses and 42K have not finished the survey.
'''<clu_sun>''' the feedback extension looks really interesting - do we have any feedback from the community about it?
'''<FrankL>''' The statistical tools of LimeSurvey could handle these data. Export as CSV file does not work on live database anymore.
'''<chris-j>''' clu_sun: Yepp. We received tons of positive feedback at the ooo con.
'''<FrankL>''' Now I am working on a list of things we need to know to create proper personas for project r.
'''<clu_sun>''' is it possible to detect different personas from the data, yet?
'''<FrankL>''' I think we will have 5-7 personas.
'''<clu_sun>''' do you already know which is the 'biggest' one?
'''<FrankL>''' We have a marketing contact from Sun who offered to make the evaluation of the survey, if we provide the questions to be answered.
'''<mprove>''' Jen McGinn presented a persona approach based on large scale survey data.
'''<mprove>''' at CHI
'''<FrankL>''' Do you have a link?
'''<mprove>''' http://blogs.sun.com/designatsun/entry/data_driven_personas
'''<mprove>''' http://flickr.com/photos/mprove/2410669538/
'''<FrankL>''' Thanks. I will provide it to Andreas.
'''<chris-j>''' What else do we have for today?
'''<clu_sun>''' maybe any community questions?
'''<mprove>''' chris-j: does the extension track the usage of task panes? open/close/schwipp-schwapp.. And tool bar customization??
'''<chris-j>''' mprove: The task panes can be tracked in parts. For example controls located within the pane.
'''<chris-j>''' mprove: toolbar customization can also be tracked, if the changes rely on 'standards'.
'''<mprove>''' chris-j: so you do not track if I close a task paine over and over again? _ http://uxooo.blogspot.com/2008/11/impress-task-pain.html
'''<mprove>''' chris-j: statistics on customization would provide insights in changing our defaults.
'''<chris-j>''' I agree.
'''<chris-j>''' Regarding the closer. We can track "document close", etc. I'm not sure about the closer. Regarding the task pa(i)ne exists a bug. I hope it gets fixed soon.
'''<mprove>''' "OOo 3.2" is not really soon.
'''<chris-j>''' I agree.
'''<mprove>''' For my Impress doc I have to close it 4 times. My scenario: 2 windows open to compare slides and changing between slide mode and slide sorter gives another 2 task panes. It really takes time to arrange the document after opening....
'''<chris-j>''' Please be so kind and add this to http://www.openoffice.org/issues/show_bug.cgi?id=95600. Thanks :-)
'''<IZBot>''' issue 95600: Presentation DEFECT NEW P3 Task Panel stays not collapsed when adding slide
'''<chris-j>''' Anything else with regards to Renaissance?
'''<chris-j>''' Ok....
'''<mprove>''' chris-j: done
'''<chris-j>''' Thanks guys. 'See' you next year :-)
'''<mdamboldt>''' bye
'''<FrankL>''' bye

= Next Meetings =
* Action Item (chris-j): Prepare Agenda

Renaissance:Status Meetings:2008-12-15

2008-12-15T16:30:19Z

Cj: New page: __NOTOC__ << Previous Meeting | Index | Next Meeting >> ...

__NOTOC__
<<[[Renaissance:Status Meetings:2008-12-08| Previous Meeting]] | [[Renaissance:Status Meetings|Index]] | [[Calendar:Status Meetings:2009-01-05| Next Meeting >>]]

'''Meeting Details'''
* 4:00 PM CET
* IRC details: irc.freenet. #calendar-mtg

== In Attendance ==
clu_sun, chris-j, mprove, Frankl, mdamboldt

== Agenda ==
# Nothing special for today
# Next Meeting

== Meeting Log ==

'''<chris-j>''' Hi
'''<chris-j>''' So, meeting time :-)
'''<clu_sun>''' o.k.
'''<chris-j>''' I've not prepared any special agenda, because this is our first meeting on IRC.
'''<chris-j>''' Ivan prepared a pretty good logo for the project
'''<chris-j>''' please find it here:
'''<chris-j>''' http://wiki.services.openoffice.org/wiki/Art/Gallery/Rennaissance_Logo
'''<clu_sun>''' i like jens habermanns third suggestion, too
'''<chris-j>''' From my point of view it is too techical....
'''<clu_sun>''' yes, but if you would combine it with stellas tag ..
'''<mprove>''' none of them looks like Florence (a nearly anonymous lurker)
'''<clu_sun>''' Florence is overrated ..
'''<chris-j>''' Agreed ... anyhow, I suggest to move on.
'''<mprove>''' clu_sun: I liked it - I was there for CHI in April
'''<chris-j>''' I'll give a short update on what's happened last week
'''<clu_sun>''' .. means: don't we have anything more important to discuss (anonymous matthias?)
'''<clu_sun>''' i prefer sienna (i have seen both about two years ago on a motorcycle tour)
'''<chris-j>''' Andreas published some results of the first survey. The data can be found here:
'''<mprove>''' I guess chris-j wants to say something
'''<chris-j>''' http://wiki.services.openoffice.org/wiki/Renaissance:IsoMetrics_Results
'''<mprove>''' chris-j: does this match the results that we got from our usability study some years ago?
'''<chris-j>''' Dave offered that some people of the City of Largo would also participate. So, the plan is to run a second survey in January.
'''<chris-j>''' mprove: yes, it matches with our results, but this time we had 171 responses
'''<mprove>''' chris-j: a nice validation for our 1st approach then.
'''<chris-j>''' that's true :-)
'''<chris-j>''' I can also give an short update on the usage feedback extension
'''<chris-j>''' It will be bundled with ooo starting with ooo 3.1
'''<mprove>''' is OOo3.1 required? And can I download the xtension right now?
'''<FrankL>''' Baseline for the extension is 3.0.1.
'''<chris-j>''' the ext. will be available for testing purposes end of this week.
'''<chris-j>''' http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Extension
'''<FrankL>''' I can provide a short update on the OOo User Survey
'''<FrankL>''' We have 149k responses so far. 107600 are full responses and 42K have not finished the survey.
'''<clu_sun>''' the feedback extension looks really interesting - do we have any feedback from the community about it?
'''<FrankL>''' The statistical tools of LimeSurvey could handle these data. Export as CSV file does not work on live database anymore.
'''<chris-j>''' clu_sun: Yepp. We received tons of positive feedback at the ooo con.
'''<FrankL>''' Now I am working on a list of things we need to know to create proper personas for project r.
'''<clu_sun>''' is it possible to detect different personas from the data, yet?
'''<FrankL>''' I think we will have 5-7 personas.
'''<clu_sun>''' do you already know which is the 'biggest' one?
'''<FrankL>''' We have a marketing contact from Sun who offered to make the evaluation of the survey, if we provide the questions to be answered.
'''<mprove>''' Jen McGinn presented a persona approach based on large scale survey data.
'''<mprove>''' at CHI
'''<FrankL>''' Do you have a link?
'''<mprove>''' http://blogs.sun.com/designatsun/entry/data_driven_personas
'''<mprove>''' http://flickr.com/photos/mprove/2410669538/
'''<FrankL>''' Thanks. I will provide it to Andreas.
'''<chris-j>''' What else do we have for today?
'''<clu_sun>''' maybe any community questions?
'''<mprove>''' chris-j: does the extension track the usage of task panes? open/close/schwipp-schwapp.. And tool bar customization??
'''<chris-j>''' mprove: The task panes can be tracked in parts. For example controls located within the pane.
'''<chris-j>''' mprove: toolbar customization can also be tracked, if the changes rely on 'standards'.
'''<mprove>''' chris-j: so you do not track if I close a task paine over and over again? _ http://uxooo.blogspot.com/2008/11/impress-task-pain.html
'''<mprove>''' chris-j: statistics on customization would provide insights in changing our defaults.
'''<chris-j>''' I agree.
'''<chris-j>''' Regarding the closer. We can track "document close", etc. I'm not sure about the closer. Regarding the task pa(i)ne exists a bug. I hope it gets fixed soon.
'''<mprove>''' "OOo 3.2" is not really soon.
'''<chris-j>''' I agree.
'''<mprove>''' For my Impress doc I have to close it 4 times. My scenario: 2 windows open to compare slides and changing between slide mode and slide sorter gives another 2 task panes. It really takes time to arrange the document after opening....
'''<chris-j>''' Please be so kind and add this to http://www.openoffice.org/issues/show_bug.cgi?id=95600. Thanks :-)
'''<IZBot>''' issue 95600: Presentation DEFECT NEW P3 Task Panel stays not collapsed when adding slide
'''<chris-j>''' Anything else with regards to Renaissance?
'''<chris-j>''' Ok....
'''<mprove>''' chris-j: done
'''<chris-j>''' Thanks guys. 'See' you next year :-)
'''<mdamboldt>''' bye
'''<FrankL>''' bye

= Next Meetings =
* Action Item (chris-j): Prepare Agenda

Renaissance:Status Meetings

2008-12-15T16:12:16Z

Cj:

[[Renaissance:Home_Page|<< Back to Renaissance Home Page]]

We hold regular weekly meetings, with agenda / notes pages here.
 
From Monday, December 15, 2008 the meeting will take place on at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
 
The meetings is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

'''Details for meeting'''

'''Notes/Agendas'''

* [[Renaissance:Status_Meetings:2009-01-05|January 05, 2009]]
* [[Renaissance:Status_Meetings:2008-12-15|December 15, 2008]]
* [[Renaissance:Status_Meetings:2008-12-08|December 08, 2008]]
* [[Renaissance:Status_Meetings:2008-12-01|December 01, 2008]]

User Experience/OpenOffice.org User Feedback Extension

2008-12-11T12:27:05Z

Cj: /* Disabling the Logging of Data */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: Available for public testing
* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry stored in the '''Logging.xcu''' allows administrators to switch the logging of data globally OFF.
The boolean value needs to be set from '''true''' to '''false'''.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

User Experience/OpenOffice.org User Feedback Extension

2008-12-11T12:25:41Z

Cj: /* Configuration */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: Available for public testing
* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== Disabling the Logging of Data ==
The ''org.OpenOffice.Office.Logging.OOoImprovement.EnablingAllowed'' configuration entry in the '''Logging.xcu''' allows administrators to switch the extension globally OFF.
and needs to be set from true to false.

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

Renaissance

2008-12-11T10:35:25Z

Cj: /* Get Involved/Share Ideas */

{{User Experience Community}}
__NOTOC__
{| style="border: thin dashed #CC2222; padding:5px"
|-
| '''Please do not edit this page unless you are on the Renaissance team.''' Your feedback and comments are welcomed on the [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] mailing list.
|}

[[Image:Renaissance Logo.png|center]]

'''Welcome''' to the wiki of the OpenOffice.org Renaissance Project.

== Our Mission ==

“Create
a User Interface so that
OpenOffice.org becomes the
users' choice not only out of need,
but also out of desire”

== Project Charter ==
* [[Renaissance:The_Challenge|The problem statement]] - What are the challenges of the current User Interface?
* [[Renaissance:The_Mission|The mission statement]] - What is our mission?
* [[Renaissance:The_Goal|The goal statement]] - What we plan to achieve.
* [[Renaissance:The Scope|The scope]] - What is the focus of this project?
* [[Renaissance:The_Roadmap|The roadmap]] - How do we plan to proceed?

== Project Phases ==
* [[Renaissance:Phase_1|Research]] - Know and understand OpenOffice.org users to better meet their needs.
** [[Renaissance:IsoMetrics Results|IsoMetrics Results]] - IsoMetrics-S Survey Results from VBG.
** [[Renaissance:ODFToolkit|ODF document analysis with ODFTOOLKIT]] - First attempt to create an ODF analyzer.
* [[Renaissance:Phase_2|Design]] - Generate and accumulate design ideas to create prototypes based on valid data.
* [[Renaissance:Phase_3|Evaluate]] - Evaluate promissing solutions.

== General Information ==
* [[Renaissance:Presentations|Presentations]] - Presentations
* [[Renaissance:Status_Meetings|Status Meetings]] - Renaissance Status Meetings
* [[Renaissance:Press_Coverage|Press Coverage]] - Project Renaissance Press Coverage
* [[Renaissance:UX_Books|User Experience Books]] - Valuable literature on User Experience topics
* [[Renaissance:UX_Sites|User Experience Sites]] - Valuable links to User Experience sites

== FAQ (Frequently Asked Questions) ==
* [[Renaissance:FAQ|Frequently Asked Questions]] - Answers on Frequently Asked Questions

== How You Can Help ==

=== Get Involved/Share Ideas ===

* You may join the UX project, just have a look at [[User_Experience/Community/How_To_Join|How To Join]].
* A first contact to the team can be established in the IRC chat at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
* Join the weekly status meetings. The meeting takes place on IRC at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net. The meetings is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

=== Share Ideas ===
Share your cool user interface ideas on [mailto:ui@ux.openoffice.org ui@ux.openoffice.org]

=== Fix bugs ===

* Actual [http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=usability&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query '''Requests For Enhancements''' or '''Bugs'''] with the keyword Usability.

[[Category:Effort]]

User Experience/OpenOffice.org User Feedback Extension

2008-12-10T14:05:14Z

Cj: /* Presentations */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Roadmap ==

* '''Mile Stone 1:''' December 18, 2008: Available for public testing
* '''Mile Stone 2:''' OpenOffice.org 3.01 Release: Delivery of final extension for Windows, Linux, Solaris, and Mac
* '''Mile Stone 3:''' OpenOffice.org 3.1 Release: Bundled with OpenOffice.org [http://www.openoffice.org/issues/show_bug.cgi?id=97101 Bug 97101]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

Renaissance:Status Meetings

2008-12-10T12:18:03Z

Cj:

Renaissance:Status Meetings

2008-12-10T12:17:43Z

Cj:

[[Renaissance:Home_Page|<< Back to Renaissance Home Page]]

We hold regular weekly meetings, with agenda / notes pages here.
From Monday, December 15, 2008 the meeting will take place on at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
 
The meetings is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

'''Details for meeting'''

'''Notes/Agendas'''
* [[Renaissance:Status_Meetings:2008-12-08|December 08, 2008]]
* [[Renaissance:Status_Meetings:2008-12-01|December 01, 2008]]

Renaissance:Status Meetings

2008-12-10T12:17:29Z

Cj:

[[Renaissance:Home_Page|<< Back to Renaissance Home Page]]

We hold regular weekly meetings, with agenda / notes pages here.
From Monday, December 15, 2008 the meeting will take place on at [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.
The meetings is scheduled for [http://www.timeanddate.com/worldclock/fixedtime.html?day=15&month=12&year=2008&hour=16&min=0&sec=0&p1=37 4pm CET].

'''Details for meeting'''

'''Notes/Agendas'''
* [[Renaissance:Status_Meetings:2008-12-08|December 08, 2008]]
* [[Renaissance:Status_Meetings:2008-12-01|December 01, 2008]]

Renaissance:Status Meetings

2008-12-10T12:13:05Z

Cj:

[[Renaissance:Home_Page|<< Back to Renaissance Home Page]]

We hold regular weekly meetings, with agenda / notes pages here.
From Monday, December 15, 2008 the meeting will take place on IRC at #ux.openoffice.org on irc.freenode.net.

'''Details for meeting'''

'''Notes/Agendas'''
* [[Renaissance:Status_Meetings:2008-12-08|December 08, 2008]]
* [[Renaissance:Status_Meetings:2008-12-01|December 01, 2008]]

Renaissance:Status Meetings:2008-12-01

2008-12-10T10:00:54Z

Cj:

__NOTOC__
<<[[Renaissance:Status Meetings:2008-12-01| Previous Meeting]] | [[Renaissance:Status Meetings|Index]] | [[Calendar:Status Meetings:2008-12-08| Next Meeting >>]]

== Meeting Details ==
16:00 CET, Hamburg 

'''Participants:''' Andreas, Frank, Bettina, Christian, Nils, Christoph

== Action Items ==
N/A
=== New ===
N/A

== Meeting Log ==

* Upcoming meetings should be held on IRC

=== Andreas ===
* Received 204 valid responses from VBG for survey bases on Isometrics
* Played with ODF Toolkit for doing some analysis on document content
* We should have a mini survey on OpenOffice.org

=== Bettina ===
* Prepares a competitive analysis based on a task oriented approach.
** How many steps are needed to create a "good looking" table

=== Frank ===
* Analysis the OpenOffice.org registration survey

=== Christian ===
* User Feedback Program: We're doing some bug fixing. Plan is to have the extension out with OpenOffice.org 3.01. Extension build which will run with dev builds of ooo 3.01 will be available for testing soon.

Renaissance:Status Meetings:2008-12-01

2008-12-10T09:54:13Z

Cj:

__NOTOC__
== Meeting Details ==
16:00 CET, Hamburg 

'''Participants:''' Andreas, Frank, Bettina, Christian, Nils, Christoph

== Action Items ==
N/A
=== New ===
N/A

== Meeting Log ==

* Upcoming meetings should be held on IRC

=== Andreas ===
* Received 204 valid responses from VBG for survey bases on Isometrics
* Played with ODF Toolkit for doing some analysis on document content
* We should have a mini survey on OpenOffice.org

=== Bettina ===
* Prepares a competitive analysis based on a task oriented approach.
** How many steps are needed to create a "good looking" table

=== Frank ===
* Analysis the OpenOffice.org registration survey

=== Christian ===
* User Feedback Program: We're doing some bug fixing. Plan is to have the extension out with OpenOffice.org 3.01. Extension build which will run with dev builds of ooo 3.01 will be available for testing soon.

Renaissance:Status Meetings:2008-12-01

2008-12-10T08:58:45Z

Cj: New page: ___NOTOC___ == Meeting Details == * 16:00 CET == Action Items == N/A === New === N/A == Meeting Log == '''Participants:''' Andreas, Frank, Bettina, Christian, Nils, Christoph ===Genera...

___NOTOC___
== Meeting Details ==
* 16:00 CET

== Action Items ==
N/A
=== New ===
N/A

== Meeting Log ==
'''Participants:''' Andreas, Frank, Bettina, Christian, Nils, Christoph

===General ===
* Upcoming meetings should be held on IRC

=== Andreas ===
* Received 204 valid responses from VBG for survey bases on Isometrics
* Played with ODF Toolkit for doing some analysis on document content
* We should have a mini survey on openoffic.org

=== Bettina ===
* Prepares a competitive analysis based on a task oriented approach.
** How many steps are needed to create a "good looking" table

=== Frank ===
* Analysis the openOffice.org registration survey

=== Christian ===
* User Feedback Program: We're doing some bug fixing. Plan is to have the extension out with OpenOffice.org 3.01. Extension build which will run with dev builds of ooo 3.01 will be available for testing soon.

Renaissance:Status Meetings

2008-12-09T13:10:47Z

Cj: New page: << Back to Renaissance Home Page We hold regular weekly meetings, with agenda / notes pages here. '''Details for meeting''' '''Notes/Agendas''' ...

[[Renaissance:Home_Page|<< Back to Renaissance Home Page]]

We hold regular weekly meetings, with agenda / notes pages here.

'''Details for meeting'''

'''Notes/Agendas'''
* [[Renaissance:Status_Meetings:2008-12-08|December 08, 2008]]
* [[Renaissance:Status_Meetings:2008-12-01|December 01, 2008]]

Renaissance/FAQ

2008-12-05T08:49:56Z

Cj: New page: Since the announcement of the Renaissance project we noticed that people are interest in general topics which are discussed repeatedly in e.g. discussion forums. This FAQ lists common ques...

Since the announcement of the Renaissance project we noticed that people are interest in general topics which are discussed repeatedly in e.g. discussion forums. This FAQ lists common questions and the corresponding answers - considering the current status of the project. If any common question seems to be missing, then please contact the Renaissance team at the [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] mailing list.

'''Will the result of Renaissance look like product XYZ? (e.g. Microsoft Fluent "Ribbon")'''

Not in general, maybe single parts. From experience it is known that UX professionals tend to develop similar solutions if there are similar problems and constraints.

Concerning Microsoft Fluent (known as "Ribbon" in Microsoft Office 2007), Microsoft has started to patent this user interface concept. As far as we know, if anybody uses the concept for office applications, then licence fees have to be paid. Additionally, it has not yet been proven that this concept represents the optimum for our users.

'''Will the future UI provide theming capabilities?'''

Maybe. Even the current OpenOffice.org provides theming capabilities to archive a high level of consistency across all the platforms (e.g. the user interface controls, icon themes). Furthermore, the Renaissance team has the impression that the concept of theming is somehow misunderstood. Theming does mainly have influence on how software will look - it won't change how software behaves. And making it behave better, e.g. by better understanding the work flow of users, is one of the goals of Renaissance.

'''Are there any mockups or preliminary designs available? Where can I find it?'''

No. The current project announcement is meant to communicate the start of an activity which requires a lot of support from different projects and roles inside the OpenOffice.org community. Please have a look at the [[Renaissance:The_Roadmap|Renaissance Roadmap]] to get an idea what to expect when.

Renaissance

2008-12-05T08:49:40Z

Cj: /* FAQ */

Renaissance

2008-12-05T08:45:42Z

Cj: /* How You Can Help */

Renaissance

2008-12-05T08:44:55Z

Cj: /* Frequently Asked Questions */

Renaissance:UX Sites

2008-12-05T08:44:09Z

Cj: New page: * [http://www.interaction-design.org/encyclopedia| Interaction-Design.org Encyclopedia] - Interaction Design Encyclopedia/Glossary

* [http://www.interaction-design.org/encyclopedia| Interaction-Design.org Encyclopedia] - Interaction Design Encyclopedia/Glossary

Renaissance

2008-12-05T08:41:04Z

Cj: /* General Information */

{{User Experience Community}}
__NOTOC__
{| style="border: thin dashed #CC2222; padding:5px"
|-
| '''Please do not edit this page unless you are on the Renaissance team.''' Your feedback and comments are welcomed on the [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] mailing list.
|}

[[Image:Renaissance Logo.png|center]]

'''Welcome''' to the wiki of the OpenOffice.org Renaissance Project.

== Our Mission ==

[[Image:Mission_statement.png|300px]]

== Project Charter ==
* [[Renaissance:The_Challenge|The problem statement]] - What are the challenges of the current User Interface?
* [[Renaissance:The_Mission|The mission statement]] - What is our mission?
* [[Renaissance:The_Goal|The goal statement]] - What we plan to achieve.
* [[Renaissance:The Scope|The scope]] - What is the focus of this project?
* [[Renaissance:The_Roadmap|The roadmap]] - How do we plan to proceed?

== Project Phases ==
* [[Renaissance:Phase_1|Research]] - Know and understand OpenOffice.org users to better meet their needs.
* [[Renaissance:Phase_2|Design]] - Generate and accumulate design ideas to create prototypes based on valid data.
* [[Renaissance:Phase_3|Evaluate]] - Evaluate promissing solutions.

== General Information ==
* [[Renaissance:Presentations|Presentations]] - Presentations
* [[Renaissance:Status_Meetings|Status Meetings]] - Renaissance Status Meetings
* [[Renaissance:Press_Coverage|Press Coverage]] - Project Renaissance Press Coverage
* [[Renaissance:UX_Books|User Experience Books]] - Valuable literature on User Experience topics
* [[Renaissance:UX_Sites|User Experience Sites]] - Valuable links to User Experience sites

== How You Can Help ==

=== Get Involved/Share Ideas ===
The people in the renaissance project hang out on [irc://ux.openoffice.org #ux.openoffice.org] on irc.freenode.net.

=== Share Ideas ===
Share your cool user interface ideas on [mailto:ui@ux.openoffice.org ui@ux.openoffice.org]

=== Fix bugs ===

* Actual [http://qa.openoffice.org/issues/buglist.cgi?issue_type=DEFECT&issue_type=ENHANCEMENT&issue_type=FEATURE&issue_type=PATCH&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_status=RESOLVED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=allwords&long_desc=&long_desc_type=allwords&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=usability&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&namedcmd=mail+merge+1&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query '''Requests For Enhancements''' or '''Bugs'''] with the keyword Usability.

== Frequently Asked Questions ==

Since the announcement of the Renaissance project we noticed that people are interest in general topics which are discussed repeatedly in e.g. discussion forums. This FAQ lists common questions and the corresponding answers - considering the current status of the project. If any common question seems to be missing, then please contact the Renaissance team at the [mailto:ui@ux.openoffice.org ui@ux.openoffice.org] mailing list.

'''Will the result of Renaissance look like product XYZ? (e.g. Microsoft Fluent "Ribbon")'''

Not in general, maybe single parts. From experience it is known that UX professionals tend to develop similar solutions if there are similar problems and constraints.

Concerning Microsoft Fluent (known as "Ribbon" in Microsoft Office 2007), Microsoft has started to patent this user interface concept. As far as we know, if anybody uses the concept for office applications, then licence fees have to be paid. Additionally, it has not yet been proven that this concept represents the optimum for our users.

'''Will the future UI provide theming capabilities?'''

Maybe. Even the current OpenOffice.org provides theming capabilities to archive a high level of consistency across all the platforms (e.g. the user interface controls, icon themes). Furthermore, the Renaissance team has the impression that the concept of theming is somehow misunderstood. Theming does mainly have influence on how software will look - it won't change how software behaves. And making it behave better, e.g. by better understanding the work flow of users, is one of the goals of Renaissance.

'''Are there any mockups or preliminary designs available? Where can I find it?'''

No. The current project announcement is meant to communicate the start of an activity which requires a lot of support from different projects and roles inside the OpenOffice.org community. Please have a look at the [[Renaissance:The_Roadmap|Renaissance Roadmap]] to get an idea what to expect when.

[[Category:Effort]]

User Experience/OpenOffice.org User Feedback Extension

2008-12-03T16:20:48Z

Cj: /* Web Site */

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

User Experience/OpenOffice.org User Feedback Extension

2008-12-03T16:02:21Z

Cj:

The OpenOffice.org User 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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

User Experience/OpenOffice.org User Feedback Extension

2008-12-03T16:00:03Z

Cj:

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.

== Status Meetings ==
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-22 2008-10-22]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-15 2008-10-15]
* [http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Program_Status_Meeting:_2008-10-08 2008-10-08]

== Presentations ==
* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface]
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)]

== Development ==
The extension is divided 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 integrated 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:

[[Image:Usage.png]]

'''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'''

<pre>
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
</pre>

=== Tools Options Dialog ===

[[Image:Usage_option.png]]

'''Strings used'''
<pre>
Tracked data
Number of reports send:

Number of tracked actions:

Show Data
</pre>

== 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 ==

The dialogs offer an information button in form of an (i) icon. This button points to the extension web site to give the user background about the extension. From there a link will point to "http://www.sun.com/privacy/".

== 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]

Renaissance:The Roadmap

2008-12-03T15:03:09Z

Cj:

[[Image:Renaissance-roadmap.png]]
 The chart above shows a first draft of the tasks work on during the first Phase (Research) of the Project.

* Design
TBD
* Evaluate
TBD

File:Renaissance-roadmap.png

2008-12-03T14:59:48Z

Cj:

Renaissance:Research

2008-12-02T12:28:23Z

Cj: /* Presentations */

* Isometrics
* Focus Groups
* Personas

=== Surveys ===
* [http://surveys.services.openoffice.org/surveys/index.php?sid=91452 OpenOffice.org User Survey] -The OpenOffice.org User Survey

=== User Feedback Channels ===
[http://wiki.services.openoffice.org/wiki/User_Experience/OpenOffice.org_User_Feedback_Extension User Feedback Program] - The OpenOffice.org User Feedback Program

=== Presentations ===

* [http://marketing.openoffice.org/ooocon2008/programme/friday_1447.pdf OOo Con 2008: Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface] - Numbers, Numbers, Numbers, or how data helps to improve the OOo User Interface
* [http://wiki.services.openoffice.org/w/images/4/4d/Numbers-numbers-numbers-WUD-HH-2008.pdf Presentation at World Usability Day 2008 in Hamburg (in German)] - Presentation at [http://www.worldusabilityday.de/hamburg/index.html World Usability Day 2008] in Hamburg (in German)