URI Examples
Several URI examples with ways to help you launch applications.
- Connections
- Launching applications
- Launching applications with arguments
- Web services
Web application URI syntax
http[
s]
://host:port/scope/action/app-name
Where:
- host 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.
- 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.
- app-name is the name of the application.
Web application URI syntax with query string
AllowUrlParameters
attribute in the EXECUTION (for an application) 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:
- host 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.
- 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.
- app-name is the name of the application.
- 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.
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:
In this example, the "myApp" web application is launched, andhttp://localhost:6394/ua/r/myApp/foo/bar
/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
connector.uri
is added to the URL to indicate to the web server (IIS, Apache, and
so on) that the application is running on the GAS, and that the request must be forwarded to a
dispatcher (isapidispatch
or fastcgidispatch
).
http://webserver/gas/ua/r/myApp
Typically, the connector.uri
has the value
"gas". The gas is a directory or virtual directory on the
web server defined by the $(connector.uri)
resource.
Running web applications
http://appserver:6394/ua/r/myApp
Running desktop applications from URL with da protocol
da
protocol launches an application via the Genero Desktop
Client (GDC)
monitor:http://appserver:6394/da/r/appid
- Genero Desktop Client is installed.
- Application extension associations for gdc are set for your machine.
Running applications with arguments set in URL
http://webserver/gas/ua/r/myApp?arg=val1&arg=val2
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.
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
gbc
query string parameter to the application
URL.http://appserver: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 parametergwc-js
was used. From version 3.10, it is renamedgbc
. Use ofgwc-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.
gbc
value provided in the query string takes
precedence over the configuration for the GBC
element in the application configuration file (xcf).Running Web applications in debug mode using the URL query string
debugMode=1
query string parameter to the application URL. For example:
http://localhost:6394/ua/r/HelloWorld?debugMode=1
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.
SOAP Web services URI Syntax
http[
s]
://host:port/scope/action/[
/group-name]
/service-name
Where:
- host 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.
- 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.
- 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
http[
s]
://host:port/scope/action/service-name/endpoint-path
Where:
- host 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.
- service-name is the name of the Web service.
- 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/myservice?openapi.json
- To access a Web service resource:
http://appserver:6394/ws/r/myservice/myresource
- Access through a Web
server:
http://appserver/gas/ws/r/myservice/myresource