SharePoint Bridge

In addition to the option of converting Word documents with the integrated "Outside In" converter, webPDF also offers the option of connecting Microsoft SharePoint (Version 2010 or higher). SharePoint’s "Word Automation Services" (or WAS for short) is used for this connection. More specifically, "webPDF SharePoint Bridge," is used to connect WAS to webPDF.

 

hint

Please make sure to have the required license for using SharePoint for document conversion purposes before using the corresponding webPDF function. Make sure to observe the Microsoft license terms for Windows and SharePoint; as well as the corresponding service and access licensing.

 

"webPDF SharePoint Bridge" is only a technical interface that does not affect the SharePoint license in any way. The customer is responsible for making sure that using Office within this context is permitted and that they have the required license for this purpose.

 

If you have any questions regarding this issue, we will be more than glad to assist you or put you in contact with the right person. Please contact Support.

 

Once this connection is established, Word documents can alternatively be converted with SharePoint. In fact, webPDF provides a SharePoint application for this purpose. This application, which is called "webPDFBridge" (webPDF SharePoint Bridge), is deployed as a SharePoint solution package and can accordingly be published under SharePoint.

 

For more information on how to deploy the solution package (WSP), please visit https://technet.microsoft.com/en-us/library/cc262995(v=office.14).aspx.

 

When this WSP (Windows SharePoint) package is deployed, a global SharePoint application that deploys WAS as a web service on the SharePoint platform will be set up. The webPDF server will connect to this web service and accordingly be able to use WAS for conversion purposes.

 

hint

On the SharePoint page, please make sure that "Word Automation Services" is installed and ready. For more information, please refer to your SharePoint documentation or visit https://technet.microsoft.com/en-us/library/cc303422(v=office.14).aspx

 

The required WSP package will be saved in the "spbridge" folder during installation. Copy the application package to the SharePoint server and deploy the application there.

 

You can do this, for example, with "SharePoint Management Shell" and the following commands:

 

Add-SPSolution -LiteralPath "C:\<Ordner mit WSP>\webPDFBridge.wsp"

 

and

 

Install-SPSolution -Identity webPDFBridge.wsp -GACDeployment

 

 

 

Among other elements, the application package contains a "Global Assembly" that implements the WCF (Windows Communication Foundation) service. The application provides a SOAP web service and can be used with SharePoint 2010 and higher.

 

After deployment, the application and web service will be available in the

 

_vti_bin

 

directory of the SharePoint server. The easiest way to test whether they work properly is to access the web service and retrieve the SOAP web service WSDL in the browser.

 

http://<URL des SharePoint Servers>/_vti_bin/webPDFBridge/FileConverter.svc?singleWsdl

 

Access to the URL will normally be protected with a user prompt. Once the prompt appears, enter a user and a password that have access to the SharePoint server and the "_vti_bin" path. If you are able to see the web service’s WSDL in the browser as a response, this means that the application has been installed correctly and can be used from webPDF.

 

Configuring and enabling "SharePoint Bridge" in webPDF

 

To use "SharePoint Bridge," it needs to be enabled in the "conf/application.xml" configuration.

 

To do this, use the portal’s Admin area. Once there, go to "Services -> Converter" to enable SharePoint Bridge and configure the relevant settings.

 

sharepoint-bridge

 

Enter the appropriate values into the dialog box so that they can be saved in the configuration:

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<application xmlns="http://schema.webpdf.de/1.0/configuration/application">

...
  <bridges>
      <sharePoint enabled="true"
                  url="url=http://<Name des SharePoint Servers>/_vti_bin/webPDFBridge/FileConverter.svc"
                  username="domain\\user"
                  password="my_password" />
  </bridges>
...
</application>

 

You can use "enabled" to enable (true) or disable (false) the "SharePoint Bridge".

 

Use "url" to enter the URL at which the web service can be reached on the SharePoint server. To do so, enter the correct server name in the example above. Leave the "?singlewsdl" bit at the end of the URL out.

 

hint

When entering the address (URL) for the web service, make sure to always enter the complete server name, including the domain (e.g., "server.xyz.local"), as login errors (HTTP Status 401) may occur otherwise. Use the same syntax specified in the WSDL under "soap:address" and the "location" attribute if retrieving the WSDL from the server.

 

hint

In SharePoint, set up a user that has access to "Word Automation Services" and the installed "webPDF SharePoint Bridge." Enter this user into the configuration. This user will be used every time webPDF accesses SharePoint.

 

Use "userName" and "password" to define the user and password for access to the web service’s URL. Please note that the user normally needs to be entered using the following format: "<domain>\\<user>".

 

Once these settings have been configured, you will be able to convert Word documents with SharePoint. To do so, you will need to set the "sharePointBridge" parameter in the "Converter" web service call. Without this parameter, webPDF will continue to use Outside In for the conversion.

 

Configuring the "SharePoint Bridge" web service

 

Within the scope of the SharePoint application, the WSP package deploys a web service that can be configured using the "web.config" configuration file. For SharePoint 2010, for example, this file will be found in the following folder:

 

C:\Program Files\Common Files\microsoft shared\Web Server Extensions\15\ISAPI\webPDFBridge

 

(If applicable, replace the installation directory and/or version number "15" with the relevant SharePoint version.)

 

By default, the maximum file size that the web service can process per call is 64 MB. This file will be received with MTOM with a max. package size of 64 kB. You can adjust these settings if necessary, but make sure to keep the SharePoint server’s overall configuration and performance in mind when doing so.

 

The web service constitutes the interface to the outside that enables webPDF to indirectly access "Word Automation Services." On the SharePoint side, configure "Word Automation Services" in such a way that an appropriate number of parallel processes will be allowed. When doing so, make sure that the settings are adjusted as necessary for your environment.

 

Commands for removing the WSP package from the server

 

If you want to remove the package from the SharePoint server, use the following commands in SharePoint Management Shell:

 

Uninstall-SPSolution –Identity webPDFBridge.wsp
 
Remove-SPSolution -Identity webPDFBridge.wsp