Webservice: PDF-Export

From BlueSpice

< Setup:Installation Manual‎ | Webservices
Jump to: navigation, search

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

Tips for this Document

  • 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. C:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps (Windows) or /var/lib/tomcat8/webapps (Linux).

Copying the BShtml2PDF Application

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

Restart Tomcat

Restart the Tomcat Webserver like described here.

Activating the 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 (#), save the file and exit it.

Open a command line and change to the <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, the web service is successfully installed.

Setup:Setup bluespice maintenance update.jpg


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