Configure software and tools for custom reporting

To generate and enable PDF reports, you must configure the software and tools used to support custom reporting. Electronic Work Instructions cannot directly display PDF documents in a report.

Configure Java and Apache FOP

Procedure

1. Verify that the JAVA_HOME system environment variable points to the location where Java is installed.

2. On the server navigate to the folder where Apache Formatting Objects Processor (FOP) is installed, set the FOP_OPTS system environment variable value to FOP_OPTS=-Djdk.xml.enableExtensionFunctions=true.

3. On the server navigate to the folder where Apache FOP is installed, browse to the fop subfolder, and then perform the following to edit the fop.bat or fop.pl file to support large amounts of data:
   
   Locate the JAVAOPTS definition in the file.
   
   Add the -Xss4M parameter to the end of the definition.
   Tip Java options are case-sensitive, so type the parameter exactly as it is shown. For options that take a size parameter, suffix the number with K to indicate kilobytes, M to indicate megabytes, or G to indicate gigabytes.
   
   
   
   
   
   Save and close the fop.bat or fop.pl file.

4. Create or edit a system environment variable named TC_FOP_HOME and set its value to point to the fop subfolder.

Configure Ghostscript, wkhtmltopdf, and Windows PowerShell

Procedure

1. Set the GS_EXECUTABLE system environment variable to point to the Ghostscript executable file, for example: C:\ghostscript10.xx\bin\gswin64.exe.

2. Set the HTML2PDF_EXECUTABLE value to point to the wkhtmltopdf executable file, for example, C:\Apps\Siemens\wkhtmltopdf\bin\wkhtmltopdf.exe.

3. Verify that the POWERSHELL_HOME value is set to POWERSHELL_HOME=%SystemRoot%\system32\WindowsPowerShell\v1.0.