Online documentation - Websydian v6.0

Users Guide | Patterns Reference | WebsydianExpress | Search
 
» Related Information

DWA Deployment Guides

Distributed Websydian Architecture Installation

Overview    Installation     Operation    Parts    Background   Error Handling

Contents

Introduction

This page describes how each of the three components in a Websydian DWA system are configured and deployed. The description is held in a platform neutral language with links to pages with platform specific details.

Before proceeding with this guide it may be a help to take a look at the Parts and Background pages.

This description assumes that all components are installed on the local host (IP 127.0.0.1) and that only one Application Service is started. Starting multiple Application Services requires only repetition of the steps necessary for starting a single Application Service.

Requirements

The following components are needed in order to deploy a Websydian DWA application, apart from the standard requirements:

Configure and Start the Websydian Server

The Websydian Server is available in a Java implementation only, so it has to be invoked by starting the Java virtual machine.

The Websydian Server is configured using a property file. The possible values for the property file can be found here.

To start the Websydian Server enter the following one-line command from a command prompt shell:

java -cp classpath websydianserver -f websydianserver.prop

Please refer to third party run-time libraries for a definition of classpath. If the file websydianserver.prop is not in the current directory, then the full path to the property file must be specified.

All parameters in the property file can be overridden from the command line. Use the option -? to see a list of all the command-line arguments:

java -cp classpath websydianserver -?

Windows Specific

The Websydian distribution includes a sample batch file (websydianserver.bat) that can be used as a template for launching the Websydian Server. It can be found in the folder

<Websydian Install Folder>\<Plex Version>\Deployment\Dwa.

iSeries Specific

For the iSeries platform the command STRWS can be used to start the Websydian Server.

[Read more about the iSeries specific details].

Configure and Start a Websydian Application Service

The Application Service is launched by starting the Application Service Listener function. The Application Service listener functions acts as a mediator between the Relay Service and the Websydian dispatcher function. It awaits requests from the Relay Service on a TCP socket and will then call the Dispatcher function so the request can be processed. For further details please go to the Application Service Listener page.

For information on parameters accepted by the Application Service Listener function please go to Application Service Options.

Windows Specific

To start an Application Service on the Windows platform please refer to the Windows specific documentation.

Automated startup of Application Services on the Windows platform can be achieved by using the Windows supplied scheduler.

Java Specific Implementation

To start an Application Service on a Java platform please refer to the Java specific documentation.

iSeries Specific Implementation

To start one or more Application Service on the iSeries platform please refer to the iSeries specific documentation.

Deploy Relay Service on the Web Server

The Relay Service comes in two variants: A Windows CGI implementation and a Java servlet implementation.

Due to the differences between these two interfaces (launching, life time, and termination) the installation and deployment very much depend on the chosen Relay Service but also on the web server used. Common for the two implementations is that the following parameters must be specified:

Parameter Description
Websydian Server IP Address The IP address of the machine where the Websydian Server is running.
Websydian Server TCP port The TCP port used by the Websydian Server for incoming connections.
Application Service Name The name of the Application Services to use.
Websydian Server URL Short-hand notation for the previous three arguments. The syntax is:

wsydwa://<Websydian Server IP>:<Websydian Server TCP>/<Service Name>

Example:

wsydwa://localhost:8189/myApp
Wait period When a Token is not found the Relay Service will wait a while before retrying to fetch a Token. The Relay Service will try three times before returning with an error.

The wait period is specified in milliseconds with this parameter.
Size of buffer Specifies the size in bytes used by the Application Service when sending DATA packets.

Windows Relay Service

The Windows CGI Relay Service is configured by deploying the file CgiRelayS.exe as a CGI program on the web server. This is done exactly the same way as the Websydian Dispatcher executable function is deployed on a web server when using CWA. Please refer to Websydian Installation and Operation for more details.

The Relay Service is configured using the INI file CgiRelayS.ini. Below is shown a sample configuration:
 

[CONNECTION]
WEBSYDIANSERVERURL = wsydwa://localhost:8189/myApp
WAITPERIOD = 1000
DATABUFFERSIZE = 4096

Please find the names of all the parameters in the table below and the description in the table above.

Parameter name Parameter description
WEBSYDIANSERVERIPADDRESS Websydian Server IP Address.
WEBSYDIANSERVERTCPPORT Websydian Server TCP port.
SERVICENAME Application Service Name.
WEBSYDIANSERVERURL Websydian Server URL.
WAITPERIOD Wait period. Used if no Application Service was available at the Websydian Server.
DATABUFFERSIZE Size of buffer. This will be used by the Application Service to buffer up the response before sending it to the Relay Service.

Servlet Relay Service

The Servlet Relay Service is implemented as a Java servlet that must be deployed within a servlet engine.

Go to the Distributed Websydian Architecture deployment guides for information on how to deploy the Servlet Relay Service servlet on various platforms.

In general, the following steps should be followed to deploy the Servlet Relay Service:
 

  1. Copy the Websydian Java class file (WsydDwa21.jar) and the third party run-time libraries to the web server, and specify them in the web server classpath.
  2. Deploy the Servlet on the web server using the following information:
    Parameter Description
    Servlet Name The name of the servlet. Any name valid in the Java World can be chosen here.
    Servlet Class com.websydian.pka.servlet.RelayService
  3. Create an alias for the servlet. The alias will be used by the end users to activate the Servlet. The alias should point to the name of the servlet (Servlet Name) specified above.
  4. Create a servlet parameter named 'servlet.propertyfile'. The value of the parameter should be the full path to the Relay Service property file. For information on the contents of this file please look at Relay Service Options.

    Alternatively the property file can be deployed with the servlet (in a WAR file). To do this leave the servlet.propertyfile parameter blank and create the property file in the WAR file structure at "WEB-INF/RelayService.prop".

Most servlet engines comes with a deployment tool to setup the servlet. Please refer to the manual of the selected servlet engine for further information.