Difference between revisions of "Integrating Applications Into Web Frontend"

Revision as of 12:50, 17 April 2010

About

This HowTo will describe the integration of an application (app.bin) into the Webend.
The system has a dynamic plugin loader (load.webplugin) which enable your app.bin
in the Webend Interface. The loader need a config file which is called webend.conf
you have to provide in the app.bin.
The integration can be used for web application with and without daemon.
Or for an application without Web-UI to show and manage the daemon only.

Functions

The following functions of integration are supported:

• create a starter Icon for the Web Application
  • set start page
  • set icon image
  • set window size
  • set config page
  • set starter icon disappear when plugin link isn't exist
  • set starter icon disappear when daemon isn't running

• create an entry for daemon status and start/stop option
  • set daemon name
  • set daemon start command
  • set daemon stop command

Activate

To activate your app.bin in webend you have to create a webend.conf (see below)
and add two commands to the init script.

1. add the application as webplugin with add.webplugin

   add.webplugin <plugin_name> <plugin_location>

   e.g. add.webplugin DownloadDaemon /apps/downloadd/var/www/dd-client

   In this case I add a Web Application and dd-client is the root of web client

   or

   e.g. add.webplugin daemon_only /apps/daemon_only_app

   Here is the plugin location root of app.bin

   The webend.conf must be in the plugin_location, so the plugin loader can find it.

   e.g. /apps/downloadd/var/www/dd-client/webend.conf

1. start the plugin loader

   now run: load.webplugin

   The loader parse the webend.conf and create code with will be include to webend.

The config file webend.conf

As follow there is an example of webend.conf (DownloadDaemon)
with all parameters and descriptions.

#### parameter for starter-icon for Web App (next 4 must be to create the starter-icon)
  # Reference to start page (e.g. index.php)
    TARGET=index.php
  # Reference to image for icon
    IMAGE=ddclient-gui.png
  # Windows size parameter
    WINDOW_SIZE_HEIGHT=700
    WINDOW_SIZE_WIDTH=900

  # additional parameter for starter-icon (required parameter for starter-icon) 
    # Flag for icon disappaer when plugin don't exist
      FLAG_EXISTS=YES
    # Reference to config page (e.g. index.php)
      #CONFIG_SIDE=config.php
    # Flag will disappear the icon if daemon not running (YES or NO)
    # Only works with parameter DAEMON_NAME
      ICON_DISAPPEAR_DAEMON_OFF=YES

#### parameter for daemon status and management (start/stop) 
  # status parameter, daemon name
    DAEMON_NAME=DownloadDaemon
  # management parameter for start/stop ( required status parameter)
    DAEMON_START_COMMAND="/tmp/init.d/S97downloadd forcestart"
    DAEMON_STOP_COMMAND="/tmp/init.d/S97downloadd stop"

Some notes to the parameter:

• TARGET, IMAGE and CONFIG_SIDE has to be set relative to the location parameter (add.webplugin).
• WINDOWS_SIZE parameter will set the launch window size
• If a parameter is not needed command out like CONFIG_SIDE
• START/STOP COMMAND has to be unix commands

This Page is under construction and will filled up soon !!!!