Skip to main content
Kinetic Community

Microsoft SharePoint Adapter

Overview

The Microsoft SharePoint Adapter is an adapter that is installed into Kinetic Bridgehub that allows access to data from the SharePoint platform, a web application platform developed by Microsoft, to be pulled back using bridging.

Installation

Note: Check to ensure that this adapter isn't already installed into your bridgehub as part of the base installation before undertaking the installation tasks.

  • Download the kinetic-bridges-adapter-sharepoint.jar file and it's dependencies here
  • Put all of the downloaded files into the WEB-INF/lib folder for you kinetic-bridgehub installation
  • Restart the tomcat that your kinetic-bridgehub installation is located in

Setup

Configuration Values

Name Description
Username SharePoint username (If necessary, include domain with username)
Password SharePoint password
Server Url Url for the SharePoint site that data will be retrieved from

Example Configuration

Name Value
Username joe.user
Password sharepass
Server Url https://sharepoint.company.com

Structures, Fields, and Queries

Structures

  • Lists

Fields

  • Most of the time the field names that will be used in the bridge are the same as the labels on the list page with spaces removed and the beginning of each word capitalized.
    • ie. Name = Name, Due Date = DueDate & my field = MyField
  • There are some exceptions to this rule though
    • Fields that are drop down lists will need to add "Value" onto the end of the field name
      • ie. Priority = PriorityValue & Status = StatusValue
    • Fields that contain a username will be returned as an Id value instead of the name, so you will need to add "Id" to the end of the field
      • ie. CreatedBy = CreatedById & ModifiedBy = ModifiedById
  • If these steps fail and you can not find how a field is mapped, you can also make a REST call to your SharePoint List Instance to figure out what all fields can be returned are.​
    • The Url will follow the form of {homepage_url}/_vti_bin/ListData.svc/{field_name}
      • ie. http://sharepoint.company.com/_vti_bin/ListData.svc/SharedDocuments
    • Depending on how your browser is configured you can either make the call directly as a Url or you can use an extension like the Postman for Chrome. 

Queries

The query structure for the SharePoint Bridge is based entirely on the SharePoint REST API. 

  • The only exception to this is that the beginning of the query always must contain the name of the list you are querying in the form of listName eq {list_name}. 
  • The SharePoint REST API supports OData query operations and a Microsoft tutorial on that can be found here.
    • Anything under the $filter category can be used for a query
    • Basic operators mappings are as follow    
      • eq       ==
      •  le       <=
      • ge       >=
      •  lt        <
      • gt        > 
      • ne       !=
    • Comparison appenders are
      • and
      • or
      • not
    • If you are referencing a string, make sure to surround it in single quotes
  • Sample Queries
    • ​Return all documents in Shared Documents
      • listName eq 'SharedDocuments'
    • Return all tasks that have a due date after 10/12/2013
      • listName eq 'Tasks' and DueDate ge datetime'2013-10-12'
    • Return only the active issues in an issue tracking list
      • listName eq 'IssueTracking' and IssueStatusValue eq 'Active'
  • When using parameters, make sure to put single quotes around the paramter!
    • listName eq '<%=parameter["List Name"]%>'

Changelog

v1.0.1 (2017-11-14)

  • Change the internal REST API calls that are being made to retrieve List information
  • Update deprecated DefaultHttpClient references

v1.0.0 (2016-03-25)

  • Initial Version