Install the Microsoft SharePoint Connector

Before you install the Microsoft SharePoint Connector Version 3.0, download, install, and configure the following applications on the SharePoint server:
ccppmop143
Before you install the Microsoft SharePoint Connector Version 3.0, download, install, and configure the following applications on the SharePoint server:
  • Microsoft Windows SharePoint 2013
  • A version of 
    Clarity Project and Portfolio Management (PPM)
     that is certified for the add-in Version 3.0.  
Microsoft SharePoint Connector Version 3.0 supports only SharePoint 2013 and does not support SharePoint 2007 or 2010.
  • Microsoft SharePoint 2013 with Microsoft SharePoint Connector Version 3.0 supports 
    Clarity Project and Portfolio Management (PPM)
     Release 13.3 or higher.
  • Microsoft SharePoint 2010 with Microsoft SharePoint Connector Service Pack 2.0.2 supports 
    Clarity Project and Portfolio Management (PPM)
     Release 13.2 and 
    Clarity Project and Portfolio Management (PPM)
     Release 13.3.
See the 
Microsoft SharePoint Connector Release Notes
 for a list of certified 
Clarity Project and Portfolio Management (PPM)
 versions.
SharePoint users are also
Clarity Project and Portfolio Management (PPM)
users. Users have to log in again when they use the Link to Clarity feature provided in List Web Parts. To avoid this behavior, enable single sign-on (SSO) in supported configurations.
2
Microsoft SharePoint Connector Supported Environments
The Microsoft SharePoint Connector for SharePoint supports only the approved version of Microsoft SharePoint. Any software and hardware configurations of servers and client computers depend upon the software and hardware requirements for Microsoft Windows SharePoint Services.
Install the Microsoft SharePoint Connector
You can install the Microsoft SharePoint Connector on a stand-alone Microsoft SharePoint server or in a multi-server Microsoft SharePoint implementation.
Follow these steps:
Install the Microsoft SharePoint Connector Add-in
Install the Microsoft SharePoint Connector on the server on which you installed Microsoft Windows SharePoint Services. The installation process creates a log file, spconn_install.log, in the server's %temp% directory. Check this log file for any errors that you may encounter during the Microsoft SharePoint Connector installation.
In a multi-server Microsoft SharePoint implementation, install Microsoft SharePoint Connector on the primary Microsoft Windows SharePoint server. This server is the server on which you first installed and configured Microsoft Windows SharePoint Services.
Follow these steps:
  1. Double-click CA Clarity Microsoft SP2013 Connector Setup.exe.
  2. Accept the license agreement to open the 
    Installation Wizard
    .
  3. On the Introduction screen, click Install, and click Next.
  4. If the wizard prompts for SharePoint Services Administration service, perform the following steps:
    1. Click Start, Administrative Tools, and Services.
    2. Start the following services:
      1. SharePoint 2013 Administration
      2. SharePoint 2013 Timer
  5. Select all the web applications or site collections where the connector needs to be installed and click Next.
  6. After the installation process is complete, click Close.
    The Microsoft SharePoint Connector is installed and deployed on the Microsoft SharePoint server.
: Your SharePoint server can communicate with your
Clarity Project and Portfolio Management (PPM)
server. However,
Clarity Project and Portfolio Management (PPM)
cannot communicate with your SharePoint server if it is behind your corporate firewall. If necessary, contact your network administrator to configure access to SharePoint at your site.
Activate the 
Clarity Project and Portfolio Management (PPM)
 Project Site Feature
After you install the Microsoft SharePoint Connector, activate the Create 
Clarity Project and Portfolio Management (PPM)
 Project Site feature from Microsoft SharePoint Central Administration. When activated, a new section, 
Clarity Project and Portfolio Management (PPM)
 Site Management, is created on the Application Management page in Microsoft SharePoint Central Administration. This section contains the Create 
Clarity Project and Portfolio Management (PPM)
 Project Site feature, which you can use to create 
Clarity Project and Portfolio Management (PPM)
 project sites.
Follow these steps:
  1. Perform the following steps to create the site collections:
    1. Navigate to Central Administration, Application Management, Create site collections.
      The Create Site Collection page appears.
    2. In the Web Application section, click Change Web Application, and then select the web application in which you want to create the site collection.
    3. In the Title and Description section, type the title and description for the site collection.
    4. In the Web Site Address section, select the path to use for your URL (for example, a wildcard inclusion path such as /sites/, or the root directory (/).
      If you select a wildcard inclusion path, you must also type the site name to use in your site's URL.
    5. In the Template Selection section, in the Select experience version list, select 2013 as the SharePoint experience version of the templates.
    6. In the Template Selection section, in the Select a template list, select the CA Clarity tab, then CA Clarity Project Site template.
    7. In the Primary Site Collection Administrator section, type the user name (in the form DOMAIN\username) for the user who will be the site collection administrator.
  2. Perform the following steps to activate the 
    Clarity Project and Portfolio Management (PPM)
     project site feature:
    1. Navigate to Central Administration, Site settings.
    2. On the Site Settings page, under Site Actions, click Manage site features.
    3. Click Activate next to all the 
      Clarity Project and Portfolio Management (PPM)
      features.
Activate 
Clarity Project and Portfolio Management (PPM)
 Web Parts
Activate the 
Clarity Project and Portfolio Management (PPM)
 Web Parts from Microsoft SharePoint's top-level site of each site collection where you want to use these Web Parts. Activating the 
Clarity Project and Portfolio Management (PPM)
 Web Parts adds the Web Parts to the Web Part Gallery of the site collection.
If you have multiple site collections under a SharePoint Web application and if you want the Web Part Galleries of all the site collections to contain the 
Clarity Project and Portfolio Management (PPM)
 Web Part, activate the Web Parts in all site collections.
 We recommend that you activate the 
Clarity Project and Portfolio Management (PPM)
 Web Parts from the Site Collection Features page, and not from the Web Part Gallery of the site collection.
 
Follow these steps:
  1. Log in to Microsoft SharePoint.
  2. Click the Settings icon and click Site settings.
  3. In the Site Collection Administration section, click Site collections features.
  4. Click Activate for the following web parts and add them to the Web Part Gallery of the site collection:
    • Against CA Clarity PPM Site Chart
    • Against CA Clarity PPM Site List
    • Against CA Clarity Document Objects
    • Against CA Clarity Objects
    • Against CA Clarity Task Objects
    • Against CA Clarity PPM ListSite Menus
  5. Browse to the SharePoint site that contains the Web Part or parts you edit.
  6. Select CA PPM Binding and provide the 
    Clarity Project and Portfolio Management (PPM)
     Server URL, Username, Password, and Project ID and click OK.
  7. On the SharePoint Ribbon, select the Page tab.
  8. Select Edit.
  9. In the Categories section, select the Custom Web Part.
  10. Select the web part, for example CAClarityPPMChart.
  11. From the Web Part tab in the Ribbon, click Edit Web Part from the drop-down arrow.
  12. To save your work and return to the normal page view, select the Page tab in the Ribbon, and then click Save.
  13. Verify that you can view 
    Clarity Project and Portfolio Management (PPM)
     Project Related data.
Uninstall the Microsoft SharePoint Connector
After you uninstall the Microsoft SharePoint Connector, you cannot access the 
Clarity Project and Portfolio Management (PPM)
 project sites that you created, or cannot use the 
Clarity Project and Portfolio Management (PPM)
 Web Parts that you added. If you intend to use the SharePoint Connector, reinstall the Microsoft SharePoint Connector and reactivate the 
Clarity Project and Portfolio Management (PPM)
 Project Site feature and the 
Clarity Project and Portfolio Management (PPM)
 Web Parts.
There are four procedures to uninstall the Microsoft SharePoint Connector add-in:
Deactivate 
Clarity Project and Portfolio Management (PPM)
 Project Site Feature
Deactivation reverses the deployment of assemblies in the 
Clarity Project and Portfolio Management (PPM)
Project Site Feature. Deactivate the 
Clarity Project and Portfolio Management (PPM)
 Project Site Features and the 
Clarity Project and Portfolio Management (PPM)
 Web Parts.
Follow these steps:
  1. Log in to Microsoft SharePoint.
  2. Click the Settings icon and click Site settings.
  3. Click Site collections features in the Site Collection Administration section.
  4. Click Deactivate against 
    Clarity Project and Portfolio Management (PPM)
     Site Management.
    The Site Management feature is deactivated.
Deactivate 
Clarity Project and Portfolio Management (PPM)
 Web Parts
Follow these steps:
  1. Log in to Microsoft SharePoint.
  2. Click the Settings icon and click Site settings.
  3. Click Site collections features in the Site Collection Administration section.
  4. Click Deactivate the following Web Parts:
    • Against CA Clarity PPM Chart
    • Against CA Clarity PPM List
The 
Clarity Project and Portfolio Management (PPM)
 Web Parts are deactivated.
Retract and Remove the Microsoft SharePoint Connector from Microsoft SharePoint
Retracting reverses the deployment of the Microsoft SharePoint Connector components. Retracting a solution removes assemblies, files, resources, safe control entries, Features, and other solution components from computers to which they have been deployed. Removing deletes the Microsoft SharePoint Connector solution package from the solution store.
Follow these steps:
  1. Log in to Microsoft SharePoint.
  2. Navigate to Central Administration, System Settings, Farm Management, Manage farm solutions.
    The Solution Management page appears.
  3. Click CA_Clarity.project_site.wsp.
    The Solution Properties page appears.
  4. Click Retract Solution and perform the following:
    1. Verify the Solution Information.
    2. Specify when you want to retract the solution. Now or at a specified time.
    3. In the Choose a Web application to retract this solution field, select All content Web applications option.
  5. Click OK.
    The solution successfully retracts.
  6. Click Remove Solution.
Uninstall Microsoft SharePoint Connector from the Server
The uninstall process creates a log file, spconn_uninstall.log, in the server's %temp% directory. Check this log file for any errors that you may encounter while uninstalling the Microsoft SharePoint Connector from the server.
Follow these steps:
  1. Double-click CA Clarity Microsoft SP2013 Connector Setup.exe.
  2. Accept the license agreement to open the 
    Installation Wizard
    .
  3. Click Install and click Next twice.
  4. On the Program Maintenance page, select Remove, and click Next to begin the uninstall process.
  5. After the uninstall process is complete, click Finish.
    The Microsoft SharePoint Connector is uninstalled from the server.