Configuring GBC client for applications

There are different methods for specifying the GBC client your applications use depending on whether you want to use the same client for all applications, or a given client for a specific application.

Set a default GBC client for all applications to use

The GAS uses the combination of the GBC and GBC_LOOKUP_PATH elements to identify the default GBC client:
  • The GBC element contains the name of the GBC client used as the default. At installation, the GBC is set to a file named _default to use the GBC delivered with the FGLGWS package. You can change the GBC to the name of any customization directory or file.
    Tip:

    Typically, there is no need to change the filename, _default; however, you can change it by setting the resource $(res.gbc) in the GAS configuration file (as.xcf).

    If the GBC element contains the name of a file, the file has a very specific format (one line only with the name of the customization to use) and it must be located in the same directory with the customization directory.

  • The GBC_LOOKUP_PATH environment variable defines paths to find the customization directory or file as defined by GBC.
To change the name of the GBC client in the _default file, you do not need to edit the file directly.

To reset the default GBC client to the GBC delivered with the FGLGWS package, see Reset GBC client to initial installed version

GAS configuration for GBC client

Table 1 summarizes how to configure for the GBC client in the Genero Application Server (GAS) and specify a default.
Table 1. GAS configuration
Configuration File Description Usage
GBC_LOOKUP_PATH GAS configuration file (as.xcf) Add the path for your GBC directory, for example, <GBC_LOOKUP_PATH>c:/project_dir/dist/customization;…;$(res.fgldir)/web_utilities/gbc</GBC_LOOKUP_PATH> Required. If the client specified in GBC is not found in the path, the default client in the $(res.fgldir)/web_utilities/gbc is used.
Your default GBC client A file called _default Create a text file with the name "_default" in a root directory where you have GBC clients, for example, c:/project_dir/dist/customization/_default. The file contains the name or alias of a directory where the GBC client you want to set as default is found. Optional. _default is at a path found in the GBC_LOOKUP_PATH. Or if using the dispatcher override, _default is specified in the user path. Can be applied for a single application, or for all applications.
Tip: A GAS restart is not required when you update the _default file.
See Set a default GBC client for all applications to use

Specify GBC client to use for an application

Table 2 shows how to specify the GBC client via the GBC element in your application configuration file or in the query string of the application URL. Table 3 shows how to specify the GBC client using the dispatcher override option.
Table 2. Apply specific GBC client to use for an application
Applied to: Element/Option Description Usage
Your application configuration file (.xcf) GBC Specify the client to use in the GBC element, for example <GBC><my-gbc></GBC>, where my-gbc references either a directory name or _default file found in GBC_LOOKUP_PATH. See Specify GBC in the application configuration file.
Application URL URL ?gbc query string parameter Specify the GBC client in the application URL, for example, http://myApplicationServer:6394/gas/ua/r/gwc-demo?gbc=<my-gbc> See Specify GBC in the application URL.
Table 3 shows how to apply the GBC to use for all applications and override GAS defaults.
Table 3. Apply GBC client with dispatcher override
Applied to: Element/Option Description Usage
Dispatcher override -E res.path.gbc.user For example, start the standalone dispatcher with override, httpdispatch -E res.path.gbc.user=C:\my_gbc\1.00.40\dist\customization See Specifying default GBC client for applications.

Specify GBC in the application URL

This method specifies the GBC client to use in the application URL.

Once you have deployed the GBC (using the gasadmin gbc command or the deploymentApp), you can use the URL query string (?gbc=<my-gbc>) to specify which GBC client to use for the application when you run it:
http://myApplicationServer:6394/ua/r/gwc-demo?gbc=<my-gbc>

Specify GBC in the application configuration file

This method uses the GBC_LOOKUP_PATH and GBC configuration parameters.

In the GAS configuration file, set GBC_LOOKUP_PATH to include the path to the folder that contains your customization directories.
Tip: The dispatcher searches the paths specified in order; therefore, it is recommended to place the path to your GBC directory first in the path list.

In the application configuration file, set GBC to your GBC directory name.