Open-Xchange - User contributions [en]

AppSuite:Sharing and Guest Mode

2018-09-27T06:14:32Z

Malte:

<div class="title">Sharing and Guest Mode</div>

{{VersionFrom|7.8.0}}

__TOC__

== Introduction ==

Starting with v7.8.0, the Open-Xchange server comes with a whole new concept to share contents with external people, allowing guest users to interact with the shared data in the same way as regular groupware users do. This article describes the underlying technical implications and outlines the different use cases.

The main idea behind the new sharing concept is that guest users, i.e. external users without a regular account on the server, should be able to access the shared contents using the existing interfaces, especially the App Suite web interface. On the one hand, this includes consuming the shared data using the App Suite's advanced media viewing capabilities. On the other hand, this enables guests to edit existing as well as to create or upload new content in the groupware. Even real-time collaboration between internal users and guests in OX Documents is possible.

The following chapters cover different topics regarding sharing and guest users and try to describe some technical background and impact where hosters, administrators or integrators might be interested in.

== Creating Shares ==

Basically, creating a share means adding an additional permission entity to the shared folder or item. Previously, this was only possible for "internal" entities, i.e. regular users or user groups. Now, the underlying permission system has been extended to support external entities, which can be either invited guest users, or special "anonymous" guest users who access a shared folder or item via a secret link. Anonymous and invited guest users are explained in more detail below.

Sharing is available for the groupware modules Calendar, Contacts, Tasks and Drive (a.k.a. Infostore/Files). While the latter one also allows "writable" access for invited guest users, folders from the Calendar, Contacts and Tasks module may only be published in "read-only" mode to external guests.

=== Invite Guests ===

To share something to a guest user, it's possible to just add the e-mail address of the invitee as new permission entity for files and folders. The middleware then takes care to provision a new or reuse an existing account for the guest user, and equips him with the required permissions for accessing the contents. So, from a client's point of view, sharing something to a guest user is mostly the same process as sharing something to an internal user or group.

=== Share Links ===

Besides explicitly inviting a guest user to a share, it's also possible to just get a secret link for a folder or item. This will result in an additional "anonymous" guest entity in the permissions of the shared object, and will grant any user with the corresponding share link access the shared contents. To simplify the creation of share links, the clients will offer an additional "wizard" to quickly get a share link for a folder or item. Unlike invited guests which behave much like internal users, anonymous guest entities are strictly bound to the underlying folder or item, i.e. there is at most one anonymous permission entity per file or folder, as well as an anonymous permission entity can only be used for only once.

=== Required Permissions and Capabilities ===

Whether a user is allowed to create share links, invite external guests, or internal groups or users, depends on the following module access permissions and capabilities. Please note that share links no longer require <code>read_create_shared_folders</code> since Open-Xchange v7.8.1; this restriction was removed in order to allow simple publications also for non-groupware accounts, e.g. as defined by the <code>pim</code> or <code>pim_infostore</code> module access combinations.

==== v7.8.0 ====
* Create, update & remove share links: <code>read_create_shared_folders</code>, <code>share_links</code>
* Add, update or remove internal users and group permissions: <code>read_create_shared_folders</code>
* Add, update or remove external guest permissions: <code>read_create_shared_folders</code>, <code>invite_guests</code>

==== v7.8.1 ====
* Create, update & remove share links: <code>share_links</code>
* Add, update or remove internal users and group permissions in modules Calendar, Contacts, Tasks: <code>read_create_shared_folders</code> for personal / <code>edit_public_folders</code> for public folders
* Add, update or remove internal users and group permissions in module Drive: none
* Add, update or remove external guest permissions in modules Calendar, Contacts, Tasks: <code>invite_guests</code>, and <code>read_create_shared_folders</code>, <code>read_create_shared_folders</code> for personal / <code>edit_public_folders</code> for public folders
* Add, update or remove external guest permissions in module Drive: <code>invite_guests</code>

'''''Administrator Notes:'''''

* Existing shares for a guest user or context may be listed using the commandline utility <code>listshares</code>
* The ability to create share links may be controlled via <code>com.openexchange.capability.share_links</code>, either globally in the configuration file <code>permissions.properties</code>, or on a more fine-granular level through the [https://oxpedia.org/wiki/index.php?title=ConfigCascade Config Cascade]
* The ability to invite guest users may be controlled via <code>com.openexchange.capability.invite_guests</code>, either globally in the configuration file <code>permissions.properties</code>, or on a more fine-granular level through the [https://oxpedia.org/wiki/index.php?title=ConfigCascade Config Cascade]
* The number of allowed share links per user may be specified via <code>com.openexchange.quota.share_links</code>, either globally in the configuration file <code>share.properties</code>, or on a more fine-granular level through the [https://oxpedia.org/wiki/index.php?title=ConfigCascade Config Cascade]
* The number of allowed guest invitations per user may be specified via <code>com.openexchange.quota.invite_guests</code>, either globally in the configuration file <code>share.properties</code>, or on a more fine-granular level through the [https://oxpedia.org/wiki/index.php?title=ConfigCascade Config Cascade]
* Both quotas can also be set on a per-context basis via a 'changecontext' call and the <code>quota-module</code> and <code>quota-value</code> options, see [http://oxpedia.org/wiki/index.php?title=AppSuite:Context_management#changecontext]. The module IDs are accordingly <code>share_links</code> and <code>invite_guests</code>.
* Quotas are always checked per-user, per default both are set to 100. You'll probably want to increase the quota for links when enabling the link mail feature available with OX App Suite 7.8.2.

== Removing Shares ==

The lifetime of shares is implicitly bound to the lifetime of the associated permission of the guest user entity. So, once a permission entity pointing to a (named or anonymous) guest user account is removed from the parent folder or item, this also leads to the removal of the associated share itself. Afterwards, the contents are no longer accessible for the guest user. For shares that were created with a specific expiry date, it is ensured that they can no longer be accessed via their share link after expiring. Additionally, expired shares are cleaned up periodically within a background task.

'''''Administrator Notes:'''''

* Shares may be revoked manually using the commandline utility <code>removeshares</code>
* The interval of the periodic cleanup task can be controlled via <code>com.openexchange.share.cleanup.periodicCleanerInterval</code> in <code>share.properties</code>

== Share Links & Tokens ==

Shares are accessed with a hyperlink that contains the so-called share "token". This 24-byte token uniquely identifies the associated guest account on the system, and carries enough randomness that it can't be guessed. Explicitly invited guest users receive this hyperlink in the invitation mail to a share, while in case of an "anonymous" share where just the link itself was generated, it's up to the sharing user to distribute the link on his own. Besides the token, a share link may contain an additional path that points to the concrete folder and item, which just aids to jump to the shared item in the web interface directly. The following shows an example of a share link:

<code>https://share.example.com/ajax/share/48b2b6190151f1bd8b4b610151f0405d9fc8cb89a087f14e/1/2/ODAxMDY</code>

If a guest user has been invited to more than one share in a context (based on his e-mail address), his individual share token remains equal, so that he will have access to all shared contents in the web interface after following any of the share links he received. However, the additional "path" still points to the concrete item. When inviting more than one guest user to the same share, each recipient will get his own individual share link.

Once the share URL is requested from the server, the associated guest account is looked up and, depending of the guest type, the request is redirected to a specific login screen or directly into the App Suite web interface. More details regarding the different login modes are described at [[#Guest_Login_&_Session_Handling|Guest Login & Session Handling]].

After a share has been revoked (either explicitly, by removing the permission, or if the share is expired), share links can't be accessed any longer, and, after the last share for the guest user was removed, the guest account is removed from the system automatically.

'''''Administrator Notes:'''''

* The share token is stored as user attribute <code>com.openexchange.shareBaseToken</code> in the corresponding guest user account
* The target database schema for a share and the associated guest account is extracted from the context identifier encoded in the share token

== Guest Users ==

As outlined above, guest users are created on demand once something is being shared. We basically distinguish between two types of guest users: Those that were invited explicitly by the sharing user, or "anonymous" guest users that are able to access by visiting the share link. Access for the latter one may optionally be secured with a fixed PIN code.

For both kinds of guest users, a corresponding user account is provisioned dynamically on the system once a new share is created. Such a guest account is handled much similar as an account for a regular user, with the following main exceptions:

* No access to the "Mail" module
* No personal folders
* No access to the "Portal"
* No access to the global address book
* Module access is restricted to only include modules from the actual shares

All those restrictions are configured and enforced using the built-in mechanisms of the Open-Xchange Server, i.e. by a reduced set of capabilities (i.e. module permissions), or by selectively set permission bits in the folder tree for the virtual guest group. This ensures that guest users are only able to access things they explicitly have been invited to, as well as a transparent handling of guest accounts within all subsystems.

'''''Administrator Notes:'''''

* Guest users are stored much similar as regular users in the database (tables <code>user</code>, <code>prg_contacts</code>, <code>user_attribute</code>, <code>user_configuration</code>)
* Additionally, the identifier of the user who (initially) created the guest account is stored in <code>user.guestCreatedBy</code>, i.e. if this column is not <code>0</code>, this entry refers to a guest user
* All service calls and APIs that list or search users have been adjusted to be "guest-aware", i.e. by default, guests users are not included in the output, yet may be included explicitly with additional parameters (namely <code>includeGuests</code> and <code>excludeUsers</code>)
* Service calls and APIs that request data explicitly based on an entity's identifier are also working with guest users, i.e. if a specific idnetifier points to a guest, then the referenced guest data is returned

=== Capabilities ===

Guest users always have the <code>guest</code> capability set. Besides they are generally configured with a limited permission set, that allows them just to work with their shared items. This permission set includes:

{|
!Permission
!Capability
!Details
|-
|<code>deniedportal</code>
|
|No <code>portal</code> capability
|-
|<code>editpublicfolders</code>
|<code>edit_public_folders</code>
|
|-
|<code>readcreatesharedfolders</code>
|<code>read_create_shared_folders</code>
|
|-
|<code>editpassword</code>
|<code>edit_password</code>
|Only for invited guests, not links
|}

Additionally, for every module the guest is having shared items in, the according module permission is granted, e.g. a shared drive folder results in permission <code>infostore</code> and the according capability. Guest users are never allowed to share folders or items on their own, i.e. the capabilities <code>share_links</code> and <code>invite_guests</code> can never be set.

'''''Administrator Notes:'''''

This limited capability set can be extended by configuration. Currently three modes are supported:

{|
!Mode
!Description
|-
|deny_all
|No further capabilities are applied to guest users, except ones that have been explicitly set for the guest user via <code>changeuser --capabilities-to-add</code>.
|-
|static
|A static list of capabilities is applied to guest users via the <code>com.openexchange.share.staticGuestCapabilities</code> property. Additionally capabilities that have been explicitly set for the guest user via <code>changeuser --capabilities-to-add</code> are applied.
|-
|inherit
|All capabilities of the user who "created" the guest, i.e. created the link or initially invited somebody, are applied to the guest user. Additionally capabilities that have been explicitly set for the guest user via <code>changeuser --capabilities-to-add</code> are applied.
|}

The mode can be configured via the <code>com.openexchange.share.guestCapabilityMode</code> property in <code>share.properties</code>. This property is config-cascade capable, so it can for example be overridden for certain sets of contexts. The same applies to the <code>com.openexchange.share.staticGuestCapabilities</code> property.

Due to this configuration mechanism it is possible to increase the user experience for guests and even allow some real collaboration. As an '''example''' one could apply the following configuration to allow guests to see preview images of files and edit shared documents with OX Documents:

<pre>com.openexchange.share.guestCapabilityMode = static
com.openexchange.share.staticGuestCapabilities = document_preview, text, spreadsheet, presentation</pre>

=== Anonymous Guest Users ===

If a "share link" is created, this results in an implicit creation of an anonymous guest user account on the server. The "secret" to access the shared contents is the share token itself that is encoded in the generated share link, so that everybody that knows the share link is able to access the shared contents. Optionally, such an anonymous share link may be secured with an additional PIN code. Guest users will be prompted to enter this PIN code when attempting to access the share.

To have a strict separation between different shared contents, each time a folder or item is shared using the "Get a link" method, a designated anonymous guest account for this share is used. Consequently, each time such an anonymous share is revoked, this guest account is terminated again with no further delay. Additionally, such an anonymous guest entity can only be applied to the permission set of the folder or item the original link was created for, i.e. it's not possible to add more shared contents to an anonymous guest - in contrast to an invited, named guest user.

Besides the common restrictions for guest accounts outlined above, the following applies for anonymous guest user accounts:

* No e-mail address or display name
* No password, if no PIN was assigned by the sharing user
* A password that may only be changed by editing the link, if a PIN code was set
* Anonymous guest users may only receive "read-only" access permissions to the shared item
* Optionally, an expiry date can be applied for an anonymous guest user after which the share link is no longer accessible

'''''Administrator Notes:'''''

* The PIN code for anonymous guest users is stored using symmetrical encryption in the database, therefore, an encryption key needs to be specified via the property <code>com.openexchange.share.cryptKey</code> in <code>share.properties</code>

=== Named Guest Users ===

Internal users are able to invite a guest user to a folder or item explicitly by specifying the e-mail address of the recipient. Such "named" guest users are internally stored as individual guest users, identified by their e-mail address.

If data is shared for the first time to the recipient in the context, a new guest user account is provisioned and an initial set of user permissions and capabilities is assigned. In case there are already shares in different contexts to the same recipient (based on his e-mail address), some existing user data like a display name or an assigned password is copied over if a cross-context database is available on the system.

If the recipient has already been invited from the same or another internal user in the context to another share before, the new share is added to the guest user in a way that the underlying folder- and object permissions are taken over, and the user capabilities getting expanded as needed to cover all modules the shares are located in. Similarly, if a share to a named guest user is revoked and the underlying folder- and object-permissions are removed, the guest user capabilities are updated implicitly to reflect the modules of the remaining shares.

After the last share to a named guest user has been revoked, the user has no longer access to any data. The account itself gets removed from the context automatically after a configurable expiry time. Additionally, any data that is stored for the guest user in the cross-context database is removed once the guest user has been deleted from all contexts in the system.

In contrast to an "anonymous" guest user, a named guest user has access to all shared items from a context after logging in, since the permissions get added to an existing guest user account automatically. For entering the web interface, he may use any of the share links that were sent to him in the different notification messages. Those links usually point to an individual share target like a folder or file, but the guest user may navigate to the other shared contents using the folder tree of the web interface in the same way as regular groupware users do. Similarly, if the guest user has access to shares from different modules, the modules can be switched in the web interface as usual.

'''''Administrator Notes:'''''

* The timespan after which an unused named guest user should be removed from the system can be configured via <code>com.openexchange.share.cleanup.guestExpiry</code> in <code>share.properties</code> - this value may also be set to <code>0</code> to force an immediate removal
* For the removal of no longer needed guest user accounts, a periodical cleanup task is scheduled based on the interval of <code>com.openexchange.share.cleanup.periodicCleanerInterval</code>
* Whether a cross-context database is considered for guest users may be configured via <code>com.openexchange.share.crossContextGuests</code>

== Guest Login & Session Handling ==

Based on the underlying guest user account, different login operations with different authentication workflows are possible.

=== Authentication ===

We have basically three different authentication options for guest users accessing a share, each of them having their own characteristics.

==== Anonymous ====

* Access is granted without providing additional authentication information, the knowledge of the link is sufficient
* When accessing the share link, a guest session is spawned implicitly
* Initially supplied cookies are considered to recycle an existing session
* The login screen is skipped, we'll redirect to the module/folder/item directly (using appropriate URL fragments)

==== Anonymous with PIN ====

* Access is granted for anonymous guest users providing a password / PIN code
* When accessing the share link, the client is redirected to the login screen of the webinterface, using <code>login_type=anonymous</code>
* User can then enter his PIN code, client executes the <code>anonymous_login</code> method, server authenticates, sends back a login response containing the target in the app suite webinterface (module/folder/item)
* Password can't be changed by an anonymous user
* Password can be re-constructed / changed by sharing user

==== Guest without Password ====

* Access is granted without providing additional authentication information, the knowledge of the guest's individual link is sufficient
* When accessing the share link, a guest session is spawned implicitly
* Exiting cookies are considered to recycle an existing session
* The login screen is skipped, we'll redirect to the module/folder/item directly (using appropriate URL fragments)
* Guest user may choose an individual password at a later stage

==== Guest with Password ====

* Access is granted for guest users providing a user name and password.
* Much similar to a regular groupware user
* When accessing the share link, the client is redirected to the login screen of the webinterface, using <code>login_type=guest</code> and <code>login_name=<NAME></code>
* The login name is used to pre-fill the username input
* User can then enter his password, client executes the <code>guest_login</code> method, server authenticates, sends back a login response containing the target in the app suite webinterface (module/folder/item)
* Password can be changed by guest user
* Guest user may reset his password if he can't remember

=== Guest Hostname ===

For serving shares, a separate guest hostname needs to be configured. This is mainly required to prevent guest- and regular user sessions using the same cookie container when logged in in the same client (otherwise, the cookie holding the alternative session identifier as well as other cookies would get overwritten concurrently). Additionally, this allows to have separate entry points to the web client for guest- and regular users.

The hostname for guests is used when generating external share links, as well as at other locations where hyperlinks are constructed in the context of guest users. Usually, the guest hostname refers to a separate subdomain of the installation like <code>share.example.com</code>, and is defined as an additional named virtual host pointing to the web client's document root in the webserver's configuration.

Once the webserver configuration is done and the web client is accessible using the guest hostname, this hostname needs to be specified in the backend configuration, too. In simple scenarios, where a fixed guest hostname should be used for the installation, this can be done statically in a configuration file. This setting may also be overridden per context via the Config Cascade. In case a dedicated hostname service is installed (for example <code>open-xchange-hostname-ldap</code>), this hostname service is also supposed to supply the guest hostname.

'''''Administrator Notes:'''''

* The guest hostname may be specified via <code>com.openexchange.share.guestHostname</code>, either globally in the configuration file <code>share.properties</code>, or on a more fine-granular level through the [https://oxpedia.org/wiki/index.php?title=ConfigCascade Config Cascade]
* The guest hostname may also be supplied via dedicated hostname services like <code>open-xchange-hostname-config-cascade</code> or <code>open-xchange-hostname-ldap</code>
* For test purposes, guests may also access the web interface using the same host as regular users do, however, this might lead to unexpected results (missing images, sessions timing out, auto-login malfunction...)

=== Cookies ===

Guest sessions basically make use of the same cookies as regular user sessions do. This includes the JSESSONID cookie for the JVM route, as well as the <code>open-xchange-secret-<hash></code> and <code>open-xchange-public-session-<hash></code> cookies. Additionally, if configured, the client may also issue a <code>store</code> request to persist the open-xchange-session-<hash> cookie. This cookie may then be used to auto-login the guest client into the previously used session if it is still valid.

Besides the common cookies, another special cookie is set: <code>open-xchange-share-<hash></code>. The value contains the unique share token bound to the guest user accessing the share. here, the cookie hash is calculated as it's done for ordinary sessions, so that there can only be one <code>open-xchange-share-<hash></code> cookie in a client at the same time. Whenever an auto-login request is issued by the client, the server checks for the existence of this "share" cookie, and, once recognized and checked for validity, it will try to perform the auto-login for an existing guest session first, i.e. using the session cookie based on the special guest hash calculation outlined above. Otherwise, the common auto-login process takes place. The "share" cookie is removed once the guest session terminates, i.e. the guest user logs out.

Since guest users access the web interface on a separate (sub)domain (see [[#Guest_Hostname|Guest Hostname]] above for details), guest session cookies won't interfere with cookies of a regular session on the same client. This allows to use the regular user session as well as one or more guest sessions in parallel - e.g. if the sharing user quickly wants to check how the contents appear for the guest user after generating a share link.

'''''Administrator Notes:'''''

* Whether guest sessions are enabled for auto-login is configurable via the property <code>com.openexchange.share.autoLogin</code> in <code>share.properties</code>
* By default, the cookie TTL for guest sessions is inherited from the TTL for cookies of regular sessions as defined by <code>com.openexchange.cookie.ttl</code> - this default may be overridden by defining a timespan at <code>com.openexchange.share.cookieTTL</code>

=== Login Modes ===

When accessing a share link, one of the following login modes is triggered to acquire a session and forward the client to the share target. The executed login operation and redirect depends on the authentication mode of underlying guest account, the share target iteself, and the client accessing the share.

==== Redirect to Target ====

In case a share is accessible without providing credentials, the client is redirected to the share target directly, i.e. without prompting for a username or password. By default, the client is redirected to the target in the App Suite web interface by responding the <code>GET</code> request to the share link with <code>HTTP 302</code>, and a location header like the following:

<code>Location: /appsuite/ui#!&session=80c711019d6f48b5bec9cd82758e3308&store=true&user=&user_id=642&context_id=1&m=files&f=41042</code>

The session for the guest user is created implicitly in the backend after checking the share link's validity, and the client is instructed to store appropriate cookies in the redirect response, including the "share" cookie:

<code>Set-Cookie: open-xchange-secret-aNobP2G9wLHJ6sMr7vtTA=38ee770d6e4f42ab8366d91db3279931; Expires=Thu, 13-Aug-2015 06:16:26 GMT; Path=/; Secure; HttpOnly</code> 
<code>Set-Cookie: open-xchange-public-session-d0759656127fb7cee6e0fe8bb5fe19f9=cae6a3e712ac429e9da9194abd389cb3; Expires=Thu, 13-Aug-2015 06:16:26 GMT; Path=/; Secure; HttpOnly</code> 
<code>Set-Cookie: open-xchange-share-b7gDSqJpnh9gS3Fs52I65Q=0ad50ac00418fbcdad50ac1418f94fb181d51b8fa7b2bde3; Expires=Thu, 13-Aug-2015 06:16:26 GMT; Path=/; Secure; HttpOnly</code>

==== Redirect to Login Screen ====

If additional credentials, i.e. an additional PIN code or username/password combination, are required to access a share target, and no "special client" like an iCal consumer is detected by the backend, the client is redirected to the login screen of the app suite webinterface. The GET request to the share link is answered with statuscode HTTP 302, and a location header depending on the required credentials to access the share.

If the share ought to be accessed anonymously, but protected by a PIN code, a location like the following is added to the response header:

<code>Location: /appsuite/ui#!&share=08b4b6110151f1bd7d4b610151f0405d9fc8bb89a887f04e&login_type=anonymous&message_type=INFO&message=Tony%20Parker%20has%20shared%20the%20folder%20%22Pictures%22%20with%20you.%20Please%20log%20in%20to%20view%20it.%20&target=151ebb38</code>

For shares to dedicated guest users identified by their e-mail address, the redirect location looks like follows:

<code>Location: /appsuite/ui#!&share=4ac9eb590f9ca4d2ac9eb58f9ca611ec9b4f4638d288c8c0&login_type=guest&message_type=INFO&message=Tony%20Parker%20has%20shared%20the%20file%20%22Agenda.pdf%22%20with%20you.%20Please%20log%20in%20to%20view%20it.%20&login_name=ray%40example.com&target=4444cbc7</code>

The redirect response already contains the <code>Set-Cookie</code> header for the JVM route. On the redirect target, the client should request the PIN code or password from the user, and then issue a special login request, supplying the share token and optional target from the URL parameters, and the password as URL encoded form data in the request body, similar to the usual login request via POST. After successful authentication, the login response includes, along with the common login response properties like the session identifier, information about the share target being accessed:

<code>{"session":"b89af2c2ce494ce4b4573c0632b48e89","user":"ray@example.com","user_id":660,"context_id":1,"locale":"en_US","module":"files","folder":"10","item":"10/456398", ... }</code>

Additionally, the client is instructed to store the secret cookies:

<code>Set-Cookie: open-xchange-share-b7gDSqJpnh9gS3Fs52I65Q=0ac9eb590f9ca4d5ac9eb58f9ca641ec9b4f4638d288c8a0; Expires=Thu, 13-Aug-2015 06:31:21 GMT; Path=/; Secure; HttpOnly</code> 
<code>Set-Cookie: open-xchange-secret-MBIRg9bJBLduCcosqQBCw=70187de16f844be6880c18be373b953d; Expires=Thu, 13-Aug-2015 06:31:21 GMT; Path=/; Secure; HttpOnly</code> 
<code>Set-Cookie: open-xchange-public-session-d0759656127fb7cee6e0fe8bb5fe19f9=4e797a59758a4dd7b763912472ccf26d; Expires=Thu, 13-Aug-2015 06:31:21 GMT; Path=/; Secure; HttpOnly</code>

Afterwards, the client is able to use the session to access the share target as usual.

=== Session Lifecycle ===

Generally, guest sessions on the server are treated just like the sessions of ordinary users. Especially, guest sessions are also held in the local session containers of the backend host they're associated with. However, by default guest sessions are marked as <code>transient</code>, i.e. they are not moved to the long-term session containers, nor they are put into the distributed session storage.

If OX Documents functionality is used for guest users in a cluster of application servers, this setting needs to be adjusted to <code>false</code> in order to also have guest sessions available in the distributed storage.

'''''Administrator Notes:'''''

* Guest sessions are also accounted in the monitoring outputs (e.g. in the sessions per container graphs)
* The <code>transient</code> handling of guest sessions may be changed via the property <code>com.openexchange.share.transientSessions</code> in <code>share.properties</code>

=== Logout ===

Guest sessions are terminated once a logout request is issued by the client, i.e. the user clicks the "Logout" button in the web interface, just like it is done for regular sessions. Additionally, guest sessions expire in the backend when not being used for a while, the actual timeout depends on the configured default session lifetime and whether they are treated as "transient" or not, as explained above.

Since guest users are not able to use the default login page for regular users, a custom logout location for guest users should be specified where guest users are taken to after clicking logout explicitly, or if their session expired.

If a share is consumed "directly", e.g. by downloading the binary contents of a file share directly (see [[#Consuming_Shares|Consuming Shares]] for details), the guest sessions is terminated instantly after serving the request.

'''''Administrator Notes:'''''

* The logout location for guest accounts can be customized via <code>guestLogoutLocation</code> in the file <code>as-config.yml</code> (see file <code>as-config-default.yml</code> for an example)

== Share Notifications ==

With the new sharing concept, notification mails can be sent out to the permission entities (i.e. internal or guest users) of folders or items. Mechanisms exist to send out such mails implicitly or explicitly. Notifications are sent out implicitly, if externals are invited as guests and can also be sent out for internal invitations, if configured so. The client (e.g. App Suite UI) decides on its own whether implicit notifications shall be sent when updating a folders or items permissions. Besides there are separate API calls for sending out notification messages explicitly. Its on the client to provide this functionality to its users. This makes it possible to re-send a link to a folder or item to an existing permission entity.

Sending out links to shared folders and items is not the only case for notification messages, it can also be necessary to send out system notifications to guest users. Currently this is the case when a guest user secured his account with a password and needs to reset that password, because he cannot remember.

'''''Administrator Notes:'''''

* A special transport must be configured for system notifications and cases where the sharing user has no configured webmail account. This transport is configured in <code>noreply.properties</code>. All properties therein are config-cascade capable, so their values can be sensitive to the current user or context.
* It is possible to disable the implicit notification of internal users about shared folders or items at all by setting <code>com.openexchange.share.notifyInternal</code> in <code>share.properties</code> to <code>false</code>.
* The layout of notifications mails can be changed via <code>as-config.yml</code>. All available properties are defined and explained in <code>as-config-defaults.yml</code>.

== API Access ==

From a client's point of view, guest users basically don't differ from regular users, although they usually have limited capabilities, for example no mail access or no personal folders. However, all those differences are reflected within the regular permission- and capability-concepts, so that existing clients, once the guest user is authenticated and has a valid session, continue to work transparently, and use the same API calls as with a regular groupware user.

To create or manage shares and guest users, the HTTP API has been extended at various locations. The following list gives an overview about the changes, derived from the corresponding software change requests.

=== Format change for object identifiers of the default "infostore" account ===

As preparation for individual object permissions where a file can be accessed from different folder "views", the object IDs for documents in the default "infostore" file storage account will get enhanced with the prefixing folder ID.

The identifiers will now be of format <code><some numbers>/<more numbers></code>. Object identifiers are already of type <code>String</code>, so this change should usually be transparent to clients. However, there may be some clever clients out there that for example tried to interpret the string of numerical characters as number, so client developers should double-check their implementation for compatibility. They most likely would run into trouble when coping with non-infostore file storages anyway.

=== Object permissions for files ===

In order to define permissions on object-level, a new property <code>object_permissions</code> for objects of type <code>infoitem</code> is introduced. Each time the underlying folder permissions are not sufficient to access an item, those object permissions are taken into account. Object permissions are stored as an array of Object Permission objects as defined below within the detailed infoitem data, the column ID is <code>108</code>.

Details about the JSON structure are available at:

* [http://oxpedia.org/index.php?title=HTTP_API#DetailedInfoitemData HTTP API: Detailed Infoitem Data]
* [http://oxpedia.org/index.php?title=HTTP_API#ObjectPermissionObject HTTP API: Object Permission Object]
* [http://oxpedia.org/index.php?title=HTTP_API#ObjectPermissionFlags HTTP API: Object Permission Flags]

=== New field for "user" data: "guest_created_by" ===

A new property has been introduced for users that needs to be exposed in our HTTP API, too. The following property is added to the detailed user data object:

* ID: 616
* Name: guest_created_by
* Type: Number
* Value: Contains the ID of the user who has created this guest in case this user represents a guest user; it is 0 for regular users

The property is read-only and can't be removed or set by clients.

See also:

* [http://oxpedia.org/index.php?title=HTTP_API#DetailedUserData HTTP API: Detailed User Data]

=== Extend folder- and object permissions for addressing external guests ===

For sharing files- or folders to external guests, the folder- and object permission objects are extended with additional properties. Those extended properties can be set during creation or update of the parent folder or file. The underlying shares and guest user entities for the referenced recipients are created automatically along with folder/file creation/update. Afterwards, the external recipients appear as regular "user" entities in the permission arrays in subsequent "get" requests.

Details about the extended JSON structure are available at:

* [http://oxpedia.org/index.php?title=HTTP_API#PermissionObject HTTP API: Permission Object]
* [http://oxpedia.org/index.php?title=HTTP_API#ObjectPermissionObject HTTP API: Object Permission Object]

=== New Ajax module: share/management ===

To work with shares, a new Ajax module is introduced.

The available actions in the module are described at:

* [http://oxpedia.org/index.php?title=HTTP_API#Module_.22share.2Fmanagement.22_.28preliminary.2C_available_with_v7.8.0.29 HTTP API: Module share management]

=== New column "shareable" in detailed infoitem data ===

Clients want to know quickly if an infostore item is shareable or not. A new (read-only) property named <code>shareable</code> of type Boolean with column identifier <code>109</code> is introduced for "detailed infoitem data". If "true", the can be considered as shareable, i.e. the item's object permissions may be adjusted by the user.

Further details are available at:

* [http://oxpedia.org/index.php?title=HTTP_API#DetailedInfoitemData HTTP API: Detailed Infoitem Data]

=== New action "shares" in module folder ===

To provide an overview of all folders of a certain modules that are shared to others, a new <code>shares</code> action is added to the Ajax module <code>folders</code>. It returns all personal folders of a certain module that are shared to other entities.

Further details are available at:

* [http://oxpedia.org/index.php?title=HTTP_API#Get_shared_folders_.28Since_7.8.0.2C_Preliminary.29 HTTP API: Get shared folders]

=== New action "shares" in module infostore ===

To provide an overview of all files that are shared to others, a new <code>shares</code> action is added to the Ajax module <code>infostore</code>. It returns all personal files that are shared to other entities.

Further details are available at:

* [http://oxpedia.org/index.php?title=HTTP_API#Get_shared_infoitems_.28Since_7.8.0.2C_Preliminary.29 HTTP API: Get shared infoitems]

=== New fields to retrieve extended permissions of files and folders ===

Clients would like to have more details about permission entities folders directly. A new read-only property named <code>com.openexchange.share.extendedPermissions</code> is introduced for "Detailed folder data", with column identifier <code>3060</code>. It basically contains the same as the regular <code>permissions</code> array, yet enhanced by resolved information about the user, group or guest entities as well as additional, sharing-related properties.

Similarly, a new read-only property named <code>com.openexchange.share.extendedObjectPermissions</code> is introduced for "Detailed infoitem data", with column identifier <code>7010</code>. It basically contains the same as the regular <code>object_permissions</code> array, yet enhanced by resolved information about the user, group or guest entities as well as additional, sharing-related properties.

Further information about the JSON structure is available at:

* [http://oxpedia.org/index.php?title=HTTP_API#ExtendedPermissionObject HTTP API: Extended Permission Object]
* [http://oxpedia.org/index.php?title=HTTP_API#ExtendedObjectPermissionObject HTTP API: Extended Object Permission Object]

== Consuming Shares ==

Depending on the shared contents and the requesting user agent, shares may be consumed in a couple of different ways. The concrete response to a request to the share URL is evaluated by the share servlet in the backend.

=== App Suite ===

The default handling for all shares is forwarding them to the App Suite web interface, where the shared contents are made available through the existing client. Based on the underlying guest account, the client is either forwarded to the login prompt, or taken directly to the share target if no credentials need to be provided. This process is described in more detail at [[#Guest_Login_&_Session_Handling|Guest Login & Session Handling]].

=== Direct Download ===

Shares to a single file may also be downloaded directly by clients, without opening them in the web interface first. This is indicated by an additional parameter appended to the plain share link, and can be specified in the following ways:

* Append <code>dl</code> parameter: 
<code>https://ox.example.com/ajax/share/48b2b6190151f1bd8b4b610151f0405d9fc8cb89a087f14e/151eab38?dl=true</code>
* Specify <code>delivery</code> parameter: 
<code>https://ox.example.com/ajax/share/48b2b6190151f1bd8b4b610151f0405d9fc8cb89a087f14e/151eab38?delivery=download</code>

If accessing the item requires authentication, an unauthenticated request is responded with <code>HTTP 401 Unauthorized</code>. The client then has to provide the correct credentials to access the share via basic authentication. If there's no dedicated username for the underlying guest account - i.e. an "anonymous" share link protected with a PIN code is accessed - only the password is checked, i.e. the client may then supply an arbitrary username in the basic authentication header like "Guest".

=== Get iCal ===

Shares to a single calendar- or task-folder may also be downloaded directly by clients as iCal files, without opening them in the web interface first. This standard format allows to consume event data directly using various calendaring clients, which often can be configured to subscribe an external calendar source.

Once a share link to a calendar- or task-folder is requested by the client, the <code>Accept</code>- and <code>User-Agent</code> headers of the request are evaluated. If the <code>Accept</code> header is either set to <code>text/calendar</code> or <code>text/iCal</code>, or if the <code>User-Agent</code> header denotes a well-known client like Microsoft Outlook or Mozilla Thunderbird w/ Lightning, the contents of the shared folder are converted to an iCal file that is directly written back in the response.

To force the iCal output, an additional parameter may be appended to the plain share link:

* Append <code>ical</code> parameter: 
<code>https://ox.example.com/ajax/share/48b2b6190151f1bd8b4b610151f0405d9fc8cb89a087f14e/151eab38?ical=true</code>

If accessing the item requires authentication, an unauthenticated request is responded with <code>HTTP 401 Unauthorized</code>. The client then has to provide the correct credentials to access the share via basic authentication. If there's no dedicated username for the underlying guest account - i.e. an "anonymous" share link protected with a PIN code is accessed - only the password is checked, i.e. the client may then supply an arbitrary username in the basic authentication header like "Guest".

'''''Administrator Notes:'''''

* The interval of task- and appointment data considered for conversion to iCal can be adjusted via <code>com.openexchange.share.handler.iCal.futureInterval</code> and <code>com.openexchange.share.handler.iCal.pastInterval</code> in configuration file <code>share.properties</code>

== Cross-context functionality ==

As already mentioned in previous sections the administrator is able to configure if guests should be handled per context (default) or server wide by using the configuration parameter <code>com.openexchange.share.crossContextGuests</code>.

If set to <code>true</code> the guests email address is used to recognize if there is already a registered user with the given address and aligns the stored password to the already existing guest user. In addition to the password (which is the most important parameter this feature is about) even the users contact data gets synchronized.

'''''Administrator Notes:'''''

* To handle user and contact data across contexts boundaries the feature has to be enabled before a guest receives the first share. Guests that receive shares before the activation cannot be considered within the alignment process. Only latter shares will be considered.
* At the moment this feature does only sync user and contact related data (no shared content). If the user got two shares from different contexts he will only see shares related to the given link.

== Publish/Subscribe vs. Sharing ==

The upcoming sharing features are going to replace the previously used OXMF "publications", allowing guest users to interact with the shared data in the same way as regular groupware users do. However, since the underlying concepts and their technical realization are completely different, a seamless migration between publications and shares is not possible without some drawbacks.

The following list gives an overview of the main discrepancies:

* Custom templates for OXMF publication targets An adminsitrator/admin may have defined some custom publication targets that are using the published data in a special way. While shares would still make all the data available (mainly via the web interface), this would only be a drop-in replacement for the ordinary "view the publication in a browser" use case, but not for anything beyond that scope.
* Subscribe of publications Publications from one user can be added to another user's groupware using the "subscribe" functionality, making use of the embedded microformat data of publications (OXMF). For sharing, we will not have a similar feature in the first iteration, so migrating an existing publication to a share would also stop it from being subscribable.
* Deep links to download files of publications Files behind an infostore publication were accessible behind a static URL, which would theoretically allow them to be requested independently of the parent publication (e.g. images linked from an external website). While the entry URL to a publication would be mappable to a corresponding share URL, converting existing publications to shares would at least break such deep links.

Because of the above points and the whole different concept, we do not migrate existing publications to shares. Instead, the default behavior will be:

* No new OXMF publications or subscriptions can be created by default
* The web client does no longer give the option to publish or subscribe in the OXMF format
* Existing OXMF publications / subscriptions can't be updated
* Existing OXMF publications continue to work as is, including associated subscriptions
* Yet it's still possible to delete existing publications and subscriptions
* Therefore, the menu section "Publications and Subscriptions" will still be available (if there's at least one publication or subscription)

Exceptions to these rules cover special internal subscriptions to 3rd party services like addressbooks from LinkedIn (removed since 7.10.0) or Xing, as well as the auto-publish feature of mail attachments exceeding a specific size.

'''''Administrator Notes:'''''

* The possibility to create/update OXMF publications via HTTP-API may be configured via <code>com.openexchange.publish.createModifyEnabled</code> in file <code>publications.properties</code>
* The possibility to create/update OXMF subscriptions via HTTP-API may be configured via <code>com.openexchange.subscribe.microformats.createModifyEnabled</code> in file <code>microformatSubscription.properties</code>

== Limit file accesses for named/anonymous guests (since 7.8.2) ==

As links to shares might be shared without knowing the audience we introduced a mechanism to prevent abuse.

Therefor the possibility to define size and/or count limits for named/anonymous guests has been introduced. As internal users can be considered as reliable it is not possible to define limits for them.

For named and anonymous guests there are two kinds of limits which apply to a defined time frame. The time frame acts as a sliding time window which means that based on the current request all earlier requests matching the time frame are cumulated and evaluated if one of the two limits is exceeded. If so, the request will be answered with an exception.

The two limits mentioned above are:

* size limits: how many content (in bytes) should the guest be allowed to download (within the defined time frame).
* count limits: how often should the guest be allowed to download a file or folder (within the defined time frame).

Named and anonymos guests can have different limits. Limits are valid for downloads of files and folders. Preview of images is not considered within the limit.

'''''Administrator Notes:'''''

* The anti-abuse mechanism will be available after updating the package open-xchange-core to release 7.8.2
* Additional parameters are located within the configuration file <code>share.properties</code>
* Per default the feature is disabled
* To enable the feature you have to set <code>com.openexchange.share.servlet.limit.enabled</code> to <code>true</code>. If not enabled all additional checks will be skipped. If you would like to set limits via config cascade those will only be checked if the feature itself is enabled.
* To be more flexible the administrator is able to overwrite limits by using the config cascade. As guests do not have fixed user identifiers only the 'context' level scope is supported.

After the feature is enabled you have the ability to configure fine-grained accesses via:
* <code>com.openexchange.share.servlet.limit.timeFrame.guests</code>: sliding time frame (in milliseconds) the limits are valid for named guests. Setting to 0 will disable the check for named guests (if not overwritten via config cascade).
* <code>com.openexchange.share.servlet.limit.timeFrame.links</code>: sliding time frame (in milliseconds) the limits are valid for anonymous guests. Setting to 0 will disable the check for anonymous guests (if not overwritten via config cascade).
* <code>com.openexchange.share.servlet.limit.size.guests</code>: the limit in bytes for named guests (valid for aboves time frame). Setting to 0 will disable the size check for named guests (if not overwritten via config cascade).
* <code>com.openexchange.share.servlet.limit.size.links</code>: the limit in bytes for anonymous guests (valid for aboves time frame). Setting to 0 will disable the size check for anonymous guests (if not overwritten via config cascade).
* <code>com.openexchange.share.servlet.limit.count.guests</code>: the limit for a number of downloads (valid for aboves time frame) for named guests. Setting to 0 will disable the count check for named guests (if not overwritten via config cascade).
* <code>com.openexchange.share.servlet.limit.count.links</code>: the limit for a number of downloads (valid for aboves time frame) for anonymous guests. Setting to 0 will disable the count check for anonymous guests (if not overwritten via config cascade).

=== Example configurations ===

A mixed configuration is possible. Have a look at the following examples assuming that <code>com.openexchange.share.servlet.limit.enabled</code> is set to <code>true</code>.

The following configuration only checks the count limit for anonymous guests. Named guests and the limit for download sizes will not be checked
* <code>com.openexchange.share.servlet.limit.timeFrame.guests:0</code> (# disabled)
* <code>com.openexchange.share.servlet.limit.timeFrame.links:3600000</code> (# 60 minutes)
* <code>com.openexchange.share.servlet.limit.size.guests:0</code> (# not considered as disabled)
* <code>com.openexchange.share.servlet.limit.size.links:0</code> (# size for 60 minutes not checked)
* <code>com.openexchange.share.servlet.limit.count.guests:0</code> (# not considered as disabled)
* <code>com.openexchange.share.servlet.limit.count.links:100</code> (# 100 downloads within 60 minutes)

The following configuration will check the count limit for named guests and the size limit for anonymous guests (both within the last 60 minutes).
* <code>com.openexchange.share.servlet.limit.timeFrame.guests:3600000</code> (# 60 minutes)
* <code>com.openexchange.share.servlet.limit.timeFrame.links:3600000</code> (# 60 minutes)
* <code>com.openexchange.share.servlet.limit.size.guests:0</code> (# disabled)
* <code>com.openexchange.share.servlet.limit.size.links:1073741824</code> (# 1 GB)
* <code>com.openexchange.share.servlet.limit.count.guests:1000</code> (# 1000 downloads within 60 minutes)
* <code>com.openexchange.share.servlet.limit.count.links:0</code> (# disabled)

It is possible to reload an adapted configuration by using reloadconfiguration command line tool.

[[Category: AppSuite]]
[[Category: Administrator]]

AppSuite:Supported file types

2017-04-27T14:25:46Z

Malte: mp4 is video, not audio

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: mp4, m4v, ogv, webm
* Safari: mp4, m4v
* IE: mp4, m4v
* Firefox: mp4, ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, wav, m4a, m4b, ogg
* Safari: mp3, wav, m4a, m4b, aac
* IE: mp3, m4a, m4b
* Firefox: mp3, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Images'''
|
|-
|png
|[[File:Cross_gray.gif]]
|-
|jpg, jpeg
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:check.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:check.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:check.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:check.gif]]
|-
|odt (OpenDocument text document)
|[[File:check.gif]]
|-
|ott (OpenDocument text document template)
|[[File:check.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:check.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:check.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:check.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:check.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|xlam (Microsoft Office Excel add-in)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:check.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:check.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:check.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:check.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:check.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:check.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:check.gif]]
|-
|ppam (Microsoft Office PowerPoint add-in)
|[[File:check.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:check.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:check.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Miscellaneous Formats'''
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|odg (OpenDocument drawing document)
|[[File:check.gif]]
|-
|otg (OpenDocument drawing document template)
|[[File:check.gif]]
|-
|odi (OpenDocument image document)
|[[File:check.gif]]
|-
|oti (OpenDocument image document template)
|[[File:check.gif]]
|-
|odc (OpenDocument chart document)
|[[File:check.gif]]
|-
|otc (OpenDocument chart document template)
|[[File:check.gif]]
|-
|odf (OpenDocument formula document)
|[[File:check.gif]]
|-
|otf (OpenDocument formula document template)
|[[File:check.gif]]
|-
|odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Editing ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:Cross_gray.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:Cross_gray.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:Cross_gray.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:Cross_gray.gif]]
|-
|odt (OpenDocument text document)
|[[File:Cross_gray.gif]]
|-
|ott (OpenDocument text document template)
|[[File:Cross_gray.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:Cross_gray.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:Cross_gray.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:Cross_gray.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:Cross_gray.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:Cross_gray.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:Cross_gray.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:Cross_gray.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:Cross_gray.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:Cross_gray.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:Cross_gray.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:Cross_gray.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:Cross_gray.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:Cross_gray.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:Cross_gray.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Presenting ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|}

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Supported file types

2017-04-27T14:24:59Z

Malte: mp4 is video, not audio

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: mp4, m4v, ogv, webm
* Safari: mp4, m4v
* IE: mp4, m4v
* Firefox: mp4, ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, mp4, wav, m4a, m4b, ogg
* Safari: mp3, mp4, wav, m4a, m4b, aac
* IE: mp3, mp4, m4a, m4b
* Firefox: mp3, mp4, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Images'''
|
|-
|png
|[[File:Cross_gray.gif]]
|-
|jpg, jpeg
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:check.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:check.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:check.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:check.gif]]
|-
|odt (OpenDocument text document)
|[[File:check.gif]]
|-
|ott (OpenDocument text document template)
|[[File:check.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:check.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:check.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:check.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:check.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|xlam (Microsoft Office Excel add-in)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:check.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:check.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:check.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:check.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:check.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:check.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:check.gif]]
|-
|ppam (Microsoft Office PowerPoint add-in)
|[[File:check.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:check.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:check.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Miscellaneous Formats'''
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|odg (OpenDocument drawing document)
|[[File:check.gif]]
|-
|otg (OpenDocument drawing document template)
|[[File:check.gif]]
|-
|odi (OpenDocument image document)
|[[File:check.gif]]
|-
|oti (OpenDocument image document template)
|[[File:check.gif]]
|-
|odc (OpenDocument chart document)
|[[File:check.gif]]
|-
|otc (OpenDocument chart document template)
|[[File:check.gif]]
|-
|odf (OpenDocument formula document)
|[[File:check.gif]]
|-
|otf (OpenDocument formula document template)
|[[File:check.gif]]
|-
|odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Editing ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:Cross_gray.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:Cross_gray.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:Cross_gray.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:Cross_gray.gif]]
|-
|odt (OpenDocument text document)
|[[File:Cross_gray.gif]]
|-
|ott (OpenDocument text document template)
|[[File:Cross_gray.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:Cross_gray.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:Cross_gray.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:Cross_gray.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:Cross_gray.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:Cross_gray.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:Cross_gray.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:Cross_gray.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:Cross_gray.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:Cross_gray.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:Cross_gray.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:Cross_gray.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:Cross_gray.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:Cross_gray.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:Cross_gray.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Presenting ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|}

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Supported file types

2017-04-27T11:35:04Z

Malte: Added RTF for editing

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, mp4, wav, m4a, m4b, ogg
* Safari: mp3, mp4, wav, m4a, m4b, aac
* IE: mp3, mp4, m4a, m4b
* Firefox: mp3, mp4, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Images'''
|
|-
|png
|[[File:Cross_gray.gif]]
|-
|jpg, jpeg
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:check.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:check.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:check.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:check.gif]]
|-
|odt (OpenDocument text document)
|[[File:check.gif]]
|-
|ott (OpenDocument text document template)
|[[File:check.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:check.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:check.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:check.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:check.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|xlam (Microsoft Office Excel add-in)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:check.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:check.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:check.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:check.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:check.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:check.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:check.gif]]
|-
|ppam (Microsoft Office PowerPoint add-in)
|[[File:check.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:check.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:check.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Miscellaneous Formats'''
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|odg (OpenDocument drawing document)
|[[File:check.gif]]
|-
|otg (OpenDocument drawing document template)
|[[File:check.gif]]
|-
|odi (OpenDocument image document)
|[[File:check.gif]]
|-
|oti (OpenDocument image document template)
|[[File:check.gif]]
|-
|odc (OpenDocument chart document)
|[[File:check.gif]]
|-
|otc (OpenDocument chart document template)
|[[File:check.gif]]
|-
|odf (OpenDocument formula document)
|[[File:check.gif]]
|-
|otf (OpenDocument formula document template)
|[[File:check.gif]]
|-
|odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Editing ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:Cross_gray.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:Cross_gray.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:Cross_gray.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:Cross_gray.gif]]
|-
|odt (OpenDocument text document)
|[[File:Cross_gray.gif]]
|-
|ott (OpenDocument text document template)
|[[File:Cross_gray.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:Cross_gray.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:Cross_gray.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:Cross_gray.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:Cross_gray.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:Cross_gray.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:Cross_gray.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:Cross_gray.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:Cross_gray.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:Cross_gray.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:Cross_gray.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:Cross_gray.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:Cross_gray.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:Cross_gray.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:Cross_gray.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Presenting ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|}

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Supported file types

2017-04-27T11:33:58Z

Malte: Added RTF for Viewing

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, mp4, wav, m4a, m4b, ogg
* Safari: mp3, mp4, wav, m4a, m4b, aac
* IE: mp3, mp4, m4a, m4b
* Firefox: mp3, mp4, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Images'''
|
|-
|png
|[[File:Cross_gray.gif]]
|-
|jpg, jpeg
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:check.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:check.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:check.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:check.gif]]
|-
|odt (OpenDocument text document)
|[[File:check.gif]]
|-
|ott (OpenDocument text document template)
|[[File:check.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|rtf (Rich Text Format)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:check.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:check.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:check.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:check.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|xlam (Microsoft Office Excel add-in)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:check.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:check.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:check.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:check.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:check.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:check.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:check.gif]]
|-
|ppam (Microsoft Office PowerPoint add-in)
|[[File:check.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:check.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:check.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Miscellaneous Formats'''
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|odg (OpenDocument drawing document)
|[[File:check.gif]]
|-
|otg (OpenDocument drawing document template)
|[[File:check.gif]]
|-
|odi (OpenDocument image document)
|[[File:check.gif]]
|-
|oti (OpenDocument image document template)
|[[File:check.gif]]
|-
|odc (OpenDocument chart document)
|[[File:check.gif]]
|-
|otc (OpenDocument chart document template)
|[[File:check.gif]]
|-
|odf (OpenDocument formula document)
|[[File:check.gif]]
|-
|otf (OpenDocument formula document template)
|[[File:check.gif]]
|-
|odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Editing ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:Cross_gray.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:Cross_gray.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:Cross_gray.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:Cross_gray.gif]]
|-
|odt (OpenDocument text document)
|[[File:Cross_gray.gif]]
|-
|ott (OpenDocument text document template)
|[[File:Cross_gray.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:Cross_gray.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:Cross_gray.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:Cross_gray.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:Cross_gray.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:Cross_gray.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:Cross_gray.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:Cross_gray.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:Cross_gray.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:Cross_gray.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:Cross_gray.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:Cross_gray.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:Cross_gray.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:Cross_gray.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:Cross_gray.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Presenting ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|}

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:DocumentsMonitoring

2017-04-05T11:33:36Z

Malte: /* OX Documentconverter */

= OX Documents / OX Documentconverter Monitoring =

== General ==

The Open-Xchange JMX offers the ability to fetch runtime information of the Java virtual machine, and about the Open-Xchange Middleware (aka groupware backend) including OX Documents and Documentconverter.

For general information about the JMX interface see: [[OX_monitoring_interface]]

The usage of Jolokia to access monitoring data is described in the article [[Jolokia]]

Plugins are available for integration in the munin monitoring framework: [[OX_munin_scripts]]

== OX Documentconverter ==

Monitoring data for OX Documentconverter can be obtained after installation of the package open-xchange-munin-scripts-jolokia. It uses Jolokia (preferred) if available and configured.

Here is a list of sample data provided by
<pre>
# /opt/open-xchange/sbin/showruntimestats --port 9998 -y
CacheHitRatio = 0.8764556962025316
ErrorCacheHitRatio = 0.8372093023255814
JobsProcessed = 1975
JobErrorsTotal = 172
JobErrorsTimeout = 124
PeakJobCountInQueue_Background = 2
PeakJobCountInQueue_Low = 0
PeakJobCountInQueue_Medium = 1
PeakJobCountInQueue_High = 0
PeakJobCountInQueue_Instant = 5
PeakJobCountInQueue_Total = 6
MedianQueueTimeMillis_Background = 1
MedianQueueTimeMillis_Low = 0
MedianQueueTimeMillis_Medium = 1
MedianQueueTimeMillis_High = 0
MedianQueueTimeMillis_Instant = 1
MedianQueueTimeMillis_Total = 3
MedianConversionTimeMillis_Background = 1006
MedianConversionTimeMillis_Low = 0
MedianConversionTimeMillis_Medium = 663
MedianConversionTimeMillis_High = 0
MedianConversionTimeMillis_Instant = 159
MedianConversionTimeMillis_Total = 1828
MedianJobTimeMillis_Background = 1006
MedianJobTimeMillis_Low = 0
MedianJobTimeMillis_Medium = 664
MedianJobTimeMillis_High = 0
MedianJobTimeMillis_Instant = 162
MedianJobTimeMillis_Total = 1832
</pre>

=== OX Documentconverter and munin ===

The Documentconverter uses a different port to provide monitoring data via Jolokia. The corresponding oxJolokiaURL is has to be configured with an entry in the settings.

<pre>
[ox_documentconverter*]
env.oxJolokiaUrl http://localhost:8008/monitoring/jolokia
</pre>

== OX Documents ==

Monitoring data for OX Documents can be obtained after installation of the package open-xchange-documents-monitoring.

Here is a list of sample data provided by

<pre>
# /opt/open-xchange/sbin/showruntimestats -f
DocumentsSizeMedian_Spreadsheet = 0
DocumentsCreated_Presentation = 2
DocumentsCreated_Spreadsheet = 2
RestoreDocCurrent = 40
RestoreDocRestoredSuccess = 0
RestoreDocRestoredFailure = 0
DocumentsSizeMedian_Text = 0
DocumentsSizeMedian_Presentation = 0
RestoreDocCreated_Total = 40
RestoreDocRemoved_Total = 0
DocumentsSizeMedian_Total = 0
DocumentsCreated_Total = 4
DocumentsCreated_Text = 0
DocumentsClosed_Text_Timeout = 0
DocumentsSaved_Text_Total = 2
DocumentsSaved_Text_Close = 2
DocumentsSaved_Text_100ops = 0
DocumentsSaved_Text_15mins = 0
DocumentsOperations_Text_Incoming = 8
DocumentsOperations_Text_Distributed = 0
DocumentsOpened_Text_Total = 2
DocumentsOpened_Text_OOXML = 1
DocumentsOpened_Text_Binary = 0
DocumentsOpened_Text_ODF = 1
DocumentsClosed_Text_Total = 2
DocumentsOpened_Spreadsheet_Total = 22
DocumentsOpened_Spreadsheet_OOXML = 16
DocumentsOpened_Spreadsheet_Binary = 0
DocumentsOpened_Spreadsheet_ODF = 6
DocumentsClosed_Spreadsheet_Total = 19
DocumentsClosed_Spreadsheet_Timeout = 0
DocumentsSaved_Spreadsheet_Total = 10
DocumentsSaved_Spreadsheet_Close = 10
DocumentsSaved_Spreadsheet_100ops = 0
DocumentsSaved_Spreadsheet_15mins = 0
DocumentsOperations_Spreadsheet_Incoming = 46
DocumentsOperations_Spreadsheet_Distributed = 0
</pre>

== Further Reading ==

Further details about accessing JMX data via Jolokia are described in an [[Jolokia_LoginCounter_HOWTO]].

A call derived from this example for OX Documentconverter looks like

<pre>
$ curl http://yourname:yourpassword@localhost:8008/monitoring/jolokia/read/com.openexchange.documentconverter:name=DocumentConverterInformation/JobsProcessed
{"timestamp":1471868314,"status":200,"request":{"mbean":"com.openexchange.documentconverter:name=DocumentConverterInformation","attribute":"JobsProcessed","type":"read"},"value":6616}
</pre>

AppSuite:Supported file types draft improvements

2017-02-16T12:56:42Z

Malte: /* Supported File Formats for Editing */

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, mp4, wav, m4a, m4b, ogg
* Safari: mp3, mp4, wav, m4a, m4b, aac
* IE: mp3, mp4, m4a, m4b
* Firefox: mp3, mp4, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Images'''
|
|-
|png
|[[File:Cross_gray.gif]]
|-
|jpg, jpeg
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:check.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:check.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:check.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:check.gif]]
|-
|odt (OpenDocument text document)
|[[File:check.gif]]
|-
|ott (OpenDocument text document template)
|[[File:check.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:check.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:check.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:check.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:check.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|xlam (Microsoft Office Excel add-in)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:check.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:check.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:check.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:check.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:check.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:check.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:check.gif]]
|-
|ppam (Microsoft Office PowerPoint add-in)
|[[File:check.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:check.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:check.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Miscellaneous Formats'''
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|odg (OpenDocument drawing document)
|[[File:check.gif]]
|-
|otg (OpenDocument drawing document template)
|[[File:check.gif]]
|-
|odi (OpenDocument image document)
|[[File:check.gif]]
|-
|oti (OpenDocument image document template)
|[[File:check.gif]]
|-
|odc (OpenDocument chart document)
|[[File:check.gif]]
|-
|otc (OpenDocument chart document template)
|[[File:check.gif]]
|-
|odf (OpenDocument formula document)
|[[File:check.gif]]
|-
|otf (OpenDocument formula document template)
|[[File:check.gif]]
|-
|odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Editing ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|'''Text Documents'''
|
|-
|docx (Microsoft Office Word text document)
|[[File:Cross_gray.gif]]
|-
|docm (Microsoft Office Word macro-enabled text document)
|[[File:Cross_gray.gif]]
|-
|dotx (Microsoft Office Word text document template)
|[[File:Cross_gray.gif]]
|-
|dotm (Microsoft Office Word macro-enabled text document template)
|[[File:Cross_gray.gif]]
|-
|odt (OpenDocument text document)
|[[File:Cross_gray.gif]]
|-
|ott (OpenDocument text document template)
|[[File:Cross_gray.gif]]
|-
|doc (Microsoft Word 97-2003 text document)
|[[File:check.gif]]
|-
|dot (Microsoft Word 97-2003 text document template)
|[[File:check.gif]]
|-
|txt (Text file)
|[[File:Cross_gray.gif]]
|-
|
|
|-
|'''Spreadsheet Documents'''
|
|-
|xlsx (Microsoft Office Excel workbook)
|[[File:Cross_gray.gif]]
|-
|xlsm (Microsoft Office Excel macro-enabled workbook)
|[[File:Cross_gray.gif]]
|-
|xltx (Microsoft Office Excel workbook template)
|[[File:Cross_gray.gif]]
|-
|xltm (Microsoft Office Excel macro-enabled workbook template)
|[[File:Cross_gray.gif]]
|-
|xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
|[[File:check.gif]]
|-
|ods (OpenDocument spreadsheet document)
|[[File:Cross_gray.gif]]
|-
|ots (OpenDocument spreadsheet document template)
|[[File:Cross_gray.gif]]
|-
|xls (Microsoft Excel 97-2003 workbook)
|[[File:check.gif]]
|-
|xlt (Microsoft Excel 97-2003 workbook template)
|[[File:check.gif]]
|-
|xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|
|
|-
|'''Presentation Documents'''
|
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:Cross_gray.gif]]
|-
|pptm (Microsoft Office PowerPoint macro-enabled presentation)
|[[File:Cross_gray.gif]]
|-
|potx (Microsoft Office PowerPoint presentation template)
|[[File:Cross_gray.gif]]
|-
|potm (Microsoft Office PowerPoint macro-enabled presentation template)
|[[File:Cross_gray.gif]]
|-
|ppsx (Microsoft Office PowerPoint slide show)
|[[File:Cross_gray.gif]]
|-
|ppsm (Microsoft Office PowerPoint macro-enabled slide show)
|[[File:Cross_gray.gif]]
|-
|odp (OpenDocument presentation document)
|[[File:Cross_gray.gif]]
|-
|otp (OpenDocument presentation document template)
|[[File:Cross_gray.gif]]
|-
|ppt (Microsoft PowerPoint 97-2003 presentation)
|[[File:check.gif]]
|-
|pot (Microsoft PowerPoint 97-2003 presentation template)
|[[File:check.gif]]
|-
|pps (Microsoft PowerPoint 97-2003 slide show)
|[[File:check.gif]]
|-
|ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Presenting ==

{|
|-
! '''File Format''' !! '''Requires Document Converter'''
|-
|
|
|-
|pdf (Portable Document Format)
|[[File:check.gif]]
|-
|pptx (Microsoft Office PowerPoint presentation)
|[[File:check.gif]]
|-
|}

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Supported file types draft improvements

2017-02-15T15:37:53Z

Malte: /* Supported File Format Edit */

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, wav, m4a, m4b, ogg
* Safari: mp3, wav, m4a, m4b, aac
* IE: mp3, m4a, m4b
* Firefox: mp3, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

=== Images ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* png
* jpg, jpeg
| [[File:Cross_gray.gif]]
|-
|}

=== Text Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document)
* dot (Microsoft Word 97-2003 text document template)
* rtf (Rich Text Format)
| [[File:check.gif]]
|-
|* txt
|[[File:Cross_gray.gif]]
|-
|}

=== Spreadsheet Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)
| [[File:check.gif]]
|-
|}

=== Presentation Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== Miscellaneous ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pdf (Portable Document Format)
* odg (OpenDocument drawing document)
* otg (OpenDocument drawing document template)
* odi (OpenDocument image document)
* oti (OpenDocument image document template)
* odc (OpenDocument chart document)
* otc (OpenDocument chart document template)
* odf (OpenDocument formula document)
* otf (OpenDocument formula document template)
* odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Formats for Editing ==

=== OX Text Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document, converted to "docx" when edited)
* dot (Microsoft Word 97-2003 text document template, converted to "dotx" when edited)
* rtf (Rich Text Format, converted to "docx" when edited)
|[[File:check.gif]]
|-
|* txt (text file)
|[[File:Cross_gray.gif]]
|-
|}

=== OX Spreadsheet Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== OX Presentation Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== OX Presenter ===

OX Presenter allows you to view presentations in a specialized user interface, where you also can give local presentations or presentations where remote participants can join.

The supported formats are PDF and PPTX.

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Supported file types draft improvements

2017-02-15T15:37:22Z

Malte: /* Supported File Format Display */

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, wav, m4a, m4b, ogg
* Safari: mp3, wav, m4a, m4b, aac
* IE: mp3, m4a, m4b
* Firefox: mp3, wav, ogg

== Supported File Formats for Viewing ==

Open-Xchange displays the following file formats from all different web frontend modules.

=== Images ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* png
* jpg, jpeg
| [[File:Cross_gray.gif]]
|-
|}

=== Text Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document)
* dot (Microsoft Word 97-2003 text document template)
* rtf (Rich Text Format)
| [[File:check.gif]]
|-
|* txt
|[[File:Cross_gray.gif]]
|-
|}

=== Spreadsheet Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)
| [[File:check.gif]]
|-
|}

=== Presentation Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== Miscellaneous ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pdf (Portable Document Format)
* odg (OpenDocument drawing document)
* otg (OpenDocument drawing document template)
* odi (OpenDocument image document)
* oti (OpenDocument image document template)
* odc (OpenDocument chart document)
* otc (OpenDocument chart document template)
* odf (OpenDocument formula document)
* otf (OpenDocument formula document template)
* odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Format Edit ==

=== OX Text Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document, converted to "docx" when edited)
* dot (Microsoft Word 97-2003 text document template, converted to "dotx" when edited)
* rtf (Rich Text Format, converted to "docx" when edited)
|[[File:check.gif]]
|-
|* txt (text file)
|[[File:Cross_gray.gif]]
|-
|}

=== OX Spreadsheet Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== OX Presentation Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== OX Presenter ===

OX Presenter allows you to view presentations in a specialized user interface, where you also can give local presentations or presentations where remote participants can join.

The supported formats are PDF and PPTX.

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Supported file types draft improvements

2017-02-15T15:36:42Z

Malte: /* OX Presenter */

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, wav, m4a, m4b, ogg
* Safari: mp3, wav, m4a, m4b, aac
* IE: mp3, m4a, m4b
* Firefox: mp3, wav, ogg

== Supported File Format Display ==

Open-Xchange displays the following file formats from all different web frontend modules.

=== Images ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* png
* jpg, jpeg
| [[File:Cross_gray.gif]]
|-
|}

=== Text Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document)
* dot (Microsoft Word 97-2003 text document template)
* rtf (Rich Text Format)
| [[File:check.gif]]
|-
|* txt
|[[File:Cross_gray.gif]]
|-
|}

=== Spreadsheet Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)
| [[File:check.gif]]
|-
|}

=== Presentation Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== Miscellaneous ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pdf (Portable Document Format)
* odg (OpenDocument drawing document)
* otg (OpenDocument drawing document template)
* odi (OpenDocument image document)
* oti (OpenDocument image document template)
* odc (OpenDocument chart document)
* otc (OpenDocument chart document template)
* odf (OpenDocument formula document)
* otf (OpenDocument formula document template)
* odm (OpenDocument global text document)
|[[File:check.gif]]
|-
|}

== Supported File Format Edit ==

=== OX Text Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document, converted to "docx" when edited)
* dot (Microsoft Word 97-2003 text document template, converted to "dotx" when edited)
* rtf (Rich Text Format, converted to "docx" when edited)
|[[File:check.gif]]
|-
|* txt (text file)
|[[File:Cross_gray.gif]]
|-
|}

=== OX Spreadsheet Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== OX Presentation Documents ===

{|
|-
! File Format !! Requires Document Converter
|-
|
* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)
|[[File:check.gif]]
|-
|}

=== OX Presenter ===

OX Presenter allows you to view presentations in a specialized user interface, where you also can give local presentations or presentations where remote participants can join.

The supported formats are PDF and PPTX.

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

AppSuite:Presenter Installation Guide

2015-10-23T16:40:14Z

Malte: /* Download & Installation OX Presenter */

{{Version|7.8.0}}

= Download & Installation OX Presenter =

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details. Additionally, the [[AppSuite:ReaderEngineInstall|readerengine]] is required.

OX Presenter is installed automatically together with OX Text and OX Spreadsheet, see the corresponding installation guides.

== Configuration ==

=== Permissions ===

To enable OX Presenter for OX Drive the associated permission has to be set.

To allow users to use the presenter feature at all, add the following capability to '''permissions.properties''':
<pre>
permissions=presenter
</pre>

With the presenter permission, users can view presentations in the specialized presentation viewer, and start local presentations. If users should also be allowed to start a remote presentation, add the following capability to '''permissions.properties''':
<pre>
permissions=remote_presenter
</pre>

Joining a remote presentation is possible for every user who has the presenter capability.

AppSuite:CalcengineInstall

2015-10-23T09:29:29Z

Malte:

= Description =

The calcengine is necessary to use spreadsheet functionality. The calcengine is licensed under Apache License 2.0, so all our other code is able to use it.

{{InstallPlugin|pluginname=calcengine|toplevel=products|sopath=appsuite/stable/calcengine|version=App Suite|reponame=calcengine}}

[[Category:AppSuite]]
[[Category:Administrator]]

AppSuite:KeyboardControlled

2015-09-23T13:58:54Z

Malte:

<div class="title">OX App Suite Keyboard Shortcuts</div>

== General navigation ==

The following keyboard shortcuts can be used across the UI in order to access element just via keyboard:

{| border=1
|'''Function''' || '''Windows / Linux''' || '''MacOS (if different)'''
|-
|Move to next accessible element, e.g. links || Tab ||
|-
|Move to previous accessible element || Shift-Tab ||
|-
|Trigger element action (same as mouse click) || Enter ||
|-
|Move selection in lists and hierarchies, e.g. folder tree || Cursor Up/Down ||
|-
|Move to top/bottom item in lists || - || Cmd+Cursor Up/Down
|-
|Open/close folder in folder tree view || Cursor right/left ||
|-
|Close popup dialogs || Escape ||
|-
|Move to next important component, e.g. top bar, folder tree, item lists || Ctrl-F6 || F6
|-
|Move to previous important component || Shift-Ctrl-F6 || Shift-F6
|}

== OX Documents ==

These keyboard shortcuts apply for all OX Documents applications.

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Collapse or expand the side pane || Ctrl + F3 || Cmd + F3
|-
|Move focus between tool bars and document content || Ctrl + F6 || F6
|-
|Move focus between tool bars and document content (backwards) || Shift + Ctrl + F6 || Shift + F6
|-
|Move focus among tool bar items || Tab ||
|-
|Move focus among tool bar items (backwards) || Shift + Tab ||
|-
|Execute the currently selected button || Enter ||
|-
|Execute the currently selected button (without moving the focus) || Space ||
|-
|Execute the currently selected entry in a dropdown menu (moving the focus to the next ribbon control) || Tab ||
|-
|Execute the currently selected entry in a dropdown menu (moving the focus to the previous ribbon control) || Shift + Tab ||
|-
|Move between dropdown menu entries || Cursor keys ||
|-
|Close dropdown menu || Esc ||
|-
|Print || Ctrl + P || Cmd + P
|}

== OX Document Viewer ==

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Scroll up || Arrow Up ||
|-
|Scroll up fast || Page Up || Space
|-
|Scroll down || Arrow Down ||
|-
|Scroll down fast || Page Down || Shift + Space
|-
|Jump to top of first page || Home || Fn + Arrow Left
|-
|Jump to top of previous page || Alt + Page Up || Cmd + Page Up
|-
|Jump to top of next page || Alt + Page Down || Cmd + Page Down
|-
|Jump to bottom of last page || End || Fn + Arrow Right
|-
|Zoom in || + (also on numeric pad) ||
|-
|Zoom out || - (also on numeric pad) ||
|}

== OX Editors ==

These keyboard shortcuts apply for all OX Documents editor applications.

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Focus the document || ESC ||
|-
| Undo the last action || Ctrl + Z, Alt + Backspace || Cmd + Z, Alt + Backspace
|-
| Redo the last action || Ctrl + Y, Shift + Alt + Backspace || Cmd + Y, Shift + Alt + Backspace
|-
| Copy selected text or object || Ctrl + C, Ctrl + Insert || Cmd + C
|-
| Cut selected text or object || Ctrl + X, Shift + Delete || Cmd + X, Shift + Delete
|-
| Paste selected text or object || Ctrl + V, Shift + Insert || Cmd + V
|}

== OX Text ==

'''Navigation'''

{| border=1
| '''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Jump one character to the left/right || Arrow Left/Right ||
|-
| Jump one word to the left/right || Ctrl + Arrow Left/Right || Alt + Arrow Left/Right
|-
| Jump to the beginning of a line || Home || Cmd + Arrow Left
|-
| Jump to the end of a line || End || ✘
|-
| Jump one line up/down || Arrow Up/Down ||
|-
| Jump to beginning/end of document || Ctrl + Home/End || Cmd + Arrow Up/Down
|-
| Jump to next table cell || Tab ||
|-
|Jump to previous table cell || Shift + Tab ||
|}

'''Text Selection'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Extend selection one character to the left/right || Shift + Arrow Left/Right ||
|-
| Extend selection to the beginning of a line || Shift + Home || Shift + Cmd + Arrow Left
|-
| Extend selection to the end of a line || Shift + End || ✘
|-
| Extend selection one line up/down || Shift + Arrow Up/Down ||
|-
| Extend selection to beginning/end of document || Shift + Ctrl + Home/End || Shift + Cmd + Arrow Up/Down
|-
| Extend selection to entire document || Ctrl + A || Cmd + A
|-
|}

'''Search and Replace'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Open Search and Replace pane || Ctrl + F || Cmd + F
|-
| Close Search and Replace pane || Esc ||
|-
| Select next search result || Ctrl + G || Cmd + G
|-
| Select previous search result || Ctrl+ Shift + G || Shift + Cmd + G
|-
|}

'''Edit Document'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Insert paragraph break || Enter ||
|-
| Insert line break without breaking paragraph || Shift + Enter ||
|-
|}

'''Format Text'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Apply/remove bold || Ctrl + B || Cmd + B
|-
| Apply/remove italic || Ctrl + I || Cmd + I
|-
| Apply/remove underline || Ctrl + U || Cmd + U
|-
| Remove all manual styles || Ctrl + Space ||
|}

== OX Spreadsheet ==

'''Navigation'''

{| border=1
| '''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Switch to previous sheet || Ctrl + Alt + Page-Up || Meta + Alt + Page-Up
|-
| Switch to next sheet || Ctrl + Alt + Page-Down || Meta + Alt + Page-Down
|-
| Move to next cell at left, right, up, down (from selection: start at active cell) || Arrow-Left/Right/Up/Down ||
|-
| Jump to next filled cell at left, right, up, down || Ctrl + Left/Right/Up/Down ||
|-
| Jump to first column || Home || Fn + Arrow Left
|-
| Jump to last filled column || End || Fn + Arrow Right
|-
| Jump to first visible Cell || Ctrl + Home || Crtl + Fn + Arrow Left
|-
| Jump to last filled Cell || Ctrl + End || Ctrl + Fn + Arrow Right
|-
| Move active cell one down (from selection: only within the selection) || ENTER ||
|-
| Move active cell one up (from selection: only within the selection) || Shift + Enter ||
|-
| Move cursor one page up, down || Page Up / Page Down || Fn + Arrow Down / Fn + Arrow Up
|-
| Move cursor one page left, right || Alt + Page Up / Page Down ||
|-
|}

'''Cell Selection'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Extend cell or selected range to left, right, up, down || Shift + Arrow-Left/Right/Up/Down ||
|-
| Select content range around active cell || Ctrl + * ||
|-
| Select whole column || Ctrl + Space ||
|-
| Select whole row || Shift + Space ||
|-
| Select all cells || Shift + Ctrl + Space / Ctrl+A || Shift + Ctrl + Space / Cmd + A
|-
| Extend selection to next filled cell at left, right, up, down || Shift+Ctrl+Left/Right/Up/Down ||
|-
| Extend selection to first column || Shift + Home ||
|-
| Extend selection to last filled column || Shift + End ||
|-
| Extend selection to first visible Cell || Shift + Ctrl + Home ||
|-
| Extend selection to last filled Cell || Shift + Ctrl + End ||
|-
| Extend selection to one page up, down || Shift + Page Up / Page Down ||
|-
| Extend selection to one page left, right || Shift + Alt + Page Up / Page Down ||
|-
|}

'''Edit-Mode'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Open Search and Replace pane || Ctrl + F || Cmd + F
|-
| Close Search and Replace pane || Esc ||
|-
|}

'''Edit Document'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Enter Cell-Edit-Mode (change Edit-Mode to Insert-Mode) || F2 ||
|-
| Insert Line-Break in Cell || Alt + Enter ||
|-
|}

'''Drawings'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
| Select a Drawing || Shift + F4 ||
|-
| Jump to next Drawing || Tab ||
|-
| Jump to previous Drawing || Shift + Tab ||
|-
|}

== OX Presenter ==

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Next slide || Arrow Down / Page Down / Key Right ||
|-
|Previous slide || Arrow Up / Page Up / Key Left ||
|-
|Jump to first slide || Home ||
|-
|Jump to last slide || End ||
|-
|}

AppSuite:Supported file types

2015-09-23T13:51:08Z

Malte: OX Presenter

= OX App Suite File Support =

OX App Suite web frontend allows you to preview, view and edit files at the different modules.

One of the modules is OX Drive, an integral part the OX App Suite user frontend. OX Drive provides view, preview, run and even edit a variety of media file types (e.g. photos, music documents etc.). Note: to edit documents you do need to have the relevant document editor activated within OX App Suite.

Other components of OX App Suite include OX Document Viewer, which allows users to preview and view various file formats, and OX Documents which further enhances collaboration and creativity by allowing real time sharing, collaboration and editing of documents online. OX Documents contains OX Text and OX Spreadsheet.

A common question is what files are supported of the different modules. The following list is not definitive

== OX Drive integrated Mediaplayer ==

The OX Drive "media player" uses the native html 5 video playback of each browser. The actual file support depends on the user's browser, so a definitive list can not be given:

=== Supported Video-Files inside OX Drive Mediaplayer ===

* Chrome: m4v, ogv, webm
* Safari: m4v
* IE: m4v
* Firefox: ogv, webm

=== Supported Audio-Files inside OX Drive Mediaplayer ===

For audio files a flash/silverlight fallback is used if a browser is not capable of native mp3 playback like Firefox.

* Chrome: mp3, wav, m4a, m4b, ogg
* Safari: mp3, wav, m4a, m4b, aac
* IE: mp3, m4a, m4b
* Firefox: mp3, wav, ogg

== OX Document Viewer ==

The OX Document Viewer delivers plugin-free document viewing capabilities for Microsoft Office (.docx, .doc, .rtf, .pptx, .ppt, .xlsx, xls) and OpenDocument (.odt, .ods, .odp, .odg) file types as well as for the Portable Document Format (.pdf). It extends OX App Suite with content thumbnails and preview capabilities.

=== Images ===

* png
* jpg, jpeg

=== Text Documents ===

* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document)
* dot (Microsoft Word 97-2003 text document template)
* rtf (Rich Text Format)

=== Spreadsheet Documents ===

* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)

=== Presentation Documents ===

* pptx (Microsoft Office PowerPoint presentation)
* pptm (Microsoft Office PowerPoint macro-enabled presentation)
* potx (Microsoft Office PowerPoint presentation template)
* potm (Microsoft Office PowerPoint macro-enabled presentation template)
* ppsx (Microsoft Office PowerPoint slide show)
* ppsm (Microsoft Office PowerPoint macro-enabled slide show)
* ppam (Microsoft Office PowerPoint add-in)
* odp (OpenDocument presentation document)
* otp (OpenDocument presentation document template)
* ppt (Microsoft PowerPoint 97-2003 presentation)
* pot (Microsoft PowerPoint 97-2003 presentation template)
* pps (Microsoft PowerPoint 97-2003 slide show)
* ppa (Microsoft PowerPoint 97-2003 add-in)

=== Miscellaneous ===

* pdf (Portable Document Format)
* odg (OpenDocument drawing document)
* otg (OpenDocument drawing document template)
* odi (OpenDocument image document)
* oti (OpenDocument image document template)
* odc (OpenDocument chart document)
* otc (OpenDocument chart document template)
* odf (OpenDocument formula document)
* otf (OpenDocument formula document template)
* odm (OpenDocument global text document)

== OX Documents ==

OX Documents contains OX Text and OX Spreadsheet.

=== OX Text Documents ===

OX Text, is a web-based word processor. Its main focus is on reducing the complexities of text editing while promoting collaborative document creation.

* docx (Microsoft Office Word text document)
* docm (Microsoft Office Word macro-enabled text document)
* dotx (Microsoft Office Word text document template)
* dotm (Microsoft Office Word macro-enabled text document template)
* odt (OpenDocument text document)
* ott (OpenDocument text document template)
* doc (Microsoft Word 97-2003 text document, converted to "docx" when edited)
* dot (Microsoft Word 97-2003 text document template, converted to "dotx" when edited)
* rtf (Rich Text Format, converted to "docx" when edited)

=== OX Spreadsheet Documents ===

OX Spreadsheet is a cloud based spreadsheet product that can work with Microsoft Excel documents. You can also edit shared spreadsheets on various devices. OX Spreadsheet is the first browser-based spreadsheet application that reads and writes native Microsoft Excel files without loss of format or detail ("Round-trip editing").

* xlsx (Microsoft Office Excel workbook)
* xlsm (Microsoft Office Excel macro-enabled workbook)
* xltx (Microsoft Office Excel workbook template)
* xltm (Microsoft Office Excel macro-enabled workbook template)
* xlsb (Microsoft Office Excel macro-enabled workbook, binary format)
* xlam (Microsoft Office Excel add-in)
* ods (OpenDocument spreadsheet document)
* ots (OpenDocument spreadsheet document template)
* xls (Microsoft Excel 97-2003 workbook)
* xlt (Microsoft Excel 97-2003 workbook template)
* xla (Microsoft Excel 97-2003 add-in)

=== OX Presenter ===

OX Presenter allows you to view presentations in a specialized user interface, where you also can give local presentations or presentations where remote participants can join.

For a list of supported file types, see "Presentation Documents" in the OX Document Viewer section above.

[[Category:AppSuite]]
[[Category:UI]]
[[Category:Server]]

SourceCodeAccess

2015-09-13T07:38:07Z

Malte:

= How to download the Open-Xchange Server source code (6.22.0 and later) =

Starting with 6.22 the source code of Open-Xchange server is available from our Git repository.

The following repositories exist:

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Repository
! content
|-
| wd/backend
| The main repository containing most of the parts of Open-Xchange server
|-
| frontend6
| The AJAX user interface (version 6)
|-
| wd/frontend/web
| The AJAX user interface of OX AppSuite
|-
| documentconverter-api
| The API of the server-based part of the documentconverter needed for OX Text
|-
| office
| The server-code for OX Text and OX Spreadsheet
|-
| office-web
| The frontend-code for OX Text and OX Spreadsheet
|-
| calcengine
| The C++, Apache OpenOffice based calc engine
|-
|}

== Git operations to access the code ==

To clone a repository, run

$ git clone https://code.open-xchange.com/git/<repository>
$ cd <repository>
$ git checkout -t origin/<branch>

For browsing the git repositories, go to https://code.open-xchange.com

== The currently used Git branches ==

For a list of available branches, run

$ git branch -r

The main development process uses the following branches:

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Git branch
! content
|-
| develop
| head development
|-
| release-<version>
| stabilizing for <version> release
|-
| master
| maintenance of previous releases
|-
|}

= How to download the Open-Xchange Server source code (6.20.7 and earlier) =

The source code of Open-Xchange Server up to and including version 6.20.7 is available using cvs access and source packages. Please make sure to use an up-to-date CVS client (cvs > 1.12) to check out the repositories. Integrated CVS clients e.g. for current Eclipse version work well, too.

== The currently maintained cvs repositories ==

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Repository
! content
|-
| open-xchange
| the main repository containing most of the parts of Open-Xchange server
|-
| open-xchange-gui
| The AJAX user interface
|-
| open-xchange-admin
| the Open-Xchange admin daemon used for provisioning (user creation, etc.)
|-
| open-xchange-admin-plugin-hosting
| contains the commandline tools and the oxinstaller
|-
| open-xchange-admin-soap
| SOAP interface
|-
|}

== CVS operations to access the code ==

To see a complete list of Open-Xchange cvs repositories, run the following command:

$ cvs -d :pserver:anonymous@www.open-xchange.com:/cvsroot rls

Note, however, that only the repositories as listed above are actively maintained.

To check out a repository, run

$ cvs -d :pserver:anonymous@www.open-xchange.com:/cvsroot co open-xchange/com.openexchange.authentication.ldap

to check out the ldap authentication plugin.

== Organization of the open-xchange repository ==

The open-xchange repository contains several [http://en.wikipedia.org/wiki/OSGi OSGi] bundles which are the building block of the Open-Xchange server package.
Each of them has an [http://ant.apache.org/ ant] <tt>build.xml</tt> file containing a target to create a source tarball and a subdirectory called <tt>packaging</tt> which contains the package metadata to build [http://en.wikipedia.org/wiki/Deb_(file_format) DEB] and [http://en.wikipedia.org/wiki/RPM_Package_Manager RPM] packages.

[[Category: OX6]]
[[Category: AppSuite]]
[[Category: Developer]]

AppSuite:Presenter Installation Guide

2015-09-11T10:26:23Z

Malte: /* Permissions */

= Download & Installation OX Presenter =

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Presenter is installed automatically together with OX Text and OX Spreadsheet, see the corresponding installation guides.

== Configuration ==

=== Permissions ===

To enable OX Presenter for OX Drive the associated permission has to be set.

To allow users to use the presenter feature at all, add the following capability to '''permissions.properties''':
<pre>
permissions=presenter
</pre>

With the presenter permission, users can view presentations in the specialized presentation viewer, and start local presentations. If users should also be allowed to start a remote presentation, add the following capability to '''permissions.properties''':
<pre>
permissions=remote_presenter
</pre>

Joining a remote presentation is possible for every user who has the presenter capability.

AppSuite:Presenter Installation Guide

2015-09-11T10:24:16Z

Malte: /* Configuration */

= Download & Installation OX Presenter =

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Presenter is installed automatically together with OX Text and OX Spreadsheet, see the corresponding installation guides.

== Configuration ==

=== Permissions ===

To enable OX Presenter for OX Drive the associated permission has to be set.

To allow people to use the presenter feature at all, add the following capability to '''permissions.properties''':
<pre>
permissions=presenter
</pre>

With the presenter permission, peoples can view presentation in the specialize presentation viewer, and start local presentations. If people should also be allowed to start a remote presentation, add the following capability to '''permissions.properties''':
<pre>
permissions=remote_presenter
</pre>

Joining a remote presentation is possible for every user who has the presenter capability.

AppSuite:Presenter Installation Guide

2015-09-11T10:19:59Z

Malte: Created page with "= Download & Installation OX Presenter = == Requirements == See the Open-Xchange software requirements page for details. OX Presenter i..."

= Download & Installation OX Presenter =

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Presenter is installed automatically together with OX Text and OX Spreadsheet, see the corresponding installation guides.

== Configuration ==

=== Permissions ===

To enable OX Presenter for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

To allow people to use the presenter feature, add the following capability to '''permissions.properties''':
<pre>
permissions=presenter
</pre>

With the presenter permission, peoples can view presentation in the specialize presentation viewer, and start local presentations. If people should also be allowed to start a remote presentation, add the following capability to '''permissions.properties''':
<pre>
permissions=remote_presenter
</pre>

AppSuite:Main Page Quickinstall

2015-09-11T10:11:21Z

Malte: /* OX Presenter */

= OX App Suite =

== Quick Installation Guide ==

To download and install the software, please use the following Installation Guides:

* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]
* [[OXSE4UCS_Installation_en|Download and Installation Guide for Univention Corporate Server]]
* [[AppSuite:Demoinstallation|Download and Installation Guide for Open-Xchange SE / App Suite for UCS VMware© Demo]]

== Installing the latest Updates for OX App Suite ==

To get the latest features and bugfixes for OX App Suite, you need to have a valid license. The following article explains how that can be done:

* [[AppSuite:UpdatingOXPackages|Updating OX App Suite packages]]
* [[UpdateTasks|Update Task Management in Open-Xchange]]

== Update from 6.22.x to OX App Suite ==

To update the software, please use the following Guides:

* [[AppSuite:Upgrade_from_6.22_Debian_6.0|Update Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Upgrade_from_6.22_for_SLES11|Update Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Upgrade_from_6.22_for_RHEL6|Update Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Upgrade_from_6.22_for_CentOS6 |Update Guide for CentOS 6]]

== Parallel Setup of OX App Suite UI and OX 6 UI ==

* [[AppSuite:Parallel_UISupport_OX6_AppSuite_Debian_6.0|Parallel Setup Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_RHEL_6_CentOS_6|Parallel Setup Guide for Red Hat Enterprise Linux 6 and CentOS 6]]
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_SLES_11|Parallel Setup Guide for SUSE Linux Enterprise Server 11]]

== OX App Suite deployment tutorials ==

A complete guide of necessary tasks with a hardware and setup recommendation for different Open-Xchange Hosting environments:

* [[AppSuite:OX_Tutorial_10K|OX App Suite deployment tutorial for up to 10.000 Users]]
* [[AppSuite:OX_Tutorial_100K|OX App Suite deployment tutorial for up to 100.000 Users]]
* [[AppSuite:OX_Tutorial_1M|OX App Suite deployment tutorial for up to 1.000.000 Users]]

== Reporting Tool (Mandatory for Maintenance) ==

To receive maintenance in the future, the installation of the Open-Xchange Reporting Tool is mandatory. It documents the current state of your system installation. Furthermore, the tool runs a validity check for your current maintenance. Based on the reported detail information Open-Xchange will then be able to improve its own support and maintenance offerings for you. This article explains how that can be done:

* [[AppSuite:OXReportClient|OX App Suite Reporting Client]]

= Open-Xchange Additional Tools and Configurations =

== Open-Xchange Document Viewer ==
The OX Document Viewer will choose the best preview format depending on the users device on the OX App Suite Web Interface (valid Open-Xchange license required).

* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]

== Open-Xchange Calendar synchronization with CalDAV ==

The Mac OS X, iOS and Thunderbird Lightning integration makes Open-Xchange appointments available to end users through their native applications.

* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]
* [[AppSuite:Caldav_carddav_Bundles| Installation CalDAV with Open-Xchange]]

== Open-Xchange Contact Synchronization with CardDAV ==

The Mac OS X and iOS integration makes Open-Xchange contacts available to end users through their native applications.

* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV with Open-Xchange]]

== Cluster-Setup ==
Multiple Open-Xchange servers can form a cluster with inter-OX-communication over a network.

* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]

== HTTP based Connector via Grizzly ==
OX App Suite offers a second HTTP based connector for the communication between the HTTP server and the backend. This new connector is based on Oracle's Project Grizzly - a NIO and Web framework.

* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]

== LDAP Contact Storage ==
Open-Xchange provides a new LDAP Contact Storage Integration Bundle. The new solution is available together with the current LDAP bundle.

* [[ContactStorageLDAP| LDAP Contact Storage]]

= Open-Xchange Additional Software =

== OX Guard ==

OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it.

* [[AppSuite:OX_Guard|Installation and information of OX Guard]]
* [[Appsuite:GuardConfiguration|Configuration Options for OX Guard]]

== OX Text ==

OX Text, is a web-based word processor. Its main focus is on reducing the complexities of text editing while promoting collaborative document creation.

* [[AppSuite:Text_Installation_Guide|Download & Installation of OX Text]]

== OX Spreadsheet ==

OX Spreadsheet is a cloud based spreadsheet product that can work with Microsoft Excel documents. You can also edit shared spreadsheets on various devices. OX Spreadsheet is the first browser-based spreadsheet application that reads and writes native Microsoft Excel files without loss of format or detail ("Round-trip editing").

* [[AppSuite:Spreadsheet_Installation_Guide|Download & Installation of OX Spreadsheet]]

== OX Presenter ==

OX Presenter allows for local and remote presentations of presentation documents.

* [[AppSuite:Presenter_Installation_Guide|Download & Installation of OX Presenter]]

== OX Messenger ==

OX Messenger is a real time text, voice and video communication application that fully integrates into OX App Suite. OX Messenger can optionally connect to existing third-party telephony options such as VoIP, PBX, PSTN termination etc. OX Messenger is a managed service that allows customers to provide their end users with a professional presence, text chat and real time audio/video communication capability. This service is fully integrated into a hybrid OX App Suite solution with the OX Messenger component provided by [http://addsumma.com/ Summa] in the Netherlands.

* [[AppSuite:OX_Messenger|Download & Installation of OX Messenger]]

== Open-Xchange Updater ==

The Open-Xchange Updater is a software tool by Open-Xchange that installs the latest version of Open-Xchange client software on computers running Windows (valid Open-Xchange license required).

* [[AppSuite:Open-Xchange_Updater|Installation of the Open-Xchange Updater]]

== Connector for Microsoft Outlook ==

The Open-Xchange Connector for Microsoft Outlook® lets users keep their Outlook client even if the organization moves to an Open-Xchange Server. Users feel right at home working with their Outlook interface while in the background the Connector synchronizes E-Mails, Calendar, Contacts and Tasks, along with Public, Shared and System Folders. Real-time synchronization enables fast response times, so teams can work as efficiently as possible (valid Open-Xchange license required).

* [[AppSuite:Connector_for_Microsoft_Outlook|Installation & Configuration of the Open-Xchange Connector for Microsoft Outlook]]

== Connector for Business Mobility (ActiveSync) ==

Connector for Business Mobility enables you to securely manage emails, contacts, calendar and tasks on a mobile device. It is based on Microsoft Exchange Active Sync (EAS) standard (valid Open-Xchange license required).

* [[AppSuite:Connector_for_Business_Mobility_Installation_Guide|Installation and information of the Connector for Business Mobility]]

== OX Drive ==

The OX Drive client lets you store and share your photos, files, documents and videos, anytime, anywhere. Access any file you save to OX Drive from all your computers, iPhone, iPad or from within OX App Suite itself.

* [[AppSuite:OX_Drive|Installation and information of OX Drive]]



==Open-Xchange Notifier==

OX Notifier informs the user about the current status of E-Mails and appointments without having to display the user interface or another clients such as Outlook. Additional the new tool will provide the possibility to mount the personal InfoStore directly in the OX Notifier settings (valid Open-Xchange license required).

* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]

==Microsoft Outlook® Uploader==

Open-Xchange provides Open-Xchange Microsoft Outlook® Uploader (short: OXUploader), a migration tool to export data from Microsoft Outlook® or from a Microsoft Exchange Server® to the Open-Xchange Server.

* [[OX_Outlook_Uploader|Download & Installation of the Open-Xchange Microsoft Outlook® Uploader]]

== OX Connector for cPanel ==

Integration of Open-Xchange with cPanel makes deployment and billing of Open-Xchange simple for service providers. Web hosters can offer Open-Xchange to their shared-hosting customers as well as to users of Virtual Private Servers - just by installing a software package together with cPanel.

* [[Open-Xchange_cPanel_Installation|Download & Installation of the Connector for cPanel]]

== OX Connector for WHMCS ==

Integration of OX App Suite with WHMCS/cPanel makes the deployment of OX App Suite simple for service providers and their customers. Web hosters can easily replace their existing webmail system on WHMCS/cPanel and provide customers a state-of-the-art, web based user interface with the benefits of a best in class, full-featured mobile web application – optimized for smartphones! The combination of OX App Suite, the provisioning of cPanel and the billing system WHMCS provides the perfect package for cPanel Hosting Provider and Reseller

* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]

== OX APS package for Odins Service Automation System and Plesk Panel ==

Odins Service Automation (OSA) is an operations support system (OSS) for service providers, who want to differentiate their offerings in order to reduce customer churn and attract new customers. Additional, the APS package adds a high performance, best in class email service to Odins Plesk Panel customers.

* [[Parallels_Integration|Integrate Open-Xchange with Odin]]

== OX APS 2.0 package for Odin Service Automation ==

Service Automation provides a single, centralized management console for managing offer and delivery of cloud services, and supports multiple tiers of service resellers with customizable white-labeled customer facing websites to initiate ordering and provisioning.

Service Automation provides access to all of the resources inside a service provider’s data center associated with cloud service offerings. The APS package adds a high performance, best in class email service to Odin's customers.

Attention: This APS 2.0 package is only for the Open-Xchange own OX as a Service platform or similar respective compatible deployments or copies of this platform.

* [[PA_APSv2_IntegrationGuide|OX APS 2.0 package for Odin Service Automation]]

= Installation Information =

== Information ==

* [[AppSuite:Backend_API_changes_extensions|OX App Suite - API Changes & Extensions]]

== Installation Requirements ==

* The [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] provides an overview about the supported components at the OX User Front-End, Connector for Microsoft Outlook, Connector for Business Mobility and OX Notifier. This overview makes no claim to be complete.
* [[AppSuite:Importing_OX_Buildkey|Importing the Open-Xchange public buildkey]]

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

AppSuite:Main Page Quickinstall

2015-09-11T10:11:05Z

Malte: /* OX Spreadsheet */

= OX App Suite =

== Quick Installation Guide ==

To download and install the software, please use the following Installation Guides:

* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_Debian_7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_SLES11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_RHEL6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Open-Xchange_Installation_Guide_for_CentOS_6|Download and Installation Guide for CentOS 6]]
* [[OXSE4UCS_Installation_en|Download and Installation Guide for Univention Corporate Server]]
* [[AppSuite:Demoinstallation|Download and Installation Guide for Open-Xchange SE / App Suite for UCS VMware© Demo]]

== Installing the latest Updates for OX App Suite ==

To get the latest features and bugfixes for OX App Suite, you need to have a valid license. The following article explains how that can be done:

* [[AppSuite:UpdatingOXPackages|Updating OX App Suite packages]]
* [[UpdateTasks|Update Task Management in Open-Xchange]]

== Update from 6.22.x to OX App Suite ==

To update the software, please use the following Guides:

* [[AppSuite:Upgrade_from_6.22_Debian_6.0|Update Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Upgrade_from_6.22_for_SLES11|Update Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Upgrade_from_6.22_for_RHEL6|Update Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Upgrade_from_6.22_for_CentOS6 |Update Guide for CentOS 6]]

== Parallel Setup of OX App Suite UI and OX 6 UI ==

* [[AppSuite:Parallel_UISupport_OX6_AppSuite_Debian_6.0|Parallel Setup Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_RHEL_6_CentOS_6|Parallel Setup Guide for Red Hat Enterprise Linux 6 and CentOS 6]]
* [[AppSuite:Parallel_UISupport_OX6_AppSuite_SLES_11|Parallel Setup Guide for SUSE Linux Enterprise Server 11]]

== OX App Suite deployment tutorials ==

A complete guide of necessary tasks with a hardware and setup recommendation for different Open-Xchange Hosting environments:

* [[AppSuite:OX_Tutorial_10K|OX App Suite deployment tutorial for up to 10.000 Users]]
* [[AppSuite:OX_Tutorial_100K|OX App Suite deployment tutorial for up to 100.000 Users]]
* [[AppSuite:OX_Tutorial_1M|OX App Suite deployment tutorial for up to 1.000.000 Users]]

== Reporting Tool (Mandatory for Maintenance) ==

To receive maintenance in the future, the installation of the Open-Xchange Reporting Tool is mandatory. It documents the current state of your system installation. Furthermore, the tool runs a validity check for your current maintenance. Based on the reported detail information Open-Xchange will then be able to improve its own support and maintenance offerings for you. This article explains how that can be done:

* [[AppSuite:OXReportClient|OX App Suite Reporting Client]]

= Open-Xchange Additional Tools and Configurations =

== Open-Xchange Document Viewer ==
The OX Document Viewer will choose the best preview format depending on the users device on the OX App Suite Web Interface (valid Open-Xchange license required).

* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]

== Open-Xchange Calendar synchronization with CalDAV ==

The Mac OS X, iOS and Thunderbird Lightning integration makes Open-Xchange appointments available to end users through their native applications.

* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]
* [[AppSuite:Caldav_carddav_Bundles| Installation CalDAV with Open-Xchange]]

== Open-Xchange Contact Synchronization with CardDAV ==

The Mac OS X and iOS integration makes Open-Xchange contacts available to end users through their native applications.

* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]
* [[AppSuite:Caldav_carddav_Bundles| Installation CardDAV with Open-Xchange]]

== Cluster-Setup ==
Multiple Open-Xchange servers can form a cluster with inter-OX-communication over a network.

* [[AppSuite:Running_a_cluster| Configuration Cluster-Setup]]

== HTTP based Connector via Grizzly ==
OX App Suite offers a second HTTP based connector for the communication between the HTTP server and the backend. This new connector is based on Oracle's Project Grizzly - a NIO and Web framework.

* [[AppSuite:Grizzly| Configuration Connector based on Grizzly]]

== LDAP Contact Storage ==
Open-Xchange provides a new LDAP Contact Storage Integration Bundle. The new solution is available together with the current LDAP bundle.

* [[ContactStorageLDAP| LDAP Contact Storage]]

= Open-Xchange Additional Software =

== OX Guard ==

OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it.

* [[AppSuite:OX_Guard|Installation and information of OX Guard]]
* [[Appsuite:GuardConfiguration|Configuration Options for OX Guard]]

== OX Text ==

OX Text, is a web-based word processor. Its main focus is on reducing the complexities of text editing while promoting collaborative document creation.

* [[AppSuite:Text_Installation_Guide|Download & Installation of OX Text]]

== OX Spreadsheet ==

OX Spreadsheet is a cloud based spreadsheet product that can work with Microsoft Excel documents. You can also edit shared spreadsheets on various devices. OX Spreadsheet is the first browser-based spreadsheet application that reads and writes native Microsoft Excel files without loss of format or detail ("Round-trip editing").

* [[AppSuite:Spreadsheet_Installation_Guide|Download & Installation of OX Spreadsheet]]

== OX Presenter ==

OX Presenter allows for local and remote presentations of presentation documents.

* [[AppSuite:Presenter_Installation_Guide|Download & Installation of OX Presenter]

== OX Messenger ==

OX Messenger is a real time text, voice and video communication application that fully integrates into OX App Suite. OX Messenger can optionally connect to existing third-party telephony options such as VoIP, PBX, PSTN termination etc. OX Messenger is a managed service that allows customers to provide their end users with a professional presence, text chat and real time audio/video communication capability. This service is fully integrated into a hybrid OX App Suite solution with the OX Messenger component provided by [http://addsumma.com/ Summa] in the Netherlands.

* [[AppSuite:OX_Messenger|Download & Installation of OX Messenger]]

== Open-Xchange Updater ==

The Open-Xchange Updater is a software tool by Open-Xchange that installs the latest version of Open-Xchange client software on computers running Windows (valid Open-Xchange license required).

* [[AppSuite:Open-Xchange_Updater|Installation of the Open-Xchange Updater]]

== Connector for Microsoft Outlook ==

The Open-Xchange Connector for Microsoft Outlook® lets users keep their Outlook client even if the organization moves to an Open-Xchange Server. Users feel right at home working with their Outlook interface while in the background the Connector synchronizes E-Mails, Calendar, Contacts and Tasks, along with Public, Shared and System Folders. Real-time synchronization enables fast response times, so teams can work as efficiently as possible (valid Open-Xchange license required).

* [[AppSuite:Connector_for_Microsoft_Outlook|Installation & Configuration of the Open-Xchange Connector for Microsoft Outlook]]

== Connector for Business Mobility (ActiveSync) ==

Connector for Business Mobility enables you to securely manage emails, contacts, calendar and tasks on a mobile device. It is based on Microsoft Exchange Active Sync (EAS) standard (valid Open-Xchange license required).

* [[AppSuite:Connector_for_Business_Mobility_Installation_Guide|Installation and information of the Connector for Business Mobility]]

== OX Drive ==

The OX Drive client lets you store and share your photos, files, documents and videos, anytime, anywhere. Access any file you save to OX Drive from all your computers, iPhone, iPad or from within OX App Suite itself.

* [[AppSuite:OX_Drive|Installation and information of OX Drive]]



==Open-Xchange Notifier==

OX Notifier informs the user about the current status of E-Mails and appointments without having to display the user interface or another clients such as Outlook. Additional the new tool will provide the possibility to mount the personal InfoStore directly in the OX Notifier settings (valid Open-Xchange license required).

* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]

==Microsoft Outlook® Uploader==

Open-Xchange provides Open-Xchange Microsoft Outlook® Uploader (short: OXUploader), a migration tool to export data from Microsoft Outlook® or from a Microsoft Exchange Server® to the Open-Xchange Server.

* [[OX_Outlook_Uploader|Download & Installation of the Open-Xchange Microsoft Outlook® Uploader]]

== OX Connector for cPanel ==

Integration of Open-Xchange with cPanel makes deployment and billing of Open-Xchange simple for service providers. Web hosters can offer Open-Xchange to their shared-hosting customers as well as to users of Virtual Private Servers - just by installing a software package together with cPanel.

* [[Open-Xchange_cPanel_Installation|Download & Installation of the Connector for cPanel]]

== OX Connector for WHMCS ==

Integration of OX App Suite with WHMCS/cPanel makes the deployment of OX App Suite simple for service providers and their customers. Web hosters can easily replace their existing webmail system on WHMCS/cPanel and provide customers a state-of-the-art, web based user interface with the benefits of a best in class, full-featured mobile web application – optimized for smartphones! The combination of OX App Suite, the provisioning of cPanel and the billing system WHMCS provides the perfect package for cPanel Hosting Provider and Reseller

* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]

== OX APS package for Odins Service Automation System and Plesk Panel ==

Odins Service Automation (OSA) is an operations support system (OSS) for service providers, who want to differentiate their offerings in order to reduce customer churn and attract new customers. Additional, the APS package adds a high performance, best in class email service to Odins Plesk Panel customers.

* [[Parallels_Integration|Integrate Open-Xchange with Odin]]

== OX APS 2.0 package for Odin Service Automation ==

Service Automation provides a single, centralized management console for managing offer and delivery of cloud services, and supports multiple tiers of service resellers with customizable white-labeled customer facing websites to initiate ordering and provisioning.

Service Automation provides access to all of the resources inside a service provider’s data center associated with cloud service offerings. The APS package adds a high performance, best in class email service to Odin's customers.

Attention: This APS 2.0 package is only for the Open-Xchange own OX as a Service platform or similar respective compatible deployments or copies of this platform.

* [[PA_APSv2_IntegrationGuide|OX APS 2.0 package for Odin Service Automation]]

= Installation Information =

== Information ==

* [[AppSuite:Backend_API_changes_extensions|OX App Suite - API Changes & Extensions]]

== Installation Requirements ==

* The [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] provides an overview about the supported components at the OX User Front-End, Connector for Microsoft Outlook, Connector for Business Mobility and OX Notifier. This overview makes no claim to be complete.
* [[AppSuite:Importing_OX_Buildkey|Importing the Open-Xchange public buildkey]]

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

AppSuite:DocumentAutomation

2015-05-21T17:25:40Z

Malte: /* The conversion URL */

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieved via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encoded in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type ''Mail merge field''.

Note: In Open Office the field type is called ''Mail merge field''. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use ''MergeField'' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new document based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

''<nowiki>https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&convert=1&EXTRA</nowiki>''

Replace FOLDERID and FILEID with the actual values of your document.

The parameter ''convert=1'' parameter is needed so that a new document will be created. Without this parameter, the original template will just be opened in the editor.

The new document will be created in "my files".

Optional parameters:
''destfilename=<filename>''
The file will be named <filename>.odt. If the name already exists, a unique name will be created

''destfolderid=<folderid>''
The new document will be places in <folderid>, if the user has write access

The EXTRA parameter depends on the way how you want to transfer the data, see below.

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: ''fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2''

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: ''fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }''

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: ''fields-source=CSVFILEID''

CSVFILEID is the id of the cvs file.

AppSuite:DocumentAutomation

2015-05-21T16:33:10Z

Malte: /* The conversion URL */

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieved via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encoded in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type ''Mail merge field''.

Note: In Open Office the field type is called ''Mail merge field''. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use ''MergeField'' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new document based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

''<nowiki>https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&convert=1&EXTRA</nowiki>''

Replace FOLDERID and FILEID with the actual values of your document.

The parameter ''convert=1'' parameter is needed so that a new document will be created. Without this parameter, the original template will just be opened in the editor.

EXTRA is one of the things described below:

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: ''fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2''

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: ''fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }''

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: ''fields-source=CSVFILEID''

CSVFILEID is the id of the cvs file.

AppSuite:Main Page userguides

2015-05-05T14:30:04Z

Malte: /* Advanced Documentation */

= OX App Suite =
OX App Suite is a centralized cloud environment that lets you take control of your digital life from anywhere. It provides and centralizes email, contacts, calendar and tasks. A cloud based file storage and document management/viewing/editing. Additional a digital life management portal that lets you access all this and more regardless of device or operating system.

{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-German-v7.6.2.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-English-v7.6.2.pdf English]
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-French-v7.6.2.pdf French]
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-Italian-v7.6.2.pdf Italian]
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-Japanese-v7.6.2.pdf Japanese]
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-Mexican_Spanish-v7.6.2.pdf Mexican]
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-Polish-v7.6.2.pdf Polish]
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-Spanish-v7.6.2.pdf Spanish]
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-simplified_Chinese-v7.6.2.pdf Simplified Chinese]
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-traditional_Chinese-v7.6.2.pdf Traditional Chinese]
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-Dutch-v7.6.2.pdf Dutch]
|[http://software.open-xchange.com/products/appsuite/doc/OX-App-Suite-User-Guide-British_English-v7.6.2.pdf British English]
|-
|}

= Open-Xchange Additional Software =

== OX Documents (OX Text, OX Spreadsheet) ==
OX Documents is a collection of document orientated apps that can be white-labelled and delivered as a variety of bundles to both consumer and business users. OX Text is a collaborative, cloud-based word processing solution. OX Spreadsheet is a cloud-based spreadsheet solution.

{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-German-v7.6.2.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-English-v7.6.2.pdf English]
|-
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-French-v7.6.2.pdf French]
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Italian-v7.6.2.pdf Italien]
|-
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Japanese-v7.6.2.pdf Japanese]
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Polish-v7.6.2.pdf Polish]
|-
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Spanish-v7.6.2.pdf Spanish]
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-British_English-v7.6.2.pdf Britsh-English]
|-
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Mexican_Spanish-v7.6.2.pdf Mexican-Spanish]
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Simplified_Chinese-v7.6.2.pdf Simplified Chinese]
|-
|[http://software.open-xchange.com/products/appsuite/doc/documents/OX-Documents-User-Guide-Traditional_Chinese-v7.6.2.pdf Traditional Chinese]
|
|-
|}

== OX Messenger ==
OX Messenger is a real time text, voice and video communication application that fully integrates into OX App Suite. OX Messenger can optionally connect to existing third-party telephony options such as VoIP, PBX, PSTN termination etc. OX Messenger is a managed service that allows customers to provide their end users with a professional presence, text chat and real time audio/video communication capability. This service is fully integrated into a hybrid OX App Suite solution with the OX Messenger component provided by Voiceworks B.V. in the Netherlands.

{|align="left">
|-
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-German-v1.0.pdf German]
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-English-v1.0.pdf English]
|-
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-French-v1.0.pdf French]
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Italian-v1.0.pdf Italien]
|-
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Japanese-v1.0.pdf Japanese]
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Polish-v1.0.pdf Polish]
|-
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Spanish-v1.0.pdf Spanish]
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-British_English-v1.0.pdf Britsh-English]
|-
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Mexican_Spanish-v1.0.pdf Mexican-Spanish]
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Simplified_Chinese-v1.0.pdf Simplified Chinese]
|-
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Traditional_Chinese-v1.0.pdf Traditional Chinese]
|[http://software.open-xchange.com/products/messenger/doc/OX-Messenger-User-Guide-Dutch-v1.0.pdf Dutch]
|-
|}

== Connector for Microsoft Outlook ==
The Open-Xchange Connector for Microsoft Outlook® lets users keep their Outlook client even if the organization moves to an Open-Xchange Server. Users feel right at home working with their Outlook interface while in the background the Connector synchronizes E-Mails, Calendar, Contacts and Tasks, along with Public, Shared and System Folders. Real-time synchronization enables fast response times, so teams can work as efficiently as possible (valid Open-Xchange license required).

{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-German-v7.4.1.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-English-v7.4.1.pdf English]
|-
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-French-v7.4.1.pdf French]
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-Italian-v7.4.1.pdf Italien]
|-
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-Japanese-v7.4.1.pdf Japanese]
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-Polish-v7.4.1.pdf Polish]
|-
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-Spanish-v7.4.1.pdf Spanish]
|[http://software.open-xchange.com/products/appsuite/doc/outlookconnector/Connector-for-Microsoft-Outlook-Dutch-v7.4.1.pdf Dutch]
|-
|}

== Connector for Business Mobility ==

=== User Guides ===
Connector for Business Mobility enables you to securely manage emails, contacts, calendar and tasks on a mobile device. It is based on Microsoft Exchange Active Sync (EAS) standard (valid Open-Xchange license required).

{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-German-v7.6.2.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-English-v7.6.2.pdf English]
|-
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-French-v7.6.2.pdf French]
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-Italian-v7.6.2.pdf Italien]
|-
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-Japanese-v7.6.2.pdf Japanese]
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-Polish-v7.6.2.pdf Polish]
|-
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-Spanish-v7.6.2.pdf Spanish]
|[http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/OX-App-Suite-Connector-for-Business-Mobility-Dutch-v7.6.2.pdf Dutch]
|-
|}

== Open-Xchange Updater ==
The Open-Xchange Updater is a software tool by Open-Xchange that installs the latest version of Open-Xchange client software on computers running Windows (valid Open-Xchange license required).

{|align="left">
|-
|[http://software.open-xchange.com/components/updater/doc/Updater-Overview-German-v7.6.0.pdf German]
|[http://software.open-xchange.com/components/updater/doc/Updater-Overview-English-v7.6.0.pdf English]
|-
|[http://software.open-xchange.com/components/updater/doc/Updater-Overview-French-v7.6.0.pdf French]
|[http://software.open-xchange.com/components/updater/doc/Updater-Overview-Spanish.pdf Spanish]
|-
|[http://software.open-xchange.com/components/updater/doc/Updater-Overview-Dutch-v7.6.0.pdf Dutch]
|
|-
|}

=== Client Configuration ===

Information about the client configuration for the different devices is available at the [http://software.open-xchange.com/products/appsuite/doc/mobilityconnector/ User Guides].

== OX Text ==

OX Text, is a web-based word processor. Its main focus is on reducing the complexities of text editing while promoting collaborative document creation.

* [[AppSuite:Text_Installation_Guide|Download & Installation of OX Text]]

== Open-Xchange Mobile Web Interface ==

Open-Xchange Mobile Web Interface, lets you access data from Open-Xchange Server 6 with your smartphone running a webkit based browser like the iPhone or Android devices. Open-Xchange Mobile Web Interface offers online and offline access to appointments, contacts and mails on the road using your smartphone (valid Open-Xchange license required).

* [[AppSuite:OX_Mobile_Web_Interface|Installation of the Open-Xchange Mobile Web Interface]]

==Open-Xchange Notifier==

OX Notifier informs the user about the current status of E-Mails and appointments without having to display the user interface or another clients such as Outlook. Additional the new tool will provide the possibility to mount the personal InfoStore directly in the OX Notifier settings (valid Open-Xchange license required).

* [[Open-Xchange_Installation_Guide_for_OX_Notifier|Installation & Configuration of the Open-Xchange Notifier]]

==Microsoft Outlook® Uploader==

Open-Xchange provides Open-Xchange Microsoft Outlook® Uploader (short: OXUploader), a migration tool to export data from Microsoft Outlook® or from a Microsoft Exchange Server® to the Open-Xchange Server.

* [[OX_Outlook_Uploader|Download & Installation of the Open-Xchange Microsoft Outlook® Uploader]]

== OX Connector for cPanel ==

Integration of Open-Xchange with cPanel makes deployment and billing of Open-Xchange simple for service providers. Web hosters can offer Open-Xchange to their shared-hosting customers as well as to users of Virtual Private Servers - just by installing a software package together with cPanel.

* [[Open-Xchange_cPanel_Installation|Download & Installation of the Connector for cPanel]]

== OX Connector for WHMCS ==

Integration of OX App Suite with WHMCS/cPanel makes the deployment of OX App Suite simple for service providers and their customers. Web hosters can easily replace their existing webmail system on WHMCS/cPanel and provide customers a state-of-the-art, web based user interface with the benefits of a best in class, full-featured mobile web application – optimized for smartphones! The combination of OX App Suite, the provisioning of cPanel and the billing system WHMCS provides the perfect package for cPanel Hosting Provider and Reseller

* [[AppSuite:Connector_for_WHMCS_Installation_Guide|Download & Installation of the OX Connector for WHMCS]]

== OX APS package for Parallels Operation Automation System and Plesk Panel ==

Parallels Operations Automation (POA) is an operations support system (OSS) for service providers, who want to differentiate their offerings in order to reduce customer churn and attract new customers. Additional, the APS package adds a high performance, best in class email service to Parallels Plesk Panel customers.

* [[Parallels_Integration|Integrate Open-Xchange with Parallels]]

== OX Drive ==
The OX Drive client lets you store and share your photos, files, documents and videos, anytime, anywhere. Access any file you save to OX Drive from all your computers, iPhone, iPad or from within OX App Suite itself.

{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-German-v1.4.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-English-v1.4.pdf English]
|-
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-French-v1.4.pdf French]
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-Italian-v1.4.pdf Italian]
|-
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-Japanese-v1.4.pdf Japanese]
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-Mexican_Spanish-v1.4.pdf Mexican]
|-
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-Polish-v1.4.pdf Polish]
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-Spanish-v1.4.pdf Spanish]
|-
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-simplified_Chinese-v1.4.pdf Simplified Chinese]
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-traditional_Chinese-v1.4.pdf Traditional Chinese]
|-
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-Dutch-v1.4.pdf Dutch]
|[http://software.open-xchange.com/products/appsuite/doc/drive/OX-OXDrive-User-Guide-British_English-v1.4.pdf British English]
|-
|}

== OX Guard ==
OX Guard is a fully integrated security add-on to OX App Suite that provides end users with a flexible email and file encryption solution. OX Guard is a highly scalable, multi server, feature rich solution that is so simple-to-use that end users will actually use it.

{|align="left">
|-
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-German-v1.2.pdf German]
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-English-v1.2.pdf English]
|-
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-French-v1.2.pdf French]
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Italian-v1.2.pdf Italian]
|-
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Japanese-v1.2.pdf Japanese]
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Mexican_Spanish-v1.2.pdf Mexican]
|-
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Polish-v1.2.pdf Polish]
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Spanish-v1.2.pdf Spanish]
|-
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Simplified_Chinese-v1.2.pdf Simplified Chinese]
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Traditional_Chinese-v1.2.pdf Traditional Chinese]
|-
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-Dutch-v1.2.pdf Dutch]
|[http://software.open-xchange.com/products/guard/doc/OX-Guard-User-Guide-British_English-v1.2.pdf British English]
|-
|}

= Open-Xchange Additional Tools and Configurations =

== Open-Xchange Document Viewer ==
The OX Document Viewer will choose the best preview format depending on the users device on the OX App Suite Web Interface (valid Open-Xchange license required).

* [[AppSuite:DocumentViewer |Download & Install Document Viewer]]

== Open-Xchange Calendar synchronization with CalDAV ==

The Mac OS X, iOS and Thunderbird Lightning integration makes Open-Xchange appointments available to end users through their native applications.

* [[AppSuite:CalDAVClients | Configuration CalDAV with Open-Xchange]]
* User Manual Calendar synchronization with CalDAV (pdf):
{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-CalDAV-CardDAV-User-Guide-German-v7.6.0.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/OX-CalDAV-CardDAV-User-Guide-English-v7.6.0.pdf English]
|}

== Open-Xchange Contact Synchronization with CardDAV ==

The Mac OS X and iOS integration makes Open-Xchange contacts available to end users through their native applications.

* [[AppSuite:CardDAVClients | Configuration CardDAV with Open-Xchange]]
* User Manual Calendar synchronization with CardDAV (pdf):
{|align="left">
|-
|[http://software.open-xchange.com/products/appsuite/doc/OX-CalDAV-CardDAV-User-Guide-German-v7.6.0.pdf German]
|[http://software.open-xchange.com/products/appsuite/doc/OX-CalDAV-CardDAV-User-Guide-English-v7.6.0.pdf English]
|}

= Advanced Documentation =
* [[Import_holidays|Importing holidays into the OX Calendar]]
* [[AppSuite:UI improvements]]
* [[AppSuite:KeyboardControlled|Keyboard Shortcuts]]
* [[AppSuite:DocumentAutomation|Field Automation]]

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

AppSuite:DocumentAutomation

2015-05-05T14:27:52Z

Malte: /* The conversion URL */

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieved via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encoded in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type ''Mail merge field''.

Note: In Open Office the field type is called ''Mail merge field''. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use ''MergeField'' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new document based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

''<nowiki>https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&convert=1&EXTRA</nowiki>''

Replace FOLDERID and FILEID with the actual values of your document.

EXTRA is one of the things described below:

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: ''fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2''

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: ''fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }''

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: ''fields-source=CSVFILEID''

CSVFILEID is the id of the cvs file.

AppSuite:DocumentAutomation

2015-05-05T14:20:18Z

Malte: /* The conversion process */

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieved via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encoded in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type ''Mail merge field''.

Note: In Open Office the field type is called ''Mail merge field''. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use ''MergeField'' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new document based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&EXTRA

Replace FOLDERID and FILEID with the actual values of your document.

EXTRA is one of the things described below:

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: fields-source=CSVFILEID

CSVFILEID is the id of the cvs file.

AppSuite:DocumentAutomation

2015-05-05T14:19:33Z

Malte: /* The document template */

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieved via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encoded in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type ''Mail merge field''.

Note: In Open Office the field type is called ''Mail merge field''. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use ''MergeField'' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new documents based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&EXTRA

Replace FOLDERID and FILEID with the actual values of your document.

EXTRA is one of the things described below:

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: fields-source=CSVFILEID

CSVFILEID is the id of the cvs file.

AppSuite:DocumentAutomation

2015-05-05T14:16:12Z

Malte: /* OX Text field automation */

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieved via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encoded in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type “Mail merge field”.

Note: In Open Office the field type is called “Mail merge field”. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use 'MergeField' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new documents based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&EXTRA

Replace FOLDERID and FILEID with the actual values of your document.

EXTRA is one of the things described below:

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: fields-source=CSVFILEID

CSVFILEID is the id of the cvs file.

AppSuite:DocumentAutomation

2015-05-05T14:15:07Z

Malte:

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieve via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encodes in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type “Mail merge field”.

Note: In Open Office the field type is called “Mail merge field”. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use 'MergeField' in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new documents based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:

https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&EXTRA

Replace FOLDERID and FILEID with the actual values of your document.

EXTRA is one of the things described below:

==== Field values via URL ====

This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by semicolon.

===== JSON notation =====

url EXTRA parameter: fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }

FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/value pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.

url EXTRA parameter: fields-source=CSVFILEID

CSVFILEID is the id of the cvs file.

AppSuite:DocumentAutomation

2015-05-05T14:11:07Z

Malte: Automatically fill fields in ODF templates

<div class="title">OX Text Field Automation</div>

== OX Text field automation ==

OX Text allows the user to automatically fill user fields in ODF text documents when creating a document from a template.

This can be achieve via regular urls passed to the browser, so that the process can also be triggered from outside, e.g. from a desktop application.

The data can easily be encodes in the url, but as the length of urls has limitations, you can also specify a cvs file in OX Drive.

=== The document template ===

The source template or regular document needs to include fields of type “Mail merge field”.

Note: In Open Office the field type is called “Mail merge field”. Unfortunately you can’t specify the name of the field, as you can only select items from an existing database. So you need to add fields with the desired name to the database that comes with Open Office. Alternatively, use “MergeField” in Microsoft Word and specify the name, but don’t forget to save as ODF.

=== The conversion process ===

To create a new documents based on an existing document or template, with updating the content of the fields, you have different choices to pass the field data to OX Text.

=== The conversion URL ===

The general syntax for all the different ways to perform a conversion is:
https://appsuiteserver/appsuite/#!&folder=FOLDERID&id=FILEID&app=io.ox/office/text&EXTRA
Replae FOLDERID and FILEID with the actual values of your document.
EXTRA is one of the things described below:

==== Field values via URL ====
This solution is convenient if you have just a few fields. Keep in mind that the maximum length of the url is limited, the limit might vary from browser to browser.

To the base url described above, add the data in field/value notation, or in JSON notation.

===== field/value pair notation =====

url EXTRA parameter: fields=FIELDNAME1;FIELDVALUE1;FIELDNAME2;FIELDVALUE2
FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/valuie pairs as you want, separated by semicolon.

===== JSON notation =====

fields={“FIELDNAME1”:“FIELDVALUE1”,“FIELDNAME2”:“FIELDVALUE2” }
url EXTRA parameter: FIELDNAME<n> is the name of the field, FIELDVALUE<n> is the text that you want to place into the field. Add as many name/valuie pairs as you want, separated by comma.

==== Field values via CVS File ====

The values can also be read from a cvs file located in OX Drive. This avoids exceeding the maximum url length.

===== CSV notation =====

The csv file can use tabs, semicolons or commas as a separator. All fields containing commas or semicolons must be placed inside quotes. The first line in the csv file contains the field names, the second line contains the field values.
url EXTRA parameter: fields-source=CSVFILEID
CSVFILEID is the id of the cvs file.

AppSuite:DocumentConverter Installation Guide

2015-01-22T17:56:39Z

Malte: /* Sharepoint support */

= 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.

== 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.

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.

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

The [[AppSuite:DocumentConverter_API|API reference]] describes the available actions with request parameters and results.

== Requirements ==

OX Document Converter requires a 64bit systems; 32bit systems are not supported. 
See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

== Download and Installation ==

The OX Document Converter deployment consists of two functional modules, that need to be installed separately: the ''readerengine'' component and the ''Document Converter Webservice'' component.

=== ReaderEngine ===

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]]

=== Webservice ===

See [[AppSuite:DocumentConverterInstall|Document converter installation instructions]]

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

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

=== Configuration ===

After deployment of both components ''readerengine'' and ''Web service'', the administrator needs to make some adjustments to the configuration of the OX Document Converter installation.

The component readerengine works with the default configuration.
The settings are in the file '''documentconverter.properties'''
located in the directory "/opt/open-xchange/etc" as described below.

{{AppSuite:ReaderEngineConfig}}



== Setup And Best Practices ==

The whole documentconverter product consists of 3 different parts: the OX backend documentconverter bundles, written in Java as OSGi plugins, the native readerengine and a native tool called pdf2svg.

=== Readerengine ===
The '''readerengine''' is - as the name implies - the low level backend engine for the converter implementation, that acts as a general purpose document conversion solution, being able to read a vast number of commonly used document formats like Microsoft binary and XML formats (MS Word, MS Excel, MS Powerpoint), the whole set of ODF (Open Document Format) document formats and many more, and to export the loaded documents into different output formats like '''PDF'''.

The '''readerengine''' itself is a stripped down Open Office installation, containing some code enhancements and optimizations, provided by Open-Xchange developers. The packaging is also done in-house to have control of the whole development cycle, versioning and other aspects of the product development.

=== PDF2SVG ===
The '''pdf2svg''' component is a tool, that uses libpoppler for reading and processing '''PDF''' source documents and Cairo for rendering the processed '''PDF''' into '''SVG''', '''JPEG''' and '''PNG''' formats, to be finally rendered within the OX appsuite client.

=== Documentconverter OSGi bundles ===
The OX appsuite backend bundles of the documentconverter are responsible for receiving and processing client conversion '''requests''', to '''schedule''' conversion jobs in multi threaded queues, to manage the correct '''startup''' and '''shutdown''' of (parallel) '''readerengine''' and '''readerengine-pdf2svg''' instances, managing the '''caching''' of conversion results, '''communication''' with remote converters and remote converter caches etc.

After installation of the documentconverter and related bundles, only minor changes have to be made by the admin in order to get the full functionality available within the appsuite.

==== Documentconverter system packages ====
The Java OSGi bundles for the documentconverter functionality are distributed via four different packages in total (revision numbers are omitted here):
* '''documentconverter-api''' This bundle contains interfaces and other simple classes that are used by different other bundles to get access to the documentconverter OSGi service.
* '''documentconverter''' This bundle contains the core documentconverter implementation as an OSGi service.
* '''documentconverter-webservice''' This bundle contains the functionality to let the documentconverter offer its functionality as a webservice. In a remote scenario, this bundle needs to be installed only on those machines, that are configured to do the real conversions.
* '''documentconverter-jolokia''' This optional bundle can be installed to make internal conversion statistics available for monitoring via Munin et al. The contained scripts provide access to the statistic data either via the modern '''Jolokia JMX''' bridge or the old fashioned '''showruntimestats''' functionality, provided by the OX appsuite backend.

=== General ===
By taking a look at the overview of documentconverter system packages in the chapter above, it can be seen, that the two essential packages to be installed are the '''documentconverter-api'' and the '''documentconverter''' packages.

If the current OX backend node is configured to only receive client requests and to make remote conversion calls to an other node, configured as a ''real'' converter node, no additional packages need to be installed.

In order to act as ''real'' converter node, the '''readerengine''' and the '''readerengine-pdf2svg''' packages need to be installed as well.

For an OX backend node to act as a conversion webservice, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', the '''documentconverter''', the '''readerengine''' and the the '''readerengine-pdf2svg''' packages.

The '''documentconverter-jolokia''' package only makes sense to be installed on an OX backend node, that acts as ''real'' converter node.

In summary, the following packages must be installed in order to act as a real converter node:

open-xchange-documentconverter-webservice readerengine open-xchange open-xchange-grizzly open-xchange-authentication-database

The package open-xchange-authentication-database is just needed to fulfill the dependencies.

=== Single OX backend with documentconverter / Single converter node ===
The simplest possible scenario is definitely a single OX appsuite backend installation with the additional installation of the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

Nevertheless, this configuration can be considered as the prototype configuration block for a ''real'' converter node with different setups. Therefore, the description for this building block will contain all details, that are necessary to setup even a highly complex scenario.

'''Important:''' although it is possible to run a ''real'' documentconverter on a standard OX backend node together with all other provided services, this setup is not recommended for production use, as long as each single node hardware is not sufficient enough to handle everything appropriately. This is especially true, if this node is also configured to act as a calcengine server, which itself has a resource consumption, that can be seen on the high side with a lot of memory consumption.

Documentconversion is a process, that might happen in the background all of the time due to permanent client requests. In such cases, the standard OX backend behavior might be slowed down in a way, that is not acceptable anymore. This is really important in cases of inferior hardware resources.

So, please use this ''all-in-one'' scenario only for quick evaluation purposes, demo setups or if there's really no dedicated conversion hardware available.

=== Configuration and Hardware ===
After installation of the single documentconverter related packages, the default values for the documentconverter properties can be found in the file /opt/open-xchange/etc/documentconverter.properties. Each entry is documented and has been assigned a default value, that is in most cases sufficient for a first setup. Please take care that all listed directory paths have the appropriate write permissions for the OX backend user.

'''VERY IMPORTANT:''' Each ''real'' converter node needs its own scratch and cache directories. Don't set these directories to shared directories like NFS shares etc., since file writes to the same cache/scratch directories by different backend nodes are not synchronized at the moment and will most possibly corrupt some files over the time. Actually, it is possible to use a shared network drive for the cache and scratch directories, as long as the finally used directories are unique for each given node. In this case, the documentconverter.properties file on each node has to be adjusted accordingly to guarantee such a unique, per node directory structure.

In addition, you should check the following entries for their validity/sensibility:

* For the scratch directory, it is recommended to use a very fast volume (e.g. on SSD or even a RAM disk, if memory allows), since temp. files are permanently created and deleted within this directory. The whole documentconverter performance will benefit from a high speed volume in any case.
* The cache sizes, configured in the properties file, should be checked against the given hardware and volume sizes and adjusted accordingly, if wanted/needed. Cache entries are only read/written once during a conversion, so that the used medium does not need to be a high speed one. For the cache, it is better to use more memory than speed, since cached files will accelerate the whole conversion process the most.
* The number of parallel readerengine instances used is configured via the property '''com.openexchange.documentconverter.jobProcessorCount'''. The default value of '''three''' should fit on almost all modern hardware. Please adjust this value depending on the really available CPU cores in your case. As long as the current node is configured as a conversion only node, the number of parallel processes should be in the order of (CPU core count - 1)
* The '''com.openexchange.documentconverter.maxVMemMB''' config entry is the '''virtual''' memory assigned to each readerengine process. You don't need to have (jobProcessorCount * maxVMemMB) in reality, since large parts of this VMem is shared memory between all running readerengine instances. So, there's no simple formula to calculate the optimum total amount of memory. For the beginning, a '''maxVMemMB''' value of 2048 is absolutely ok and sufficient. The node, the documentconverter is running on, should have at least 8GB RAM, with more RAM and more processors being better, of course. A good recommendation would be a total amount of 16GB RAM for the node and a CPU core count of 4. A dual CPU machine with 4 cores each seems to be a better recommendation, if hardware is not a crucial point in the whole setup.
* The upper limit for the Java VM memory allocation should not be below 2048MB (-Xmx2048m). Please adjust this value accordingly, but don't set this value too high, since values greater than about 4GB will have significant negative impact on the Java VM Garbage Collector. 2048MB seemed to be a very sensible value for the -Xmx limit during our tests.

=== OX backend(s) with one remote documentconverter ===
A remote documentconverter setup uses (at least) one OX backend, configured as a ''real'' documentconverter as described in the chapter above. This documentconverter node should not handle standard OX backend requests, but only remote conversion requests from the standard OX backends.

The standard OX backend needs to have the '''documentconverter-api''' and the '''documentconverter''' packages installed. '''readerengine''' and '''readerengine-pdf2svg''' packages are not needed on the standard OX backends.

For the remote converter node, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

In order to request remote conversions, the only entry, that needs to be set within the '''documentconverter.properties''' file at the standard OX backend(s) is the '''com.openexchange.documentconverter.RemoteBaseUrl''' entry. In general, this is a http-URL consisting of the remote conversion node ip address followed by the '''/documentconverterws''' path:\\

<blockquote>
com.openexchange.documentconverter.RemoteBaseUrl=http://host[:port]/documentconverterws
</blockquote>

No other entry from the '''documentconverter.properties''' is used on the standard OX backend if the '''RemoteBaseUrl''' is set.

In order to check, if the remote documentconverter is correctly set up, you can enter the complete RemoteBaseUrl into a browser and should see a page, stating that the documentconverter is running.

=== OX backend cluster with one remote documentconverter ===
The OX backend cluster is the standard OX backend scenario, which is similar, if not equal to the standard OX backend with one documentconverter scenario above.

The only thing that you need to take care of is to add the the appropriate documentconverterws ProxyPass entry to the proxy_http.conf configuration file of e.g. the Apache web server:

<blockquote>
<Proxy /documentconverterws> 
ProxyPass balancer://oxcluster/documentconverterws 
<proxy> 
</blockquote>

=== Sample cluster installation ===

A typical, basic cluster setup consists of two or more standard OX backend nodes (e.g. samplehost-node-1, samplehost-node-2, ...., samplehost-node-n), with each of these standard backend nodes having their '''com.openexchange.documentconverter.RemoteBaseUrl''' config entry set to a dedicated documentconverter cluster node (e.g. samplehost-node-x).

=== OX backend cluster with two or more documentconverters ===
To reduce the load on one documentconverter within a cluster installation, you can add more documentconverter nodes to the given cluster. The general setup is the same as with the '''Ox backend cluster with one remote documentconverter''' setup.

In addition, care needs to be taken to add the appropriate JSESSIONID cookie handling to the cluster setup. This is done for OX clusters in general, but mentioned here for completeness. Setting the JSESSIONID cookie is essential in a multi documentconverter setup, since the Viewer client application uses stateful calls into the OX backend to retrieve the single pages of a document on demand.

A typical Proxy configuration with proper stickysession handling looks as follows:

<blockquote>
<Proxy balancer://oxcluster> 
Order deny,allow 
Allow from all 
BalancerMember http://docs-develop-cluster-b1:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX1 
BalancerMember http://docs-develop-cluster-b2:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX2 
ProxySet stickysession=JSESSIONID 
SetEnv proxy-initial-not-pooled 
SetEnv proxy-sendchunked 
</Proxy> 
</blockquote>

=== Remote caching with two or more documentconverters ===
As mentioned above, using a cache gives a lot of performance improvements with subsequent conversion request. Having more than one ''real'' documentconverter node configured allows to get access to the remote caching feature.

In general, one converter acts as a so called master cache in this scenario. It is set up as usual and as described in one of the chapters above.

The second (third, ...) converter are also set up as usual, but have their '''com.openexchange.documentconverter.RemoteCacheUrls documentconverter.properties''' set, so that the first URL (of possible more URLs) points to the master cache converter.

The URL to be used is the standard RemoteBaseURL with an additional '''/cache''' path set:

<blockquote>
com.openexchange.documentconverter.RemoteCacheUrls=http://mastercachehost[:port]/documentconverterws/cache
</blockquote>

In this case, after searching the local cache for a conversion result after a conversion request arrives without any success, all set remote cache hosts are queried for a successful cache result.

If one of the remote cache hosts returns a valid cache result, the cache entry is locally replicated and the cache result is returned.

If none of the remote cache hosts returns a valid cache result, a local conversion is performed, a local cache entry is created and the cache result is transferred to the first set remote cache host (the master cache host).

=== Sharepoint support ===

It's possible to optionally use a Sharepoint server to perform certain conversions, mainly to convert from Microsoft Word and PowerPoint to PDF so that the documents look better in the OX Document Viewer.

No OX user credentials are needed on the Sharepoint server, as shown in this overview:

[[File:OX_Document_Converter_Overview.jpg]]

AppSuite:DocumentConverter Installation Guide

2015-01-22T17:56:14Z

Malte: /* Sharepoint support */

= 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.

== 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.

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.

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

The [[AppSuite:DocumentConverter_API|API reference]] describes the available actions with request parameters and results.

== Requirements ==

OX Document Converter requires a 64bit systems; 32bit systems are not supported. 
See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

== Download and Installation ==

The OX Document Converter deployment consists of two functional modules, that need to be installed separately: the ''readerengine'' component and the ''Document Converter Webservice'' component.

=== ReaderEngine ===

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]]

=== Webservice ===

See [[AppSuite:DocumentConverterInstall|Document converter installation instructions]]

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

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

=== Configuration ===

After deployment of both components ''readerengine'' and ''Web service'', the administrator needs to make some adjustments to the configuration of the OX Document Converter installation.

The component readerengine works with the default configuration.
The settings are in the file '''documentconverter.properties'''
located in the directory "/opt/open-xchange/etc" as described below.

{{AppSuite:ReaderEngineConfig}}



== Setup And Best Practices ==

The whole documentconverter product consists of 3 different parts: the OX backend documentconverter bundles, written in Java as OSGi plugins, the native readerengine and a native tool called pdf2svg.

=== Readerengine ===
The '''readerengine''' is - as the name implies - the low level backend engine for the converter implementation, that acts as a general purpose document conversion solution, being able to read a vast number of commonly used document formats like Microsoft binary and XML formats (MS Word, MS Excel, MS Powerpoint), the whole set of ODF (Open Document Format) document formats and many more, and to export the loaded documents into different output formats like '''PDF'''.

The '''readerengine''' itself is a stripped down Open Office installation, containing some code enhancements and optimizations, provided by Open-Xchange developers. The packaging is also done in-house to have control of the whole development cycle, versioning and other aspects of the product development.

=== PDF2SVG ===
The '''pdf2svg''' component is a tool, that uses libpoppler for reading and processing '''PDF''' source documents and Cairo for rendering the processed '''PDF''' into '''SVG''', '''JPEG''' and '''PNG''' formats, to be finally rendered within the OX appsuite client.

=== Documentconverter OSGi bundles ===
The OX appsuite backend bundles of the documentconverter are responsible for receiving and processing client conversion '''requests''', to '''schedule''' conversion jobs in multi threaded queues, to manage the correct '''startup''' and '''shutdown''' of (parallel) '''readerengine''' and '''readerengine-pdf2svg''' instances, managing the '''caching''' of conversion results, '''communication''' with remote converters and remote converter caches etc.

After installation of the documentconverter and related bundles, only minor changes have to be made by the admin in order to get the full functionality available within the appsuite.

==== Documentconverter system packages ====
The Java OSGi bundles for the documentconverter functionality are distributed via four different packages in total (revision numbers are omitted here):
* '''documentconverter-api''' This bundle contains interfaces and other simple classes that are used by different other bundles to get access to the documentconverter OSGi service.
* '''documentconverter''' This bundle contains the core documentconverter implementation as an OSGi service.
* '''documentconverter-webservice''' This bundle contains the functionality to let the documentconverter offer its functionality as a webservice. In a remote scenario, this bundle needs to be installed only on those machines, that are configured to do the real conversions.
* '''documentconverter-jolokia''' This optional bundle can be installed to make internal conversion statistics available for monitoring via Munin et al. The contained scripts provide access to the statistic data either via the modern '''Jolokia JMX''' bridge or the old fashioned '''showruntimestats''' functionality, provided by the OX appsuite backend.

=== General ===
By taking a look at the overview of documentconverter system packages in the chapter above, it can be seen, that the two essential packages to be installed are the '''documentconverter-api'' and the '''documentconverter''' packages.

If the current OX backend node is configured to only receive client requests and to make remote conversion calls to an other node, configured as a ''real'' converter node, no additional packages need to be installed.

In order to act as ''real'' converter node, the '''readerengine''' and the '''readerengine-pdf2svg''' packages need to be installed as well.

For an OX backend node to act as a conversion webservice, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', the '''documentconverter''', the '''readerengine''' and the the '''readerengine-pdf2svg''' packages.

The '''documentconverter-jolokia''' package only makes sense to be installed on an OX backend node, that acts as ''real'' converter node.

In summary, the following packages must be installed in order to act as a real converter node:

open-xchange-documentconverter-webservice readerengine open-xchange open-xchange-grizzly open-xchange-authentication-database

The package open-xchange-authentication-database is just needed to fulfill the dependencies.

=== Single OX backend with documentconverter / Single converter node ===
The simplest possible scenario is definitely a single OX appsuite backend installation with the additional installation of the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

Nevertheless, this configuration can be considered as the prototype configuration block for a ''real'' converter node with different setups. Therefore, the description for this building block will contain all details, that are necessary to setup even a highly complex scenario.

'''Important:''' although it is possible to run a ''real'' documentconverter on a standard OX backend node together with all other provided services, this setup is not recommended for production use, as long as each single node hardware is not sufficient enough to handle everything appropriately. This is especially true, if this node is also configured to act as a calcengine server, which itself has a resource consumption, that can be seen on the high side with a lot of memory consumption.

Documentconversion is a process, that might happen in the background all of the time due to permanent client requests. In such cases, the standard OX backend behavior might be slowed down in a way, that is not acceptable anymore. This is really important in cases of inferior hardware resources.

So, please use this ''all-in-one'' scenario only for quick evaluation purposes, demo setups or if there's really no dedicated conversion hardware available.

=== Configuration and Hardware ===
After installation of the single documentconverter related packages, the default values for the documentconverter properties can be found in the file /opt/open-xchange/etc/documentconverter.properties. Each entry is documented and has been assigned a default value, that is in most cases sufficient for a first setup. Please take care that all listed directory paths have the appropriate write permissions for the OX backend user.

'''VERY IMPORTANT:''' Each ''real'' converter node needs its own scratch and cache directories. Don't set these directories to shared directories like NFS shares etc., since file writes to the same cache/scratch directories by different backend nodes are not synchronized at the moment and will most possibly corrupt some files over the time. Actually, it is possible to use a shared network drive for the cache and scratch directories, as long as the finally used directories are unique for each given node. In this case, the documentconverter.properties file on each node has to be adjusted accordingly to guarantee such a unique, per node directory structure.

In addition, you should check the following entries for their validity/sensibility:

* For the scratch directory, it is recommended to use a very fast volume (e.g. on SSD or even a RAM disk, if memory allows), since temp. files are permanently created and deleted within this directory. The whole documentconverter performance will benefit from a high speed volume in any case.
* The cache sizes, configured in the properties file, should be checked against the given hardware and volume sizes and adjusted accordingly, if wanted/needed. Cache entries are only read/written once during a conversion, so that the used medium does not need to be a high speed one. For the cache, it is better to use more memory than speed, since cached files will accelerate the whole conversion process the most.
* The number of parallel readerengine instances used is configured via the property '''com.openexchange.documentconverter.jobProcessorCount'''. The default value of '''three''' should fit on almost all modern hardware. Please adjust this value depending on the really available CPU cores in your case. As long as the current node is configured as a conversion only node, the number of parallel processes should be in the order of (CPU core count - 1)
* The '''com.openexchange.documentconverter.maxVMemMB''' config entry is the '''virtual''' memory assigned to each readerengine process. You don't need to have (jobProcessorCount * maxVMemMB) in reality, since large parts of this VMem is shared memory between all running readerengine instances. So, there's no simple formula to calculate the optimum total amount of memory. For the beginning, a '''maxVMemMB''' value of 2048 is absolutely ok and sufficient. The node, the documentconverter is running on, should have at least 8GB RAM, with more RAM and more processors being better, of course. A good recommendation would be a total amount of 16GB RAM for the node and a CPU core count of 4. A dual CPU machine with 4 cores each seems to be a better recommendation, if hardware is not a crucial point in the whole setup.
* The upper limit for the Java VM memory allocation should not be below 2048MB (-Xmx2048m). Please adjust this value accordingly, but don't set this value too high, since values greater than about 4GB will have significant negative impact on the Java VM Garbage Collector. 2048MB seemed to be a very sensible value for the -Xmx limit during our tests.

=== OX backend(s) with one remote documentconverter ===
A remote documentconverter setup uses (at least) one OX backend, configured as a ''real'' documentconverter as described in the chapter above. This documentconverter node should not handle standard OX backend requests, but only remote conversion requests from the standard OX backends.

The standard OX backend needs to have the '''documentconverter-api''' and the '''documentconverter''' packages installed. '''readerengine''' and '''readerengine-pdf2svg''' packages are not needed on the standard OX backends.

For the remote converter node, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

In order to request remote conversions, the only entry, that needs to be set within the '''documentconverter.properties''' file at the standard OX backend(s) is the '''com.openexchange.documentconverter.RemoteBaseUrl''' entry. In general, this is a http-URL consisting of the remote conversion node ip address followed by the '''/documentconverterws''' path:\\

<blockquote>
com.openexchange.documentconverter.RemoteBaseUrl=http://host[:port]/documentconverterws
</blockquote>

No other entry from the '''documentconverter.properties''' is used on the standard OX backend if the '''RemoteBaseUrl''' is set.

In order to check, if the remote documentconverter is correctly set up, you can enter the complete RemoteBaseUrl into a browser and should see a page, stating that the documentconverter is running.

=== OX backend cluster with one remote documentconverter ===
The OX backend cluster is the standard OX backend scenario, which is similar, if not equal to the standard OX backend with one documentconverter scenario above.

The only thing that you need to take care of is to add the the appropriate documentconverterws ProxyPass entry to the proxy_http.conf configuration file of e.g. the Apache web server:

<blockquote>
<Proxy /documentconverterws> 
ProxyPass balancer://oxcluster/documentconverterws 
<proxy> 
</blockquote>

=== Sample cluster installation ===

A typical, basic cluster setup consists of two or more standard OX backend nodes (e.g. samplehost-node-1, samplehost-node-2, ...., samplehost-node-n), with each of these standard backend nodes having their '''com.openexchange.documentconverter.RemoteBaseUrl''' config entry set to a dedicated documentconverter cluster node (e.g. samplehost-node-x).

=== OX backend cluster with two or more documentconverters ===
To reduce the load on one documentconverter within a cluster installation, you can add more documentconverter nodes to the given cluster. The general setup is the same as with the '''Ox backend cluster with one remote documentconverter''' setup.

In addition, care needs to be taken to add the appropriate JSESSIONID cookie handling to the cluster setup. This is done for OX clusters in general, but mentioned here for completeness. Setting the JSESSIONID cookie is essential in a multi documentconverter setup, since the Viewer client application uses stateful calls into the OX backend to retrieve the single pages of a document on demand.

A typical Proxy configuration with proper stickysession handling looks as follows:

<blockquote>
<Proxy balancer://oxcluster> 
Order deny,allow 
Allow from all 
BalancerMember http://docs-develop-cluster-b1:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX1 
BalancerMember http://docs-develop-cluster-b2:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX2 
ProxySet stickysession=JSESSIONID 
SetEnv proxy-initial-not-pooled 
SetEnv proxy-sendchunked 
</Proxy> 
</blockquote>

=== Remote caching with two or more documentconverters ===
As mentioned above, using a cache gives a lot of performance improvements with subsequent conversion request. Having more than one ''real'' documentconverter node configured allows to get access to the remote caching feature.

In general, one converter acts as a so called master cache in this scenario. It is set up as usual and as described in one of the chapters above.

The second (third, ...) converter are also set up as usual, but have their '''com.openexchange.documentconverter.RemoteCacheUrls documentconverter.properties''' set, so that the first URL (of possible more URLs) points to the master cache converter.

The URL to be used is the standard RemoteBaseURL with an additional '''/cache''' path set:

<blockquote>
com.openexchange.documentconverter.RemoteCacheUrls=http://mastercachehost[:port]/documentconverterws/cache
</blockquote>

In this case, after searching the local cache for a conversion result after a conversion request arrives without any success, all set remote cache hosts are queried for a successful cache result.

If one of the remote cache hosts returns a valid cache result, the cache entry is locally replicated and the cache result is returned.

If none of the remote cache hosts returns a valid cache result, a local conversion is performed, a local cache entry is created and the cache result is transferred to the first set remote cache host (the master cache host).

=== Sharepoint support ===

It's possible to optionally use a Sharepoint server to perform certain conversions, mainly to convert from Microsoft Word and PowerPoint to PDF so the documents look better in the OX Document Viewer.

No OX user credentials are needed on the Sharepoint server, as shown in this overview:

[[File:OX_Document_Converter_Overview.jpg]]

AppSuite:DocumentConverter Installation Guide

2015-01-22T17:55:00Z

Malte: /* Sharepoint support */

= 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.

== 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.

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.

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

The [[AppSuite:DocumentConverter_API|API reference]] describes the available actions with request parameters and results.

== Requirements ==

OX Document Converter requires a 64bit systems; 32bit systems are not supported. 
See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

== Download and Installation ==

The OX Document Converter deployment consists of two functional modules, that need to be installed separately: the ''readerengine'' component and the ''Document Converter Webservice'' component.

=== ReaderEngine ===

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]]

=== Webservice ===

See [[AppSuite:DocumentConverterInstall|Document converter installation instructions]]

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

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

=== Configuration ===

After deployment of both components ''readerengine'' and ''Web service'', the administrator needs to make some adjustments to the configuration of the OX Document Converter installation.

The component readerengine works with the default configuration.
The settings are in the file '''documentconverter.properties'''
located in the directory "/opt/open-xchange/etc" as described below.

{{AppSuite:ReaderEngineConfig}}



== Setup And Best Practices ==

The whole documentconverter product consists of 3 different parts: the OX backend documentconverter bundles, written in Java as OSGi plugins, the native readerengine and a native tool called pdf2svg.

=== Readerengine ===
The '''readerengine''' is - as the name implies - the low level backend engine for the converter implementation, that acts as a general purpose document conversion solution, being able to read a vast number of commonly used document formats like Microsoft binary and XML formats (MS Word, MS Excel, MS Powerpoint), the whole set of ODF (Open Document Format) document formats and many more, and to export the loaded documents into different output formats like '''PDF'''.

The '''readerengine''' itself is a stripped down Open Office installation, containing some code enhancements and optimizations, provided by Open-Xchange developers. The packaging is also done in-house to have control of the whole development cycle, versioning and other aspects of the product development.

=== PDF2SVG ===
The '''pdf2svg''' component is a tool, that uses libpoppler for reading and processing '''PDF''' source documents and Cairo for rendering the processed '''PDF''' into '''SVG''', '''JPEG''' and '''PNG''' formats, to be finally rendered within the OX appsuite client.

=== Documentconverter OSGi bundles ===
The OX appsuite backend bundles of the documentconverter are responsible for receiving and processing client conversion '''requests''', to '''schedule''' conversion jobs in multi threaded queues, to manage the correct '''startup''' and '''shutdown''' of (parallel) '''readerengine''' and '''readerengine-pdf2svg''' instances, managing the '''caching''' of conversion results, '''communication''' with remote converters and remote converter caches etc.

After installation of the documentconverter and related bundles, only minor changes have to be made by the admin in order to get the full functionality available within the appsuite.

==== Documentconverter system packages ====
The Java OSGi bundles for the documentconverter functionality are distributed via four different packages in total (revision numbers are omitted here):
* '''documentconverter-api''' This bundle contains interfaces and other simple classes that are used by different other bundles to get access to the documentconverter OSGi service.
* '''documentconverter''' This bundle contains the core documentconverter implementation as an OSGi service.
* '''documentconverter-webservice''' This bundle contains the functionality to let the documentconverter offer its functionality as a webservice. In a remote scenario, this bundle needs to be installed only on those machines, that are configured to do the real conversions.
* '''documentconverter-jolokia''' This optional bundle can be installed to make internal conversion statistics available for monitoring via Munin et al. The contained scripts provide access to the statistic data either via the modern '''Jolokia JMX''' bridge or the old fashioned '''showruntimestats''' functionality, provided by the OX appsuite backend.

=== General ===
By taking a look at the overview of documentconverter system packages in the chapter above, it can be seen, that the two essential packages to be installed are the '''documentconverter-api'' and the '''documentconverter''' packages.

If the current OX backend node is configured to only receive client requests and to make remote conversion calls to an other node, configured as a ''real'' converter node, no additional packages need to be installed.

In order to act as ''real'' converter node, the '''readerengine''' and the '''readerengine-pdf2svg''' packages need to be installed as well.

For an OX backend node to act as a conversion webservice, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', the '''documentconverter''', the '''readerengine''' and the the '''readerengine-pdf2svg''' packages.

The '''documentconverter-jolokia''' package only makes sense to be installed on an OX backend node, that acts as ''real'' converter node.

In summary, the following packages must be installed in order to act as a real converter node:

open-xchange-documentconverter-webservice readerengine open-xchange open-xchange-grizzly open-xchange-authentication-database

The package open-xchange-authentication-database is just needed to fulfill the dependencies.

=== Single OX backend with documentconverter / Single converter node ===
The simplest possible scenario is definitely a single OX appsuite backend installation with the additional installation of the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

Nevertheless, this configuration can be considered as the prototype configuration block for a ''real'' converter node with different setups. Therefore, the description for this building block will contain all details, that are necessary to setup even a highly complex scenario.

'''Important:''' although it is possible to run a ''real'' documentconverter on a standard OX backend node together with all other provided services, this setup is not recommended for production use, as long as each single node hardware is not sufficient enough to handle everything appropriately. This is especially true, if this node is also configured to act as a calcengine server, which itself has a resource consumption, that can be seen on the high side with a lot of memory consumption.

Documentconversion is a process, that might happen in the background all of the time due to permanent client requests. In such cases, the standard OX backend behavior might be slowed down in a way, that is not acceptable anymore. This is really important in cases of inferior hardware resources.

So, please use this ''all-in-one'' scenario only for quick evaluation purposes, demo setups or if there's really no dedicated conversion hardware available.

=== Configuration and Hardware ===
After installation of the single documentconverter related packages, the default values for the documentconverter properties can be found in the file /opt/open-xchange/etc/documentconverter.properties. Each entry is documented and has been assigned a default value, that is in most cases sufficient for a first setup. Please take care that all listed directory paths have the appropriate write permissions for the OX backend user.

'''VERY IMPORTANT:''' Each ''real'' converter node needs its own scratch and cache directories. Don't set these directories to shared directories like NFS shares etc., since file writes to the same cache/scratch directories by different backend nodes are not synchronized at the moment and will most possibly corrupt some files over the time. Actually, it is possible to use a shared network drive for the cache and scratch directories, as long as the finally used directories are unique for each given node. In this case, the documentconverter.properties file on each node has to be adjusted accordingly to guarantee such a unique, per node directory structure.

In addition, you should check the following entries for their validity/sensibility:

* For the scratch directory, it is recommended to use a very fast volume (e.g. on SSD or even a RAM disk, if memory allows), since temp. files are permanently created and deleted within this directory. The whole documentconverter performance will benefit from a high speed volume in any case.
* The cache sizes, configured in the properties file, should be checked against the given hardware and volume sizes and adjusted accordingly, if wanted/needed. Cache entries are only read/written once during a conversion, so that the used medium does not need to be a high speed one. For the cache, it is better to use more memory than speed, since cached files will accelerate the whole conversion process the most.
* The number of parallel readerengine instances used is configured via the property '''com.openexchange.documentconverter.jobProcessorCount'''. The default value of '''three''' should fit on almost all modern hardware. Please adjust this value depending on the really available CPU cores in your case. As long as the current node is configured as a conversion only node, the number of parallel processes should be in the order of (CPU core count - 1)
* The '''com.openexchange.documentconverter.maxVMemMB''' config entry is the '''virtual''' memory assigned to each readerengine process. You don't need to have (jobProcessorCount * maxVMemMB) in reality, since large parts of this VMem is shared memory between all running readerengine instances. So, there's no simple formula to calculate the optimum total amount of memory. For the beginning, a '''maxVMemMB''' value of 2048 is absolutely ok and sufficient. The node, the documentconverter is running on, should have at least 8GB RAM, with more RAM and more processors being better, of course. A good recommendation would be a total amount of 16GB RAM for the node and a CPU core count of 4. A dual CPU machine with 4 cores each seems to be a better recommendation, if hardware is not a crucial point in the whole setup.
* The upper limit for the Java VM memory allocation should not be below 2048MB (-Xmx2048m). Please adjust this value accordingly, but don't set this value too high, since values greater than about 4GB will have significant negative impact on the Java VM Garbage Collector. 2048MB seemed to be a very sensible value for the -Xmx limit during our tests.

=== OX backend(s) with one remote documentconverter ===
A remote documentconverter setup uses (at least) one OX backend, configured as a ''real'' documentconverter as described in the chapter above. This documentconverter node should not handle standard OX backend requests, but only remote conversion requests from the standard OX backends.

The standard OX backend needs to have the '''documentconverter-api''' and the '''documentconverter''' packages installed. '''readerengine''' and '''readerengine-pdf2svg''' packages are not needed on the standard OX backends.

For the remote converter node, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

In order to request remote conversions, the only entry, that needs to be set within the '''documentconverter.properties''' file at the standard OX backend(s) is the '''com.openexchange.documentconverter.RemoteBaseUrl''' entry. In general, this is a http-URL consisting of the remote conversion node ip address followed by the '''/documentconverterws''' path:\\

<blockquote>
com.openexchange.documentconverter.RemoteBaseUrl=http://host[:port]/documentconverterws
</blockquote>

No other entry from the '''documentconverter.properties''' is used on the standard OX backend if the '''RemoteBaseUrl''' is set.

In order to check, if the remote documentconverter is correctly set up, you can enter the complete RemoteBaseUrl into a browser and should see a page, stating that the documentconverter is running.

=== OX backend cluster with one remote documentconverter ===
The OX backend cluster is the standard OX backend scenario, which is similar, if not equal to the standard OX backend with one documentconverter scenario above.

The only thing that you need to take care of is to add the the appropriate documentconverterws ProxyPass entry to the proxy_http.conf configuration file of e.g. the Apache web server:

<blockquote>
<Proxy /documentconverterws> 
ProxyPass balancer://oxcluster/documentconverterws 
<proxy> 
</blockquote>

=== Sample cluster installation ===

A typical, basic cluster setup consists of two or more standard OX backend nodes (e.g. samplehost-node-1, samplehost-node-2, ...., samplehost-node-n), with each of these standard backend nodes having their '''com.openexchange.documentconverter.RemoteBaseUrl''' config entry set to a dedicated documentconverter cluster node (e.g. samplehost-node-x).

=== OX backend cluster with two or more documentconverters ===
To reduce the load on one documentconverter within a cluster installation, you can add more documentconverter nodes to the given cluster. The general setup is the same as with the '''Ox backend cluster with one remote documentconverter''' setup.

In addition, care needs to be taken to add the appropriate JSESSIONID cookie handling to the cluster setup. This is done for OX clusters in general, but mentioned here for completeness. Setting the JSESSIONID cookie is essential in a multi documentconverter setup, since the Viewer client application uses stateful calls into the OX backend to retrieve the single pages of a document on demand.

A typical Proxy configuration with proper stickysession handling looks as follows:

<blockquote>
<Proxy balancer://oxcluster> 
Order deny,allow 
Allow from all 
BalancerMember http://docs-develop-cluster-b1:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX1 
BalancerMember http://docs-develop-cluster-b2:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX2 
ProxySet stickysession=JSESSIONID 
SetEnv proxy-initial-not-pooled 
SetEnv proxy-sendchunked 
</Proxy> 
</blockquote>

=== Remote caching with two or more documentconverters ===
As mentioned above, using a cache gives a lot of performance improvements with subsequent conversion request. Having more than one ''real'' documentconverter node configured allows to get access to the remote caching feature.

In general, one converter acts as a so called master cache in this scenario. It is set up as usual and as described in one of the chapters above.

The second (third, ...) converter are also set up as usual, but have their '''com.openexchange.documentconverter.RemoteCacheUrls documentconverter.properties''' set, so that the first URL (of possible more URLs) points to the master cache converter.

The URL to be used is the standard RemoteBaseURL with an additional '''/cache''' path set:

<blockquote>
com.openexchange.documentconverter.RemoteCacheUrls=http://mastercachehost[:port]/documentconverterws/cache
</blockquote>

In this case, after searching the local cache for a conversion result after a conversion request arrives without any success, all set remote cache hosts are queried for a successful cache result.

If one of the remote cache hosts returns a valid cache result, the cache entry is locally replicated and the cache result is returned.

If none of the remote cache hosts returns a valid cache result, a local conversion is performed, a local cache entry is created and the cache result is transferred to the first set remote cache host (the master cache host).

=== Sharepoint support ===

It's possible to optionally use a Sharepoint server to perform certain conversions, mainly to conversion from Microsoft Word and PowerPoint to PDF so the documents look better in the OX Document Viewer.

No OX user credentials are needed on the Sharepoint server, as shown in this overview:

[[File:OX_Document_Converter_Overview.jpg]]

File:OX Document Converter Overview.jpg

2015-01-22T17:53:42Z

Malte: OX Document Converter Overview

OX Document Converter Overview

AppSuite:DocumentConverter Installation Guide

2015-01-22T17:51:59Z

Malte: /* Remote caching with two or more documentconverters */

= 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.

== 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.

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.

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

The [[AppSuite:DocumentConverter_API|API reference]] describes the available actions with request parameters and results.

== Requirements ==

OX Document Converter requires a 64bit systems; 32bit systems are not supported. 
See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

== Download and Installation ==

The OX Document Converter deployment consists of two functional modules, that need to be installed separately: the ''readerengine'' component and the ''Document Converter Webservice'' component.

=== ReaderEngine ===

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]]

=== Webservice ===

See [[AppSuite:DocumentConverterInstall|Document converter installation instructions]]

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

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

=== Configuration ===

After deployment of both components ''readerengine'' and ''Web service'', the administrator needs to make some adjustments to the configuration of the OX Document Converter installation.

The component readerengine works with the default configuration.
The settings are in the file '''documentconverter.properties'''
located in the directory "/opt/open-xchange/etc" as described below.

{{AppSuite:ReaderEngineConfig}}



== Setup And Best Practices ==

The whole documentconverter product consists of 3 different parts: the OX backend documentconverter bundles, written in Java as OSGi plugins, the native readerengine and a native tool called pdf2svg.

=== Readerengine ===
The '''readerengine''' is - as the name implies - the low level backend engine for the converter implementation, that acts as a general purpose document conversion solution, being able to read a vast number of commonly used document formats like Microsoft binary and XML formats (MS Word, MS Excel, MS Powerpoint), the whole set of ODF (Open Document Format) document formats and many more, and to export the loaded documents into different output formats like '''PDF'''.

The '''readerengine''' itself is a stripped down Open Office installation, containing some code enhancements and optimizations, provided by Open-Xchange developers. The packaging is also done in-house to have control of the whole development cycle, versioning and other aspects of the product development.

=== PDF2SVG ===
The '''pdf2svg''' component is a tool, that uses libpoppler for reading and processing '''PDF''' source documents and Cairo for rendering the processed '''PDF''' into '''SVG''', '''JPEG''' and '''PNG''' formats, to be finally rendered within the OX appsuite client.

=== Documentconverter OSGi bundles ===
The OX appsuite backend bundles of the documentconverter are responsible for receiving and processing client conversion '''requests''', to '''schedule''' conversion jobs in multi threaded queues, to manage the correct '''startup''' and '''shutdown''' of (parallel) '''readerengine''' and '''readerengine-pdf2svg''' instances, managing the '''caching''' of conversion results, '''communication''' with remote converters and remote converter caches etc.

After installation of the documentconverter and related bundles, only minor changes have to be made by the admin in order to get the full functionality available within the appsuite.

==== Documentconverter system packages ====
The Java OSGi bundles for the documentconverter functionality are distributed via four different packages in total (revision numbers are omitted here):
* '''documentconverter-api''' This bundle contains interfaces and other simple classes that are used by different other bundles to get access to the documentconverter OSGi service.
* '''documentconverter''' This bundle contains the core documentconverter implementation as an OSGi service.
* '''documentconverter-webservice''' This bundle contains the functionality to let the documentconverter offer its functionality as a webservice. In a remote scenario, this bundle needs to be installed only on those machines, that are configured to do the real conversions.
* '''documentconverter-jolokia''' This optional bundle can be installed to make internal conversion statistics available for monitoring via Munin et al. The contained scripts provide access to the statistic data either via the modern '''Jolokia JMX''' bridge or the old fashioned '''showruntimestats''' functionality, provided by the OX appsuite backend.

=== General ===
By taking a look at the overview of documentconverter system packages in the chapter above, it can be seen, that the two essential packages to be installed are the '''documentconverter-api'' and the '''documentconverter''' packages.

If the current OX backend node is configured to only receive client requests and to make remote conversion calls to an other node, configured as a ''real'' converter node, no additional packages need to be installed.

In order to act as ''real'' converter node, the '''readerengine''' and the '''readerengine-pdf2svg''' packages need to be installed as well.

For an OX backend node to act as a conversion webservice, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', the '''documentconverter''', the '''readerengine''' and the the '''readerengine-pdf2svg''' packages.

The '''documentconverter-jolokia''' package only makes sense to be installed on an OX backend node, that acts as ''real'' converter node.

In summary, the following packages must be installed in order to act as a real converter node:

open-xchange-documentconverter-webservice readerengine open-xchange open-xchange-grizzly open-xchange-authentication-database

The package open-xchange-authentication-database is just needed to fulfill the dependencies.

=== Single OX backend with documentconverter / Single converter node ===
The simplest possible scenario is definitely a single OX appsuite backend installation with the additional installation of the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

Nevertheless, this configuration can be considered as the prototype configuration block for a ''real'' converter node with different setups. Therefore, the description for this building block will contain all details, that are necessary to setup even a highly complex scenario.

'''Important:''' although it is possible to run a ''real'' documentconverter on a standard OX backend node together with all other provided services, this setup is not recommended for production use, as long as each single node hardware is not sufficient enough to handle everything appropriately. This is especially true, if this node is also configured to act as a calcengine server, which itself has a resource consumption, that can be seen on the high side with a lot of memory consumption.

Documentconversion is a process, that might happen in the background all of the time due to permanent client requests. In such cases, the standard OX backend behavior might be slowed down in a way, that is not acceptable anymore. This is really important in cases of inferior hardware resources.

So, please use this ''all-in-one'' scenario only for quick evaluation purposes, demo setups or if there's really no dedicated conversion hardware available.

=== Configuration and Hardware ===
After installation of the single documentconverter related packages, the default values for the documentconverter properties can be found in the file /opt/open-xchange/etc/documentconverter.properties. Each entry is documented and has been assigned a default value, that is in most cases sufficient for a first setup. Please take care that all listed directory paths have the appropriate write permissions for the OX backend user.

'''VERY IMPORTANT:''' Each ''real'' converter node needs its own scratch and cache directories. Don't set these directories to shared directories like NFS shares etc., since file writes to the same cache/scratch directories by different backend nodes are not synchronized at the moment and will most possibly corrupt some files over the time. Actually, it is possible to use a shared network drive for the cache and scratch directories, as long as the finally used directories are unique for each given node. In this case, the documentconverter.properties file on each node has to be adjusted accordingly to guarantee such a unique, per node directory structure.

In addition, you should check the following entries for their validity/sensibility:

* For the scratch directory, it is recommended to use a very fast volume (e.g. on SSD or even a RAM disk, if memory allows), since temp. files are permanently created and deleted within this directory. The whole documentconverter performance will benefit from a high speed volume in any case.
* The cache sizes, configured in the properties file, should be checked against the given hardware and volume sizes and adjusted accordingly, if wanted/needed. Cache entries are only read/written once during a conversion, so that the used medium does not need to be a high speed one. For the cache, it is better to use more memory than speed, since cached files will accelerate the whole conversion process the most.
* The number of parallel readerengine instances used is configured via the property '''com.openexchange.documentconverter.jobProcessorCount'''. The default value of '''three''' should fit on almost all modern hardware. Please adjust this value depending on the really available CPU cores in your case. As long as the current node is configured as a conversion only node, the number of parallel processes should be in the order of (CPU core count - 1)
* The '''com.openexchange.documentconverter.maxVMemMB''' config entry is the '''virtual''' memory assigned to each readerengine process. You don't need to have (jobProcessorCount * maxVMemMB) in reality, since large parts of this VMem is shared memory between all running readerengine instances. So, there's no simple formula to calculate the optimum total amount of memory. For the beginning, a '''maxVMemMB''' value of 2048 is absolutely ok and sufficient. The node, the documentconverter is running on, should have at least 8GB RAM, with more RAM and more processors being better, of course. A good recommendation would be a total amount of 16GB RAM for the node and a CPU core count of 4. A dual CPU machine with 4 cores each seems to be a better recommendation, if hardware is not a crucial point in the whole setup.
* The upper limit for the Java VM memory allocation should not be below 2048MB (-Xmx2048m). Please adjust this value accordingly, but don't set this value too high, since values greater than about 4GB will have significant negative impact on the Java VM Garbage Collector. 2048MB seemed to be a very sensible value for the -Xmx limit during our tests.

=== OX backend(s) with one remote documentconverter ===
A remote documentconverter setup uses (at least) one OX backend, configured as a ''real'' documentconverter as described in the chapter above. This documentconverter node should not handle standard OX backend requests, but only remote conversion requests from the standard OX backends.

The standard OX backend needs to have the '''documentconverter-api''' and the '''documentconverter''' packages installed. '''readerengine''' and '''readerengine-pdf2svg''' packages are not needed on the standard OX backends.

For the remote converter node, the '''documentconverter-webservice''' package needs to be installed beside the '''documentconverter-api''', '''documentconverter''', '''readerengine''' and '''readerengine-pdf2svg''' packages.

In order to request remote conversions, the only entry, that needs to be set within the '''documentconverter.properties''' file at the standard OX backend(s) is the '''com.openexchange.documentconverter.RemoteBaseUrl''' entry. In general, this is a http-URL consisting of the remote conversion node ip address followed by the '''/documentconverterws''' path:\\

<blockquote>
com.openexchange.documentconverter.RemoteBaseUrl=http://host[:port]/documentconverterws
</blockquote>

No other entry from the '''documentconverter.properties''' is used on the standard OX backend if the '''RemoteBaseUrl''' is set.

In order to check, if the remote documentconverter is correctly set up, you can enter the complete RemoteBaseUrl into a browser and should see a page, stating that the documentconverter is running.

=== OX backend cluster with one remote documentconverter ===
The OX backend cluster is the standard OX backend scenario, which is similar, if not equal to the standard OX backend with one documentconverter scenario above.

The only thing that you need to take care of is to add the the appropriate documentconverterws ProxyPass entry to the proxy_http.conf configuration file of e.g. the Apache web server:

<blockquote>
<Proxy /documentconverterws> 
ProxyPass balancer://oxcluster/documentconverterws 
<proxy> 
</blockquote>

=== Sample cluster installation ===

A typical, basic cluster setup consists of two or more standard OX backend nodes (e.g. samplehost-node-1, samplehost-node-2, ...., samplehost-node-n), with each of these standard backend nodes having their '''com.openexchange.documentconverter.RemoteBaseUrl''' config entry set to a dedicated documentconverter cluster node (e.g. samplehost-node-x).

=== OX backend cluster with two or more documentconverters ===
To reduce the load on one documentconverter within a cluster installation, you can add more documentconverter nodes to the given cluster. The general setup is the same as with the '''Ox backend cluster with one remote documentconverter''' setup.

In addition, care needs to be taken to add the appropriate JSESSIONID cookie handling to the cluster setup. This is done for OX clusters in general, but mentioned here for completeness. Setting the JSESSIONID cookie is essential in a multi documentconverter setup, since the Viewer client application uses stateful calls into the OX backend to retrieve the single pages of a document on demand.

A typical Proxy configuration with proper stickysession handling looks as follows:

<blockquote>
<Proxy balancer://oxcluster> 
Order deny,allow 
Allow from all 
BalancerMember http://docs-develop-cluster-b1:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX1 
BalancerMember http://docs-develop-cluster-b2:8009 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX2 
ProxySet stickysession=JSESSIONID 
SetEnv proxy-initial-not-pooled 
SetEnv proxy-sendchunked 
</Proxy> 
</blockquote>

=== Remote caching with two or more documentconverters ===
As mentioned above, using a cache gives a lot of performance improvements with subsequent conversion request. Having more than one ''real'' documentconverter node configured allows to get access to the remote caching feature.

In general, one converter acts as a so called master cache in this scenario. It is set up as usual and as described in one of the chapters above.

The second (third, ...) converter are also set up as usual, but have their '''com.openexchange.documentconverter.RemoteCacheUrls documentconverter.properties''' set, so that the first URL (of possible more URLs) points to the master cache converter.

The URL to be used is the standard RemoteBaseURL with an additional '''/cache''' path set:

<blockquote>
com.openexchange.documentconverter.RemoteCacheUrls=http://mastercachehost[:port]/documentconverterws/cache
</blockquote>

In this case, after searching the local cache for a conversion result after a conversion request arrives without any success, all set remote cache hosts are queried for a successful cache result.

If one of the remote cache hosts returns a valid cache result, the cache entry is locally replicated and the cache result is returned.

If none of the remote cache hosts returns a valid cache result, a local conversion is performed, a local cache entry is created and the cache result is transferred to the first set remote cache host (the master cache host).

=== Sharepoint support ===

It's possible to optionally use a Sharepoint server to perform certain conversions, mainly to conversion from Microsoft Word and PowerPoint to PDF so the documents look better in the OX Document Viewer.

No OX user credentials are needed on the Sharepoint server, as shown in this overview.

AppSuite:DocumentConverter Installation Guide

2015-01-22T17:44:54Z

Malte: /* Readerengine */

AppSuite:Spreadsheet Installation Guide

2015-01-16T09:28:38Z

Malte: /* Permissions */

= Download & Installation OX Spreadsheet =

== General Information ==
OX Spreadsheet is a browser based, cloud ready, spreadsheet product that can work with Microsoft Excel documents in a lossless way. And you can also collaborate with other people to edit shared spreadsheets on various devices.

Learn more about the highlights of OX Spreadsheet here: [http://software.open-xchange.com/products/appsuite/doc/OX_Spreadsheet_Product_Guide.pdf OX Spreadsheet Product Guide]

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Spreadsheet needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]].

For compatibility with XLS files (not XLSX) and for printing functionality in OX Spreadsheet the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

* The calcengine: See [[AppSuite:CalcengineInstall|calcengine installation instructions]]

== Installation ==

The OX Spreadsheet deployment consists of the packages <tt>open-xchange-documents-backend</tt>,<tt>open-xchange-documents-ui</tt> and <tt>open-xchange-documents-ui-static</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 6.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|office|office-web}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 7.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|office|office-web}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 11 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc3n=susename|pc3v=SLES11|office|office-web}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

== Printing and .xls Editing ==

For .XLS and/or printing support from OX Spreadsheet the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Configuration ==

=== Permissions ===

To enable OX Spreadsheet for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "spreadsheet" module capability globally.
#com.openexchange.capability.spreadsheet=true
</pre>

Uncomment the above line so that the capability is set to true.

Starting with 7.6.2, you can disable the spreadsheet portal app. In '''permissions.properties''':
<pre>
permissions=spreadsheetportaldisabled
</pre>

=== calcengine ===

The calcengine has to be configured in the file ''/opt/open-xchange/etc/calcengine.properties''.

<pre>
# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# possible values :
#
# - local
# a set of worker processes are used at localhost;
# One worker = one calc engine process.
# JNI is used within worker process - not within main process.
#
# - http
# calc engine client will connect to a remote server
# where a calc engine server is running.
# Every calc engine server will host a set of worker processes.
# Communication protocol between client<->server<->worker is HTTP.
#
calcengine.mode=local

# -----------------------------------------------------------------------------
# timeout to detect hanging calc engine request
#
# unit = [ms]
# default = 20s

calcengine.request.timeout=20000

# -----------------------------------------------------------------------------
# define the max. value for memory reserved for one worker instance.
#
# Each worker will use that value separately.
# So the memory consumption for the whole pool of worker instances
# will be : pool-size * worker.memory.
#
# unit=[MB]
#
# default = 2048

calcengine.worker.memory.max-mb=2048

# -----------------------------------------------------------------------------
# define the count of worker we use as reserve for exchanging 'dirty' worker instances.
#
# Note:
#
# - If reserve count is configured with 0 no pro-active restart of any worker will happen
# ... excepting in error case.
#
# - Reserve count needs to be in sync with worker pool size.
# Means : port range has to be higher then these reserve count.
#
# default = 1

calcengine.worker.restart.reserve-count=1

# -----------------------------------------------------------------------------
# configure restart of one worker in case more then X documents was opened
# within those process.
#
# Note:
#
# - A value of 0 means -> these restart trigger is disabled
# ... where might other restart trigger can be active.
#
# - Don't forget to configure reserve count value too
# if you configure these restart trigger.
#
# default = 50

calcengine.worker.restart.trigger.max-doc-count=50

# -----------------------------------------------------------------------------
# timeout to detect non starting worker process
#
# unit = [ms]
# default = 55s

calcengine.worker.init.timeout=55000

# -----------------------------------------------------------------------------
# define the range of ports to be used for a pool of worker processes.
#
# Of course MIN and MAX values needs to be in right (ascending) order.
# If not - an error is shown and calc engine environment wont work.
#
# MIN and MAX port are included in range. So pool size is MAX-MIN+1.
#
# default = 5001 ... 5003

calcengine.worker.port_range.min=5001
calcengine.worker.port_range.max=5003
</pre>

AppSuite:ReaderEngineConfig

2015-01-08T11:54:49Z

Malte:

A summary of all configuration items, together with each default value, is given below. Although the defaults have been carefully chosen for a real life deployment, the admin should take a closer look at each of them and adjust them accordingly, if necessary.

; com.openexchange.documentconverter.installDir=/opt/readerengine

This item contains the the directory of the libreaderengine installation. The libreaderengine installation directory in general contains the ./program directory, which itself contains the engine executables.
 
'''VERY IMPORTANT:''' If not set correctly, the complete web service will be nonfunctional.
 
Default value: "/opt/readerengine"

; com.openexchange.documentconverter.cacheDir=/var/spool/open-xchange/documentconverter/readerengine.cache

This item contains the directory that will make up the cache for persistent job data. The directory itself does not need to exist at startup, but the parent directory needs to exist and needs to have write permissions for the user running the servlet, in order for the servlet to create this cache directory at runtime.
 
'''VERY IMPORTANT:''' If not set correctly, the complete web service will be nonfunctional.
 
Default value: "/var/spool/open-xchange/documentconverter/readerengine.cache"

; com.openexchange.documentconverter.scratchDir=/var/spool/open-xchange/documentconverter/readerengine.scratch

This item contains the directory, that will make up the runtime enironment for the readerengine. The directory itself does not need to exist at startup, but the parent directory needs to exist and needs to have write permissions for the user running the servlet , in order for the servlet to create this cache directory at runtime.
 
'''VERY IMPORTANT:''' If not set correctly, the complete web service will be nonfunctional.
 
Default value: "/var/spool/open-xchange/documentconverter/readerengine.scratch"

; com.openexchange.documentconverter.errorDir=

The temporary directory, containing files that could not be loaded due to an error condition or due to a timeout
 
Default value: n/a

; com.openexchange.documentconverter.blacklistFile=/opt/open-xchange/etc/readerengine.blacklist

The list of external document content URLs that are not allowed to be loaded
by the readerengine after loading a document.
The file itself contains a list of (newline separated) regular expressions.
Each external URL is first checked against the list of blacklist URL regular
expressions.
If the external URL matches one blacklist entry, the external URL is
then checked against the list of whitelist URL regular expressions.
The behavior in summary is as follows:
If the URL is not blacklisted and not whitelisted, it is resolved at runtime.
If the URL is blacklisted but not whitelisted, it is not resolved at runtime.
If the URL is not blacklisted but whitelisted, it is resolved at runtime.
If the URL is blacklisted and whitelisted, it is resolved at runtime.
In boolean notation: valid = (!blacklisted) || whitelisted
Please note that the regular expressions need to fully qualify the patterns that
the URL should be checked against.
Upper/Lower cases need to be handled by the regular expression as well.
The file itself needs to be UTF-8 encoded to be read appropriately.
 
Default value: "/opt/open-xchange/etc/readerengine.blacklist"

; com.openexchange.documentconverter.whitelistFile=/opt/open-xchange/etc/readerengine.whitelist

The list of external document content URLs that are allowed to be loaded
by the readerengine after an external URL matched a blacklist pattern.
The file itself contains a list of (newline separated) regular expressions.
Each external URL is only checked against the list of whitelist URL regular
expressions if it previously matched a pattern in the blacklist file.
If the external URL matches one blacklist entry, the external URL is
then checked against the list of whitelist URL regular expressions.
The behavior in summary is as follows:
If the URL is not blacklisted and not whitelisted, it is resolved at runtime.
If the URL is blacklisted but not whitelisted, it is not resolved at runtime.
If the URL is not blacklisted but whitelisted, it is resolved at runtime.
If the URL is blacklisted and whitelisted, it is resolved at runtime.
In boolean notation: valid = (!blacklisted) || whitelisted
Please note that the regular expressions need to fully qualify the patterns that
the URL should be checked against.
Upper/Lower cases need to be handled by the regular expression as well.
The file itself needs to be UTF-8 encoded to be read appropriately.
 
Default value: "/opt/open-xchange/etc/readerengine.whitelist"

; com.openexchange.documentconverter.urlLinkLimit=200

The external URL link limit specifies the maximum amount of
valid external internet URLs (filtered by blacklist and whitelist before),
that are tried to get resolved by the engine when loading a document.
When this limit is reached, no more external internet URLs are resolved
for the current document.
 
'''Important:''' Please take note than one externally linked object within the document does not automatically correspond to one external URL call. In general, there are - at least - two URL calls necessary to display one externally linked object. Such additional calls are in most cases based on a format detection, happening prior to resolving the object data itself.
 
Set to -1 for no upper limit or to 0 to disable the resolving of internet URLs completely
 
Default value: 200

; com.openexchange.documentconverter.urlLinkProxy =

The external URL link proxy entry specifies a proxy server that is used by the readerengine
to resolve external links, contained within a document. Such links are e.g. external http://
graphic links, that are going to be resolved during the filtering process of a readerengine
instance.
Set this entry to the address of the proxy server: host:port
Recognized protocols are ''<nowiki>http://, https:// and ftp://</nowiki>''
Leave empty, if no proxy server should be used by the readerengine
 
Default value: n/a

; com.openexchange.documentconverter.RemoteBaseUrl =

Use a remote document conversion webservice to do the actual conversion;
Set this entry to the base URL of the remote host ''<nowiki>http://host[:port]/documentconverterPath</nowiki>'';
leave empty if conversion should happen on the local machine
 
Default value: n/a

; com.openexchange.documentconverter.RemoteCacheUrls =

Use one or more remote converter cache(s) to speedup the conversion. The first entry, if set, is treated as the remote master cache, receiving cache updates from the local cache. Additional entries are treated as remote slave caches for read purposes only. 
Set the (whitespace separated) entries to the base URL('s) of the appropriate remote host(s): ''<nowiki>http://host[:port]/documentconverterCachePath</nowiki>'' 
Leave empty if only the local filesystem cache should be used
 
Default value: n/a


; com.openexchange.documentconverter.RemoteSharePointUrl =

Use a remote SharePoint service to do MSO to PDF conversions. 
Set this entry to the URL of the SharePoint host: ''<nowiki>http://host[:port]/_vti_bin/oxconvert.svc/mex?wsdl</nowiki>'' 
If left empty, the corresponding conversion job always returns false. 
Default value: n/a

; com.openexchange.documentconverter.RemoteSharePointUsername =

The login user name to be used for calls to the SharePoint service 
Default value: n/a

; com.openexchange.documentconverter.RemoteSharePointPassword =

The password to be used for calls to the SharePoint service 
Default value: n/a

; com.openexchange.documentconverter.jobProcessorCount=3

This item determines the number of engines working in parallel for job execution. The value needs to be greater or equal to 1, with best performance results about (n+1), where n specifies the number of available CPU cores of the machine the service is running on.
 
Default value: 3

; com.openexchange.documentconverter.jobRestartCount=50

This item determines the maximum number of executed jobs after which a single engine is automatically restarted in order to avoid memory fragmentation and possible memory leaks within one libreaderengine instance,
 
Default value: 50

; com.openexchange.documentconverter.jobExecutionTimeoutMilliseconds=60000

This item determines the timeout in milliseconds, after which the execution of a single job is terminated.
 
Default value: 60000

; com.openexchange.documentconverter.maxVMemMB=2048

This item determines the maximum size in megabytes (MB) of virtual memory that each started readerengine process is allowed to consume. If a job tries to consume more VMem than set via this config item, the processing of the current job for the appropriate readerengine process will be aborted and the underlying process is restarted to avoid memory corruption.
 
Set this value to -1 for no upper limit.
 
Default value: 2048

; com.openexchange.documentconverter.maxCacheSizeMB=-1

This item determines the maximum size in megabytes (MB) of all persistently cached converter job entries at runtime. A larger value may drastically reduce the time for conversion jobs, e.g. in case of a repeated creation of document previews.
 
Set this value to -1 for no upper limit.
 
Default value: -1

; com.openexchange.documentconverter.maxCacheEntries=-1

This item determines the maximum number of converter jobs cached at runtime. The value affects the amount of runtime job information to be cached as well as the number of file entries within the cache directory.
 
Set this value to -1 for no upper limit.
 
Default value: -1

; com.openexchange.documentconverter.cacheEntryTimeoutSeconds=2592000

This item determines the timeout in seconds, after which a cached job result is automatically removed from the cache.
 
Set this value to 0 to disable the timeout based removal of cached job results.
 
Default value: 2592000

; com.openexchange.documentconverter.enableCacheLookup=false

Setting this flag to true enables the caller of the RemoteInternalPreviewService#getCachedPreviewFor implementation (OfficePreviewService) to retrieve the cached only result of a previous conversion call, without scheduling a new job in case of a non existing cache entry, which might run for a long period time, up to the given job timeout time.
 
Set to false to disable the cache lookup within the RemoteInternalPreviewService#getCachedPreviewFor implementation.
 
Default value: false

; com.openexchange.documentconverter.errorCacheTimeoutSeconds=600

This value determines, how long an error, associated with a job hash value, is held within the error cache. If the timeout has not been reached, additional RemoteInternalPreviewService#getPreviewFor calls with the same job hash will instantly return with the cached error code instead of processing the job again.
 
Set to 0 to disable the error cache handling.
 
Default value: 0

; com.openexchange.documentconverter.errorCacheMaxCycleCount=5

This value determines the number of cycles, a job, associated with a job hash value, is added to the error cache.
One cycle starts after adding a job to the error cache and ends after the errorCacheTimeout has been reached.
After reaching the given maximum cycle count, the job is not removed from the error cache anymore and will be held within the error cache for the rest of the runtime of the current backend instance.
Since the error cache is not persistent, the cycle counter for each job hash is reset after a restart of the
backend instance.
 
Set to 0 to disable the error cache handling.
 
Default value: 5

; com.openexchange.documentconverter.servletLocalFileUrls=false

This item determines, if the documentconverter servlet should be allowed to handle file Urls of the form file://... The file Url itself is a resource that locates files that are locally accessible on the machine, the documentconverter backend is running on.
 
Default value: false

; com.openexchange.capability.sharepointconversion=false

Capability to enable the usage of a SharePoint conversion server; capability is only
checked, if a valid SharePoint remote converter has been configured appropriately
 
Default value: false

;

AppSuite:ReaderEngineConfig

2015-01-08T11:44:07Z

Malte:

A summary of all configuration items, together with each default value, is given below. Although the defaults have been carefully chosen for a real life deployment, the admin should take a closer look at each of them and adjust them accordingly, if necessary.

; com.openexchange.documentconverter.installDir=/opt/readerengine

This item contains the the directory of the libreaderengine installation. The libreaderengine installation directory in general contains the ./program directory, which itself contains the engine executables.
 
'''VERY IMPORTANT:''' If not set correctly, the complete web service will be nonfunctional.
 
Default value: "/opt/readerengine"

; com.openexchange.documentconverter.cacheDir=/var/spool/open-xchange/documentconverter/readerengine.cache

This item contains the directory that will make up the cache for persistent job data. The directory itself does not need to exist at startup, but the parent directory needs to exist and needs to have write permissions for the user running the servlet, in order for the servlet to create this cache directory at runtime.
 
'''VERY IMPORTANT:''' If not set correctly, the complete web service will be nonfunctional.
 
Default value: "/var/spool/open-xchange/documentconverter/readerengine.cache"

; com.openexchange.documentconverter.scratchDir=/var/spool/open-xchange/documentconverter/readerengine.scratch

This item contains the directory, that will make up the runtime enironment for the readerengine. The directory itself does not need to exist at startup, but the parent directory needs to exist and needs to have write permissions for the user running the servlet , in order for the servlet to create this cache directory at runtime.
 
'''VERY IMPORTANT:''' If not set correctly, the complete web service will be nonfunctional.
 
Default value: "/var/spool/open-xchange/documentconverter/readerengine.scratch"

; com.openexchange.documentconverter.errorDir=

The temporary directory, containing files that could not be loaded due to an error condition or due to a timeout
 
Default value: n/a

; com.openexchange.documentconverter.blacklistFile=/opt/open-xchange/etc/readerengine.blacklist

The list of external document content URLs that are not allowed to be loaded
by the readerengine after loading a document.
The file itself contains a list of (newline separated) regular expressions.
Each external URL is first checked against the list of blacklist URL regular
expressions.
If the external URL matches one blacklist entry, the external URL is
then checked against the list of whitelist URL regular expressions.
The behavior in summary is as follows:
If the URL is not blacklisted and not whitelisted, it is resolved at runtime.
If the URL is blacklisted but not whitelisted, it is not resolved at runtime.
If the URL is not blacklisted but whitelisted, it is resolved at runtime.
If the URL is blacklisted and whitelisted, it is resolved at runtime.
In boolean notation: valid = (!blacklisted) || whitelisted
Please note that the regular expressions need to fully qualify the patterns that
the URL should be checked against.
Upper/Lower cases need to be handled by the regular expression as well.
The file itself needs to be UTF-8 encoded to be read appropriately.
 
Default value: "/opt/open-xchange/etc/readerengine.blacklist"

; com.openexchange.documentconverter.whitelistFile=/opt/open-xchange/etc/readerengine.whitelist

The list of external document content URLs that are allowed to be loaded
by the readerengine after an external URL matched a blacklist pattern.
The file itself contains a list of (newline separated) regular expressions.
Each external URL is only checked against the list of whitelist URL regular
expressions if it previously matched a pattern in the blacklist file.
If the external URL matches one blacklist entry, the external URL is
then checked against the list of whitelist URL regular expressions.
The behavior in summary is as follows:
If the URL is not blacklisted and not whitelisted, it is resolved at runtime.
If the URL is blacklisted but not whitelisted, it is not resolved at runtime.
If the URL is not blacklisted but whitelisted, it is resolved at runtime.
If the URL is blacklisted and whitelisted, it is resolved at runtime.
In boolean notation: valid = (!blacklisted) || whitelisted
Please note that the regular expressions need to fully qualify the patterns that
the URL should be checked against.
Upper/Lower cases need to be handled by the regular expression as well.
The file itself needs to be UTF-8 encoded to be read appropriately.
 
Default value: "/opt/open-xchange/etc/readerengine.whitelist"

; com.openexchange.documentconverter.urlLinkLimit=200

The external URL link limit specifies the maximum amount of
valid external internet URLs (filtered by blacklist and whitelist before),
that are tried to get resolved by the engine when loading a document.
When this limit is reached, no more external internet URLs are resolved
for the current document.
 
'''Important:''' Please take note than one externally linked object within the document does not automatically correspond to one external URL call. In general, there are - at least - two URL calls necessary to display one externally linked object. Such additional calls are in most cases based on a format detection, happening prior to resolving the object data itself.
 
Set to -1 for no upper limit or to 0 to disable the resolving of internet URLs completely
 
Default value: 200

; com.openexchange.documentconverter.urlLinkProxy =

The external URL link proxy entry specifies a proxy server that is used by the readerengine
to resolve external links, contained within a document. Such links are e.g. external http://
graphic links, that are going to be resolved during the filtering process of a readerengine
instance.
Set this entry to the address of the proxy server: host:port
Recognized protocols are ''<nowiki>http://, https:// and ftp://</nowiki>''
Leave empty, if no proxy server should be used by the readerengine
 
Default value: n/a

; com.openexchange.documentconverter.RemoteBaseUrl =

Use a remote document conversion webservice to do the actual conversion;
Set this entry to the base URL of the remote host ''<nowiki>http://host[:port]/documentconverterPath</nowiki>'';
leave empty if conversion should happen on the local machine
 
Default value: n/a

; com.openexchange.documentconverter.RemoteCacheUrls =

Use one or more remote converter cache(s) to speedup the conversion. The first entry, if set, is treated as the remote master cache, receiving cache updates from the local cache. Additional entries are treated as remote slave caches for read purposes only. 
Set the (whitespace separated) entries to the base URL('s) of the appropriate remote host(s): ''<nowiki>http://host[:port]/documentconverterCachePath</nowiki>'' 
Leave empty if only the local filesystem cache should be used
 
Default value: n/a


; com.openexchange.documentconverter.jobProcessorCount=3

This item determines the number of engines working in parallel for job execution. The value needs to be greater or equal to 1, with best performance results about (n+1), where n specifies the number of available CPU cores of the machine the service is running on.
 
Default value: 3

; com.openexchange.documentconverter.jobRestartCount=50

This item determines the maximum number of executed jobs after which a single engine is automatically restarted in order to avoid memory fragmentation and possible memory leaks within one libreaderengine instance,
 
Default value: 50

; com.openexchange.documentconverter.jobExecutionTimeoutMilliseconds=60000

This item determines the timeout in milliseconds, after which the execution of a single job is terminated.
 
Default value: 60000

; com.openexchange.documentconverter.maxVMemMB=2048

This item determines the maximum size in megabytes (MB) of virtual memory that each started readerengine process is allowed to consume. If a job tries to consume more VMem than set via this config item, the processing of the current job for the appropriate readerengine process will be aborted and the underlying process is restarted to avoid memory corruption.
 
Set this value to -1 for no upper limit.
 
Default value: 2048

; com.openexchange.documentconverter.maxCacheSizeMB=-1

This item determines the maximum size in megabytes (MB) of all persistently cached converter job entries at runtime. A larger value may drastically reduce the time for conversion jobs, e.g. in case of a repeated creation of document previews.
 
Set this value to -1 for no upper limit.
 
Default value: -1

; com.openexchange.documentconverter.maxCacheEntries=-1

This item determines the maximum number of converter jobs cached at runtime. The value affects the amount of runtime job information to be cached as well as the number of file entries within the cache directory.
 
Set this value to -1 for no upper limit.
 
Default value: -1

; com.openexchange.documentconverter.cacheEntryTimeoutSeconds=2592000

This item determines the timeout in seconds, after which a cached job result is automatically removed from the cache.
 
Set this value to 0 to disable the timeout based removal of cached job results.
 
Default value: 2592000

; com.openexchange.documentconverter.enableCacheLookup=false

Setting this flag to true enables the caller of the RemoteInternalPreviewService#getCachedPreviewFor implementation (OfficePreviewService) to retrieve the cached only result of a previous conversion call, without scheduling a new job in case of a non existing cache entry, which might run for a long period time, up to the given job timeout time.
 
Set to false to disable the cache lookup within the RemoteInternalPreviewService#getCachedPreviewFor implementation.
 
Default value: false

; com.openexchange.documentconverter.errorCacheTimeoutSeconds=0

This value determines, how long an error, associated with a job hash value, is held within the error cache. If the timeout has not been reached, additional RemoteInternalPreviewService#getPreviewFor calls with the same job hash will instantly return with the cached error code instead of processing the job again.
 
Set to 0 to disable the error cache handling.
 
Default value: 0

; com.openexchange.documentconverter.errorCacheMaxCycleCount=5

This value determines the number of cycles, a job, associated with a job hash value, is added to the error cache.
One cycle starts after adding a job to the error cache and ends after the errorCacheTimeout has been reached.
After reaching the given maximum cycle count, the job is not removed from the error cache anymore and will be held within the error cache for the rest of the runtime of the current backend instance.
Since the error cache is not persistent, the cycle counter for each job hash is reset after a restart of the
backend instance.
 
Set to 0 to disable the error cache handling.
 
Default value: 5

; com.openexchange.documentconverter.servletLocalFileUrls=false

This item determines, if the documentconverter servlet should be allowed to handle file Urls of the form file://... The file Url itself is a resource that locates files that are locally accessible on the machine, the documentconverter backend is running on.
 
Default value: false

; com.openexchange.capability.sharepointconversion=false

Capability to enable the usage of a SharePoint conversion server; capability is only
checked, if a valid SharePoint remote converter has been configured appropriately
 
Default value: false

AppSuite:Spreadsheet Installation Guide

2015-01-07T17:43:32Z

Malte: /* calcengine */

= Download & Installation OX Spreadsheet =

== General Information ==
OX Spreadsheet is a browser based, cloud ready, spreadsheet product that can work with Microsoft Excel documents in a lossless way. And you can also collaborate with other people to edit shared spreadsheets on various devices.

Learn more about the highlights of OX Spreadsheet here: [http://software.open-xchange.com/products/appsuite/doc/OX_Spreadsheet_Product_Guide.pdf OX Spreadsheet Product Guide]

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Spreadsheet needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]].

For compatibility with XLS files (not XLSX) and for printing functionality in OX Spreadsheet the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

* The calcengine: See [[AppSuite:CalcengineInstall|calcengine installation instructions]]

== Installation ==

The OX Spreadsheet deployment consists of the packages <tt>open-xchange-documents-backend</tt>,<tt>open-xchange-documents-ui</tt> and <tt>open-xchange-documents-ui-static</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 6.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|office|office-web}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 7.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|office|office-web}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 11 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc3n=susename|pc3v=SLES11|office|office-web}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

== Printing and .xls Editing ==

For .XLS and/or printing support from OX Spreadsheet the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Configuration ==

=== Permissions ===

To enable OX Spreadsheet for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "spreadsheet" module capability globally.
#com.openexchange.capability.spreadsheet=true
</pre>

Uncomment the above line so that the capability is set to true.

=== calcengine ===

The calcengine has to be configured in the file ''/opt/open-xchange/etc/calcengine.properties''.

<pre>
# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# possible values :
#
# - local
# a set of worker processes are used at localhost;
# One worker = one calc engine process.
# JNI is used within worker process - not within main process.
#
# - http
# calc engine client will connect to a remote server
# where a calc engine server is running.
# Every calc engine server will host a set of worker processes.
# Communication protocol between client<->server<->worker is HTTP.
#
calcengine.mode=local

# -----------------------------------------------------------------------------
# timeout to detect hanging calc engine request
#
# unit = [ms]
# default = 20s

calcengine.request.timeout=20000

# -----------------------------------------------------------------------------
# define the max. value for memory reserved for one worker instance.
#
# Each worker will use that value separately.
# So the memory consumption for the whole pool of worker instances
# will be : pool-size * worker.memory.
#
# unit=[MB]
#
# default = 2048

calcengine.worker.memory.max-mb=2048

# -----------------------------------------------------------------------------
# define the count of worker we use as reserve for exchanging 'dirty' worker instances.
#
# Note:
#
# - If reserve count is configured with 0 no pro-active restart of any worker will happen
# ... excepting in error case.
#
# - Reserve count needs to be in sync with worker pool size.
# Means : port range has to be higher then these reserve count.
#
# default = 1

calcengine.worker.restart.reserve-count=1

# -----------------------------------------------------------------------------
# configure restart of one worker in case more then X documents was opened
# within those process.
#
# Note:
#
# - A value of 0 means -> these restart trigger is disabled
# ... where might other restart trigger can be active.
#
# - Don't forget to configure reserve count value too
# if you configure these restart trigger.
#
# default = 50

calcengine.worker.restart.trigger.max-doc-count=50

# -----------------------------------------------------------------------------
# timeout to detect non starting worker process
#
# unit = [ms]
# default = 55s

calcengine.worker.init.timeout=55000

# -----------------------------------------------------------------------------
# define the range of ports to be used for a pool of worker processes.
#
# Of course MIN and MAX values needs to be in right (ascending) order.
# If not - an error is shown and calc engine environment wont work.
#
# MIN and MAX port are included in range. So pool size is MAX-MIN+1.
#
# default = 5001 ... 5003

calcengine.worker.port_range.min=5001
calcengine.worker.port_range.max=5003
</pre>

AppSuite:Main Page userguides

2013-07-02T13:52:12Z

Malte: /* Advanced Documentation */

AppSuite:KeyboardControlled

2013-07-02T13:45:12Z

Malte: /* OX Text */

== OX App Suite Keyboard Shortcuts ==

=== OX Document Viewer ===
{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Move between tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Scroll up || Arrow Up ||
|-
|Scroll up, jump to previous page || Page Up ||
|-
|Scroll down || Arrow Down ||
|-
|Scroll down, jump to next page || Page Down ||
|-
|Jump to top of first page || Home ||
|-
|Jump to top of previous page || Alt + Page Up || Meta + Page Up
|-
|Jump to top of next page || Alt + Page Down || Meta + Page Down
|-
|Jump to bottom of last page || End ||
|-
|Zoom in || + (also on numeric pad) ||
|-
|Zoom out || - (also on numeric pad) ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Documents ===

These keyboard shortcuts apply for all OX Documents editor applications.
{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Move between side pane, tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Focus the document || ESC ||
|-
|Collapse or expand the side pane **(NIY)** || Ctrl+F3 ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Undo the last action || Ctrl + Z || Meta + Z
|-
| || Alt + Backspace ||
|-
|Redo the last action || Ctrl + Y || Meta + Y
|-
| || Shift + Alt + Backspace ||
|-
|Copy selected text or object || Ctrl + C || Meta + C
|-
| || Ctrl + Insert ||
|-
|Cut selected text or object || Ctrl + X || Meta + X
|-
| || Shift + Delete ||
|-
|Paste selected text or object || Ctrl + V || Meta + V
|-
| || Ctrl + Insert ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Text ===

'''Navigation'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Jump one character to the left / to the right || Arrow Left/Right ||
|-
|Jump one word to the left / to the right || Ctrl + Arrow Left/Right ||
|-
|Jump to the beginning of a line || Home || Meta + Arrow Left
|-
|Jump to the end of a line || End || ✘
|-
|Jump one line down / one line up || Arrow Down/Arrow Up ||
|-
|Jump to end / to beginning of document || Ctrl + End/Home || Meta + Arrow Down/Up
|-
|Jump to next table cell || Tab ||
|-
|Jump to previous table cell || Shift + Tab ||
|}

'''Text Selection'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Extend selection one character to the right / to the left || Shift + Arrow Right/Left ||
|-
|Extend selection to the beginning of a line || Shift + Home || Shift + Meta + Arrow Left
|-
|Extend selection to the end of a line || Shift + End || ✘
|-
|Extend selection one line down / one line up || Shift + Arrow Down/Arrow Up ||
|-
|Extend selection to end / to beginning of document || Shift + Ctrl + End/Home || Shift + Meta + Arrow Down/Up
|-
|Extend selection to entire document || Ctrl + A || Meta + A
|-
|}

'''Search and Replace'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Open Search and Replace pane || Ctrl + F || Meta + F
|-
|Close Search and Replace pane || Esc ||
|-
|}

'''Edit Document'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Insert paragraph break || Enter ||
|-
|Insert line break without breaking paragraph || Shift + Enter ||
|-
|}

'''Format Tex'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Apply / remove bold || Ctrl + B || Meta + B
|-
|Apply / remove italic || Ctrl + I || Meta + I
|-
|Apply / remove underline || Ctrl + U || Meta + U
|-
|Remove all manual styles || Ctrl + Space ||
|-
|}

AppSuite:KeyboardControlled

2013-07-02T13:44:51Z

Malte: /* OX Text */

AppSuite:KeyboardControlled

2013-07-02T13:43:11Z

Malte: /* OX Text */

AppSuite:KeyboardControlled

2013-07-02T13:42:11Z

Malte: /* OX Text */

AppSuite:KeyboardControlled

2013-07-02T13:39:21Z

Malte: /* OX Text */

AppSuite:KeyboardControlled

2013-07-02T13:38:44Z

Malte: /* OX Text */

== OX App Suite Keyboard Shortcuts ==

=== OX Document Viewer ===
{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Move between tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Scroll up || Arrow Up ||
|-
|Scroll up, jump to previous page || Page Up ||
|-
|Scroll down || Arrow Down ||
|-
|Scroll down, jump to next page || Page Down ||
|-
|Jump to top of first page || Home ||
|-
|Jump to top of previous page || Alt + Page Up || Meta + Page Up
|-
|Jump to top of next page || Alt + Page Down || Meta + Page Down
|-
|Jump to bottom of last page || End ||
|-
|Zoom in || + (also on numeric pad) ||
|-
|Zoom out || - (also on numeric pad) ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Documents ===

These keyboard shortcuts apply for all OX Documents editor applications.
{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Move between side pane, tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Focus the document || ESC ||
|-
|Collapse or expand the side pane **(NIY)** || Ctrl+F3 ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Undo the last action || Ctrl + Z || Meta + Z
|-
| || Alt + Backspace ||
|-
|Redo the last action || Ctrl + Y || Meta + Y
|-
| || Shift + Alt + Backspace ||
|-
|Copy selected text or object || Ctrl + C || Meta + C
|-
| || Ctrl + Insert ||
|-
|Cut selected text or object || Ctrl + X || Meta + X
|-
| || Shift + Delete ||
|-
|Paste selected text or object || Ctrl + V || Meta + V
|-
| || Ctrl + Insert ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Text ===

'''Navigation'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Jump one character to the left / to the right || Arrow Left/Right ||
|-
|Jump one word to the left / to the right || Ctrl + Arrow Left/Right ||
|-
|Jump to the beginning of a line || Home || Meta + Arrow Left
|-
|Jump to the end of a line || End || ✘
|-
|Jump one line down / one line up || Arrow Down/Arrow Up ||
|-
|Jump to end / to beginning of document || Ctrl + End/Home || Meta + Arrow Down/Up
|-
|Jump to next table cell || Tab ||
|-
|Jump to previous table cell || Shift + Tab ||
|}

'''Text Selection'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Extend selection one character to the right / to the left || Shift + Arrow Right/Left ||
|-
|Extend selection to the beginning of a line || Shift + Home Shift + Meta + Arrow Left
|-
|Extend selection to the end of a line || Shift + End || ✘
|-
|Extend selection one line down / one line up || Shift + Arrow Down/Arrow Up ||
|-
|Extend selection to end / to beginning of document || Shift + Ctrl + End/Home || Shift + Meta + Arrow Down/Up
|-
|Extend selection to entire document || Ctrl + A || Meta + A
|-
|}

AppSuite:KeyboardControlled

2013-07-02T13:37:32Z

Malte: /* OX Text */

== OX App Suite Keyboard Shortcuts ==

=== OX Document Viewer ===
{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Move between tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Scroll up || Arrow Up ||
|-
|Scroll up, jump to previous page || Page Up ||
|-
|Scroll down || Arrow Down ||
|-
|Scroll down, jump to next page || Page Down ||
|-
|Jump to top of first page || Home ||
|-
|Jump to top of previous page || Alt + Page Up || Meta + Page Up
|-
|Jump to top of next page || Alt + Page Down || Meta + Page Down
|-
|Jump to bottom of last page || End ||
|-
|Zoom in || + (also on numeric pad) ||
|-
|Zoom out || - (also on numeric pad) ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Documents ===

These keyboard shortcuts apply for all OX Documents editor applications.
{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Move between side pane, tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Focus the document || ESC ||
|-
|Collapse or expand the side pane **(NIY)** || Ctrl+F3 ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Undo the last action || Ctrl + Z || Meta + Z
|-
| || Alt + Backspace ||
|-
|Redo the last action || Ctrl + Y || Meta + Y
|-
| || Shift + Alt + Backspace ||
|-
|Copy selected text or object || Ctrl + C || Meta + C
|-
| || Ctrl + Insert ||
|-
|Cut selected text or object || Ctrl + X || Meta + X
|-
| || Shift + Delete ||
|-
|Paste selected text or object || Ctrl + V || Meta + V
|-
| || Ctrl + Insert ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Text ===

'''Navigation'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Jump one character to the left / to the right || Arrow Left/Right ||
|-
|Jump one word to the left / to the right || Ctrl + Arrow Left/Right ||
|-
|Jump to the beginning of a line || Home || Meta + Arrow Left
|-
|Jump to the end of a line || End || ✘
|-
|Jump one line down / one line up || Arrow Down/Arrow Up ||
|-
|Jump to end / to beginning of document || Ctrl + End/Home || Meta + Arrow Down/Up
|-
|Jump to next table cell || Tab ||
|-
|Jump to previous table cell || Shift + Tab ||
|}

'''Text Selection'''

{| border=1
|'''Function''' || '''Windows / Linux''' || '''Apple Mac (if different)'''
|-
|Extend selection one character to the right / to the left || Shift + Arrow Right/Left ||
|-
|Extend selection to the beginning of a line || Shift + Home | Shift + Meta + Arrow Left |
|-
|Extend selection to the end of a line || Shift + End || ✘
|-
|Extend selection one line down / one line up || Shift + Arrow Down/Arrow Up ||
|-
|Extend selection to end / to beginning of document || Shift + Ctrl + End/Home | Shift + Meta + Arrow Down/Up |
|-
|Extend selection to entire document || Ctrl + A || Meta + A
|-
|}

AppSuite:KeyboardControlled

2013-07-02T13:30:08Z

Malte: /* OX Text */

AppSuite:KeyboardControlled

2013-07-02T13:29:44Z

Malte: /* OX App Suite Keyboard Shortcuts */

AppSuite:KeyboardControlled

2013-07-02T13:26:25Z

Malte: /* OX Documents */

== OX App Suite Keyboard Shortcuts ==

=== OX Document Viewer ===
{| border=1
|Function || Windows / Linux || Apple Mac (if different)
|-
|Move between tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Scroll up || Arrow Up ||
|-
|Scroll up, jump to previous page || Page Up ||
|-
|Scroll down || Arrow Down ||
|-
|Scroll down, jump to next page || Page Down ||
|-
|Jump to top of first page || Home ||
|-
|Jump to top of previous page || Alt + Page Up || Meta + Page Up
|-
|Jump to top of next page || Alt + Page Down || Meta + Page Down
|-
|Jump to bottom of last page || End ||
|-
|Zoom in || + (also on numeric pad) ||
|-
|Zoom out || - (also on numeric pad) ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

=== OX Documents ===

These keyboard shortcuts apply for all OX Documents editor applications.
{| border=1
|Function || Windows / Linux || Apple Mac (if different)
|-
|Move between side pane, tool bars and document content || Ctrl + F6 || F6
|-
|Move among tool bar items || Tab ||
|-
|Focus the document || ESC ||
|-
|Collapse or expand the side pane **(NIY)** || Ctrl+F3 ||
|-
|Execute the currently selected ribbon command || Enter ||
|-
|Undo the last action || Ctrl + Z || Meta + Z
|-
| || Alt + Backspace ||
|-
|Redo the last action || Ctrl + Y || Meta + Y
|-
| || Shift + Alt + Backspace ||
|-
|Copy selected text or object || Ctrl + C || Meta + C
|-
| || Ctrl + Insert ||
|-
|Cut selected text or object || Ctrl + X || Meta + X
|-
| || Shift + Delete ||
|-
|Paste selected text or object || Ctrl + V || Meta + V
|-
| || Ctrl + Insert ||
|-
|Print **(NIY)** || Ctrl+P ||
|}

==== OX Text ====

Navigation

{| border=1
|Function || Windows / Linux || Apple Mac (if different)
|-
|Jump one character to the left / to the right || Arrow Left/Right ||
|-
|Jump one word to the left / to the right || Ctrl + Arrow Left/Right ||
|-
|Jump to the beginning of a line || Home || Meta + Arrow Left
|-
|Jump to the end of a line || End || ✘
|-
|Jump one line down / one line up || Arrow Down/Arrow Up ||
|-
|Jump to end / to beginning of document || Ctrl + End/Home || Meta + Arrow Down/Up
|-
|Jump to next table cell || Tab ||
|-
|Jump to previous table cell || Shift + Tab ||
|}