GRE environment variables

These environment variables are relevant for the Genero Report Engine (GRE).

GREDIR

The GREDIR environment variable specifies the installation directory of the Genero Report Engine (GRE).

GREOUTPUTDIR

The GREOUTPUTDIR environment variable specifies the directory where all writing operations that would otherwise be performed in the current working directory of the Genero Report Engine (GRE) will be performed.

The value can be an absolute or a relative file path. If the value is a relative file path, then it is internally prepended with the current working directory of GRE. When set, all writing operations that would otherwise be performed in the current working directory of GRE will be performed in the specified directory.

Examples include relative path specification in the functions fgl_report_setOutputFileName(), fgl_report_configureImageDevice() (the filePath parameter), fgl_report_setBrowserDocumentDirectory(), fgl_report_setBrowserFontDirectory() and the location of the GRE debug files (jdebug0.xml, jdebug1.xml, and so on.)

GRE_MAX_CONCURRENT_JOBS

The GRE_MAX_CONCURRENT_JOBS environment variable limits the number of worker threads in distributed mode.

By default, the Genero Report Engine runs 25 concurrent threads. As such, by default it can process no more than 25 concurrent jobs. Jobs that a started at a point in time when the maximum value has been reached are queued until another job completes. The limit on concurrent threads is to prevent memory exhaustion in times of critical load.

GRE_MAX_CONCURRENT_JOBS allows the modification of the number of concurrent threads. This variable takes an integer.

GREDEBUG

The GREDEBUG environment variable defines the debug level for the Genero Report Engine.

Valid values include:
  • 0: nothing
  • 1: fatal only
  • 2: fatal and error
  • 3: fatal, error, and warning
  • 4: fatal, error, warning, and info
  • 5: fatal, error, warning, info, and debug
  • 6: fatal, error, warning, info, debug, and trace
  • 6+: all debug information

With GREDEBUG enabled, additional details are written to the Output panel. This can be very useful for debugging a report design document; see Debugging your Report Design Document for more information.

In addition, debugging files are created. These debug files are the intermediary files that are created as the report is processed through various filters on its path from the DVM to the final report output. The number and names of these debug files will vary, depending on the amount of processing that is required. In general, you can look for files with names like fdebug0.xml (the initial intermediate file output by the DVM filter) or jdebug0.xml (an intermediate file created and used by a Java filter). When multiple intermediate files are created, they are numbered sequentially. Additional files will be created if needed, however the names of those files are not guaranteed. At a minimum, the names will all include the terms debug and will be .xml files.

Tip: These files are created and can be provided to support to assist with a support case, they can be used by advanced users to identify code to include in objects such as the RichTextBox, or they can be used to simply understand what is happening between the time the data is output from the DVM to the creation of the report. There is no expectation, however, that you are expected to do much with these debug files.

These files are written to the directory specified by the GREOUTPUTDIR environment variable. If GREOUTPUTDIR is not set, they are written to the current working directory of the Genero Report Engine (GRE). See GREOUTPUTDIR for more information.

GRE_DEFAULT_IMAGE_URL

The GRE_DEFAULT_IMAGE_URL environment variable defines the URL of the fallback image for an Image Box in a report design document.

The fallback image is the image to display if the requested image for an Image Box is not found.

The URL can be an absolute or relative URL. If it is a relative URL, the URL is resolved relative to the location of the form design (4rp) document.

This environment variable is specific to Genero Report Writer.