AppSuite:Developing for the UI

Revision as of 09:57, 4 November 2013 by Tierlieb (talk | contribs) (Tierlieb moved page DevelopingTheUI to AppSuite:Developing for the UI: Corrected name space, changed camelCased title)
UI Development for OX AppSuite

This page contains articles about the inner workings of the web-based graphical user interface. It is aimed at software developers that want to improve on existing features, implement extensions or just gain a general understanding.

Tech Overview

All technologies and frameworks used for developing a new component for the AppSuite UI are listed and described in the following article: Requirements to develop for the UI

Developing Guidelines

While developing code for OX products the UI Developement Style Guide helps you writing safe, clear and functional code.

Designing apps, plugins and widgets running with the right layout, colors, look and feel is a breeze following the guidelines described in the UI Design Guide.

Always keep in mind, that using OX products should be possible for everyone and therefor it's important to follow simple rules regarding accessibility.

Using extension points

Writing apps or plugins for AppSuite will often include extending the existing user interface. AppSuite provides extension points offering you possibilties to add your own contents. Beginning to develop using extension points? Read this guide first having a hands-on introduction for extending the OX user interface. Get more information and a complete list of extension points offered by OX products.

How to get code

Using git as a version version control system getting the code from existing OX products is quite easy. Simply clone the UI or the backend repository and start working with it.

What can i build?

If you want to have a simple introduction following easy steps from creating your workspace to actually performing your source code within AppSuite, read our GettingStarted guide.

There are several other possibilities available to develop for AppSuite.

  • A portal plugin is a widget, which can be used in the 'portal'-section of AppSuite only. Please just check for the right extension point to write a plugin which extends and interacts with other parts of AppSuite. Configuring portal plugins can be achieved by reading this guide.
  • Upsell Widget, to enable the AppSuite user to purchase additional features.
  • A wizard, which can be first time users to show them important informations or configure initial settings for 3rd party applications.

You got stuck somewhere? There are some hints, which might help you debugging the UI.

How to get your code running

Written your first app/plugin? Using the UI build system will help you to get fast, easy-to-distribute and correct builds running on your AppSuite. The article will show you how to package your code and copy from OX source code / directories.

Since the AppSuite product consists of a server and a UI, you also need a working backend (AppSuite application server) to communicate with. Therefor you should run Appserver using an existing OX AppSuite server and (with local parts of the AppSuite) automaticly get the recent stable source packages from the AppSuite servers. For using your namespace as a source for hosting your app, simply add the build-path of your app as an parameter while running appserver.

What's next

No Idea what to do first? Read our GettingStarted guide to have a step-by-step introduction about how to install the SDK, use the Build System, write your first app and get it running.