AppSuite:OXReportClient - Revision history

Khgras at 08:56, 15 May 2019

2019-05-15T08:56:08Z

← Older revision		Revision as of 08:56, 15 May 2019
Line 1:		Line 1:
	The content on this page has moved to https://documentation.open-xchange.com/~~latest~~/middleware/~~components~~/report_client.html.		The content on this page has moved to https://documentation.open-xchange.com/7.10.2/middleware/miscellaneous/report_client.html.
	Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.		Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

	[[Category: OX7]]		[[Category: OX7]]
	[[Category: AppSuite]]		[[Category: AppSuite]]

Khgras at 10:25, 22 May 2017

2017-05-22T10:25:48Z

← Older revision		Revision as of 10:25, 22 May 2017
Line 1:		Line 1:
	The content on this page has moved to https://documentation.open-xchange.com/~~7.8.2~~/middleware/components/report_client.html.		The content on this page has moved to https://documentation.open-xchange.com/latest/middleware/components/report_client.html.
	Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.		Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

	[[Category: OX7]]		[[Category: OX7]]
	[[Category: AppSuite]]		[[Category: AppSuite]]

Khgras at 09:17, 12 July 2016

2016-07-12T09:17:50Z

@@ Line 1: / Line 1: @@
-== Introduction ==
+The content on this page has moved to https://documentation.open-xchange.com/7.8.2/middleware/components/report_client.html.
+Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.
 [[Category: OX7]]
 [[Category: AppSuite]]

WolfgangRosenauer at 09:37, 12 June 2015

2015-06-12T09:37:13Z

@@ Line 77: / Line 77: @@
   -g,--get-appsuite-report                          Retrieve the report that was generated, can (and should) be combined with the options for sending, displaying or saving the report
   -x,--run-and-deliver-report                       Create a new report and send it immediately. Note: This command will run until the report is finished, and that could take a while. Can (and should) be combined with the options for sending, displaying or saving the report
 == Automatic reports ==

WolfgangRosenauer at 09:36, 12 June 2015

2015-06-12T09:36:11Z

← Older revision		Revision as of 09:36, 12 June 2015
Line 41:		Line 41:
	=== Display data usage report ===		=== Display data usage report ===

	$ /opt/open-xchange/sbin/report -d		$ /opt/open-xchange/sbin/report -x -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:		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:
Line 47:		Line 47:
	=== Send data usage report ===		=== Send data usage report ===

	$ /opt/open-xchange/sbin/report -s		$ /opt/open-xchange/sbin/report -x -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.		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.
Line 80:		Line 80:
	=== Explanation of console output ===		=== Explanation of console output ===

	$ /opt/open-xchange/sbin/report -d		$ /opt/open-xchange/sbin/report -x -d
	Starting the Open-Xchange report client. Note that the report generation may take a little while.		Starting the Open-Xchange report client. Note that the report generation may take a little while.

Line 146:		Line 146:
	$ vim /etc/cron.d/open-xchange_report		$ vim /etc/cron.d/open-xchange_report

	0 3 * * 7 open-xchange /opt/open-xchange/sbin/report -s -x 1> /dev/null 2>&1		0 3 * * 7 open-xchange /opt/open-xchange/sbin/report -x -s 1> /dev/null 2>&1

	== What will be reported using the send method? ==		== What will be reported using the send method? ==
Line 153:		Line 153:

	# Version number of the Open-Xchange server package		# Version number of the Open-Xchange server package
	~~# Version number of the Open-Xchange admin package~~
	# Total user count		# Total user count
	# Total context count		# Total context count
	# Detailed context information: context age, creation date or date of creation, user count, context id		# Detailed context information: context age, creation date or date of creation, user count, context id, context quota
	# Detailed user information (per context): User ~~access combination flags~~ (which modules have been activated for the users)		# Detailed user information (per context): User capabilities (which modules have been activated for the users)
			# login counters for the different components

	[[Category: OX7]]		[[Category: OX7]]
	[[Category: AppSuite]]		[[Category: AppSuite]]

WolfgangRosenauer: /* Available options */

2015-06-12T09:31:42Z

Available options

← Older revision		Revision as of 09:31, 12 June 2015
Line 57:		Line 57:
	lists all available options:		lists all available options:

	Usage: report		Usage: report
	-h,--help Prints a help text		-h,--help Prints a help text
	--environment Show info about commandline environment		--environment Show info about commandline environment
	--nonl Remove all newlines (\n) from output		--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		-H,--host <host> specifies the host
			-T,--timeout <timeout> timeout in seconds for the connection creation to the backend (default 15s)
	-J,--jmxauthuser <jmxauthuser> jmx username (required when jmx authentication enabled)		-J,--jmxauthuser <jmxauthuser> jmx username (required when jmx authentication enabled)
	-P,--jmxauthpassword <jmxauthpassword> jmx username (required when jmx authentication enabled)		-P,--jmxauthpassword <jmxauthpassword> jmx username (required when jmx authentication enabled)
Line 72:		Line 71:
	-f,--savereport Save the report as JSON String instead of sending it		-f,--savereport Save the report as JSON String instead of sending it
	-b,--showaccesscombination <showaccesscombination> Show access combination for bitmask		-b,--showaccesscombination <showaccesscombination> Show access combination for bitmask
			-e,--run-appsuite-report Schedule an appsuite style report. Will print out the reports UUID or, if a report is being generated, the UUID of the pending report
			-t,--report-type <report-type> The type of the report to run. Leave this off for the 'default' report.
			--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, can (and should) be combined with the options for sending, displaying or saving the report
			-x,--run-and-deliver-report Create a new report and send it immediately. Note: This command will run until the report is finished, and that could take a while. Can (and should) be combined with the options for sending, displaying or saving the report

	=== Explanation of console output ===		=== Explanation of console output ===

Strotti: /* Automatic reports */

2015-05-27T06:12:59Z

Automatic reports

← Older revision		Revision as of 06:12, 27 May 2015
Line 141:		Line 141:
	$ vim /etc/cron.d/open-xchange_report		$ vim /etc/cron.d/open-xchange_report

	0 3 * * 7 open-xchange /opt/open-xchange/sbin/report -s 1> /dev/null 2>&1		0 3 * * 7 open-xchange /opt/open-xchange/sbin/report -s -x 1> /dev/null 2>&1

	== What will be reported using the send method? ==		== What will be reported using the send method? ==

Thorben: /* Available options */

2015-04-23T13:51:48Z

Available options

← Older revision		Revision as of 13:51, 23 April 2015
Line 61:		Line 61:
	--environment Show info about commandline environment		--environment Show info about commandline environment
	--nonl Remove all newlines (\n) from output		--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		-H,--host <host> specifies the host
	-J,--jmxauthuser <jmxauthuser> jmx username (required when jmx authentication enabled)		-J,--jmxauthuser <jmxauthuser> jmx username (required when jmx authentication enabled)

Choeger at 06:39, 13 March 2013

2013-03-13T06:39:33Z

← Older revision		Revision as of 06:39, 13 March 2013
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	~~Beginning with the release of OX App Suite v7.0,~~ '''~~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.		'''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?'''		'''You have been blocked already?'''
Line 22:		Line 22:

	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:		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		$ vim /opt/open-xchange/etc/licensekeys.properties
Line 33:		Line 29:
	If you are behind a firewall and the report client needs to be configured using a HTTP proxy, please edit file:		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		$ vim /opt/open-xchange/etc/reportclient.properties

Khgras at 13:12, 25 February 2013

2013-02-25T13:12:27Z

← Older revision		Revision as of 13:12, 25 February 2013
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	Beginning with the release of ~~Open-Xchange~~ App Suite v7.0, '''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.		Beginning with the release of OX App Suite v7.0, '''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?'''		'''You have been blocked already?'''
Line 7:		Line 7:
	'''Don't panic''', you can still access http://software.open-xchange.com/..., 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.		'''Don't panic''', you can still access http://software.open-xchange.com/..., 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~~ App Suite 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.		The Open-Xchange Report Client extension of the OX App Suite 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)		You will find further information at the Open-Xchange Frequent Asked Questions (FAQ)