Difference between revisions of "OXReportClient"

(Available options)
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Introduction ==
#REDIRECT [[AppSuite:OXReportClient]]
Beginning with the release of Open-Xchange Server version 6.18, '''generating a report every month'''
is mandatory in order to have access to the maintenance updates available in the updates directory
on software.open-xchange.com.
'''You have been blocked already?'''
'''Don't panic''', you can still access http://software.open-xchange.com/OX6/stable, because that
is open for everyone.
So install the Report Client from stable instead of updates and once you're done, update to the latest version.
The Open-Xchange Report Client extension of the Open-Xchange Server enables you to generate and send usage reports of your environment to Open-Xchange. The report will contain information of how many contexts and users have been created in the given Open-Xchange environment. This article will guide you through the installation of the  Open-Xchange Report Client. It describes the setup of the software extension itself, and which additional configurations need to be done to execute this extension.
You will find further information at the Open-Xchange Frequent Asked Questions (FAQ)
* [http://sdb.open-xchange.com/faq/70 English]
* [http://sdb.open-xchange.com/category/1/71 German]
== Configuration ==
A requirement to execute the Open-Xchange Report Client is to have your Open-Xchange license key stored in one specific file on your Open-Xchange installation. The latest version of our [[Main_Page#Installation_based_on_packages | installation guide]] documentation will automatically enable you to store your license key on disk by using a new oxinstaller command.
If you want to use the report client on an already installed environment you need to store your license key manually on disk. To do so create and edit the following file on your Open-Xchange server:
$ vim /opt/open-xchange/etc/common/licensekeys.properties
or on 6.22 or newer
$ vim /opt/open-xchange/etc/licensekeys.properties
If you are behind a firewall and the report client needs to be configured using a HTTP proxy, please edit file:
$ vim /opt/open-xchange/etc/groupware/reportclient.properties
or on 6.22 or newer
$ vim /opt/open-xchange/etc/reportclient.properties
After editing this file accordingly to your proxy needs, try to start the report client again.
== Using the Report tool ==
Now as the package has been correctly installed and you provided your license key in the according properties file your are ready to launch the report client to generate a report. By default (if no option is given) the report client will display and send the generated report to an Open-Xchange service on activation.open-xchange.com. Note that only data that is displayed in the console will be transfered to Open-Xchange
=== Display data usage report ===
$ /opt/open-xchange/sbin/report -d
If you want to know which data would be transfered, execute the report client with the option "-d" (display_only). If this option is given to the report client no data will be send:
=== Send data usage report ===
$ /opt/open-xchange/sbin/report -s
If you don't want to have the report displayed in the console (which might be the case for automated executions of the report client) execute the report client with the option -s (send_only). Now no report will be displayed after the report has been sent to activation.open-xchange.com.
=== Available options ===
$ /opt/open-xchange/sbin/report -h
lists all available options:
Usage: report
-h,--help                                        Prints a help text         
    --environment                                  Show info about commandline environment
    --nonl                                        Remove all newlines (\n) from output
    --responsetimeout <responsetimeout>            response timeout in seconds for reading response from
                                                    the backend (default 0s; infinite)
-H,--host <host>                                  specifies the host         
-T,--timeout <timeout>                            timeout (in s) to conntect to the backend (default 15s)
-J,--jmxauthuser <jmxauthuser>                    jmx username (when jmx authentication enabled)
-P,--jmxauthpassword <jmxauthpassword>            jmx password (when jmx authentication enabled)
-s,--sendonly                                    Send report without displaying it (Disables default)
-d,--displayonly                                  Display report without sending it (Disables default)
-c,--csv                                          Show output as CSV         
-a,--advancedreport                              Run an advanced report
-f,--savereport                                  Save the report as JSON String instead of sending it
-b,--showaccesscombination <showaccesscombination>  Show access combination for bitmask
-e,--run-appsuite-report                          Schedule an appsuite style report
-t,--report-type <report-type>                    The type of the report to run
    --inspect-appsuite-reports                    Prints information about currently running reports
    --cancel-appsuite-reports                      Cancels pending reports   
-g,--get-appsuite-report                          Retrieve the report that was generated
-x,--run-and-deliver-report                      Create a new report and send it immediately
=== Explanation of console output ===
$ /opt/open-xchange/sbin/report -d
Starting the Open-Xchange report client. Note that the report generation may take a little while.
module    version   
admin    6.20.5 Rev1
groupware 6.20.5 Rev1
'''contexts users'''
3        56 
'''mac      count adm disabled'''
268435455 6    1  0     
237044501 48    0  0     
5        2    2  0     
'''usmeas olox2 mobileapp carddav caldav'''
1      0    0        0      0
'''usmeasyear olox2year mobileappyear carddavyear caldavyear'''
4          12        7            11          10       
:total number of contexts
:total number of users
:decimal value of the module access. For conversion decimal to human readable permission please use <tt>report -b</tt> as described below
:amount of users with this module access
:amount of admin users with this specific module access
:amount of users that are disabled
The last rows show the amount of users that did login to Open-Xchange within the ''last 30 days'' and ''the last year'' using the specified OXtender/service.
If you want to know the access permissions of a specific <tt>mac</tt>, run e.g.
$  /opt/open-xchange/sbin/report -b 237044501
:using mobile phone via active sync (OXtender for Business Mobility) within the last 30 days
:using OXtender 2 for Microsoft Outlook within the last 30 days
:using Open-Xchange Mobile Web Interface within the last 30 days
:using the CalDAV/CardDAV feature within the last 30 days
:using mobile phone via active sync (OXtender for Business Mobility) within the last year
:using OXtender 2 for Microsoft Outlook within the last year
:using Open-Xchange Mobile Web Interface within the last year
:using the CalDAV/CardDAV feature within the last year
'''Example:''' a value of 7 below <tt>olox2</tt> means, that within the last 30 days, 7 different users used the OXtender 2 for Microsoft Outlook to connect to Open-Xchange.
== Automatic reports ==
Creating a cron entry which will automatically execute the report client once a week saves a lot of work. To create this cron entry execute:
$ vim /etc/cron.d/open-xchange_report
0 3 * * 7 open-xchange /opt/open-xchange/sbin/report -s 1> /dev/null 2>&1
== What will be reported using the send method? ==
The report client will display and / or transfer the following information:
# Version number of the Open-Xchange server package
# Version number of the Open-Xchange admin package
# Total user count
# Total context count
# Detailed context information: context age, creation date or date of creation, user count, context id
# Detailed user information (per context): User access combination flags (which modules have been activated for the users)

Latest revision as of 05:43, 10 August 2017