Difference between revisions of "OX6:OX Mobile Web Interface"

(Configuration)
Line 114: Line 114:
  
 
Installation on the Apache or another webserver:
 
Installation on the Apache or another webserver:
# After installation locate the installed files in your webroot directory, i.e. <code>/var/www/ox6-mobile-v2/</code> on Debian
+
* After installation locate the installed files in your webroot directory, i.e. <code>/var/www/ox6-mobile-v2/</code> on Debian
# Edit the file <code>"ox-access.conf"</code> in directory ox6-mobile-v2
+
* Edit the file <code>"ox-access.conf"</code> in directory ox6-mobile-v2
# If your open-xchange server is running on a different host, change localhost to your OX server address, i.e. "<code>https://example.com/ajax</code>". '''Note''': We strongly recommend the usage of https, otherwise data will be transmitted unencrypted via client and server
+
* If your open-xchange server is running on a different host, change localhost to your OX server address, i.e. "<code>https://example.com/ajax</code>". '''Note''': We strongly recommend the usage of https, otherwise data will be transmitted unencrypted via client and server
# run the command <code>/opt/open-xchange/sbin/update-cache.manifest /var/www/ox6-mobile-v2/cache.manifest.in /var/www/ox6-mobile-v2/cache.manifest /var/www/ox6-mobile-v2/ox-access.conf</code> - path might be different on SLES/RHEL -.
+
* run the command (adopt webserver path on SLES/RHEL).
# You also need to add a new mimetype to your webserver configuration to make sure the caching (offline mode) works.  
+
$ /opt/open-xchange/sbin/update-cache.manifest /var/www/ox6-mobile-v2/cache.manifest.in /var/www/ox6-mobile-v2/cache.manifest /var/www/ox6-mobile-v2/ox-access.conf
## On Apache servers you can add the mimetype either global or via "<code>.htaccess</code>" file.
+
* You also need to add a new mimetype to your webserver configuration to make sure the caching (offline mode) works.  
## For global configuration edit the file <code>mime.conf</code> under  <code>/etc/apache2/mods-enabled/</code>
+
** On Apache servers you can add the mimetype either global or via "<code>.htaccess</code>" file.
## Add the line "<code>AddType text/cache-manifest .manifest</code>" to the file, save and restart apache
+
** For global configuration edit the file <code>mime.conf</code> under  <code>/etc/apache2/mods-enabled/</code>
## For configuration via <code>.htaccess</code> file just add a .htaccess file to the install directory. This should include the line  "<code>AddType text/cache-manifest .manifest'</code>". '''Note''': Either the global configuration or the .htaccess file should be used. (.htaccess files will only work if your Apache settings contain <code>AllowOverride</code>. For further information on mime types, please refer to your webservers user manual)
+
** Add the line "<code>AddType text/cache-manifest .manifest</code>" to the file, save and restart apache
 +
** For configuration via <code>.htaccess</code> file just add a .htaccess file to the install directory. This should include the line  "<code>AddType text/cache-manifest .manifest'</code>". '''Note''': Either the global configuration or the .htaccess file should be used. (.htaccess files will only work if your Apache settings contain <code>AllowOverride</code>. For further information on mime types, please refer to your webservers user manual)
  
 
* For more details and README see the systems documentation directory (/usr/share/doc).
 
* For more details and README see the systems documentation directory (/usr/share/doc).

Revision as of 07:31, 28 March 2011

Information and Installation of Open-Xchange Mobile Web App (Preview)

Description

Later this year, Open-Xchange will release Open-Xchange Mobile Web App, which 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 App offers online and offline access to appointments, contacts and mails on the road using your smartphone. Optimized for low bandwiths Open-Xchange Mobile Web App offers instant and fast over the air access to your data, which are at the same time safely stored on Open-Xchange Server. The following modules are supported:

  • E-Mail
  • Calendar
  • Contacts

Moreover the app offers seamless integration to use your phones basic functions like phone calls. You can easily start calls from your Open-Xchange contacts on your smartphone or directly send E-Mails.

Features and Functions

Mail Module

  • Access to all Open-Xchange standard folder: Inbox, Sent, Trash, Spam and Drafts
  • Creation of new e-mails
  • Answer, forward and delete e-mails
  • Mail attachments (Attachment handling/support is defined by mobile device)

Contact Module

  • Access to all Open-Xchange contact folder and contacts with details
  • Creation of e-mail directly from contact module
  • Start call directly from contact module

Calendar Module

  • Access to all Open-Xchange calendar folder and appointments with details
  • Accept/Decline of appointments
  • Participants and resources list from all appointments
  • Planned: Additional notes for Accept/Decline function, creation of new appointments

Persistence of the Mobile Web App

  • Offline capability
  • All contacts are available offline
  • All appointments are available offline
  • All mail header are available offline
  • All mails which are opened once are available offline

Configuration

  • Number of e-mails retrieved (25,50,75,100)
  • Number of days which will be checked for appointments (5,10,20,30)
  • Animation for iOS devices (on/off)
  • Subscription of contact folders
  • Autologin

Themeability, branding and i18n

  • i18n for DE and EN, other languages can be added.
  • Branding options: App name and app icon
  • Themeability by CSS

Supported devices

The OX Mobile Web App should work on devices running a Webkit based browser. These are mainly the devices running iOS, Android and newest generation of BlackBerrys. For devices running Symbian we recommend to use Opera Mobile Browser.

Device Support    
Apple iPhone yes (iPhone running iOS 2.0, 2.1, 3.0, 4.0, 4.2.1, 4.3) Official Supported by OX: 2G, 3G, 3GS, 4 and iPod-Touch 3.1.3
Android yes Official Supported by OX: Google Nexus One (Android 2.3.3), HTC Desire (Sense Android 2.1)
Nokia/Symbian S60 5th Edition via Opera Mini i.e Nokia N97 (Although there is a built-in Webkit browser running on this device a Symbian bug in the cookie-handling which prevents login to the OX-Server)
Windows Mobile running Internet Explorer no
Windows Phone 7 not yet

Technical overview

  • Based on HTML5, CSS, Javascript (Frameworks jQuery and jQTouch)
  • Optimized for Webkit browsers like Mobile Safari and Chrome. Will also work with restrictions on Firefox and Opera Mobile
  • Complete offline capability

Offline Mode details

The OX Mobile Web App uses HTML5 to provide an offline mode for the user. To do this, there are two different kinds of storage mechanisms.

  • The whole application will be cached using the "HTML5 application cache". This will be done on the first visit/start of the app. After this initial download, all graphics, language files, js-files and everything else which is needed to run the app is stored locally on your phone in a storage managed by the browser.
  • The data from the OX server will be stored using the HTML5 storage mechanism which will be supportet by the users device. These can be a HTML5 local storage, session storage or an SQLite database. For the user there's no difference between these different storage modes.

Note: In case your device has no storage support (like the Nokia N97), a log message will inform you about this. The log can be found under the settings page, hitting the button in the upper right corner showing the exclamation mark symbol.

Requirements

  • Open-Xchange Server >= v.6.20
  • 1GB RAM

Download & Documentation

Please note that everything from this page and beyond is in Preview: This means nothing is final, changes will be made before final release, stability is not guaranteed and nothing from this site should be used in production.

Follow this link to download the installation package, Release Notes and documentation.

Install on OX AppSuite

Debian GNU/Linux 8.0

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

deb https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/DebianJessie/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/OXtender-unstable/MobileApp/updates/DebianJessie/ /

and run

$ apt-get update
$ apt-get install open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

Debian GNU/Linux 9.0

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

deb https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/DebianStretch/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/OXtender-unstable/MobileApp/updates/DebianStretch/ /

and run

$ apt-get update
$ apt-get install open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

SUSE Linux Enterprise Server 12

Add the package repository using zypper if not already present:

$ zypper ar https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/SLE_12 mobilewebapp

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

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

and run

$ zypper ref
$ zypper in open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

RedHat Enterprise Linux 6

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

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

[mobilewebapp]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/OXtender-unstable/MobileApp/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

RedHat Enterprise Linux 7

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

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

[mobilewebapp]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/OXtender-unstable/MobileApp/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

CentOS 6

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

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

[mobilewebapp]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/OXtender-unstable/MobileApp/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

CentOS 7

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

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

[mobilewebapp]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/OXtender-unstable/MobileApp/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/OXtender-unstable/MobileApp/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-gui-mobile-v2-gui open-xchange-gui-mobile-v2

Configuration

Installation on the Apache or another webserver:

  • After installation locate the installed files in your webroot directory, i.e. /var/www/ox6-mobile-v2/ on Debian
  • Edit the file "ox-access.conf" in directory ox6-mobile-v2
  • If your open-xchange server is running on a different host, change localhost to your OX server address, i.e. "https://example.com/ajax". Note: We strongly recommend the usage of https, otherwise data will be transmitted unencrypted via client and server
  • run the command (adopt webserver path on SLES/RHEL).
$ /opt/open-xchange/sbin/update-cache.manifest /var/www/ox6-mobile-v2/cache.manifest.in /var/www/ox6-mobile-v2/cache.manifest /var/www/ox6-mobile-v2/ox-access.conf
  • You also need to add a new mimetype to your webserver configuration to make sure the caching (offline mode) works.
    • On Apache servers you can add the mimetype either global or via ".htaccess" file.
    • For global configuration edit the file mime.conf under /etc/apache2/mods-enabled/
    • Add the line "AddType text/cache-manifest .manifest" to the file, save and restart apache
    • For configuration via .htaccess file just add a .htaccess file to the install directory. This should include the line "AddType text/cache-manifest .manifest'". Note: Either the global configuration or the .htaccess file should be used. (.htaccess files will only work if your Apache settings contain AllowOverride. For further information on mime types, please refer to your webservers user manual)
  • For more details and README see the systems documentation directory (/usr/share/doc).

Running the OX Mobile Web App on your smartphone

After installation of the App on your webserver, a client can easily access the app via his phone's browser. We recommend to add a new subdomain to your web address to make access for clients easy. A short subdomain like https://m.example.com which points to your installation will save users from entering a long URL on their devices.

Like mentioned before, the OX Mobile Web App is a pure web application. Due to this fact there is no installation or download needed to use this app on a smartphone. Just add a bookmark in your browser to access the app again later.

Especially on iOS devices there's a seamless integration within the native apps installed via the AppStore®. Just add a new bookmark to the OX Mobile Web App and choose "Add to homescreen". After this, the OX Mobile Web App will place a new app icon on the homescreen.

Using the offline mode

During the first run, the app is stored localy on your smartphone. These caching mechanism makes a later access to the app very fast and gives you the possibility to run the app even if there's no internet connection available.

The OX Mobile Web App detects on startup whether there's an internet connection available or not. If not, the App will start in offline mode. In this case a plane icon is shown in the upper left corner of the main menu. In offline mode you can access all your subscribed contacts and all of your appointments. Also all your mail headlines are available. Furthermore each email which was opened earlier is available in offline mode.

Note: At the moment the OX Mobile Web App will not detect if internet connection reappears during a run in offline mode. To re-enter online mode just restart the app.

Known Problems

  • The OX Mobile Web App uses a custom, built-in navigation and history. To navigate back you will have to use the "back" buttons located on the top-left of the page. Do not use browser's back button. This causes the app to jump to the login screen and you will have to reload the app.
  • If you want to use the App in airplane mode or no network connection is availabe, the android browser will show up a message like "page could not be loaded due to missing network connection". Just ignore this alert and press "OK". The app will work in offline mode even android shows up this message.
  • If you clean the browser cache on your device or reset it to defaults, all local stored data will be flushed.

Deployment as native app

The OX Mobile Web App can also be deployed as a native smartphone app. This option is available for Android Systems and later for iOS, too. As Android allows installation of apps from every location you can place an *.apk file on a webserver or in your own Android App-Store. The OX Mobile Web App will act like any other app on the device and offers the same functionality as the web hosted variant.

Deploying a native iOS App can only be done via the Apple AppStore®. To do so you need to submit your special branded version of the app to Apple. Only Apple decides if the app will be listed in the AppStore or not. These option will not be available for the Preview version of the app.

For more information on native app deployment please contact us directly.

Branding options

Application name

The OX Mobile Web App comes with the standard name set "OX Mobile Web App". This title is saved in a png file under "/lib/jqtouch/themes/cupertino/external/brand.png". To brand the app with you custom title just replace this file in the standard theme or you own theme. To configure the page title (in html title tag) please use the i18n module:

  1. Locate your installstion directory (i.e. /var/www/ox6-mobile-v2)
  2. Change to "lang" folder
  3. The folder contains all available language files (*.po)
  4. Open one of the files and locate the line containing msgid "OX Mobile"
  5. Change the corresponding msgstr to your title of the app, i.e. "My App".
  6. Do this for all language files
  • Note: Do not change the msgid, this must be "OX Mobile". Only change the msgstr value.

This title will also be the "App title" for the iPhone when the function "Add to homescreen" is used.

Theming

The OX Mobile Web App is themed via CSS and HTML. To create your own theme you will have to create new graphics and edit the css files in the theme path. To do so follow the steps below:

  1. Locate the theme path under "path to your webroot/ox6-mobile-v2/lib/jqtouch/themes"
  2. The default theme is named "cupertino". To create your own theme make a copy of this folder and backup the original one
  3. The folder contains two css files and two folders with images. The file jqt_theme.css contains all styles which belong to the "overall" look of the app. These are styles for lists, buttons, background, toolbars and so on. The file ox_theme.css contains more high level theming styles such as module icons, progress bars, infobox and the way the details in lists are shown (like the appointment lists or mail list). To change the whole look of the app (like colors) you will mainly edit the file jqt_theme.css
  4. The folders "img" and "external" hold all graphics which are used in the app. To change them, just edit and save them under the same name. Don't change filenames or the theme will be broken. Also keep all file dimensions and file types (*.png, *.jpg). Changing files dimensions will corrupt the theme and layout will be broken.
  5. Always remember: Your are designing for mobile. This means: Keep fonts clear and easy to read. Keep file sizes small due to small bandwiths. Keep buttons big enought the user can touch them easily.

Reporting

Open-Xchange is interested in learning about bugs, specifically in your runtime environment. If you experience any misbehaviors, please report bugs via our public bugzilla: Open-Xchange Bugzilla
Product: OX Mobile App

The OX Mobile Web App logs all errors to a logfile which can be found under settings -> log.

Please note

There may be some issues with checkboxes on Android devices. Sometimes checkboxes and listboxes do not respond to tap actions. If so, please rotate your phone to landscape mode and back. Then, the checkboxes should response again

Please read the SDB article to inform you about the reasons and solution.