EMC ApplicationXtender SPI (for SharePoint Integration)

Transcription

1 EMC ApplicationXtender SPI (for SharePoint Integration) 6.0 Deployment Guide P/N A01 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright 2009 EMC Corporation. All rights reserved. Published June 2009 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. MC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

3 Table of Contents Preface... 7 Chapter 1 Introduction... 9 High-level steps... 9 Overview of features... 9 Chapter 2 Preparing for Deployment Downloading the AXSPI solution Adding the AXSPI solution to the SharePoint solution store Chapter 3 Deploying AXSPI Deploying the AXSPI solution files Verifying the deployment Chapter 4 Activating AXSPI Features Activating AXSPI Administration features Verifying the activation of Administration features Activating AXSPI Content features Verifying the activation of Content features Chapter 5 Configuring a Connector Chapter 6 Next Steps Archiving SharePoint documents to ApplicationXtender Using custom ECM lists Using ECM Web Parts Chapter 7 Removing AXSPI Appendix A AXSPI Scripts AddSolution CleanUp EMC ApplicationXtender SPI Deployment Guide 3

4 Table of Contents List of Figures Figure 1. Solution Management Page: AXSPI Solutions (full feature set) Figure 2. Solution Properties Page Figure 3. Deploy Solution Page Figure 4. Solution Management Page: Deployed AXSPI Solutions (full feature set) Figure 5. Manage Farm Features Page Figure 6. Successful Activation: AXSPI Administration Features Figure 7. Version Information Page Figure 8. Site Features Page: SharePoint Content Site (full feature set) Figure 9. Successful Activation: AXSPI Content Features (full feature set) Figure 10. Application Management Page Figure 11. External Content Management Connectors Page Figure 12. New Connector Page Figure 13. Site Settings Page Figure 14. AXSPI Web Parts EMC ApplicationXtender SPI Deployment Guide

5 Table of Contents List of Tables Table 1. AXSPI Content Features EMC ApplicationXtender SPI Deployment Guide 5

6 Table of Contents 6 EMC ApplicationXtender SPI Deployment Guide

7 Preface This guide describes how to prepare for and deploy the EMC ApplicationXtender SPI software solution, hereafter referred to as AXSPI. In addition, it provides an overview of configuration steps for AXSPI. The guide also describes how to deactivate, retract, and remove an AXSPI solution. In this guide, ECM refers to External Content Management. Intended Audience The information in this guide is intended primarily for SharePoint and ApplicationXtender administrators who are responsible for deploying the AXSPI software solution for SharePoint. The guide is also intended to assist Information Technology (IT) administrators who are responsible for planning for an AXSPI implementation. This guide assumes that the reader has significant experience and knowledge in configuring and administering Microsoft Office SharePoint, EMC ApplicationXtender, and Microsoft Windows Server 2003 or In addition to this guide, the documentation set for EMC ApplicationXtender SPI includes the EMC ApplicationXtender SPI Release Notes. Online help is also provided for complex fields on the AXSPI administration pages. Revision History The following changes have been made to this document. Revision Date June 2009 Description Initial publication EMC ApplicationXtender SPI Deployment Guide 7

8 Preface 8 EMC ApplicationXtender SPI Deployment Guide

9 Chapter 1 Introduction AXSPI is a software solution that allows organizations to integrate ApplicationXtender basic content management functionality into one or more Microsoft SharePoint portals. AXSPI lets you use the Microsoft Office and SharePoint user interfaces to interact through business processes and workflows with content that is stored, protected, and managed by EMC ApplicationXtender. This solution allows you to direct SharePoint content to integrated archives for long-term preservation, thus improving operational efficiencies, enabling scalability of production systems, and facilitating sound information governance and litigation readiness. High-level steps The following high-level steps are required to implement an AXSPI solution: 1. Download the AXSPI software and add it to the SharePoint solution store using the procedures in Chapter 2, Preparing for Deployment. 2. Deploy the AXSPI solution using the procedures in Chapter 3, Deploying AXSPI. 3. Activate the AXSPI features using the procedures in Chapter 4, Activating AXSPI Features. 4. Configure a connector between SharePoint and ApplicationXtender using the high-level procedures in Chapter 5, Configuring a Connector. Detailed configuration information is available in the online help for the AXSPI pages in SharePoint. 5. Finish the configuration steps identified in Chapter 6, Next Steps using the AXSPI online help. 6. Notify users that AXSPI has been implemented and is available for use. Alternatively, you can add, deploy, and activate the AXSPI solution using the AXSPI AddSolution command script. Refer to Appendix A, AXSPI Scripts for more information. Overview of features Table 1, page 10 lists and describes all available features in AXSPI release 6.0. You can choose to deploy all AXSPI Content features or AXSPI Web Parts only. Refer to Chapter 2, Preparing for Deployment for more information. EMC ApplicationXtender SPI Deployment Guide 9

10 Introduction Table 1. AXSPI Content Features This feature... ApplicationXtender SPI Archiving ApplicationXtender SPI External Content Management Lists ApplicationXtender SPI External Content Management Web Parts ApplicationXtender SPI Session Management Enables SharePoint administrators to... Create rule-based, scheduled archival of SharePoint content into an ECM repository. In addition, SharePoint administrators can enable manual archiving according to rules or based on user input, which gives individual SharePoint users the ability to select ECM destinations from any SharePoint list. Refer to Archiving SharePoint documents to ApplicationXtender, page 29 for more information. Create new lists based on queries from an ECM system. These lists, which are associated with a given query, can be configured to synchronize with the results of that query on demand, on a schedule, or both. ECM lists are full-fledged SharePoint lists, so any operations that can be performed on native SharePoint lists can also be applied to imported ECM data. Refer to Using custom ECM lists, page 30 for more information. Create Web Parts that allow SharePoint portals to access data in an ECM system. Web Parts allow users to perform tasks that are impractical for ECM lists, for example, frequent, varied, open-ended queries and queries that result in thousands of results from the ECM system. AXSPI provides two Web Parts that can be hosted in a SharePoint site: Query and Result Set. These custom Web Parts are available for use on any Web Part page. Note: Unlike ECM list objects, ECM content that is available using Web Parts cannot be used interchangeably with native SharePoint content. Refer to Using ECM Web Parts, page 31 for more information. Allow users to log in or out of external systems such as ApplicationXtender. 10 EMC ApplicationXtender SPI Deployment Guide

11 Chapter 2 Preparing for Deployment Preparing for deployment of the AXSPI software solution includes the following tasks: Downloading the AXSPI solution, page 11 Adding the AXSPI solution to the SharePoint solution store, page 12 The procedures in this chapter assume that you have already installed and configured an ApplicationXtender release 5.40 SP1 or higher system. In addition, you must have installed and configured SharePoint Server 2007, including the required third-party components specified in the EMC ApplicationXtender SPI Release Notes. Downloading the AXSPI solution After you have set up your SharePoint environment, you are ready to download the SharePoint Solution Package for AXSPI. AXSPI provides standard SharePoint solution files for deployment. Download the appropriate set of solution files, based on the AXSPI features you plan to deploy: ApplicationXtender SPI This solution deploys all available AXSPI features: Archiving, External Content Management Lists, and External Content Management Web Parts. It consists of the following solution files: AXSPI.Administration.wsp Administration package, which must be deployed to the SharePoint Central Administration Web application on the Web farm root server AXSPI.wsp Site Content package, which must be deployed to a SharePoint content Web application on one or more front-end Web servers ApplicationXtender Web Parts This solution deploys the AXSPI External Content Management Web Parts. It consists of the following solution files: AXSPI.Administration.wsp Administration package, which must be deployed to the SharePoint Central Administration Web application on the Web farm root server AXSPI.Webpart.wsp Web Part package, which must be deployed to a SharePoint content Web application on one or more front-end Web servers EMC ApplicationXtender SPI Deployment Guide 11

12 Preparing for Deployment Obtain the AXSPI solution from one of the following sources: Download the solution files from the EMC download center at to a temporary directory on your SharePoint server. If you installed SharePoint in a Web server farm environment, EMC recommends that you download the AXSPI solution to the Web farm root server. Insert the AXSPI software media into your media drive. Adding the AXSPI solution to the SharePoint solution store After downloading the AXSPI solution files, add them to the SharePoint solution store. Solution files must reside in the store before they can be deployed. You can add the AXSPI solution to SharePoint in one of two ways: using the SharePoint Stsadm command-line utility described in this section, or using the AXSPI AddSolution command script. The AddSolution script deploys and activates the AXSPI solution after adding it to SharePoint. Refer to Appendix A, AXSPI Scripts for more information. To add the AXSPI solution to the SharePoint solution store using Stsadm: 1. Log on to your SharePoint server as SharePoint administrator. 2. Open a command prompt and navigate to the location of the downloaded AXSPI solution files. 3. Type the following command to add the AXSPI Administration solution to SharePoint: stsadm -o addsolution -filename <wsp_filename> where <wsp_filename> is AXSPI.Administration.wsp. 4. Repeat step 3 to add the AXSPI Content solution to SharePoint, replacing the <wsp_filename> variable with AXSPI.wsp if you are deploying all AXSPI features or AXSPI.Webpart.wsp if you are deploying only the AXSPI Web Parts. 5. Navigate to the Solution Management page on your Central Administration site and confirm that it displays the AXSPI solution files. Figure 1, page 12 shows an example of the Solution Management page that displays if you are deploying the full feature set for AXSPI. Figure 1. Solution Management Page: AXSPI Solutions (full feature set) 12 EMC ApplicationXtender SPI Deployment Guide

13 Preparing for Deployment 6. Proceed to Chapter 3, Deploying AXSPI to deploy the AXSPI solution files. EMC ApplicationXtender SPI Deployment Guide 13

14 Preparing for Deployment 14 EMC ApplicationXtender SPI Deployment Guide

15 Deploying AXSPI Chapter 3 After you have added the AXSPI solution files to the SharePoint solution store, you are ready to deploy the solutions. You can deploy AXSPI in either a standalone environment or a Web farm environment. In a standalone environment, AXSPI files are deployed on a single computer. In a Web farm environment, AXSPI files are deployed on the master (root) Web server. The root server then deploys the software to all the front-end Web servers in your Web farm automatically provided the Windows SharePoint Services Timer service is running on the root server.the Web farm root server hosts the SharePoint Central Administration site. Note: You must be a SharePoint Web farm administrator to deploy the AXSPI package in a SharePoint Web farm environment. IMPORTANT: Ensure that you deploy the AXSPI solution files to the correct Web application. Otherwise, users will be unable to access the AXSPI content. The AXSPI administration package must be deployed to the Central Administration Web application and the AXSPI Content package must be deployed to the front-end Web application. Deploying the AXSPI solution files The following procedures assume that you have already created a SharePoint Web application and one or more SharePoint sites for your ApplicationXtender content. Ensure that you create the content site from the SharePoint Central Administration site. To deploy the AXSPI solution files: 1. Log on to your SharePoint server as SharePoint Site Administrator. 2. From the SharePoint Central Administration page, navigate to the Solution Management page. 3. Select the link for the AXSPI Administration package (AXSPI.Administration.wsp). The Solution Properties page shown in Figure 2, page 16 appears. EMC ApplicationXtender SPI Deployment Guide 15

16 Deploying AXSPI Figure 2. Solution Properties Page 4. Click Deploy Solution. The Deploy Solution page shown in Figure 3, page 16 appears. Figure 3. Deploy Solution Page 16 EMC ApplicationXtender SPI Deployment Guide

17 Deploying AXSPI 5. On the Deploy Solution page, do the following: a. Specify when you want to deploy the solution. b. Select the Web application for the SharePoint Central Administration site. Note: The AXSPI Administration package must be deployed to the SharePoint Central Administration site on the Web farm root server. c. Click OK. 6. Repeat the steps above to deploy the Site Content package for the AXSPI features you are deploying (either AXSPI.wsp or AXSPI.Webpart.wsp), ensuring that you select the Web application for the SharePoint Content site in step 5b rather than the SharePoint Central Administration site. 7. Restart IIS. 8. Verify the deployment using the procedures in Verifying the deployment, page 17. Verifying the deployment If you deployed the AXSPI solutions successfully, the SharePoint Solution Management page displays the AXSPI solution files with a status of Deployed. This page also shows the Web application to which you deployed each solution file. Figure 4, page 18 shows an example of the Solution Management page for a full feature deployment. EMC ApplicationXtender SPI Deployment Guide 17

18 Deploying AXSPI Figure 4. Solution Management Page: Deployed AXSPI Solutions (full feature set) 18 EMC ApplicationXtender SPI Deployment Guide

19 Activating AXSPI Features Chapter 4 After deploying the AXSPI solution files to your SharePoint sites, activate the AXSPI features for each SharePoint site that requires ApplicationXtender functionality. Note: If Windows 2008 is installed on the server where you deployed the AXSPI features and User Access Control (UAC) is enabled, activate the AXSPI features using the Microsoft Stsadm utility rather than the SharePoint Central Administration page. Otherwise, errors may occur. Refer to the website for Microsoft Windows SharePoint Services for procedures. IMPORTANT: Ensure that you activate the AXSPI features on the correct site. The AXSPI Administration features must be activated on the SharePoint Central Administration site and the AXSPI Content features must be activated on the SharePoint content site(s). Activating AXSPI Administration features Perform the following procedures to activate the AXSPI Administration features. To activate the Administration features: 1. Log on to your SharePoint server as SharePoint Site Administrator. 2. From the SharePoint Central Administration page, navigate to Operations > Global Configuration > Manage farm features. 3. On the Manage Farm Features page, click Activate for the ApplicationXtender SPI Administration and ApplicationXtender SPI Logging features. The status of each feature changes to Active, as shown in Figure 5, page 20. EMC ApplicationXtender SPI Deployment Guide 19

20 Activating AXSPI Features Figure 5. Manage Farm Features Page Verifying the activation of Administration features If you activated the AXSPI Administration features successfully, the Application Management page on the SharePoint Central Administration site displays a new category for ApplicationXtender with two links, External Content Management Connectors and Version Information, as shown in Figure 6, page EMC ApplicationXtender SPI Deployment Guide

21 Activating AXSPI Features Figure 6. Successful Activation: AXSPI Administration Features You can use the Version Information link to review version information for all AXSPI assemblies installed on the server, as shown in Figure 7, page 22. EMC ApplicationXtender SPI Deployment Guide 21

22 Activating AXSPI Features Figure 7. Version Information Page Activating AXSPI Content features Activating the AXSPI Content features makes them available to SharePoint users. The features available for activation depend on whether you chose to deploy all AXSPI Content features or AXSPI Web Parts only. Refer to Table 1, page 10 for a description of all AXSPI features provided in this release. Perform the following procedures to activate the AXSPI Content features. To activate AXSPI Content features: 1. From the SharePoint content site, navigate to Site Actions > Site Settings > Site Administration > Site features. 2. On the Site Features page, click Activate for each AXSPI feature that you want to activate. The status of each selected feature changes to Active. Figure 8, page 23 shows an example of the Site Features page following deployment and activation of the full set of AXSPI Content features. Note: For AXSPI Web Part-only deployments, only the ApplicationXtender SPI External Content Management Web Parts and ApplicationXtender SPI Session Management features are displayed on the Site Features page following deployment. 22 EMC ApplicationXtender SPI Deployment Guide

23 Activating AXSPI Features Figure 8. Site Features Page: SharePoint Content Site (full feature set) 3. Verify the activation using the procedures in Verifying the activation of Content features, page 23. Verifying the activation of Content features If you successfully activated the full set of AXSPI Content features, the Site Settings page on the content site displays a new category for ApplicationXtender with the following links: Archiving Schedules Archiving Rules Version Information Content Type Associations Figure 9, page 24 shows an example of a successful activation. EMC ApplicationXtender SPI Deployment Guide 23

24 Activating AXSPI Features Figure 9. Successful Activation: AXSPI Content Features (full feature set) Note: For AXSPI Web Part-only deployments, only the Version Information link is displayed on the Site Settings page following a successful activation. The next step is to configure a connection between SharePoint and your ECM system (in this case, ApplicationXtender) using the procedures in Chapter 5, Configuring a Connector. 24 EMC ApplicationXtender SPI Deployment Guide

25 Configuring a Connector Chapter 5 After you have downloaded, deployed, and activated the AXSPI features, you need to create and configure an External Content Management connector. A connector specifies how your SharePoint content Web application should connect to the ECM system, in this case, ApplicationXtender. The help link on the External Content Management Connectors page provides a more detailed description of a connector including its purpose and how to create multiple connectors. To create an External Content Management connector for ApplicationXtender: 1. Log on to your SharePoint server as SharePoint Site Administrator. 2. From the SharePoint Central Administration page, select Application Management. The Application Management page shown in Figure 10, page 25 appears. Figure 10. Application Management Page EMC ApplicationXtender SPI Deployment Guide 25

26 Configuring a Connector 3. Under the ApplicationXtender category, click the External Content Management Connectors link. The External Content Management Connectors page shown in Figure 11, page 26 appears. Figure 11. External Content Management Connectors Page 4. Click New Connector. The New Connector page shown in Figure 12, page 26 appears. Figure 12. New Connector Page 5. Configure your new connector using the AXSPI online help. IMPORTANT: Ensure that you select the Web application you created for your AXSPI content. 26 EMC ApplicationXtender SPI Deployment Guide

27 Configuring a Connector 6. Perform additional configuration steps using the procedures in Chapter 6, Next Steps. EMC ApplicationXtender SPI Deployment Guide 27

28 Configuring a Connector 28 EMC ApplicationXtender SPI Deployment Guide

29 Chapter 6 Next Steps After downloading and deploying AXSPI, activating the desired features, and configuring a connector, the next steps depend on which AXSPI functionality you want to implement. Proceed to the appropriate section: Archiving SharePoint documents to ApplicationXtender, page 29 Using custom ECM lists, page 30 Using ECM Web Parts, page 31 Archiving SharePoint documents to ApplicationXtender AXSPI provides an archiving feature that allows users to archive documents in a SharePoint document library to the ApplicationXtender repository. Document metadata is stored in the ApplicationXtender repository while the document files are copied or moved to EMC Centera, EMC DiskXtender (DX), or other designated storage device based on the configuration of the target content type in ApplicationXtender. Refer to the EMC ApplicationXtender Core Components Administrator s Guide for information on configuring a document storage server for ApplicationXtender content types. You can allow users to archive SharePoint documents to ApplicationXtender manually or you can set up automatic archiving for the document library. Setting up automatic archiving requires that you configure the following: Content type associations, which specify what to archive Each metadata field in a document can be mapped to one or more ApplicationXtender index fields (a one-to-many relationship). Archiving rules, which specify how to archive Because a SharePoint document library can contain multiple content types, you can define multiple sets of archiving rules for each document library. Archiving schedules, which specify when to archive The Windows SharePoint Service Timer service archives SharePoint documents to ApplicationXtender based on the associations, rules, and schedules you define. Note: EMC recommends that you set up a dedicated user account for this service to perform automatic archive jobs. EMC ApplicationXtender SPI Deployment Guide 29

30 Next Steps Perform these tasks using the options displayed in Figure 13, page 30. Figure 13. Site Settings Page Refer to the AXSPI online help for additional information on archiving SharePoint documents. Using custom ECM lists A SharePoint list allows users to perform a standard set of functions on a set of documents. AXSPI provides an External Content Management List feature that allows SharePoint administrators to create a custom ECM list. This list allows users to access ApplicationXtender content through the SharePoint user interface. Users can perform all the same document functions in ApplicationXtender custom lists as they can in standard SharePoint lists, including using SharePoint business process and workflow functionality. A custom ECM list contains standard SharePoint features plus additional options for ApplicationXtender. Each custom ECM list is associated with a specific ApplicationXtender store, content type, and public query. As a result, the list s content represents the results of a specific query in ApplicationXtender. You can specify how and when you want to synchronize the custom ECM list with the ApplicationXtender content. You create a custom ECM list by navigating to Lists > Create > External Content Management List from your content site. Specify ApplicationXtender options such as the connector you created in Chapter 5, Configuring a Connector, store, content type, query, and login for the ECM list. Refer to the AXSPI online help for additional information on creating and customizing ECM lists. 30 EMC ApplicationXtender SPI Deployment Guide

31 Next Steps Using ECM Web Parts You can allow users to access ApplicationXtender content using ECM Web Parts. A Web Part is an ASP.NET server control that is added to a Web Part zone on a Web Part page. AXSPI provides two types of ECM Web Parts, query and result set, which enable SharePoint portals to see a view of ECM content embedded within a SharePoint portal page. These Web Parts, which are installed to the SharePoint site automatically when you deploy AXSPI, are hosted in standard SharePoint Web Part pages. They are available for use on any Web Part page immediately following deployment, activation, and configuration of an ECM connector. Figure 14, page 31 displays the Web Parts provided by AXSPI. Figure 14. AXSPI Web Parts Note: Data displayed using Web Parts cannot be used with other SharePoint features, for example, Business Process Management (BPM). After you have created a Web Part page on your AXSPI content site to host the ECM Web Parts, do the following: Add the ECM query and result set Web Parts to the Web Part page (Site Actions > Edit Page > Add a Web Part) Connect the query and result set Web Parts Configure the ECM Web Parts, including the External Content Management connector, store, and content type EMC ApplicationXtender SPI Deployment Guide 31

32 Next Steps Refer to the AXSPI online help for additional information on customizing ECM Web Parts. 32 EMC ApplicationXtender SPI Deployment Guide

33 Removing AXSPI Chapter 7 If you no longer require AXSPI functionality, you can remove the AXSPI solutions from your SharePoint sites. Removal includes deactivating, retracting, and removing the AXSPI solution files. You can remove AXSPI manually using the procedures in this section or in a single step using the AXSPI CleanUp command script. Refer to Appendix A, AXSPI Scripts for more information. To remove AXSPI manually: 1. From the SharePoint content site, deactivate the AXSPI Content features using the SharePoint Site Features page. This step deactivates the AXSPI Content features on all Web applications. Note: Deactivating features does not remove them from the Site Features page. 2. From the SharePoint Central Administration site, do the following: a. Deactivate the AXSPI admin features using the SharePoint Manage Farm Features page. b. Retract the AXSPI solutions using the Retract Solution option on the Solution Properties page. This step removes the AXSPI features from the Site Features page of the content Web application on the front-end Web servers. c. Remove the AXSPI solution (.wsp files) from the SharePoint solution store using the Remove Solution option on the Solution Properties page. EMC ApplicationXtender SPI Deployment Guide 33

34 Removing AXSPI 34 EMC ApplicationXtender SPI Deployment Guide

35 Appendix A AXSPI Scripts AXSPI provides two command scripts that can streamline the process of integrating AXSPI solutions with SharePoint: AddSolution Adds, deploys, and activates AXSPI solutions CleanUp Deactivates, retracts, and removes AXSPI solutions Run these commands on your SharePoint server as either SharePoint administrator or SharePoint farm administrator. Open a command prompt and navigate to the location of the downloaded AXSPI solution files. AddSolution Run the AddSolution.cmd file as follows: AddSolution.cmd <adminurl> <axspiurl> where <adminurl> is the URL of the Central Administration site to which you want to deploy the AXSPI Administration solution and <axspiurl> is the URL of the Content site to which you want to deploy the AXSPI Content solution. For example: AddSolution.cmd The AddSolution script automatically detects which AXSPI solution files you downloaded. The script displays detailed output as it adds, deploys, and activates the AXSPI solutions. The script also stops and restarts IIS, where necessary. CleanUp Run the CleanUp.cmd file as follows: CleanUp.cmd <adminurl> <axspiurl> where <adminurl> is the URL of the Central Administration site from which you want to remove the AXSPI Administration solution and <axspiurl> is the URL of the Content site from which you want to remove the AXSPI Content solution. For example: CleanUp.cmd EMC ApplicationXtender SPI Deployment Guide 35

36 AXSPI Scripts The CleanUp script automatically detects which AXSPI solution files you previously downloaded. The script displays detailed output as it deactivates, retracts, and removes the AXSPI solutions. The script also stops and restarts IIS, where necessary. 36 EMC ApplicationXtender SPI Deployment Guide