Application URIs

To access a Web application, you enter the appropriate application URI in your browser's address bar.

URI Syntax

This topic describes the URIs acknowledged by the GAS based on the standard syntax shown below and explained in Table 1. This topic provides you with URIs to access your Genero applications. The information is intended to help you tune and monitor your Web server configuration for Genero.

http[s]://
  {
    web-server[:web-server-port]
      [
        /directory [...]
      ]
    |
    app-server[:app-server-port]
  }
  /scope
  /action
  /group
  /
    {
      web-application-id
    }
  [
    ?
    parameter=parameter-value
      [
        &
        parameter=parameter-value
      ]
      [...]
  ]
Table 1. Explanation of URI syntax options
Option Description Valid Values
web-server Name or IP address of the Web Server e.g. localhost
web-server-port Port on which the Web Server listens e.g. 1100
directory A directory or virtual directory on the Web Server defined by the $(connector.uri) resource in as.xcf Typically this directory is called "gas".
Note: If you are using a direct connection to the GAS like the standalone dispatcher, httpdispatch, the resource connector.uri is not used, instead the URI syntax will look like this, http://localhost:port/ua/r/app-name
app-server Name or IP address of the Application Server e.g. localhost
app-server-port Port on which the Application Server listens e.g. 6394
scope Scope or protocol you are working on, e.g. uaproxy or Web service ua, ws
action Action requested of the Application Server See Application URIs acknowledge by the GAS
group Application group defined in as.xcf see GROUP (for an application)
web-application-id Web application identifier or name e.g. gwc-demo
parameter Parameter to communicate to the Application Server to start application with arguments See Starting applications with arguments
parameter-value Parameter value See Set gwc-js customization with query string parameter
Table 2. Application URIs Acknowledged by the GAS
URI path Description
/ua/r
Genero Web Client for JavaScript (GWC-JS) application is started with a /ua/r request. See Running a Web application.
/ua/sua
Once the startup request has been answered, the DVM uses /ua/sua requests to submit user actions and communicate with the front-end.
/ua/ft
GWC-JS file transfer
/ua/interrupt
Front-end client uses the interrupt request to send an interrupt message to the DVM.
/ua/i
Resource, e.g. a fully-qualified URL pointing to an application's image file, see Table 1
/ua/components
Web component resource, e.g. a fully-qualified URL pointing to an application's web component file, see Table 1
/ua/close
Front-end sends a close request to the DVM to stop an application.
/ua/newtask
Front-end sends a newtask request to ask the GAS if it has any pending applications that have not been already notified to the client.
/ua/report/viewer 
URL with the report/viewer prefix is used by the Genero Report Engine (GRE) running in local mode to load the HTML report viewer implementation. It is bound to the $(GREDIR)/viewer directory by default, see REPORT_VIEWER_DIRECTORY.
/ua/report/public 
URL with the report/public prefix is used by the GRE to access public resources or documents shared between applications on the local server, for example, report fonts.
/ua/report/private/$(session.id)/reports
URL with the report/private prefix is used by the GRE to access private resources or documents locally. These resources are not shared between applications or users and are deleted when the session ends.
/ua/report-r/viewer 
URL with the report-r/viewer prefix is used by the GAS running a GRE in distributed mode to load the HTML report viewer implementation. Adding a REPORT_REMOTE_URL_PREFIX configuration entry in the GAS as.xcf configuration file enables distributed mode support. See Configure GRE in distributed mode
/ua/report-r/public 
URL with the report-r/public prefix is used for by GAS to access public resources or documents on remote server shared between applications, for example, report fonts.
/ua/report-r/private/$(session.id)/reports
URL with the report-r/private prefix is used by the GAS to access private resources or documents on a remote server. These resources are not shared between applications or users and are deleted when the session ends.
/private/${sessionid}
The GAS will send an HTTP request to the remote host to notify it that the GRE session has ended. The remote server is responsible for removing recursively private data identified by the session identifier. For example,
DELETE /private/ebf19aba4d09e80cd19cfea7868a9a2a
/ua/w
URL dedicated to the look up of the GWC-JS directory. The complete format of the URI is ua/w/$(GWC-JS)/<filename>, where files served directly by the dispatcher for the customized GWC-JS are found. The GAS searches for the GWC-JS directory in one of the paths specified as document root in GWC_JS_LOOKUP_PATH.
/ws/r
GWS request to start Web service application. See Running a WSDL Web service application.
/da/r
Request to start application using the GDC from URI. See Running a desktop application.
/monitor
Monitor requests
/monitor/log
Monitor logs requests
/monitor/configuration/application/
group
Returns a list of all groups configured for applications. See Get the groups for all applications.
/monitor/configuration/application/
name?abstract
Returns a list of all application names (or only the abstract applications if ?abstract is specified).
/monitor/configuration/application/
dua?appId
Returns a list of all DUAs allowed for the application identified by appId
/monitor/configuration/service/group
Returns a list of all groups configured for services.
/monitor/configuration/service/
name?abstract
Returns a list of all service names (or only the abstract services if ?abstract is specified).
/monitor/configuration/service/invalid
Returns a list of static and dynamic services that have been invalidated by the dispatcher because first request did not succeed in starting a DVM. See Get list of services invalidated by dispatcher.
Note: A URI path is a string without line breaks. Line breaks have been added to the URIs above to support the printed version of our documentation.