Aspose.Words for SharePoint Documentation

Transcription

1 Aspose.Words for SharePoint Documentation Introducing Aspose.Words for SharePoint Does your organization base a corporate document depository on Windows SharePoint Services or Microsoft Office SharePoint Server s technologies? Do you have to utilize multiple document formats in your internal work process or in your interaction with customers and partners? Would you like to see an affordable and fast tool capable of converting documents right in your SharePoint s document library with high fidelity but without the use of Microsoft Word automation? Aspose.Words for SharePoint is a unique solution supporting document conversion that makes it possible to convert documents within the Microsoft SharePoint applications and support multiple document formats, such as: PDF - Adobe Portable Document DOCX Office Open XML DOC - Microsoft Word Document RTF - Rich Text MHT - Web Page Archive TXT - Plain Text XML - Microsoft Word 2003 WordprocessingML XML Flat OPC ODT - OpenDocument EPUB - IDPF Digital Book XPS - XML Paper Specification Aspose.Words for SharePoint is designed to be used with the following products: Windows SharePoint Services 3.0 (WSS) Microsoft Office SharePoint Server 2007 (MOSS) Standard Microsoft Office SharePoint Server 2007 (MOSS) Enterprise There are no additional system requirements besides ones, which exist for the products above.

2 Please read on to learn more. This documentation describes the features, installation, evaluation, licensing, common use cases and settings of Aspose.Words for SharePoint. You can use Aspose.Words for SharePoint right from your SharePoint s document library to convert a particular document: OR to convert all files in the current folder:

3 Features Multiple formats support Having Aspose.Words for SharePoint installed you can convert documents right from your SharePoint document library between many popular office document formats and most of the conversions will be done with high fidelity. Currently Aspose.Words for SharePoint supports the following input formats: DOCX Office Open XML DOC - Microsoft Word Document RTF - Rich Text MHT - Web Page Archive XML - Microsoft Word 2003 WordprocessingML XML - Flat OPC ODT - OpenDocument To generate documents, Aspose.Words for SharePoint relies on a built-in version of Aspose.Words for.net, the market leading document-processing component from Aspose. DOC, OOXML, RTF and WordprocessingML copies of the same document will look identical to each other, thanks to the high degree of support for the underlying file formats, provided by Aspose.Words. Microsoft Word is not used to generate documents. The full list of output formats supported by Aspose.Words for SharePoint is below: PDF - Adobe Portable Document DOCX Office Open XML DOC - Microsoft Word Document RTF - Rich Text MHT - Web Page Archive TXT - Plain Text XML - Microsoft Word 2003 WordprocessingML XML - Flat OPC ODT - OpenDocument EPUB - IDPF Digital Book XPS - XML Paper Specification

4 Adobe Portable Document (PDF) document generated by Aspose.Words for SharePoint from Microsoft Word (DOC) source. XML Paper Specification (XPS) document generated by Aspose.Words for SharePoint from Microsoft Word (DOC) source.

5 WordprocessingML (XML) document generated by Aspose.Words for SharePoint from Microsoft Word (DOC) source. Office Open XML (DOCX) document generated by Aspose.Words for SharePoint from Microsoft Word (DOC) source.

6 Different conversion options The following options are available during conversion setup: Convert files in subfolders This option is available when a folder is selected for conversion. You can recursively convert all subfolders of the selected folder by using this option. The same subfolder structure is created below the destination folder during conversion. Save destination folder option Once you have selected Destination folder you can use this option to not have to go through the same steps again. It will save your selection and prepopulate Destination folder field upon next conversion session. Overwrite existing files in the destination folder Destination folder you have selected can already contain some of the files you want to convert. This option allows you to skip conversion for such files and process only files which are not presented in the destination folder. Browse for destination folder Corporate site can consists of dozens of document libraries with complex URL to them and manual entering of Destination folder can be a headache. So, to not have to remember the whole URL path to the particular library or subfolder within it you can use Browse button to choose Destination folder visually. IMPORTANT NOTE: Browse button is only available with Microsoft Office SharePoint Server Windows SharePoint Services 3.0 does not support picker-tree dialog component used to implement browsing. Moreover, some browsers may have issues with the picker tree dialog that may make this dialog non-functional on some software configuaraions. This does not affect overall Aspose.Words for SharePoint functionality, as it is always possible to enter the destination folder manually. In most cases, this issue can be fixed by installing latest Service Packs for WSS/MOSS or by shifting to the latest version of the browser you are using. Different options will help to adjust the conversion process.

7 World Class Free Technical Support Aspose is renowned for its free and unlimited technical support provided directly by the developers of the products. If there is a new version of a product available, or if resolving a question results in a fix in the product, all new releases are free if you have an active subscription. Aspose.Support Forums is the place to not only resolve technical issues, but also to participate in development discussions with the vibrant and growing community of Aspose users. Currently there are over 40,000 users registered at the Aspose website. Aspose.Blogs is the place to look for information about latest releases and about what Aspose developers have to say. There is plenty of activity in the Aspose.Support Forums. Install Aspose.Words for SharePoint System Requirements Server Requirements To install Aspose.Words for SharePoint you need a computer running one of the following:

8 Windows SharePoint Services 3.0 Microsoft Office SharePoint Server 2007 Installing Service Pack 2 or later updates for these products is recommended. Client Requirements You need a browser to access SharePoint sites. The following browsers were checked with Aspose.Words for SharePoint: Microsoft Internet Explorer 6, 7, 8 Mozilla FireFox 3.5 Google Chrome 3 Safari 4 Installing Aspose.Words for SharePoint Aspose.Words for SharePoint is downloadable as Aspose.Words.SharePoint.zip archive. This archive contains: Aspose.Words.SharePoint.wsp SharePoint solution file. Aspose.Words for SharePoint is packaged as a SharePoint solution to facilitate deployment/retraction and feature activation/deactivation across the server farm. Aspose_LicenseAgreement.rtf End user license agreement Aspose.Words for SharePoint.pdf User documentation setup.exe Setup program setup.exe.config Setup configuration file The setup program checks the following conditions before proceeding: WSS 3.0 or MOSS 2007 is installed. The user has permission to install SharePoint solutions. SharePoint database is online. WSS Administration service is started. WSS Timer service is started. WSS Administration service and Timer service are needed because some setup actions rely on a timer job to propagate to all servers in the server farm. To install Aspose.Words for SharePoint: Unpack Aspose.Words.SharePoint zip to the local drive on the MOSS 7.0 or WSS 3.0 server. Run setup.exe and follow the instructions on the screen. The setup program performs the following actions: Check installation prerequisites. Setup will not continue if any check fails. Display End User License Agreement. The user must accept the agreement in order to proceed. Display deployment target selection dialog. The user selects web applications and site collections where the feature shall be activated. See the figure below. Deploy the feature to the server farm.

9 Activate the featue for the selected site collections and configure their parent web applications. Display a list of web applications and site collections where the feature has been deployed and activated. Deployment target selection dialog. More installation details Deployment Aspose.Words for SharePoint performs the following actions during deployment: Install Aspose.Words.SharePoint.dll into Global Assembly Cache and add SafeControl entry to the web.config file. Install feature manifest and other necessary files to the appropriate directories. Register the feature in the SharePoint database and make it available for the activation at the feature scope. Activation Aspose.Words for SharePoint is packaged as a site (site collection) level feature and can be activated and deactivated on site collections. During activation, the feature makes some changes to the virtual directory of the parent web application of the site collection: Enable SessionState in the web.config file

10 Add conversion settings page to the sitemap file Copy necessary resource files to the App_GlobalResources folder in the virtual directory Activation and Deactivation after installation During installation, Aspose.Words for SharePoint is activated for all selected site collections. After installation, you can use Site Actions menu at the root web site of a site collection to activate and deactivate Aspose.Words for SharePoint. Activating Aspose.Words for SharePont on a site collection. A known issue with permissions to the personal site collections SharePoint by default does not grant full permissions to manage personal sites to portal administrators. That is why activation and deactivation on a personal site collection may fail when performed by portal administrators. This includes activation and deactivation during setup. When this issue occurs during installation, UnauthorizedAccessException Microsoft.SharePoint.SPFeature.Activate() is logged to the SharePoint trace log at When deactivation fails as a part of uninstallation, UnauthorizedAccessException is displayed on the last setup screen for the failed deactivation(s). To prevent this issue, you can grant portal administrators the permission to manage MySite Web application by following the steps below: Go to SharePoint Central Administration and select Application Management tab. Choose "Policy for Web Application" under the "Application Security" group. Make sure you select the correct Web Application for your My Site in the "Web Application" drop down list on the right. Select "Add Users" on the upper left. Choose "All Zones" by default on the "Add Users" screen and click "Next". Add the appropriate user(s) or Active Directory group that you want to have control over your My Site Web Application. Select the level of control. Click "Finish".

11 Granting permission to the personal sites. Uninstalling Aspose.Words for SharePoint To uninstall Aspose.Words for SharePoint, just run the setup program. If Aspose.Words for SharePoint is already installed, the setup program suggests to remove or repair it. Please note that Repair option does not re-activates Aspose.Words for SharePoint for any site collections. The feature must be activated manually after redeployment with Repair option. Uninstalling using Remove option and then installing back again may be more convenient as it allows to select target web applications and site collections during installation.

12 Choose Remove option to uninstall the feature. During uninstallation the setup program deactivates Aspose.Words for SharePoint feature for all site collections and retracts the solution from the server farm. Evaluate Aspose.Words for SharePoint Make sure to take advantage of the free Aspose.Words for SharePoint evaluation as it has no time limit, and free technical support is provided for evaluation users. It is the same download for both the evaluation and the paid version of Aspose.Words for SharePoint. Simply download Aspose.Words for SharePoint from the download page, install it and it will work in the evaluation mode. Evaluation mode injects watermarks into exported reports and limits them to several pages. When you have purchased a license, simply install the license solution over installed evaluation copy of Aspose.Words for SharePoint and it will then work in the licensed mode.

13 Aspose.Words for SharePoint injects a watermark when working in the evaluation mode. License Aspose.Words for SharePoint Installing Aspose.Words for SharePoint License Once you are happy with your evaluation, you can purchase a license. Before purchasing make sure you understand and agree to the license subscription terms. The license will be ed to you after the order has been paid. The license is a.zip archive containing a regular SharePoint solution package. This archive contains: Aspose.Words.SharePoint.License.wsp SharePoint solution package file. Aspose.Words for SharePoint License is packaged as a SharePoint solution to facilitate deployment/retraction across the server farm. readme.txt License installation instructions License installation is performed from the server console via stsadm.exe. The steps required to install the license are below. Note: The paths are omitted for clarity. You may need to add the actual path to stsadm.exe and/or solution file when executing them. 1. Run stsadm to add the solution to the SharePoint solution store: stsadm.exe -o addsolution -filename Aspose.Words.SharePoint.License.wsp 2. Deploy the solution to all servers in the farm: stsadm.exe -o deploysolution -name Aspose.Words.SharePoint.License.wsp -immediate force 3. Execute administrative timer jobs to complete the deployment immediately stsadm.exe -o execadmsvcjobs Note: You will receive a warning when running deployment step if Windows SharePoint Services Administration service is not started. Stsadm.exe relies on this service and Windows SharePoint

14 Timer Service to replicate solution data across the farm. If these serivices are not running on you server farm, you may need to deploy the license at each server. Testing a License To test that a license has been installed correctly, convert any document into desired format. If the document contains no watermark at the top, the license was activated successfully. When a valid Aspose.Words for SharePoint License has been installed correctly there will be no evaluation watermark. If there is a problem with the license, Aspose.Words for ShaerPoint will work in evaluation mode and still include watermarks into the doculent. Unnstalling Aspose.Words for SharePoint License To uninstall Aspose.Words for SharePoint license, please use the steps below from the server console. 1. Retract the license solution from the farm:

15 stsadm.exe -o retractsolution -name Aspose.Words.SharePoint.License.wsp -immediate 2. Execute administrative timer jobs to complete the retraction immediately: stsadm.exe -o execadmsvcjobs 3. Wait for the retraction to complete. You can use Central Administration to check if the retraction completed under Central Administration -> Operations -> Solution Management 4. Remove the solution from the SharePoint solution store: stsadm.exe -o deletesolution -name Aspose.Words.SharePoint.License.wsp User s Guide Convert One File To convert a particular document in a document library please choose Convert via Aspose.Words item in the document s Edit Control Block (ECB). Selecting Convert via Aspose.Words item in the document s ECB. This will lead you to conversion settings screen that allows tuning of the following options: Convert to radio button list selects desired destination file format. Destination file edit box allows entering the name of destination file. By default, Aspose.Words for SharePoint prepopulates this field with the name of the source file. But you can change it if needed. The extension is added automatically depending on the selected format. Destination folder edit box allows entering the URL of the document library or folder where you would like to place the converted file. It can be a folder in the current document library, another library within the current site collectin or even library or folder in the different site collection. You can always type a path to the destination folder directly in the edit box, but it may be more convenient to select the destination folder using a graphical view of the sites and lists hierarchy provided by the Browse button (... ) placed next to the edit box.

16 NOTE: Browse button is only available with Microsoft Office SharePoint Server Windows SharePoint Services 3.0 does not support picker tree dialog component used to implement browsing. Save destination folder check box will save your selection and prepopulate Destination folder field upon next conversion session. This option saves URLs independently for different users. Moreover, as destination folder is stored at the site collection level you will have different destination folders prepopulated when starting conversion from, for example, a personal site and from a corporate site. Overwrite existing files in the destination folder check box defines what should be done in case when destination file already exits. By default, conflicting files are skipped during conversion. Checking Overwrite existing files option will change the default behaviour: If destination library has versioning enabled, a new file version is added for conflicting files. If versioning is not enabled for the destination library, an existing file with a conflicting name is overwritten. Convert button launches conversion process. Cancel button gets you back to the library and dismisses all changes in settings. Conversion Settings screen for one file conversion.

17 Selecting destination folder using graphical view via Browse button Convert All Files in a Folder If you want to convert all files in a folder you can do so either by selecting Convert via Aspose.Words option in ECB of desired folder while staying in the parent folder or by selecting Convert All via Aspose.Words from the Action menu while staying in the folder itself or in the root fo the document library. Whichever way you have chosen, Aspose.Words for SharePoint will try to convert every document in the selected folder or library.

18 Convert all files in the subfolder. Convert all files in the current folder. This will lead you into conversion s settings screen that is the same as with single file use case but with one change, Convert files in subfolders check box is now available instead of Destination file edit box. Convert files in subfolders check box lets you include all subfolders into conversion. During conversion, Aspose.Words for SharePoint will create the same subfolders tree in the destination folder.

19 Conversion Settings screen for multiple files conversion. Conversion results screen After finishing the conversion Aspose.Words for SharePoint shows Conversion Results screen having three parts: Conversion Settings pane shows parameters used during conversion. Information string shows the totals of the conversion: overall number of processed files, number of files successfully converted and number of skipped files. Results list at the bottom of the page shows individual information for each file processed during conversion. Source Path in this list shows relative path from the folder there the conversion was started. You can sort the information in this list by pressing the title of any column. After getting familiar with the results, you can return either to the source or to the destination library by pressing corresponding button at the end of the page.

20 Conversion Results screen.