Installing the DocConverter® Plugin for Microsoft SharePoint® ActivePDF DocConverter
Document Number: D-140530 Rev B
© 2015 by ActivePDF, Inc. All rights reserved. This manual, and the software described in it, is furnished under a license agreement. No part of this manual may be produced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or otherwise, without the prior, written permission of ActivePDF, Inc.
Trademarks ActivePDF DocConverter is a trademark of ActivePDF, Inc. All rights reserved. Microsoft, SharePoint, Windows, Word, Excel and PowerPoint are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. Other product and brand names may be trademarks or registered trademarks of their respective owners.
Documentation Disclaimer Information in this document is subject to change without notice and does not represent a commitment on the part of ActivePDF. ActivePDF assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual.
ActivePDF, Inc 1.866.GO.TO.PDF 949.582.9002
[email protected] http://www.ActivePDF.com Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
2
Table of Contents About the DocConverter Plugin for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Additional resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Installation overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Installing DocConverter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Setting up SharePoint document conversion services . . . . . . . . . . . . . . . . . . . . . . . . . 7 To start the service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 To configure the document conversion settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 To enable the publishing feature on your site collection.. . . . . . . . . . . . . . . . . . . . 8 Installing and configuring the plugin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 To install the plugin: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 To configure the plugin:. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Testing your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 To test the installation: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 About DocConverter settings and conversions from SharePoint . . . . . . . . . . . . 11 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 To troubleshoot DocConverter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 To troubleshoot the SharePoint Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Uninstalling the DocConverter Plugin for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . 14
D-140530 Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
3
Table of Contents
D-140530 Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
4
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint About the DocConverter Plugin for SharePoint ActivePDF's DocConverter Plugin for SharePoint enables your end users to submit documents from your SharePoint site to DocConverter for conversion. Office documents can be converted to PDF, applying encryption, metadata, or linearization to the output files. File types supported: •
Microsoft Word (doc/docx)
•
Microsoft Excel (xls/xlsx)
•
Microsoft PowerPoint (ppt/pptx)
•
Text
•
PDF
Once installed, the plugin is enabled at the Web-application level, and is available for every document library in every site in that Web application.
Requirements •
•
The DocConverter Plugin for SharePoint requires: -
Microsoft SharePoint 2010 or later
-
DocConverter Enterprise 2010
You need: -
A familiarity with administering SharePoint.
-
The privileges required to install solutions to your SharePoint environment.
-
Local Administrator rights on the computer where the DocConverter Plugin for SharePoint is installed. Notes
•
•
The DocConverter plugin must be installed on the SharePoint server. While it is possible to also host DocConverter on your SharePoint server, it is recommended that you use a separate server for this purpose. The DocConverter plugin for SharePoint requires a licensed version of DocConverter to function.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
5
Installation overview
Additional resources The following additional online resources are available: •
•
Documentation: -
Using the DocConverter Plugin for Microsoft SharePoint
-
Links for DocConverter documentation
Technical Support If you need more assistance, check our Technical Support Portal: http://support.activepdf.com/ From the Support Portal, you can: -
Search the knowledgebase for information on current ActivePDF products: http://support.activepdf.com/index.php?/Knowledgebase/List
-
Submit a new Technical Support or Customer Service request. http://support.activepdf.com/index.php?/Knowledgebase/Article/ View/1 (Requires registration.)
•
Customer Service ActivePDF Customer Service is available to help you with questions about software purchases and licensing. To contact Customer Service: -
Phone (US): Dial 1-866-GoTo-PDF (1-866-468-6733), and then press 2.
-
Phone (Intl): Dial +1-949-582-9002, and then press 2.
Installation overview To install and configure the DocConverter Plugin for SharePoint you will: •
Install DocConverter.
•
Set up SharePoint Document Conversion Services.
•
Configure your firewall.
•
Install and configure the plugin.
•
Perform a test conversion.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
6
Installing DocConverter
Installing DocConverter ActivePDF DocConverter is required to use the DocConverter Plugin for SharePoint. While it is possible to install DocConverter on the server where SharePoint is hosted, it is not recommended. DocConverter should be installed and configured on a separate server. Refer to the online DocConverter Installation Guide for detailed instructions.
Setting up SharePoint document conversion services To set up the SharePoint Document Conversion services, you will: •
Start the service.
•
Configure the document conversion settings.
•
Enable the publishing feature on the site collection in your SharePoint site.
To start the service 1.
In SharePoint, login to Central Administration.
2.
Go to Application Management > Manage Services.
3.
Start the Document Conversions Load Balancer Service.
4.
Start the Document Conversions Launcher Service.
To configure the document conversion settings 1.
In SharePoint, login to Central Administration,
2.
Go to General Application Settings -> External Service Connections -> Configure document conversions.
3.
Select the Web Application you wish to enable.
4.
Set Enable document conversions for this site? to Yes.
5.
Select your load balancer server.
6.
Use the default Converter Settings or edit them as needed.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
7
Installing and configuring the plugin
To enable the publishing feature on your site collection. 1.
Login to your SharePoint site.
2.
Go to Site Settings.
3.
Select Site Collection Features and click Enable SharePoint Server Publishing. Infrastructure.
4.
Select Manage Site Feature and click Enable SharePoint Server Publishing.
Installing and configuring the plugin Follow these instructions to install and configure the plugin on the SharePoint server. Note
You need local administrator rights or a domain account with local administrator rights to run the plugin installer.
To install the plugin: 1.
Log on to the SharePoint server.
2.
Exit all Windows programs that are running.
3.
Download the latest build of the DocConverter Plugin for SharePoint from: https://store.activepdf.com/downloads
4.
Double-click APDCSharePoint.exe.
5.
When the Welcome dialog box appears, click Next to begin installation.
6.
Follow the on-screen prompts, clicking Next to continue.
7.
When the Installation Successful dialog box appears, click Finish.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
8
Installing and configuring the plugin
To configure the plugin: 1.
Log in to the SharePoint server as an Administrator.
2.
Select Site Actions > Site Settings. The Site Settings screen appears.
Figure 1 Site settings 3.
In the Site Administration section, click ActivePDF Converter Settings. The Global Converter Settings screen appears.
Figure 2 Site settings
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
9
Installing and configuring the plugin
4.
Complete the Global Converter Settings as follows, depending on the location where DocConverter is installed: If If DocConvert er is installed on the SharePoint server If DocConvert er is installed on a separate server
Notes
•
•
5.
Then Set the Server Address to 127.0.0.1
Set the: • Server Address: Enter the IP address of the DocConverter machine. • Port Number: Enter the port number that SharePoint should use to communicate with DocConverter. The default port number is 54546. • User: Enter the name of the user under which the DocConverter service is installed and running. • Domain: Enter the domain of the DocConverter machine. • Password: Enter the password for the DocConverter user, and then type it again in Confirm Password. Enabling verbose logging is not recommended unless you have been instructed to do so by an activePdf technical support representative. The log information captured is for the DocConverter Plugin only. Setting verbose logging here does not capture information from DocConverter.
Click OK to save the changes.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
10
Testing your installation
Testing your installation This procedure converts a Microsoft Word document to PDF to make sure the plugin is functioning correctly.
To test the installation: 1.
In your document library, right-click a Word document, and select Convert Document > Word To PDF.
2.
Type a File name for the output file. Note
3.
Do not add an extension (such as .pdf) to the file name. The extension is automatically added.
Click Convert. Your document is submitted for conversion. Note
4.
Document conversions may take anywhere from a few seconds to several minutes to complete, depending on your SharePoint environment. You will not see a progress bar.
Click your browser’s Refresh or Reload button. The output PDF appears in the same library as the original document.
About DocConverter settings and conversions from SharePoint Some settings configured in DocConverter apply to conversions performed with the plugin. For example, setting Word > Office Settings to PDFPrint results in Word documents being printed as PDF, rather than using PDFExport. Timeout settings configured in DocConverter do not apply to conversions performed by the plugin. Note
SharePoint has internally defined rules and priorities for processing conversion requests, which are outside of DocConverter's control. Your users may notice a delay between the time a conversion is initiated and the time when the converted document appears; this is normal and expected.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
11
Troubleshooting
Troubleshooting If document conversions fail (i.e. no conversion output is generated), use the following procedures to troubleshoot issues with the plugin. •
To troubleshoot DocConverter, on page 12
•
To troubleshoot the SharePoint Server, on page 13
To troubleshoot issues with the converted output (i.e. corrupted PDF files), consult the DocConverter documentation or contact ActivePDF Technical Support.
To troubleshoot DocConverter 1.
On the DocConverter server, place a simple Word .doc or .docx file in the folder: C:\Windows\ActivePDF\Docconverter\Input.
2.
Observe the folder for the output PDF: C:\Windows\ActivePDF\Docconverter\Output If The PDF is created The PDF is not created
3.
Then DocConverter is working properly. Proceed to Troubleshooting the SharePoint Server. • Enable logging and restart services. For instructions, refer to the online DocConverter Administrator’s Guide. • Repeat Steps 1 and 2. a. If successful, Proceed to Troubleshooting the SharePoint Server. b. If the PDF is still not created, proceed to Step 3.
If the PDF is still not created in the Output folder: a. Review the log file in the default location, C:\WINDOWS\ActivePDF\Logs\DCLog.log, or in the custom location you selected in the DocConverter Global Settings. b. Check this online list for error messages listed in the log file and implement suggested resolutions: DocConverter Return Codes c. Follow these online instructions to check that DCOM permissions are set properly: Setting DCOM Permissions
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
12
Troubleshooting
To troubleshoot the SharePoint Server This procedure makes sure that the SharePoint server communicates with the DocConverter server. 1.
Confirm that the DocConverter Plugin for SharePoint is installed with a license.
2.
In SharePoint, select Site Actions > Site Settings.
3.
Click ActivePDF Converter Settings in the Site Administration section.
4.
Verify the following: If If DocConvert er is installed on the SharePoint server If DocConvert er is installed on a separate server
Then Verify that the Server Address is 127.0.0.1
If DocConverter is installed on a separate server: verify that the • Server Address • Port Number • User • Domain • Password are correct for the DocConverter Server and the user under which the DocConverter service was installed.
5.
Convert a document in SharePoint using the plugin. If the conversion is unsuccessful: a. If SharePoint and DocConverter are on different servers, try pinging the two servers. Make sure that all ports are open. b. Check your firewall rules to make sure all ports are open and that all servers are configured properly.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
13
Uninstalling the DocConverter Plugin for SharePoint
Uninstalling the DocConverter Plugin for SharePoint To uninstall the plugin: 1.
Exit all Windows programs that are running.
2.
Select Start > All Programs > ActivePDF > ActivePDF SharePoint > Uninstall.
3.
Follow the on-screen prompts to complete the removal.
Installing the ActivePDF DocConverter Plugin for Microsoft SharePoint
14
