Datamining

What is this?

This is a simple Tool to get an idea how a specific installation of Open-Xchange is used. Operating on the MySQL-database exclusively for now it is quite fast and uses few resources. Off-hours are still recommended for its usage to limit any performance-impact, though. It will find its required parameters automatically in the file /opt/open-xchange/etc/groupware/configdb.properties. It is also possible to specify all parameters explicitly. Output is a single text-file. The filename starts with "open-xchange_datamining" and includes the current date in YYYY-MM-DD format. The content of the file is camelCased-Parameters, unique and one per line. This should make using these files as input, for example for a visualization, pretty easy.

Install on OX {{#if:|{{{version}}}| AppSuite}}

Debian GNU/Linux 10.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://{{#if:%7C{{{ldbaccount}}}@%7C}}software.open-xchange.com/{{#if:%7C{{{toplevel}}}%7Cproducts}}/stable/DebianBuster/ /{{#if:||

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/{{#if:|{{{toplevel}}}|products}}/stable/updates/DebianBuster/ /

}}

and run

$ apt-get update
$ apt-get install open-xchange-datamining

Debian GNU/Linux 11.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://{{#if:%7C{{{ldbaccount}}}@%7C}}software.open-xchange.com/{{#if:%7C{{{toplevel}}}%7Cproducts}}/stable/DebianBullseye/ /{{#if:||

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/{{#if:|{{{toplevel}}}|products}}/stable/updates/DebianBullseye/ /

}}

and run

$ apt-get update
$ apt-get install open-xchange-datamining

Usage

/opt/open-xchange/sbin/datamining

Available Parameters

-?, -h, --help                         Print the available parameters
                
-d, --dbName <dbname>                  Name of the MySQL-database that contains the Open-Xchange configDB  (default: configdb)                        
                  
--dbPort <port>                        Port where MySQL is running on the host specified with "-hostname"  (default: 3306)                      

-n, --hostname <hostname>              Host where the Open-Xchange MySQL-database is running                  

-p, --dbPassword <dbpassword>          Password for the user specified with "-dbUser"                              

--reportfilePath <path>                Path where the report-file is saved (default: )                          

-u, --dbUser <dbuser>                  Name of the MySQL-User for configdb    

-v, --verbose                          With this the tool prints what it is doing live

What questions are answered?

• numberOfSchemata
• AverageFilestoreSize
• NumberOfContexts
• NumberOfUsers
• NumberOfAppointments
• NumberOfUsersWhoCreatedAppointments
• MaximumNumberOfCreatedAppointmentsForOneUser
• AverageNumberOfAppointmentsPerUserWhoHasAppointmentsAtAll
• NumberOfUsersWithEventsInPrivateCalendarThatAreInTheFutureAndAreNotYearlySeries
• NumberOfUsersWhoChangedTheirCalendarInTheLast30Days
• NumberOfDocuments
• NumberOfUsersWhoCreatedDocuments
• MaximumNumberOfCreatedDocumentsForOneUser
• AverageNumberOfDocumentsPerUserWhoHasDocumentsAtAll
• AverageNumberOfInfostoreObjectsPerContext
• AverageNumberOfInfostoreObjectsPerSchema
• NumberOfNewInfostoreObjectsInTheLast30Days
• NumberOfChangedInfostoreObjectsInTheLast30Days
• NumberOfUsersWithNewInfostoreObjectsInTheLast30Days
• SliceAndDiceOnDocumentSize
• AverageDocumentSize
• NumberOfContacts
• NumberOfUserCreatedContacts
• NumberOfUsersWhoHaveContacts
• NumberOfUsersWhoCreatedContacts
• MaximumNumberOfContactsForOneUser
• MaximumNumberOfCreatedContactsForOneUser
• AverageNumberOfContactsPerUserWhoHasContactsAtAll
• AverageNumberOfContactsPerUserWhoHasCreatedContacts
• NumberOfUsersWhoChangedTheirContactsInTheLast30Days
• NumberOfUsersWithLinkedSocialNetworkingAccounts
• NumberOfUsersConnectedToFacebook
• NumberOfUsersConnectedToLinkedIn
• NumberOfUsersConnectedToTwitter
• NumberOfUsersConnectedToGoogle
• NumberOfUsersConnectedToMSN
• NumberOfUsersConnectedToYahoo
• NumberOfUsersConnectedToXing
• NumberOfUsersConnectedToTOnline
• NumberOfUsersConnectedToGMX
• NumberOfUsersConnectedToWebDe
• NumberOfTasks
• NumberOfUsersWhoCreatedTasks
• MaximumNumberOfCreatedTasksForOneUser
• AverageNumberOfTasksPerUserWhoHasTasksAtAll
• NumberOfUsersWhoChangedTheirTasksInTheLast30Days
• NumberOfUsersWhoSelectedTeamViewAsCalendarDefault
• NumberOfUsersWhoSelectedCalendarViewAsCalendarDefault
• NumberOfUsersWhoSelectedListViewAsCalendarDefault
• NumberOfUsersWhoSelectedCardsViewAsContactsDefault
• NumberOfUsersWhoSelectedListViewAsContactsDefault
• NumberOfUsersWhoSelectedListViewAsTasksDefault
• NumberOfUsersWhoSelectedHSplitViewAsTasksDefault
• NumberOfUsersWhoSelectedListViewAsInfostoreDefault
• NumberOfUsersWhoSelectedHSplitViewAsInfostoreDefault
• NumberOfUsersWhoActivatedMiniCalendar
• NumberOfUsersWhoLoggedInWithClientOX6UIInTheLast30Days
• NumberOfUsersWhoLoggedInWithClientAppSuiteUIInTheLast30Days
• NumberOfUsersWhoLoggedInWithClientMobileUIInTheLast30Days
• NumberOfUsersWhoLoggedInWithClientEASInTheLast30Days
• NumberOfUsersWhoLoggedInWithClientCalDAVInTheLast30Days
• NumberOfUsersWhoLoggedInWithClientCardDAVInTheLast30Days