Installation Guide
Instructions for installing SLIP components in SharePoint farm and on Client Automation Servers
Contents
SLIP SharePoint Connector Solution4
SLIP SharePoint Publishing Foundation Solution5
SLIP HTML Converter Pack Solution6
SLIP OOX Converter Pack Solution7
SLIP PDF Converter Pack Solution8
SLIP WAS Converter Pack Solution9
SLIP SharePoint Client Automation Services Solution10
Client Automation Components12
SLIP Client Automation Service12
Installation of Office Client Applications13
Configuration of Office Client Applications17
Installation of SLIP Client Automation Service17
Appendix A - Notes on User Access Control (UAC)19
Introduction
SLIP components are mainly targeted at SharePoint but, depending on requirements, you may have use for the non-SharePoint components as well. In either case you would probably want to install the SharePoint components first, although this is not a requirement.
This document describes the installation process in an order that makes each component build upon the former ones. The installation process is straightforward for a SharePoint administrator since all SLIP:td components are deployed using standard SharePoint solutions (WSP).
Not all the components described in this document might be required to be installed in your SharePoint farm. Contact SLIP Systems or your reseller to plan your installation based on your business requirements and goals. If you have special requirements for PowerShell scripted installations, this is also possible to accomplish and samples can be requested on a per-project basis. Simply contact SLIP Systems A/S.
SharePoint Components
SLIP Task List Solution
The name of the Task List solution file is SLIP Task List.wsp and is the foundation for a SLIP:td infrastructure and is required in all SLIP:td installations and exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the appropriate version to the solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP Task List folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains the following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP Transaction Manager 5e0cb0a6-0ded-4783-8114-05a4aaae0428 | Web Application | The SLIP Transaction Manager handles all task processing that happens in SharePoint. This includes selecting profiles for tasks and processing internal tasks. |
SLIP Clean Up Agent 25c07832-11ea-4941-a997-6723c0e0784e | Web Application | Older tasks may not be needed after some time and the SLIP Clean Up Agent will take care of removing these obsolete tasks to avoid sanding up the system. |
SLIP Tuning 79f108c6-20b9-4a57-8d7a-5580f1d0c30f | Web Application | Use the SLIP Tuning to specify which sites the SLIP Transaction Manager should visit |
SLIP Task List Infrastructure 00027ba7-b2b0-47b4-b253-5bc172d47c5b | Site Collection | This feature contains the core SLIP lists and libraries that are used as data and configuration store and by e.g. the SLIP Transaction Manager and the SLIP Clean Up Agent. |
SLIP Item Monitor 6100b74c-2095-4706-b203-175cde903228 | Site Collection | The SLIP Item Monitor enable a slip profile and task to be configured to monitor items across your farm and trigger an e-mail or action when criteria are met. |
SLIP Link List f850e1f3-387b-4b6e-98c3-76045f53e9b3 | Site Collection | The SLIP Link List enable maintaining a list of all hyperlinks found within content managed by SLIP:td |
SLIP List Receiver d058f83f-5014-4e8f-87db-ff657183d828 | Site Collection | The SLIP List Receiver is used to connect to remote Lists in e.g. SharePoint Online and pull documents that needs to be transformed by SLIP:td |
The following assembles are put in the GAC on solution deployment:
• Binary Toolkit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• SharePoint Toolkit, Version=1.12.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Task List Interface, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Task List, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP Task List Solution.
SLIP SharePoint Connector Solution
The name of the SharePoint Connector solution file is SLIP SharePoint Connector.wsp.
The solution exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the appropriate version to the solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP SharePoint Connector folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains the following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP SharePoint Connector | Site | This feature creates the SLIP SharePoint Connector Configuration Page that lets you control which lists and libraries are synchronized with the SLIP Task List. I.e. you control which lists have attached event handlers that create tasks when items are created, edited and deleted. The configuration page also lets you control which task list receives the generated tasks. |
SLIP SharePoint Connector Web Application Configuration | Web Application | This web application scoped feature is hidden and activated by default for Central Administration. It enables the configuration page for use within Central Administration. |
SLIP Create Tasks | Site Collection | This feature This feature adds a button that enables the user to create tasks for a collection of list items. |
SLIP Redeployment | Site Collection | This feature adds a site action that enables the user to initiate a SLIP redeployment process. |
The following assembles are put in the GAC on solution deployment:
• Binary Toolkit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Task List Interface, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip SharePoint Connector, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP SharePoint Connector Solution.
SLIP SharePoint Publishing Foundation Solution
The name of the SLIP SharePoint Publishing Foundation solution file is SLIP SharePoint Publishing Foundation.wsp. The solution exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the appropriate version to the solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
NOTE: See Appendix A if you have User Access Control (UAC) enabled as it typically is on Windows 2008.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP SharePoint Publishing Foundation folder.
IMPORTANT: After the solution has been added to the solution store either manually or using the supplied batch file the solution must be deployed to one or more web applications from with the Central Administration, Solution Management.
The solution contains following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP SharePoint Page Deployer | Site Collection | This feature deploys the SLIP SharePoint Page Deployer code to the GAC and registers it in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. |
SLIP SharePoint Foundation | Site Collection | This feature contains the core SLIP SharePoint resources like SLIP site columns, basic page content type. All resources are required as the foundation for publishing simple pages, items or documents in your SharePoint infrastructure. |
SLIP SharePoint Publishing | Site Collection | This feature contains the core SLIP resources supporting the SharePoint Publishing infrastructure like SLIP CMS site columns, page content type and a sample SlipArticle.aspx page layout. All resources are required for publishing pages to your SharePoint Publishing CMS infrastructure. |
The following assembles are put in the GAC on solution deployment:
• SLIP SharePoint Publishing Foundation, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP SharePoint Publishing Foundation Solution.
SLIP HTML Converter Pack Solution
The name of the HTML Converter Pack solution file is SLIP HTML Converter Pack.wsp.
The solution exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the solution to the SharePoint solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
NOTE: See Appendix A if you have User Access Control (UAC) enabled as it typically is on Windows 2008.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP HTML Converter Pack folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains following features:
Name | Scope | Purpose |
|---|---|---|
SLIP HTML Converter | Site Collection | This feature deploys the SLIP HTML Converter code to the GAC and registers it in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. The SLIP Converter transforms Office Open XML documents into HTML using the Office Open XML SDK. |
SLIP SharePoint HTML Converter | Site Collection | This feature deploys the SLIP SharePoint HTML Converter code to the GAC and registers it in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. The SLIP Converter transforms Office Open XML documents into HTML using the built-in SharePoint Document Converter framework in combination with the Office Open XML SDK. |
The following assembles are put in the GAC on solution deployment:
• Binary Toolkit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• DocumentFormat.OpenXml, Version=2.0.5022.0, Culture=neutral, PublicKeyToken= 31bf3856ad364e35
• Office Open Xml Conversion, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Office Open Xml Toolkit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Html Converter Pack, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• SgmlReader, Version= 1.8.7.0, Culture=neutral, PublicKeyToken= 46b2db9ca481831b
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP HTML Converter Pack Solution.
SLIP OOX Converter Pack Solution
The name of the Open Office XML (OOX) Converter Pack solution file is SLIP OOX Converter Pack.wsp.
The solution exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the solution to the SharePoint solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP OOX Converter Pack folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP OOX Converter Pack | Site Collection | This feature deploys the SLIP OOX Converter Pack code to the GAC and registers a number of Office Open XML Converters in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. The SLIP Office Open XML converters manipulate and repairs Office Open Xml based documents using the Office Open XML SDK. |
The following assembles are put in the GAC on solution deployment:
• DocumentFormat.OpenXml, Version=2.0.5022.0, Culture=neutral, PublicKeyToken= 31bf3856ad364e35
• Office Open Xml Toolkit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Oox Converter Pack, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP OOX Converter Pack Solution.
SLIP PDF Converter Pack Solution
The name of the PDF Converter Pack solution file is SLIP PDF Converter Pack.wsp.
The solution exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the solution to the SharePoint solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP PDF Converter Pack folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains the following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP PDF Converter Pack | Site Collection | This feature deploys the SLIP PDF Converter Pack code to the GAC and registers a number of SLIP PDF Converters in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. The SLIP PDF converters manipulate PDF based documents using the PdfSharp XML SDK. |
The following assembles are put in the GAC on solution deployment:
• PdfSharp-WPF, Version= 1.31.1789.0, Culture=neutral, PublicKeyToken= f94615aa0424f9eb
• Slip Pdf Converter Pack, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP PDF Converter Pack Solution.
SLIP WAS Converter Pack Solution
The SLIP Word Automation Service (WAS) Converter Pack solution integrates seamless with the Word Automation Services application available in a SharePoint 2010/2013/2016 based farm. The WAS enables unattended, server-side conversion of documents supported by the Microsoft Word client application. Before using the SLIP WAS Converter Pack a Word Automation Services application must be created and configured correctly. Please refer to the Microsoft guides found here http://msdn.microsoft.com/en-us/library/ee557330.aspx or request assistance from your supplier.
The name of the WAS Converter Pack solution file is SLIP WAS Converter Pack.wsp. The solution exists for SharePoint 2010 and 2013/2016. You may add the solution to the SharePoint solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP WAS Converter Pack folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains the following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP WAS Converter Pack | Site Collection | This feature deploys the SLIP WAS Converter code to the GAC and registers it in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. The SLIP WAS transforms Microsoft Office Word documents into DOCX, PDF, XPS and MHTML formats using the Word Automation Service (WAS) application in SharePoint 2010. |
The following assembles are put in the GAC on solution deployment:
• Slip Was Converter Pack, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP WAS Converter Pack Solution.
SLIP SharePoint Client Automation Services Solution
The SLIP SharePoint Client Automation Services (CAS) solution integrates seamless with the SLIP Client Automation Service server. The SLIP CAS enables unattended, server-side conversion of office documents supported by the Microsoft Office client applications. Before using the SLIP CAS Converter Pack a SLIP Client Automation Server must be installed and configured on your network. Please refer to SLIP Client Automation Service section found later in this document or request assistance from your supplier.
The name of the SLIP SharePoint Client Automation Services solution file is SLIP SharePoint Client Automation Services.wsp. The solution exists for SharePoint 2007, SharePoint 2010 and 2013/2016. You may add the solution to the SharePoint solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP SharePoint Client Automation Services folder. Please verify the solution has been deployed successfully in Central Administration, Solution Management.
The solution contains the following feature(s):
Name | Scope | Purpose |
|---|---|---|
SLIP CAS Converter Pack | Site Collection | This feature deploys the SLIP CAS Converter Pack code to the GAC and registers a number of SLIP CAS Converters in the SLIP Components list found on the current site collection ready to be applied to your SLIP Profiles. The SLIP CAS converters provide remote conversion of office document through a SLIP Client Automation Service server into DOCX, PDF, XPS and MHTML formats using the Microsoft Office 2010 client application. |
The following assembles are put in the GAC on solution deployment:
• Slip SharePoint Client Automation Services, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on activation and configuration of the SLIP SharePoint Client Automation Services Solution.
SLIP Search Solution
The SLIP Search module must be installed on the SharePoint server that has the indexer role. If you are not sure which server performs indexing, please go to Central Administration, System Settings, Manage servers in this farm. Find out which server is running the service SharePoint Server Search and log on to that server while installing and activating SLIP Search.
Since the solution contains a farm feature, this feature is activated automatically when deploying the solution. The feature must update the registry and restart the SharePoint Server Search service so it should be a local administrator on that machine. An appropriate login choice would be the SharePoint setup account used to install SharePoint initially.
The file name of the SLIP Search solution file is SLIP Search.wsp. The solution exists for SharePoint 2007, SharePoint 2010 and 2013 but recently Cumulate Updates for SharePoint 2013 don’t support Search Protocol Handlers hence the SLIP Search.
You may add the solution to the SharePoint solution store manually using STSADM or you may use the supplied command line batch file to auto-detect your installation and perform both the appropriate installation and deployment in one go.
To use supplied batch file, simply run Install solution.cmd from the supplied SLIP Search folder. Please verify the solution has been deployed successfully in Central Administration under System Settings, Farm Management and Manage farm solutions. If the deployment appears to hang, please cancel the deployment and redeploy manually through the web interface.
The solution contains the following feature:
Name | Scope | Purpose |
|---|---|---|
SLIP Search Infrastructure | Farm | This feature registers the SLIP Search module for use by the SharePoint indexer. The SLIP Converter transforms Office Open XML documents into HTML using the Office Open XML SDK. |
The following assembles are put in the GAC on solution deployment:
• Windows.SearchApi.Interop, Version=1.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Search Protocol Handler, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Search Infrastructure, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
• Slip Search 2010 Module, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8f5505a445cce3ae
See SLIP:td Configuration Guide for further details on how to create and manage SLIP content sources.
Client Automation Components
SLIP Client Automation Service
The SLIP Client Automation Service, or SLIP CAS for short, manages and processes work items that are converted using client automation. The service exposes an extensible framework for automation of client applications. The current release implements PDF and XPS generation through Word 2010, Excel 2010, PowerPoint 2010, Publisher 2010 and Visio 2010.
Prerequisites
Please see the end of this section for a discrete list of unqualified, recommended prerequisites.
The following applies to newer versions of Windows, i.e. Windows Vista, Windows 7, Windows Server 2008 and newer. It would most likely be possible to run the SLIP CAS on older Windows versions like Windows XP for instance. However, because of architectural differences in the OS, circumstances would be different and the guidance provided below may not apply or may even be misleading.
As indicated, the SLIP CAS uses client applications for document conversion. This means that these applications must be installed upon the server.
At the time of writing, the SLIP CAS has been tested and deployed exclusively in 64-bit environments. Theoretically it would run fine in a 32-bit system as well. The most important thing to note is that if installed in a 64-bit environment, the client applications should also be installed using their 64-bit versions. If you have a specific requirement to run 32-bit client applications in a 64-bit version of Windows then please contact your supplier for assistance.
The account that runs the service will launch the client applications in what is known as session 0. This means that certain special directories require read and write access when the service processes work items. One such directory is %systemroot%\System32\config\systemprofile\Desktop. The same is not the case when the applications are run in a normal user process. Each client application also has an associated COM object that requires launch and activation permission for the SLIP CAS account.
Rather than working through security requirements like these, it is recommended to simply add the account for SLIP CAS to the group of local administrators (i.e. BUILTIN\Administrators). This also improves the chance that the service will continue functioning without problems after future system updates.
You are free to use or create a local user account for the SLIP CAS, however for ease of control and to simplify possible future setup of an instance of the SLIP Work Synchronization Service, it is recommended to use or create a domain user account.
In summary, the following is a list of the recommended software prerequisites:
• Microsoft Windows Server 2008 R2 64-bit installed and activated
• Microsoft .Net Framework 4.0 installed
• A domain user account named SlipCas which is a member of the local administrators group
• Microsoft Office 2010 UK Professional 64-bit software and product key ready
• Microsoft Visio 2010 UK Professional 64-bit software and product key ready
• Microsoft Office Language Pack 64-bit software ready
• All available important and recommended Windows updates installed
Installation of Office Client Applications
Please follow these instructions when installing the Office 2010 suite:
1. Log on using the SlipCas user account.
2. Launch the Microsoft Office 2010 software installation.
3. Enter the product key, enable the option to activate Office online and click Continue.
4. Accept the license agreement and click Continue.
5. Click the button to customize the installation.
6. Make sure that the following components are set to Run all from My Computer:
a. Microsoft Excel
b. Microsoft PowerPoint
c. Microsoft Publisher
d. Microsoft Word
e. Office Shared Features
f. Office Tools
7. Click Install Now.
8. Wait for the installation to complete and then click Close.
Please follow these instructions when installing the Visio 2010:
1. Launch the Microsoft Visio 2010 software installation.
2. Enter the product key, enable the option to activate Visio online and click Continue.
3. Accept the license agreement and click Continue.
4. Click the button to customize the installation.
5. Make sure that all components are set to Run all from My Computer.
6. Click Install Now.
7. Wait for the installation to complete and then click Close.
Configuration of Office Client Applications
After installation, start one of the Office client applications. Please take notice that you are still logged on with the SlipCas user account. Office will prompt you to select a maintenance plan and choose your preferred file format.
You are free to choose your preferred maintenance policy and default file format. You should keep in mind, however, that these client applications are intended to run in an unattended mode, so issue troubleshooting, problem diagnosis and user feedback is probably irrelevant.
Installation of SLIP Client Automation Service
Please follow these instructions for installing the SLIP Client Automation Service:
1. In the supplied SLIP 3 software directory locate the directory SLIP Client Automation Service.
2. Copy this directory to a location on the local system like Program Files or simply the system root.
3. Open the destination folder and open the file Slip Client Automation Service.exe.config in a text editor.
4. Verify that the settings are correct. In particular note that the setting FileSystemQueueFolderPath can be either a relative or absolute path. The relative variant is relative to the location of Slip Client Automation Service.exe.
5. Run Slip Client Automation Service.exe as administrator if required and click Install Service.
6. When prompted for user account information, enter the credentials of the SlipCas user.
7. Click Start Service.
8. Close the Slip Client Automation Service.exe interface.
The SLIP Client Automation Service now listens for work item requests on port 5667 via the http (TCPIP) protocol and must be opened internally in the firewall(s) between the SLIP CAS and the servers in your SharePoint farm.
If the environment has UAC enabled the install solutions.cmd must be run with administrator privileges.
1. Click the start menu and right click on the Command Prompt option. Choose “Run as administrator”.
2. Click the “Yes” button
3. Type in the path and Install solutions.cmd command and press enter to run the installation
Comments
Please sign in to leave a comment.