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.

Web application URI syntax

A web application URI entered in your browser's address bar takes the form of the following syntax:
http[s]://host:port/scope/action/app-name
Where:
  1. host is the name or IP address of the Application Server.
  2. port is the port number on which the Application Server listens.
  3. scope is the client protocol, for example, ua (uaproxy) for applications.
  4. 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.
  5. app-name is the name of the application.

Web application URI syntax with query string

If the AllowUrlParameters attribute in the EXECUTION element is set to TRUE, parameters can be passed as arguments in the application URL. A web application URI with arguments takes the form of the following syntax:
http[s]://host:port/scope/action/app-name?arg-name=arg-value[&...]
Where:
  1. host is the name or IP address of the Application Server.
  2. port is the port number on which the Application Server listens.
  3. scope is the client protocol, for example, ua (uaproxy) for applications.
  4. 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.
  5. app-name is the name of the application.
  6. arg-name=arg-value is a query string in the key/value pair format. There can be one or more query strings in the URL. A question mark (?) follows the application name before the first query string. Each key/value pair thereafter is separated by an ampersand (&).

For an example using arguments in the app URL, see Running applications with GBC customization set in URL query string.

Connections

Running applications with 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.

Running applications through web server

This example launches the "myApp" application through the "webserver" web Server.
http://webserver/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 from URL with da protocol

Using a URL with da protocol launches an application via the Genero Desktop Client (GDC) monitor:
http://appserver:6394/da/r/appid
A .gdc shortcut is downloaded to your downloads directory. Doubleclick on the gdc shortcut to run the application. Alternatively, if your browser supports it, you can configure file association in the browser to open the .gdc shortcut with the GDC monitor and run the application directly. For more information on setting file association, see the browser's documentation.
Note:
Prerequisites:
  1. Genero Desktop Client is installed.
  2. Application extension associations for gdc are set for your machine.

Running applications with arguments set in the URL

In this example, the "myApp" application is launched by the "webserver" web server after passing in the two parameters (arguments) specified:
http://webserver/gas/ua/r/myApp?arg=val1&arg=val2

If the DVM already has parameters set in the application configuration file, the parameters in the URL are added to the end of parameter list.

For examples using arguments in the app URL, see Running applications with GBC customization set in URL query string .

Running applications with GBC customization set in URL query string

To specify the GBC customization to use, add a query string component – represented by a key-value pair – to the application URL using the gbc query string key.
http://appserver:6394/ua/r/demo?gbc=my-custom-gbc
You can see:
  • A question mark (?) follows the application name.
  • gbc is the required query string key.
    Note:

    In the Genero web client prior to version 3.00, the query string key gwc-js was used. Starting with version 3.10, it is renamed gbc. Use of gwc-js is deprecated but remains for compatibility.

  • my-custom-gbc is the query string value. This 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 value for the gbc key provided in the query string takes precedence over the value specified by the GBC element in the application configuration file (xcf).

Running web applications in debug mode using the URL query string

To enable debug mode for a web application running in the GBC, add the debugmode=1 query string parameter to the application URL. For example: http://localhost:6394/ua/r/HelloWorld?debugmode=1
Tip:

Add the query string parameter debugmode=0 to the URL to execute the application without debug mode. This can be useful when the GAS runs in development mode (with the --development flag), but you do not want the app running in debug mode.

Web services

SOAP web services URI Syntax

A SOAP web services URI entered in your browser's address bar takes the form of the following syntax:
http[s]://host:port/scope/action/[/group-name]/service-name
Where:
  1. host is the name or IP address of the Application Server.
  2. port is the port number on which the Application Server listens.
  3. scope is the client protocol ws (gwsproxy) for web services
  4. 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.
  5. group-name is the name of the group. If the web service belongs to the default group on the GAS, this is optional. If the web service is part of a group that is not the default, you must provide the group name.
  6. service-name is the name of the web service.

Running SOAP Web service applications

  • To get the WSDL for a specified service:
    http://appserver:6394/ws/r/service?WSDL
  • To access the web service: 
    http://appserver:6394/ws/r/service
  • If the web service uses a group: 
    http://appserver:6394/ws/r/mygroup/service
  • Access through a web server:
    http://appserver/gas/ws/r/service

REST web services URI syntax

A REST web services URI entered in your browser's address bar takes the form of the following syntax:
http[s]://host:port/scope/action/[/group-name]/xcf-file/service-name/endpoint-path
Where:
  1. host is the name or IP address of the Application Server.
  2. port is the port number on which the Application Server listens.
  3. scope is the client protocol ws (gwsproxy) for web services
  4. 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.
  5. group-name is the name of the group. If the web service belongs to the default group on the GAS, this is optional. If the web service is part of a group that is not the default, you must provide the group name.
  6. xcf-file is the name of the web service configuration file.
  7. service-name is the name of the web service.
  8. endpoint-path contains path segments pointing to a resource.

Running REST web service applications

  • To get the OpenAPI specification file for a specified service:
    http://appserver:6394/ws/r/myxcf/myservice?openapi.json
  • To access a web service resource: 
    http://appserver:6394/ws/r/myxcf/myservice/myresource
  • If the web service uses a group: 
    http://appserver:6394/ws/r/mygroup/myxcf/myservice/myresource
  • Access through a web server:
    http://appserver/gas/ws/r/myxcf/myservice/myresource