Retrieve Data from SharePoint Online

To automatically retrieve content from SharePoint Online (part of Office 365), 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.

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 parameters necessary for authentication.

    • Micro Focus recommends that you configure OAuth authentication for both the SharePoint OData/REST API and the Microsoft Graph API. Using this approach prevents you having to configure authentication for each API separately. After running the OAuth tool as described in Configure OAuth Authentication, the parameters needed to authenticate can be found in a file named oauth.cfg. You can import these parameters into the task as follows:

      [MyTask] < "oauth.cfg" [OAUTH]

      For more information about including parameters from another file, see Include an External Configuration File.

    • If you prefer to use basic authentication for the SharePoint OData/REST API, set the following parameters.

      Username The user name for authentication with SharePoint. You can encrypt the user name before adding it to the configuration file.
      Password The password for authentication with SharePoint. Micro Focus recommends encrypting the password. For information about how to do this, see Encrypt Passwords.

      If you want to generate ACLs for mapped security, you still need to configure OAuth for the Microsoft Graph API. For more information, see Resolve SIDs into User and Group Names.

  2. Set the following parameters to configure the connection to SharePoint.

    SharepointOnline A Boolean that specifies whether you are retrieving data from a SharePoint Online shared server. To retrieve data from a SharePoint Online shared server, set this parameter to true. If you are retrieving data from a SharePoint Online dedicated server, set this parameter to false.
    SSLMethod The version of SSL/TLS to use to connect to SharePoint Online. To use the latest protocol supported by both client and server, set this parameter to NEGOTIATE.
    SharepointUrlType

    The type of URL to retrieve data from:

    • TenantAdmin - The URL of the primary SharePoint site collection. The connector then retrieves all site collections and sites.
    • SiteCollection - A site collection URL.
    • PersonalSiteCollection - A personal site collection URL.
    SharepointUrl Specify a URL that matches the type you set using SharepointUrlType.
    SharepointAdminUrl The URL of the admin site collection. If you want to retrieve user profiles from SharePoint Online, you must set this parameter.
    SharepointMySiteUrl The URL of the "MySites" site collection.
  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, refer to the SharePoint OData Connector Reference.
  4. Save and close the configuration file.