Genero Desktop Client ActiveX API

The Genero Desktop Client ActiveX API provides the ability to configure GDC behavior via JavaScript™ calls.

Note:

Most of the parameters are likely to be variables, which will be expanded by Genero Application Server. Since these variables will be expanded as simple strings, you need to add quotes, so they will be interpreted as strings in the JavaScript. For example: "$(pictures.uri)"

Mandatory functions

Table 1. GDC ActiveX API mandatory functions
Function name	Parameters	Description
setSrvUrl ( url )	url : The url used to start the html page; usually "`location.href`", or more complex if you are using connector uri, queryString...	Indicates to GDC/AX the URL used. This is needed to correctly initialize the communication between the GDC and the Genero Application Server (GAS).
setAppName ( appName )	appName : Application name as defined in the GAS configuration file; usually "`"$(application.id)"`"	Indicates to GDC/AX that it has to start the given application. Important: Without this parameter, the application will never start; all parameters must have been initialized before calling this function.

Optional functions

Table 2. Optional API functions for GDC ActiveX configuration
Function name	Parameters	Description
setPictureUrl ( url )	url : Default remote path for pictures; usually "`"$(pictures.uri)"`"	Indicates to GDC/AX where to search for images stored on the server side. Important: This requires GDC Version 1.21.1g or greater and GAS Version 1.21.1a or greater.
setAdmin ( mode )	mode : `true` or `false`	Defines that GDC starts in Admin Mode (equivalent to -a command line option)
setDebug ( mode )	mode : `true` or `false`	Defines that GDC starts in Debug Mode (equivalent to -D command line option)
setPingTimeOut( timeout )	timeOut : a numeric value	Defines GDC ping timeout, by default 120 seconds.
setProxy ( proxyUrl )	proxyUrl : url of the proxy	Defines the http proxy used for the connection. By default, GDC/AX is using Internet Explorer settings; you can define a specific proxy with this method.
setListeningMode( listeningMode )	listeningMode : one of `ANY\|NONE\|LOCAL\|AUTO`	Allows to configure the tcp server. See `--listen` command line options for more details.

Table 3. Optional API function for returning information
Function name	Parameters	Description
applicationCount	N/A	Returns the count of running applications. Replaces the old `getApplicationCount()`