Loading TOC...
Connector for SharePoint® Administrator's Guide (PDF)

Connector for SharePoint® Administrator's Guide — Chapter 2

Installing the MarkLogic Connector for SharePoint

This chapter describes how to install the MarkLogic Connector for SharePoint. The MarkLogic Connector for SharePoint installation procedure involves installing the connector in SharePoint and installing some XQuery modules in an instance of MarkLogic Server. The following sections are included:

MarkLogic Connector for SharePoint Installation Package

You can download the latest MarkLogic Connector for SharePoint installation package from developer.marklogic.com. The installation package is a zip file containing the following:

  • XQuery files (in the Modules directory) to be installed on each instance of MarkLogic Server to which the MarkLogic Connector for SharePoint will communicate.
  • MarkLogic Connector for SharePoint feature solution package (.wsp file in the SharePoint directory).
  • SharePoint Developer's Kit assembly files (.dll files in the SharePoint directory).
  • MarkLogic Connector for SharePoint command-line utility (mlcadm.exe file in the SharePoint directory).
  • Sample SharePoint Workflows.

There are two main parts to the installation process: installing the MarkLogic Connector for SharePoint and copying the MarkLogic Server XQuery files to each instance of MarkLogic Server to which the connector will communicate. For information about system requirements, see System Requirements.

Installing the Connector in SharePoint

On the machine in which SharePoint is installed, perform the following steps. You need administrative privileges to SharePoint to perform these steps.

  1. Unpack the MarkLogicConnector.wsp file from the SharePoint directory of MarkLogic Connector for SharePoint zip file and store it in a known disk location.
  2. Verify you have SharePointSite Collection Administrator privilege. Without this you will not see the MarkLogic Connector menu when you are done. You can set the Site Collection Administrator in several places in SharePoint, including the following:
    • In the Central Administration tool > Application Management tab > Site Collection Administrators page.
    • In the top-level site in the Site Settings (Site Actions > Site Settings > Advanced permissions).

      For details, see your SharePoint documentation.

  3. If a previous version of the MarkLogic Connector for SharePoint is installed in SharePoint, uninstall it as described in Uninstalling the MarkLogic Connector for SharePoint from Microsoft SharePoint.
  4. Add the solution to SharePoint server. Open a command window as administrator (right click on Command Prompt and select Run as administrator). Assuming you have the SharePoint administration tool (stsadm.exe) on your search path, you can add the solution to SharePoint with the following command:
    C:\> stsadm -o addsolution -filename <path>\MarkLogicConnector.wsp

    where <path> is the path to the MarkLogicConnector.wsp file. The stsadm utility will respond with 'operation completed successfully' after a successful installation.

Installing the mlcadm.exe Utility

The release includes a command-line MarkLogic Connector for SharePoint utility called mlcadm.exe, distributed in the SharePoint folder of the zip installation package. This utility is optional. If you plan on using it, copy the mlcadm.exe file to a directory on your search path. For details about using this utility, see mlcadm Command Line Utility.

Installing and Configuring MarkLogic Server to Use the Connector

Perform the following steps to install the XQuery files used by the MarkLogic Connector for SharePoint on MarkLogic Server. These steps should be repeated for each node in your MarkLogic Server cluster that communicates with the MarkLogic Connector for SharePoint. In order to install the XQuery modules on the machine in which MarkLogic Server is installed, you will need permissions to write to the directory in which MarkLogic Server is installed.

  1. Make sure MarkLogic Server is installed. For details on installing MarkLogic Server, see the Installation Guide in the MarkLogic Server product documentation.
  2. Install the MarkLogic Connector for SharePoint in your Microsoft SharePoint environment, as described in Installing the Connector in SharePoint.
  3. Copy the SharePoint installation package to the machine(s) in which MarkLogic Server is installed and unzip it.
  4. In your MarkLogic Server installation(s), create a directory named SharePoint under marklogic-dir/Modules/MarkLogic, where marklogic-dir is the directory in which MarkLogic Server is installed. For example, on Linux systems, enter commands similar to the following:
    % cd /opt/MarkLogic/Modules/MarkLogic
    % mkdir SharePoint
  5. In your MarkLogic Server installation(s), copy the XQuery files from the MarkLogic Connector for SharePoint installation zip package into the Modules/MarkLogic/SharePoint directory in the MarkLogic Server installation directory. For example, on Linux systems, enter commands similar to the following (assuming the installation package is unzipped into the /tmp directory):
    % cd /tmp/SharePointConnector-1.1-1/Modules
    % cp *.xqy /opt/MarkLogic/Modules/MarkLogic/SharePoint

    The MarkLogic Connector for SharePoint XQuery modules should now be under the marklogic-dir/Modules/MarkLogic/SharePoint directory.

  6. In the Admin Interface in your MarkLogic Server installation, create an XDBC Server. Requests from the MarkLogic Connector for SharePoint will use this XDBC Server, and will mirror SharePoint documents in the database specified in the XDBC Server configuration. The XDBC Server must have a root corresponding to the directory in which you copied the XQuery modules. If you copied them as described above, then the XDBC Server root must be Modules/MarkLogic/SharePoint. Set authentication to basic.
  7. Note the hostname, port number for this XDBC Server, and the login credentials for MarkLogic Server, which you will need to access this XDBC Server from the MarkLogic Connector for SharePoint, as described in Configuring the MarkLogic Connector for SharePoint, Step 3.

    If you have a cluster of several MarkLogic Server instances, you only need to create the XDBC Server in one of them (because it will be available to every node in the group in which it is created).

You can now connect to this XDBC Server from the MarkLogic Connector for SharePoint.

Configuring the MarkLogic Connector for SharePoint

Once you have installed the connector components in Microsoft SharePoint and in MarkLogic Server, you must configure the MarkLogic Connector for SharePoint to point to your MarkLogic Server XDBC Server.

MarkLogic Connector for SharePoint operates with Windows SharePoint Services 3.0 and SharePoint Foundation 2010. The configuration procedure is slightly different for each version. The following sections describe the configuration procedure for both versions of SharePoint:

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 SharePoint from Microsoft SharePoint

MarkLogic Connector for SharePoint operates with Windows SharePoint Services 3.0 and SharePoint Foundation 2010. The uninstall procedure is slightly different for each version. The following sections describe the uninstall procedure for both versions of SharePoint:

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.

« Previous chapter
Next chapter »
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy