SharePoint OData Connector 25.3
SharePoint OData Connector Help

# Retrieve Data from SharePoint

To automatically retrieve content from SharePoint, create a new fetch task by following these steps. The connector runs each fetch task automatically, based on the schedule that is defined in the configuration file.

TIP: For SharePoint Online, see Retrieve Data from SharePoint Online.

To create a new Fetch Task

1. Stop the connector.
2. Open the configuration file in a text editor.

3. In the `[FetchTasks]` section of the configuration file, specify the number of fetch tasks using the `Number` parameter. If you are configuring the first fetch task, type `Number=1`. If one or more fetch tasks have already been configured, increase the value of the `Number` parameter by one (1). Below the `Number` parameter, specify the names of the fetch tasks, starting from zero (0). For example:

       [FetchTasks]
       Number=1
       0=MyTask

4. Below the `[FetchTasks]` section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

       [FetchTasks]
       Number=1
       0=MyTask

       [MyTask]

1. In the new section, set the following parameters. These parameters are required to connect to the SharePoint repository.

   `SharepointUrl` | The starting point for the `synchronize` action. You can specify either a web application URL or a site collection URL.
   `SharepointUrlType` | The type of URL specified by `SharepointUrl`: `WebApplication` `SiteCollection`

2. Set the configuration parameters necessary to authenticate with the SharePoint API:

   - To use Basic authentication, set Domain, Username, and Password.

   - To use NTLM authentication, set NTLMUsername and NTLMPassword.

   - To use Kerberos authentication, set EnableKerberos to `TRUE`, UseSpnego to `TRUE`, and if necessary configure GSSName and GSSPath. On Linux, you should also obtain a valid GSS API ticket.

     To obtain a GSS API ticket on Linux

     1. On a Windows server, generate a `.keytab` file for the domain user who you want to authenticate as. Run the following command, where `<user>` is the user name, `<domain>` is the domain, and `<password>` is the password.

        `ktpass -out <user>.keytab -princ <user>@<domain> -mapUser <user> -mapOp set -pass <password> -crypto all -ptype KRB5_NT_PRINCIPAL`
     2. Copy the `.keytab` file to the Linux server that hosts SharePoint OData Connector.

     3. Install the Kerberos client packages. For example, on CentOS:

        `sudo yum install krb5-workstation krb5-libs`

     4. Run `kinit`, using the `.keytab` file that you generated earlier.

        `kinit -k -t /home/<user>/<user>.keytab -c /home/<user>/krbcache <user>@<domain>`

     5. Set the `KRB5CCNAME` environment variable to the path of the Kerberos cache that you generated and start SharePoint OData Connector:

        `KRB5CCNAME=FILE:/home/<user>/krbcache ./sharepointodataconnector.exe`
3. (Optional) You can set additional configuration parameters to specify the information that you want to retrieve. For more information about the parameters that you can use, see Connector Configuration Parameters.
4. Save and close the configuration file.

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery SharePoint OData Connector 25.3

Topic Title: Retrieve Data from SharePoint