May 10th, 2021
EcoSys reports can be customized by adding images. These images can display any image file (of type .jpg, .png or .gif), including a customer’s business and/or company logo. These images can be configured in a report or report template. If in a template, the template can then be applied to multiple reports in EcoSys.
Setting Up Report Images
To use images in headers/footers, the image file must be uploaded to the application server. The image extension file can be in the format of jpg, png, or gif. To host images on the same server as EcoSys, create a “reportimages” directory inside the ESFM_HOME directory. (Note: This folder must be added to each node in a clustered environment and the image files must exist in each folder of each node.)
If an html preview of reports is desired, “http://” is required. In this case, the FMServerSettings.properties file must point the URL to the report images folder.
Set the FMServerSettings.properties as follows:
For PDF generation in command line batch mode, both “http://” and “file://” are supported. The trailing “/” must be included.
This is broken down in the example image below.
As a test, you should be able to type the URL and the file name of the image into a browser and access the file. If the file cannot be accessed with that test, an EcoSys administrator needs to make the file location available on the application server (see the Setup section above). For more information, please refer to this Hexagon/EcoSys Knowledgebase article.
Adding Images to Reports
To add the image to a report, in the report’s configuration editor, the Header/Footer tab sets various report format options or specifies a report format template to use to set formatting options. This tab also allows inclusion of specific global variables and images to display in headers and footers.
To customize the header or footer to include an image:
- Select the Customize radio button for the desired Report Header/Footer or Page Header/Footer.
- Click the pencil icon.
- Use the variable drop down to add the image variable, ‘[Image:<filename>]’
- Add the image filename to the variable. For example, if my file name is “EcoSysLogo.png” then the variable would read “[Image:EcoSysLogo.png]”.
- The URL and file names are case sensitive.
The above configured template has been added to the below report. The preview of this report now displays a product logo in the top left Report Header and a company logo in the top right Report Header.
Adding images to reports gives a visual highlight to the report, which can be an inventive, enticing, and attractive addition to EcoSys reports.
Report design is covered in depth in the TECO2100 Advanced EcoSys Reports & Charts and the TECO2200 Advanced EcoSys Configuration courses. These courses are designed for technical and business leaders to focus in depth on new report features introduced with the report builder engine. More information and the current schedule can be found on our training page.