URI Examples

Several URI examples with ways to help you launch applications.

In this page examples are grouped under the headings: connections, launching applications, launching applications with arguments, and launching Web services.

Connections
- Direct connection to standalone GAS
- Connection through Web server
Launching applications
- Running Web applications
- Running desktop applications
Launching applications with arguments
- Applications with arguments set in the URL
- Set GBC customization in URL parameter
Web services
- Running Web service applications

URI Syntax

A Web application URI entered in your browser's address bar takes the form of the following syntax:

http://app-server:port/scope/action/app-name

Where:

app-server is the name or IP address of the Application Server
port is the port number on which the Application Server listens
scope is the client protocol, for example, ua (uaproxy) for applications, or ws (gwsproxy) for Web services
action is the action requested of the Application Server. For example, r is used for a start-up request. This changes depending on the action requested of the server as the application runs.

Connections

Direct connection to standalone GAS

This example launches the "myApp" Web application on the "localhost" Application Server, listening to port 6394:
```
http://localhost:6394/ua/r/myApp
```
If the startup URL lists additional path members, they are allowed but ignored:
```
http://localhost:6394/ua/r/myApp/foo/bar
```
In this example, the "myApp" Web application is launched, and /foo/bar is ignored.
When the proxy is started, the FGL_VMPROXY_START_URL environment variable is set to the URL used to start the application. In our example, this includes the additional path members /foo/bar, making the full path available for use by the application.
If the application is in the default group (_default), you can use the same URL or you can include the group name:
```
http://localhost:6394/ua/r/_default/myApp
```
The use of the _default group name is optional.

Connection through Web server

This example launches the "myApp" application through the "myWebServer" Web Server.

http://myWebServer/gas/ua/r/myApp

The gas is a directory or virtual directory on the Web Server defined by the $(connector.uri) resource in the GAS configuration file (as.xcf). Typically this directory is called "gas".

Launching applications

Running Web applications

This URL example launches the "myApp" application:

http://appserver:6394/ua/r/myApp

Running desktop applications

Using the URL with da protocol launches an application via the Genero Desktop Client (GDC) monitor.

http://appserver:6394/da/r/appid

Note: Prerequisites:

GDC is installed
Application extension associations for gdc are set

Application with arguments set in URL

If the AllowUrlParameters attribute in the EXECUTION (for an application) is set to TRUE, parameters can be passed as arguments in the application URL using the format "Arg=value".

For example, the "myApp" application is launched with two arguments by the "myWebServer" Web server:

http://myWebServer/gas/ua/r/myApp?Arg=Val1&Arg=Val2

A question mark (?) follows the application name.
In the key/value pair format, Arg is the key and Val1 is the value of the argument.
Each key/value pair is separated by an ampersand (&).

If the DVM already has parameters set by the command line, the parameters in the URL are added to the end of the command line.

Set GBC customization in URL parameter

To specify the customization to use for the GBC user interface, add the gbc query string parameter to the application URL.

http://myApplicationServer:6394/ua/r/gwc-demo?gbc=<my-custom-gbc>

You can see:

A question mark (?) follows the application name.
gbc is the required query string parameter.
Note: In the Genero web client prior to version 3.00, the parameter gwc-js was used. From version 3.10, it is renamed gbc. Use of gwc-js is deprecated but remains for compatibility.
The <my-custom-gbc> value is either the name of a text file referencing the customization directory name, or the actual name of the customization directory in paths defined by the GBC_LOOKUP_PATH element.

Important: The gbc value provided in the query string takes precedence over the configuration for the GBC element in the application configuration file (xcf).

Web services

Web services URI Syntax

A Web services URI entered in your browser's address bar takes the form of the following syntax::

http://app-server:port/scope/action/app-name

Where:

app-server is the name or IP address of the Application Server
port is the port number on which the Application Server listens
scope is the client protocol ws (gwsproxy) for Web services
action is the action requested of the Application Server. For example, r is used for a start-up request. This changes depending on the action requested of the server as the application runs.

Running Web service applications

To get the WSDL for a specified service:
```
http://appserver:6394/ws/r/appid/service?WSDL
```

To access the Web service:

http://appserver:6394/ws/r/appid/service

If the Web service uses a group:

http://appserver:6394/ws/r/groupid/appid/service

Access through a Web server:
```
http://webserver/gas/ws/r/appid/service
```