AppSuite:DocumentConverter Installation Guide - Revision history

Thomas.siedentopf: typo

2023-02-14T14:07:04Z

typo

← Older revision		Revision as of 14:07, 14 February 2023
Line 1:		Line 1:
	= Product Description =		= Product Description =

	Open-Xchange Inc. (“Open-Xchange”) has created a proprietary software program called the Open-Xchange Document Converter (the “Software”), which converts Microsoft (OOXML) ~~und~~ OpenOffice (ODF) office documents to PDF or to HTML5 with embedded SVG files (Scalable Vector Graphics). Additional the OX Document Converter converts PDF format files to SVG files and Microsoft files to OpenOffice files and backwards. So users can view and print documents in the existing infrastructure without any necessary additional plugins.		Open-Xchange Inc. (“Open-Xchange”) has created a proprietary software program called the Open-Xchange Document Converter (the “Software”), which converts Microsoft (OOXML) and OpenOffice (ODF) office documents to PDF or to HTML5 with embedded SVG files (Scalable Vector Graphics). Additional the OX Document Converter converts PDF format files to SVG files and Microsoft files to OpenOffice files and backwards. So users can view and print documents in the existing infrastructure without any necessary additional plugins.

	== Introduction ==		== Introduction ==

Stx12: /* Configuration */

2019-10-25T09:45:47Z

Configuration

← Older revision		Revision as of 09:45, 25 October 2019
Line 42:		Line 42:
	=== Configuration ===		=== Configuration ===

	After ~~deployment~~ of both components ''readerengine'' and ''server'', the administrator needs to make some adjustments to the configuration.		After installation of both components ''readerengine'' and ''server'', the administrator needs to make some adjustments to the configuration.
	First, if this is a new installation, make sure that the node is allowing it's services to listen and be available for traffic. You can configure this by defining the "host to listen" in		First, if this is a new installation, make sure that the node is allowing it's services to listen and be available for traffic. You can configure this by defining the "host to listen" in
	/opt/open-xchange/etc/overwrite.properties:		/opt/open-xchange/etc/overwrite.properties:

Stx12: /* Introduction */

2019-10-25T09:44:49Z

Introduction

← Older revision		Revision as of 09:44, 25 October 2019
Line 6:		Line 6:
	Offering document preview functionality within OX App Suite, the user expects to be able to open as much different document formats as possible or - to get a better picture - she doesn't need to take care of the document format she just received. It should just work, without knowing anything about document formats at all.		Offering document preview functionality within OX App Suite, the user expects to be able to open as much different document formats as possible or - to get a better picture - she doesn't need to take care of the document format she just received. It should just work, without knowing anything about document formats at all.

	To offer such transparent behavior to the user, OX App Suite needs to take care of converting a lot of document formats into the display formats needed by OX Drive. OX Drive is extended with document preview functionality by the module OX Document Viewer.		To offer such transparent behavior to the user, OX App Suite needs to take care of converting a lot of document formats into the display formats needed by OX Drive. OX Drive is extended with document preview functionality by the module [[AppSuite:DocumentViewer\|OX Document Viewer]]. </br>
			DocumentConverter version 7.10.2-rev5 and higher support preview functionality in OX App Suite 7.6.3, 7.8.4 and 7.10.x.

	The conversion functionality is also available as stand-alone product OX Document Converter. The OX Document Converter Service allows customers the flexible integration of document conversion in their offering.		The conversion functionality is also available as stand-alone product OX Document Converter. The OX Document Converter Service allows customers the flexible integration of document conversion in their offering.

Stx12: /* Introduction */

2019-10-25T09:37:45Z

Introduction

← Older revision		Revision as of 09:37, 25 October 2019
Line 4:		Line 4:

	== Introduction ==		== Introduction ==
	Offering document preview functionality within ~~Open-Xchange~~ App Suite, the user expects to be able to open as much different document formats as possible or - to get a better picture - she doesn't need to take care of the document format she just received. It should just work, without knowing anything about document formats at all.		Offering document preview functionality within OX App Suite, the user expects to be able to open as much different document formats as possible or - to get a better picture - she doesn't need to take care of the document format she just received. It should just work, without knowing anything about document formats at all.

	To offer such transparent behavior to the user, OX App Suite needs to take care of converting a lot of document formats into the display formats needed by OX ~~Files~~. OX ~~Files~~ is extended with document preview functionality by the module OX Document Viewer.		To offer such transparent behavior to the user, OX App Suite needs to take care of converting a lot of document formats into the display formats needed by OX Drive. OX Drive is extended with document preview functionality by the module OX Document Viewer.

	The conversion functionality is also available as stand-alone product OX Document Converter. The OX Document Converter Service allows customers the flexible integration of document conversion in their offering.		The conversion functionality is also available as stand-alone product OX Document Converter. The OX Document Converter Service allows customers the flexible integration of document conversion in their offering.

Stx12: /* Configuration */

2019-10-25T09:26:26Z

Configuration

← Older revision		Revision as of 09:26, 25 October 2019
Line 42:		Line 42:

	After deployment of both components ''readerengine'' and ''server'', the administrator needs to make some adjustments to the configuration.		After deployment of both components ''readerengine'' and ''server'', the administrator needs to make some adjustments to the configuration.
	First, if this is a new AS installation, make sure that the node is allowing it's AS services to listen and be available for traffic. You can configure this by defining the "host to listen" in		First, if this is a new installation, make sure that the node is allowing it's services to listen and be available for traffic. You can configure this by defining the "host to listen" in
	/opt/open-xchange/etc/overwrite.properties:		/opt/open-xchange/etc/overwrite.properties:
	com.openexchange.connector.networkListenerHost=0.0.0.0		com.openexchange.connector.networkListenerHost=0.0.0.0

Stx12 at 09:05, 25 October 2019

2019-10-25T09:05:35Z

← Older revision		Revision as of 09:05, 25 October 2019
Line 47:		Line 47:
	Defined here as 0.0.0.0 as a wildcard address.		Defined here as 0.0.0.0 as a wildcard address.

	In order to enable users to use ~~the~~ functionality, they must be given the appropriate permission, i.e. use '''com.openexchange.capability.document_preview=true''' in the file '''/opt/open-xchange/etc/permissions.properties''' to set this globally, or use [[ConfigCascade\|ConfigCascade]].		In order to enable users to use [[AppSuite:DocumentViewer\|Preview functionality]], they must be given the appropriate permission in OX App Suite middleware properties, i.e. use '''com.openexchange.capability.document_preview=true''' in the file '''/opt/open-xchange/etc/permissions.properties''' to set this globally, or use [[ConfigCascade\|ConfigCascade]].

	The component readerengine works with the default configuration.		The component readerengine works with the default configuration.

Stx12: /* Server */

2019-10-25T08:32:49Z

Server

← Older revision		Revision as of 08:32, 25 October 2019
Line 38:		Line 38:

	See [[AppSuite:DocumentConverterAPIInstall\|Document converter API installation instructions]]		See [[AppSuite:DocumentConverterAPIInstall\|Document converter API installation instructions]]

	~~See [[AppSuite:DocumentConverterWSInstall\|Document converter Webservice instructions]]~~

	=== Configuration ===		=== Configuration ===

Kai.ahrens: /* Conversion Job Priority */

2019-09-13T16:46:31Z

Conversion Job Priority

← Older revision		Revision as of 16:46, 13 September 2019
Line 94:		Line 94:

	The set priority of a conversion job affects the sorting order of the conversion queue of the DocumentConverter. Conversion jobs with a higher priority will always be processed before jobs with a lower priority. Conversion jobs with the same priority are added to the queue in a time based, sequential order according to their set priority.		The set priority of a conversion job affects the sorting order of the conversion queue of the DocumentConverter. Conversion jobs with a higher priority will always be processed before jobs with a lower priority. Conversion jobs with the same priority are added to the queue in a time based, sequential order according to their set priority.

	Due to this fact and a possible high amount of other conversion jobs with a higher priority due to e.g. direct user interaction, the caller of a conversion request should ensure to set the appropriate priority with respect to her current conversion task. In case of conversion results, intended to be seen by the user as soon as possible, setting the highest conversion priority 'instant' should be taken into account in general.		Due to this fact and a possible high amount of other conversion jobs with a higher priority due to e.g. direct user interaction, the caller of a conversion request should ensure to set the appropriate priority with respect to her current conversion task. In case of conversion results, intended to be seen by the user as soon as possible, setting the highest conversion priority 'instant' should be taken into account in general.

Kai.ahrens: /* Conversion Job Priority */

2019-09-13T16:45:15Z

Conversion Job Priority

← Older revision		Revision as of 16:45, 13 September 2019
Line 85:		Line 85:
	The currently available priority parameter values in increasing order are:		The currently available priority parameter values in increasing order are:

	* background		* background
	* '''low'''		* '''low'''
	* medium		* medium
	* high		* high
	* instant		* instant

	In case no priority is set within the request, the default priority 'low' is used internally.		In case no priority is set within the request, the default priority 'low' is used internally.

Kai.ahrens: /* Processing Overwiew */

2019-09-13T16:39:43Z

Processing Overwiew

← Older revision		Revision as of 16:39, 13 September 2019
Line 77:		Line 77:

	After the conversion by one of the parallel running conversion engines of the DocumentConverter has finished, the result of the conversion is returned to the caller of the conversion request. The whole conversion process in this case is a synchronous process from the point of view of the caller.		After the conversion by one of the parallel running conversion engines of the DocumentConverter has finished, the result of the conversion is returned to the caller of the conversion request. The whole conversion process in this case is a synchronous process from the point of view of the caller.

			=== Conversion Job Priority ===
			In case of larger deployments with different document conversion demands like in the Appsuite case, it is often needed to specify some constraints wrt. the calling performance for conversion requests.
			E.g. in case of conversion requests as a result of direct user input within the frontend, the conversion result should be available as soon as possible for a better UI experience for the user.
			There are other scenarios for which there's no need for a fast conversion response, e.g. in case of a background pre conversion of documents, that are not visible for the customer at the moment of the conversion request.
			For such cases, the DocumentConverter provides a mechanism to set a priority at each conversion request via the 'priority' parameter.
			The currently available priority parameter values in increasing order are:

			* background
			* '''low'''
			* medium
			* high
			* instant

			In case no priority is set within the request, the default priority 'low' is used internally.

			The set priority of a conversion job affects the sorting order of the conversion queue of the DocumentConverter. Conversion jobs with a higher priority will always be processed before jobs with a lower priority. Conversion jobs with the same priority are added to the queue in a time based, sequential order according to their set priority.
			Due to this fact and a possible high amount of other conversion jobs with a higher priority due to e.g. direct user interaction, the caller of a conversion request should ensure to set the appropriate priority with respect to her current conversion task. In case of conversion results, intended to be seen by the user as soon as possible, setting the highest conversion priority 'instant' should be taken into account in general.

	== Setup And Best Practices ==		== Setup And Best Practices ==