Eloquence JDLG

Documentation / Eloquence JDLG / Starting JDLG

Starting JDLG

 Document revision: 2017-08-29 Refers to JDLG version: 1.7.6 Contents Using the Java command JDLG may be started using a Java command line like below: java -jar jdlgS.jar  Notes: If the jdlgS.jar file is not located in the current directory, the full path must be specified. For example: java -jar /path/to/jdlgS.jar  The -D command line option may be used to specify JDLG configuration properties. For example, to specify a JDLG configuration file, a command line like below could be used: java -Deloquence.config.file=/path/to/jdlg.cfg -jar jdlgS.jar  Note: Any -D command line option must be specified before the -jar option on the command line. By default, Java limits the allocated memory, i.e., the heap size, to 64 MB for the 32-bit virtual machine and 84 MB for the 64-bit virtual machine. This may be insufficient for complex applications. The -Xmx command line option may be used to increase the Java heap size limit. For example, the command line below specifies a maximum heap size of 128 MB: java -Xmx128M -jar jdlgS.jar  Notes: The -Xmx command line option must be specified before the -jar option on the command line. If the 64-bit virtual machine is used, JDLG is expected to use at least 30% more memory than if the 32-bit virtual machine is used. On the Windows platform, the java command opens a console window where any Java or JDLG error messages would be output. To avoid that a console window is opened, the javaw command may be used instead, for example: javaw -jar C:\path\to\jdlgS.jar  Note: When using the javaw command, it is recommended to configure an error log file, otherwise any Java or JDLG error messages would not be reported. JDLG version 1.7.0 or newer requires Java version 1.5 or newer. It is recommended to use the most recent available Java version. Note: JDLG versions before 1.7.0 require Java version 1.4.2 or newer. Using Java Webstart (JNLP) The Java Webstart feature may be used to easily deploy JDLG from a central system on the network, eliminating complex installation or update procedures. To use JDLG with Java Webstart, a JNLP file like below should be configured:  Eloquence JDLG Marxmeier Software AG Eloquence JDLG JDLG  In the example above, the underlined items may require further explanation: The codebase attribute of the tag specifies the JNLP codebase directory, for example located on a web server in the network (here: http://intranet/jdlg), where the JDLG files are stored. These files are: jdlg.jnlp : This is the JNLP file shown above. eq-logo.gif : Specifies a logo image which is used by Java Webstart as the JDLG logo. This file may be downloaded from the Eloquence web site at: http://eloquence.marxmeier.com/images/eq-logo.gif jdlgS.jar : This is the JDLG jar file, available for download at: http://eloquence.marxmeier.com/download/jdlg/1.7/ jdlg.cfg : The example above demonstrates how a JDLG configuration property may be specified. Here, the jnlp.eloquence.config.url property is configured so that the jdlg.cfg file is loaded from the conf subdirectory relative to the JNLP codebase directory. Multiple JDLG configuration properties may be specified by configuring multiple tags in the section. The tag in the section above requests a Java version 1.5 or newer. Java 1.5 is the minimum version required to run JDLG 1.7.0 or newer. The "1.5+" version specification uses the newest available Java version on the system. Note: JDLG versions before 1.7.0 require Java version 1.4.2 or newer, therefore version="1.4.2+" could be configured. In the example above, the URL of the JNLP file is: http://intranet/jdlg/jdlg.jnlp Loading this URL in a browser will pass the JNLP file to Java Webstart. In turn, Java Webstart then checks if JDLG is already installed on the system. If not, or if the installed JDLG version is older than the jdlgS.jar file on the web server, the jdlgS.jar file is loaded from the web server and installed on the system. After that, JDLG is started, using the configuration specified in the JNLP file. As an alternative, the javaws command may be used with an URL or a local JNLP file. For example: javaws http://intranet/jdlg/jdlg.jnlp javaws /path/to/jdlg.jnlp  Notes: By default, Java limits the allocated memory, i.e., the heap size, to 64 MB for the 32-bit virtual machine and 84 MB for the 64-bit virtual machine. This may be insufficient for complex applications. The max-heap-size attribute of the tag may be used to increase the Java heap size limit. For example, the tag below specifies a maximum heap size of 128 MB:   Note: If the 64-bit virtual machine is used, JDLG is expected to use at least 30% more memory than if the 32-bit virtual machine is used. The web server must be configured to associate the "jnlp" file extension with the "application/x-java-jnlp-file" mime type, otherwise Java Webstart will not recognize a JNLP file loaded from the web server. Notes (JDLG version 1.6.3 or newer): Starting with Oracle(TM) Java version 7u45, Java Webstart requires that JDLG properties are prefixed with "jnlp.", otherwise they are ignored. If no configuration file or URL is specified in a JNLP file, JDLG loads the default jdlg.cfg file if present in the JNLP codebase directory. Relative URLs in JDLG configuration properties are resolved relative to the JNLP codebase directory. This simplifies JDLG configuration and allows to move JNLP files along with the related resources from one directory to another without requiring to edit the configured URLs besides the JNLP code base. A relative URL may be specified for each of the configuration properties below: eloquence.config.url (or: jnlp.eloquence.config.url) eloquence.config.sessions (or: jnlp.eloquence.config.sessions) eloquence.config.logoicon (or: jnlp.eloquence.config.logoicon) eloquence.config.baseurl (or: jnlp.eloquence.config.baseurl) eloquence.config.helpbaseurl (or: jnlp.eloquence.config.helpbaseurl) icon attribute in an application configuration file When specified, a relative URL is considered relative to the JNLP codebase directory. For example, if the JNLP header specifies ...   ... and the jnlp.eloquence.config.url property is defined as ...   ... the configuration is read from the resulting URL: http://intranet/jdlg/conf/jdlg.cfg Note (JDLG versions before 1.7.0): URLs in JDLG configuration properties must be absolute. In the example above, the following must be configured: