AppSuite:Debugging the UI

Revision as of 10:38, 4 November 2013 by Tierlieb (talk | contribs) (Does not load, fails with error: Could not read...)
Debugging the UI

Synopsis: A collection of hints to debug during UI development

What capabilities are available?


Which files failed to load?


What portal widgets are available?

require(['io.ox/portal/widgets'], function (widgets) {

Check settings

// check core settings
// check mail settings

Clear all persistent caches

Please mind that this does not clear the regular browser cache! It clears localStorage, IndexedDB, and WebSQL.


Debug relogin


Enable/disable capability via URL hash

Just add the parameter "cap" to URL hash. A leading minus disables a capability. Multiple capabilities separated by comma. Example:


Changes do not apply while developing

You did changes in your code and they don't simply don't apply? There are several possibilites, you should check in order to find a solution.

  • Reload AppSuite with cleared Browser Cache. Using Firefox on Linux-Distributions you can simply press Ctrl+F5. Please check the documentation of your Browser for Shortcuts and how to clear the cache.
  • Disable Source Caching. Therefor add the parameter "debug-js=true" to URL hash. Example:

Debug a specific folder

If you want to get details of a specific folder, just inspect it via dev tools and look for data-obj-id="...". Copy the id and run the following in console:

void require('io.ox/core/api/folder').get({ folder: 'default0/INBOX' }).always(_.inspect);

Does not load, fails with error: Could not read...

"Could not read 'io.ox/core/http.js'" 
"Could not read 'io.ox/core/events.js'" 

That's not all, the system is probably hiding even more errors. It is more probable that the whole UI cannot be found. Check the com.openexchange.apps.path, usually hidden in Does it point to where your webserver serves the files from? The default is /var/www/appsuite, on OSX is is more likely to be /Libraries/WebServer/Documents/appsuite

App Suite loads, but no apps show up

So bother backend and frontend are devoid of errors, the UI loads nicely, you see the top bar with settings, notifications and refresh button but no apps at all, right? This is a manifest problem. Check the capabilities (see hint in the beginning of this page). If even those are correct, check the backend's /tmp folder and the there: Are the paths of com.openexchange.apps.path and com.openexchange.apps.manifestPath pointing to your build directory?