Back to Contents | GAS Configuration File Overview

Application Execution Component - Configuration Reference

An Execution component prepares the runtime environment for an application or Web service, defining execution rules and setting the execution environment. An Execution component is referenced in an application by its unique identifier, set by the Id attribute.

Web Application Execution Component
Service Application Execution Component

WEB_APPLICATION_EXECUTION_COMPONENT

The WEB_APPLICATION_EXECUTION_COMPONENT creates a Web application execution component, which defines a set of execution parameters that are used when starting the Web application. It takes an attribute Id, which specifies the unique identifier for this set of execution definitions. It is this unique identifier that is referenced by an application, providing that application with a base set of execution parameters. The attribute AllowUrlParameters defines whether the parameters provided on the command line should be ignored ("FALSE", default value) or provided to the DVM ("TRUE").

Syntax:

<WEB_APPLICATION_EXECUTION_COMPONENT Id="compId" [ AllowUrlParameters="allowParam" ] >
  [ <ENVIRONMENT_VARIABLE Id="envId" > env </ENVIRONMENT_VARIABLE> [...] ] 
  [ <PATH> path </PATH> ] 
  [ <DVM> dvm </DVM> ] 
  [ <MODULE> module </MODULE> ]
  [ <AUTHENTICATION> authtype </AUTHENTICATION> ] 
  [ <PARAMETERS> parameterSettings </PARAMETERS> ] 
</WEB_APPLICATION_EXECUTION_COMPONENT>

Notes:

The WEB_APPLICATION_EXECUTION_COMPONENT element may contain the following child elements (described below):

Zero or more ENVIRONMENT_VARIABLE elements (optional).
Zero or one PATH element (optional).
Zero or one DVM element (optional).
Zero or one MODULE element (optional).
Zero or one AUTHENTICATION element (optional).
Zero or one PARAMETERS element (optional).

Example:

<WEB_APPLICATION_EXECUTION_COMPONENT Id="cpn.wa.execution.local">
  <ENVIRONMENT_VARIABLE Id="FGLDIR">$(res.fgldir)</ENVIRONMENT_VARIABLE>
  <ENVIRONMENT_VARIABLE Id="PATH">$(res.path)</ENVIRONMENT_VARIABLE>
  <ENVIRONMENT_VARIABLE Id="INFORMIXDIR">$(res.informixdir)</ENVIRONMENT_VARIABLE>
  <ENVIRONMENT_VARIABLE Id="INFORMIXSERVER">$(res.informixserver)</ENVIRONMENT_VARIABLE>
  ... 
  <DVM>$(res.dvm.wa)</DVM>
</WEB_APPLICATION_EXECUTION_COMPONENT>

Back to the top

SERVICE_APPLICATION_EXECUTION_COMPONENT

The SERVICE_APPLICATION_EXECUTION_COMPONENT creates a Web service execution component, which defines a set of execution parameters that are used when starting the Web service. It takes an attribute Id, which specifies the unique identifier for this set of execution definitions. It is this unique identifier that is referenced by a Web service, providing that Web service with a base set of execution parameters.

Syntax:

<SERVICE_APPLICATION_EXECUTION_COMPONENT Id="compId">
  <ENVIRONMENT_VARIABLE Id="envId" > env </ENVIRONMENT_VARIABLE> [...]
  [ <PATH> path </PATH> ] 
  [ <DVM> dvm </DVM> ] 
  [ <MODULE> module </MODULE> ] 
  [ <AUTHENTICATION> authtype </AUTHENTICATION> ] 
  [ <PARAMETERS> parameterSettings </PARAMETERS> ] 
  [ <POOL> poolSettings </POOL> ]   
</SERVICE_APPLICATION_EXECUTION_COMPONENT>

Notes:

The SERVICE_APPLICATION_EXECUTION_COMPONENT element may contain the following child elements (described below):

Zero or more ENVIRONMENT_VARIABLE elements (optional).
Zero or one PATH element (optional).
Zero or one DVM element (optional).
Zero or one MODULE element (optional).
Zero or one AUTHENTICATION element (optional).
Zero or one PARAMETERS element (optional).
Zero or one POOL element (optional).

Example:

<SERVICE_APPLICATION_EXECUTION_COMPONENT Id="cpn.wa.execution.local">
  <ENVIRONMENT_VARIABLE Id="FGLDIR">$(res.fgldir)</ENVIRONMENT_VARIABLE>
  <ENVIRONMENT_VARIABLE Id="PATH">$(res.path)</ENVIRONMENT_VARIABLE>
  <ENVIRONMENT_VARIABLE Id="INFORMIXDIR">$(res.informixdir)</ENVIRONMENT_VARIABLE>
  <ENVIRONMENT_VARIABLE Id="INFORMIXSERVER">$(res.informixserver)</ENVIRONMENT_VARIABLE>
  ... 
  <DVM>$(res.dvm.wa)</DVM>
</SERVICE_APPLICATION_EXECUTION_COMPONENT>

Back to the top

ENVIRONMENT_VARIABLE

The ENVIRONMENT_VARIABLE element provides the value to be set for an environment variable. It takes an attribute Id, which specifies the name of the environment variable. Prior to starting the application, the environment variable is set using this information.

Usage Example:

  <ENVIRONMENT_VARIABLE Id="FGLGUI">1</ENVIRONMENT_VARIABLE>

In this example, the environment variable FGLGUI is set to 1.

The CGI transmits the environment variables it receives from the web server to the GAS. Each environment variable is prefixed by FGL_WEBSERVER_ for the DVM environment

Back to the top

PATH

The PATH element specifies the current working directory for the application module.

Usage Example:

  <PATH>/home/appdir/sales/</ENVIRONMENT_VARIABLE>

Back to the top

DVM

The DVM element specifies the name of the Dynamic Virtual Machine you want to use to start and run the application. Typically this value is fglrun for Unix Systems (UNX) and fglrun.exe for Windows NT/2000/XP (WNT).

Usage Example:

  <DVM>$(res.dvm.wa)</DVM>

Back to the top

MODULE

The MODULE element specifies the application module name (the name of the .42r module you want to run). If omitted, the Genero Application Server uses the name of the requested application.

While this element can be specified as part of an execution component, it is typically defined at the application level.

Usage Example:

  <MODULE>Edit</MODULE>

Back to the top

AUTHENTICATION

The AUTHENTICATION element specifies the type of authentication to be used for the application. At this time, only Kerberos is supported.

While this element can be specified as part of an execution component, it is typically defined at the application level.

Usage Example:

  <AUTHENTICATION>KERBEROS</AUTHENTICATION>

Back to the top

PARAMETERS

The PARAMETERS element specifies the parameters to provide on the DVM command line. To enable URL parameters, in the EXECUTION tag, set the AllowUrlParameters attribute of the to TRUE.

Syntax:


  <PARAMETERS> 
    [ <PARAMETER> parameterValue </PARAMETER> [...] ]
  </PARAMETERS>

Usage Examples:

The following example provides two parameters:

Hello world!
Again

<PARAMETERS> <PARAMETER>Hello world!</PARAMETER> <PARAMETER>Again</PARAMETER> </PARAMETERS>

If URL parameters are allowed, these parameters are listed after the ones defined in the configuration file.

Back to the top

POOL

The POOL element sets the limitations regarding the number of Virtual Machines that are attached to a Web Service. You specify three values within a POOL element: the number of Virtual Machines to start when the Genero Application Server starts, the minimum number of Virtual Machines to have alive while the Genero Application Server is running, and the maximum number of Virtual Machines to have alive while the Genero Application Server is running.

Note: The POOL element is only available for Web Services.

Syntax:

<POOL> [ <START> startValue </START> ] [ <MIN_AVAILABLE> minValue </MIN_AVAILABLE> ] [ <MAX_AVAILABLE> maxValue </MAX_AVAILABLE> ] </POOL>

Notes:

The POOL element may contain the following child elements (described below):

Zero or one START elements (optional).
Zero or one MIN_AVAILABLE element (optional).
Zero or one MAX_AVAILABLE element (optional).

Example:

<POOL>
  <START>5</START>
  <MIN_AVAILABLE>3</MIN_AVAILABLE>
  <MAX_AVAILABLE>10</MAX_AVAILABLE>
</POOL>

In this example, 5 Virtual Machines are started to service the Web service when the Genero Application Server starts; the number can fall as low as 3 Virtual Machines or raise as high as 10 Virtual Machines. For more information on setting service pool elements, refer to the Service Pool section of the Deployment Architecture for Web Services topic.

Back to the top

START

The START element specifies the number of Virtual Machines to start for this Web Service when the Genero Application Server starts.

Constraint:

START <= MAX_AVAILABLE

Back to the top

MIN_AVAILABLE

The MIN_AVAILABLE element specifies the minimum number of available Virtual Machine to be attached to a Web Service. It can be either less than or greater than the value specified by START. If START > MIN_AVAILABLE, based on the setting of DVM_FREE, the number of DVMs can decrease to reach MIN_AVAILABLE.

Constraint:

0 <= MIN_AVAILABLE <= MAX_AVAILABLE

Back to the top

MAX_AVAILABLE

The MAX_AVAILABLE element specifies the maximum number of available Virtual Machines to be attached to a Web Service.

Constraints:

START <= MAX_AVAILABLE MIN_AVAILABLE <= MAX_AVAILABLE

Back to the top