Setup:Installation Guide/Webservices/PDF-Export

This document describes the installation of BlueSpice - PDF export. Please make sure that the Apache Tomcat server is completely installed and configured at on the BlueSpice server.

Tips for this DocumentMoving the BShtml2PDF Application

Please, read this manual completely and work through the single installation steps one after another. 

For editing the configuration files with a text editor, the files must be saved in UTF-8 coding without BOM (Byte Order Mark).

The placeholder <installpath-bluespice> stands for the path to your BlueSpice installation, e.g C:\inetpub\wwwroot\bluespice (Windows) or /var/www/bluespice (Linux).

The placeholder <tomcat-webapps> stands for the path to the Webapps directory of your Tomcat server, e.g. 

Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <tomcat-webapps>

The default paths are as follows:

• C:\Program Files\Apache Software Foundation\Tomcat 89.50\webapps (Apache Tomcat on Windows) or 
• /var/lib/tomcat8jetty9/webapps (Linux).

Copying the BShtml2PDF Application

• Jetty on Debian)

The application usually starts automatically without the need for rebooting the application server.

Checking the functionality

Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <tomcat-webapps>

Restart Tomcat

The correct functionality of the BShtml2PDF service can be checked as follows:

On Windows

Restart the Tomcat Webserver like described here.

Activating the

Open Internet Explorer using the URL http://localhost:8080/BShtml2PDF. With correct functionality, you should see the following website:

Tomcat Check 03

Enable PDF Export in BlueSpice

Go to the directory <installpath-bluespice>/settings.d. Open the file 020-BlueSpiceUEModulePDF.php in a text editor.

In the second line is a the code to activate the extension:

return; // Disabled. Needs Tomcat

You can either add a comment character (#) to the beginning of this line or delete the line completely, save the file and exit it.

Open a command line and change to the into the folder <installpath-bluespice> folder. Execute the following command:

                php maintenance/update.php (Linux)
php maintenance\update.php (Windows))

            

In Windows, make sure that the environment variables are set correctly to access the "php" command.

Note that you must update the file system permissions after running update.php.

When the script is finished with the "Done" message, you have successfully isntalled the web service is successfully installed .

Troubleshooting

If there is a problem with the PDF export in BlueSpice, first check the file system permissions.

Download WebservicesWeb services

If the required war-file should happen to be is missing in your installation packetpackage, you can download it here: Webservices.