MarkLogic 9 Product Documentation

Connector for SharePoint^® Administrator's Guide — Chapter 2

Configuring the MarkLogic Connector for Windows SharePoint Services 3.0

To configure Windows SharePoint Services 3.0, perform the following steps.

1. Deploy the MarkLogic Connector for SharePoint solution from the SharePoint 3.0 Central Administration tool as follows:
   • Launch the SharePoint Central Administration tool (for example, Start Menu > All Programs > Administrative Tools > SharePoint 3.0 Central Administration).
   • Click the Operations tab.
   • Click Solution management in the Global Configuration section.
   • You should see marklogicconnector.wsp in the name column. Click this name.
   • On the Solution Properties page click Deploy Solution.
   • On the Deploy Solution page set Deploy When? to Now. Click OK to deploy the solution.

     The page should revert to the Solution Management page with the marklogicconnector.wsp Status set to Deployed.

2. Activate the feature as follows:
   • Log in to the SharePoint Team Site. Typically, this is running on port 80 of the machine in which SharePoint is running (for example, ).
   • Click the Site Actions menu and select Site Settings.
   • On the Site Settings page, click Site features (under the Site Administration column).
   • On the Site Features page, click the Activate button for Mark Logic Connector.

     The status of the Mark Logic Connector will change to Active.

3. Configure the MarkLogic connection as follows:
   • In the SharePoint Team Site, click the Site Actions menu and select MarkLogic Connector Settings. [2010: MarkLogic Server Settings]
   • Enter the hostname and port number of the MarkLogic Server XDBC App Server you created in Installing and Configuring MarkLogic Server to Use the Connector, as well as the username and password credentials for MarkLogic Server. The database field is optional.
   • Click the Configure button. You will see a message similar to the following when the configuration is correct:

     Status: Server xcc://user:pass@host:123/sharepoint has been configured.
     Version: 1.1-1 

4. Test the connection information by clicking the Test Connection button. If the test succeeds then the MarkLogic Connector for SharePoint is communicating successfully with MarkLogic Server. If it fails, go back and repeat the previous steps.
5. Configure document mirroring as follows:
   • The document libraries in your site will be shown as a tree view with checkboxes. Check the libraries which should be mirrored to MarkLogic server. All documents and folders in the library will be mirrored.
   • Click the Push to Server button.
   • Use the Refresh button to refresh the display.
   • If you want to remove the mirrored documents, use the Reset Server button to remove all mirrored documents from this SharePoint site.

The MarkLogic Connector for SharePoint is now ready, and any SharePoint documents or document libraries that you have set up for mirroring are automatically mirrored in MarkLogic Server.

If you mirror a directory containing many documents, enable document mirroring for your document library after saving your docs to the document library to SharePoint. This is to improve the performance of load times. If you attempt to save a large number of docs to a document library with mirroring already enabled, the load will be slow.

Configuring the MarkLogic Connector for SharePoint Foundation 2010

To configure SharePoint Foundation 2010, perform the following steps.

1. Deploy the MarkLogic Connector for SharePoint solution from the SharePoint 2010 Central Administration tool as follows:
   • Launch the SharePoint Central Administration tool (for example, Start Menu > All Programs > Microsoft Sharepoint 2010 Products > SharePoint 2010 Central Administration).
   • Click System Settings in the left-hand menu.
   • In the Farm Management section, click Manage farm solutions.
   • You should see marklogicconnector.wsp in the name column. Click this name.
   • On the Solution Properties page click Deploy Solution.
   • On the Deploy Solution page set Deploy When? to Now. Click OK to deploy the solution.

     The page should revert to the Solution Management page with the marklogicconnector.wsp Status set to Deployed.

2. Activate the feature as follows:
   • Log in to the SharePoint Team Site. Typically, this is running on port 80 of the machine in which SharePoint is running (for example, ).
   • Click the Site Actions menu in the upper left of the page and select Site Settings.
   • On the Site Settings page, under Site Actions, click Manage site features.
   • On the Site Features page, click the Activate button for Mark Logic Connector.

     The status of the Mark Logic Connector will change to Active.

3. Configure the MarkLogic connection as follows:
   • In the SharePoint Team Site, click the Site Actions menu and select MarkLogic Server Settings.
   • Enter the hostname and port number of the MarkLogic Server XDBC App Server you created in Installing and Configuring MarkLogic Server to Use the Connector, as well as the username and password credentials for MarkLogic Server. The database field is optional.
   • Click the Configure button. You will see a message similar to the following when the configuration is correct:

     Status: Server xcc://user:pass@host:123/sharepoint has been configured.
     Version: 1.1-1 

4. Test the connection information by clicking the Test Connection button. If the test succeeds then the MarkLogic Connector for SharePoint is communicating successfully with MarkLogic Server. If it fails, go back and repeat the previous steps.
5. Configure document mirroring as follows:
   • The document libraries in your site will be shown as a tree view with checkboxes. Check the libraries which should be mirrored to MarkLogic server. All documents and folders in the library will be mirrored.
   • Click the Push to Server button.
   • Use the Refresh button to refresh the display.
   • If you want to remove the mirrored documents, use the Reset Server button to remove all mirrored documents from this SharePoint site.

The MarkLogic Connector for SharePoint is now ready, and any SharePoint documents or document libraries that you have set up for mirroring are automatically mirrored in MarkLogic Server.

If you mirror a directory containing many documents, enable document mirroring for your document library after saving your docs to the document library to SharePoint. This is to improve the performance of load times. If you attempt to save a large number of docs to a document library with mirroring already enabled, the load will be slow.

Uninstalling the MarkLogic Connector for Windows SharePoint Services 3.0

Perform the following steps to uninstall the MarkLogic Connector for SharePoint from your Microsoft SharePoint Services 3.0 installation. You need administrative privileges to SharePoint to perform these steps.

1. Deactivate the feature as follows:
   • Log in to the SharePoint Team Site. Typically, this is running on port 80 of the machine in which SharePoint is running (for example, ).
   • Click the Site Actions menu and select Site Settings.
   • On the Site Settings page, click Site features (under the Site Administration column).
   • On the Site Features page, click the Deactivate button for Mark Logic Connector.

     The Active status box next to Mark Logic Connector will disappear.

2. Launch the SharePoint 3.0 Central Administration tool. Typically, you can do this from the Start Menu > All Programs > Administrative Tools > SharePoint 3.0 Central Administration. If you know the machine name and port number, you can also access the Central Administration panel from any browser that has access to your network.
3. Click the Operations tab.
4. Click on Solution Management in the Global Configuration section.
5. Retract and remove the MarkLogicConnector solution by clicking the marklogicconnector.wsp link.
6. On the Solutions Properties page, click Retract Solution.
7. On the Retract Solution Page, click OK. The page will return to the Solution Management page.
8. Refresh the Solution Management page until marklogicconnector.wsp shows a status of Not Deployed.
9. Click the link again and click Remove Solution.

The solution is now uninstalled from SharePoint.

Uninstalling the MarkLogic Connector for SharePoint Foundation 2010

Perform the following steps to uninstall the MarkLogic Connector for SharePoint from your SharePoint Foundation 2010 installation. You need administrative privileges to SharePoint to perform these steps.

1. Deactivate the feature as follows:
   • Log in to the SharePoint Team Site. Typically, this is running on port 80 of the machine in which SharePoint is running (for example, ).
   • Click the Site Actions menu in the upper left of the page and select Site Settings.
   • On the Site Settings page, under Site Actions, click Manage site features.
   • On the Site Features page, click the Deactivate button for Mark Logic Connector.

     The Active status box next to Mark Logic Connector will disappear.

2. Launch the SharePoint Central Administration tool (for example, Start Menu > All Programs > Microsoft Sharepoint 2010 Products > SharePoint 2010 Central Administration).
3. Click System Settings in the left-hand menu.
4. In the Farm Management section, click Manage farm solutions.
5. You should see marklogicconnector.wsp in the name column. Click this name.
6. On the Solutions Properties page, click Retract Solution.
7. On the Retract Solution Page, click OK. The page will return to the Solution Management page.
8. Refresh the Solution Management page until marklogicconnector.wsp shows a status of Not Deployed.
9. Click the link again and click Remove Solution.

The solution is now uninstalled from SharePoint.