Difference between revisions of "Setup:Installation Guide/Webservices/PDF-Export"

[quality revision][quality revision]
(translation changes based on DE changes)
(Tag: 2017 source edit)

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[edit | edit source]

  • 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[edit | edit source]

    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[edit | edit source]

    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:

    Enable PDF Export in BlueSpice[edit | edit source]

    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))
    
                


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


    Hint.jpg
    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 .

    Setup:Setup bluespice maintenance update.jpg

    Troubleshooting[edit | edit source]

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


    Download WebservicesWeb services[edit | edit source]

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

    {{DISPLAYTITLE:Webservice: PDF-Export}}
            
            __TOC__
            
    
            This document describes the installation of BlueSpice - PDF export. Please make sure that the [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat|Apache Tomcat server]] is completely installed and configured aton 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 <code>&lt;installpath-bluespice&gt;</code> stands for the path to your BlueSpice installation, e.g <code>C:\inetpub\wwwroot\bluespice</code> (Windows) or <code>/var/www/bluespice</code> (Linux).
                
                *The placeholder Moving the BShtml2PDF Application==
                
                Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code>&lt;tomcat-webapps&gt;</code> stands for the path to the Webapps directory of your Tomcat server, e.g. <code>
                
    
                The default paths are as follows:
                
    
                * C:\Program Files\Apache Software Foundation\Tomcat 8.59.0\webapps</code> (Windows) or <code>/var/lib/tomcat8/webapps</code> (Linux).
                
    
                ==Copying the BShtml2PDF Application==
                
                Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code>&lt;tomcat-webapps&gt;</code>
                
    
                ==Restart Tomcat==
                
                Restart the Tomcat Webserver like described [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat#Restart_Tomcat|here]].
                
    
                ==Activating the  '''(Apache Tomcat on Windows)'''
                
                * /var/lib/jetty9/webapps '''(Jetty on Debian)'''
                
    
                The application usually starts automatically without the need for rebooting the application server.
                
    
                ==Checking the functionality ==
                
                The correct functionality of the BShtml2PDF service can be checked as follows:
                
    
                ===On Windows===
                
                Open Internet Explorer using the URL <nowiki>http://localhost:8080/BShtml2PDF</nowiki>. With correct functionality, you should see the following website:
                
                [[File: Setup: Tomcat_Check_03.png|center|400px|Tomcat Check 03]]
                
    
                ==Enable PDF Export in BlueSpice==
            
            Go to the directory <code>&lt;installpath-bluespice&gt;/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.
            
    
            In the second line is athe 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 <code>&lt;installpath-bluespice></code> folder. Execute the following command:
            
    
             php maintenance/update.php ''(Linux)''
            
             php maintenance\update.php ''(Windows))''
            
            {{Hint
            
            |text=In Windows, make sure that the environment variables are set correctly to access the "php" command.}}
            
                {{Hint
            
            |text=Note that you must update the [[Setup:Installation ManualGuide/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|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.<br /><br />.
            
    
            [[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]
            
    
            ==Troubleshooting==
            
            If there is a problem with the PDF export in BlueSpice, first check the [[Setup:Installation ManualGuide/Security Settings/File System Permissions|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: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].
            
    
            [[en:{{FULLPAGENAME}}]]
            
            [[de:Setup:Installationsanleitung/Webservices/PDF-Export]]
    Line 2: Line 2:
     
    __TOC__
     
    __TOC__
      
    This document describes the installation of BlueSpice - PDF export. Please make sure that the [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat|Apache Tomcat server]] is completely installed and configured at the BlueSpice server.
    +
    This document describes the installation of BlueSpice - PDF export. Please make sure that the [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat|Apache Tomcat server]] is completely installed and configured on the BlueSpice server.
      
    ==Tips for this Document==
    +
    ==Moving the BShtml2PDF Application==
     +
    Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code>&lt;tomcat-webapps&gt;</code>
      
    *Please, read this manual completely and work through the single installation steps one after another. 
    +
    The default paths are as follows:
    *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 <code>&lt;installpath-bluespice&gt;</code> stands for the path to your BlueSpice installation, e.g <code>C:\inetpub\wwwroot\bluespice</code> (Windows) or <code>/var/www/bluespice</code> (Linux).
     
    *The placeholder <code>&lt;tomcat-webapps&gt;</code> stands for the path to the Webapps directory of your Tomcat server, e.g. <code>C:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps</code> (Windows) or <code>/var/lib/tomcat8/webapps</code> (Linux).
     
      
    ==Copying the BShtml2PDF Application==
    +
    * C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps '''(Apache Tomcat on Windows)'''
    Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code>&lt;tomcat-webapps&gt;</code>
    +
    * /var/lib/jetty9/webapps '''(Jetty on Debian)'''
     +
     
     +
    The application usually starts automatically without the need for rebooting the application server.
     +
     
     +
    ==Checking the functionality ==
     +
    The correct functionality of the BShtml2PDF service can be checked as follows:
      
    ==Restart Tomcat==
    +
    ===On Windows===
    Restart the Tomcat Webserver like described [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat#Restart_Tomcat|here]].
    +
    Open Internet Explorer using the URL <nowiki>http://localhost:8080/BShtml2PDF</nowiki>. With correct functionality, you should see the following website:
     +
    [[File: Setup: Tomcat_Check_03.png|center|400px|Tomcat Check 03]]
      
    ==Activating the PDF Export in BlueSpice==
    +
    ==Enable PDF Export in BlueSpice==
     
    Go to the directory <code>&lt;installpath-bluespice&gt;/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.
     
    Go to the directory <code>&lt;installpath-bluespice&gt;/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.
      
    In the second line is a code to activate the extension:
    +
    In the second line is the code to activate the extension:
      
     
      return; // Disabled. Needs Tomcat
     
      return; // Disabled. Needs Tomcat
    Line 26: Line 30:
     
    You can either add a comment character (#) to the beginning of this line or delete the line completely, save the file and exit it.
     
    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 <code>&lt;installpath-bluespice></code> folder. Execute the following command:
    +
    Open a command line and change into the folder <code>&lt;installpath-bluespice></code>. Execute the following command:
      
     
      php maintenance/update.php ''(Linux)''
     
      php maintenance/update.php ''(Linux)''
     
      php maintenance\update.php ''(Windows))''
     
      php maintenance\update.php ''(Windows))''
     
    {{Hint
     
    {{Hint
    |text=In Windows, make sure that the environment variables are set correctly to access the php command.}}
    +
    |text=In Windows, make sure that the environment variables are set correctly to access the "php" command.}}
     
     
     
    {{Hint
     
    {{Hint
    |text=Note that you must update the [[Setup:Installation Manual/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|file system permissions]] after running update.php.}}
    +
    |text=Note that you must update the [[Setup:Installation Guide/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|file system permissions]] after running update.php.}}
      
    When the script is finished with the "Done" message, the web service is successfully installed.<br /><br />
    +
    When the script is finished with the "Done" message, you have successfully isntalled the web service .
      
     
    [[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]
     
    [[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]
      
     
    ==Troubleshooting==
     
    ==Troubleshooting==
    If there is a problem with PDF export in BlueSpice, first check the [[Setup:Installation Manual/Security Settings/File System Permissions|file system permissions]].
    +
    If there is a problem with the PDF export in BlueSpice, first check the [[Setup:Installation Guide/Security Settings/File System Permissions|file system permissions]].
      
      
    ==Download Webservices==
    +
    ==Download Web services==
    If the required war-file should happen to be missing in your installation packet, you can download it here: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].
    +
    If the required war-file is missing in your installation package, you can download it here: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].
      
      
     
    [[en:{{FULLPAGENAME}}]]
     
    [[en:{{FULLPAGENAME}}]]
     
    [[de:Setup:Installationsanleitung/Webservices/PDF-Export]]
     
    [[de:Setup:Installationsanleitung/Webservices/PDF-Export]]

    Attachments

    Discussions