Setup:Installation Guide/Webservices/PDF-Export

This document describes the installation of BlueSpice - PDF export. Please make

Make sure that the Apache Tomcat server is completely installed and configured at on the BlueSpice server before setting up PDF-Export.

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 810.50\webapps (Apache Tomcat on Windows) or 
• /var/lib/tomcat8jetty9/webapps (LinuxJetty on Debian).

Copying the BShtml2PDF Application

Move the file "BShtml2PDF.war" from the directory <installpath-bluespice>/extensions/BlueSpiceExtensions/UEModulePDF/webservices to <tomcat-webapps>

Restart Tomcat

Or run the command sudo mv /var/www/bluespice/w/extensions/BlueSpiceUEModulePDF/webservices/BShtml2PDF.war /var/lib/jetty9/webapps in the terminal. (Linux)

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

Checking the functionality

Restart the Tomcat Webserver like described here.

Activating the

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

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

Enable PDF Export in BlueSpice

Go to the directory <installpath-bluespice>/extensions/BlueSpiceExtensions. If the file BlueSpiceExtensions.local.php does not exist already, please copy the file BlueSpiceExtensions.default.php and place it in the same folder under the name BlueSpiceExtensions.local.php.  Open this file in a text editor.

Scroll to the end of the file.You will find the following lines there:

                #require_once( __DIR__."/UniversalExport/UniversalExport.setup.php" );
#require_once( __DIR__."/UEModulePDF/UEModulePDF.setup.php" );

            

Remove the first character (#)settings.d. Open the file 020-BlueSpiceUEModulePDF.php in a text editor.

Or open the 020-BlueSpiceUEModulePDF.php in the terminal using the command sudo nano /var/www/bluespice/w/settings.d/020-BlueSpiceUEModulePDF.php. (Linux)

In the second line is 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.

Give the user "Everyone" full access to the Temp folder under C:\Widows.

Installing BlueSpice 3 with installer

1. Open localhost/w in your Browser and follow the instructions.
2. For BlueSpice WikiFarm, move the .htaccess and web.config files to C:\bluespice\var

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

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 Web services

If the required war-file is missing in your installation package, you can download it here: Webservices.