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.

Installation on OX AppSuite

Debian GNU/Linux 7.0

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

deb https://software.open-xchange.com/OX6/stable/DebianWheezy/ /
# 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/OX6/stable/updates/DebianWheezy/ /

and run

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

Debian GNU/Linux 8.0

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

deb https://software.open-xchange.com/OX6/stable/DebianJessie/ /
# 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/OX6/stable/updates/DebianJessie/ /

and run

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

SUSE Linux Enterprise Server 11

Add the package repository using zypper if not already present:

$ zypper ar https://software.open-xchange.com/OX6/stable/SLES11 ox

If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed:

$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/SLES11 ox-updates

and run

$ zypper ref
$ zypper in open-xchange-datamining

SUSE Linux Enterprise Server 12

Add the package repository using zypper if not already present:

$ zypper ar https://software.open-xchange.com/OX6/stable/SLE_12 ox

If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed:

$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/SLES11 ox-updates

and run

$ zypper ref
$ zypper in open-xchange-datamining

RedHat Enterprise Linux 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# 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
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-datamining

RedHat Enterprise Linux 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# 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
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-datamining

CentOS 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# 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
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-datamining

CentOS 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# 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
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum 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