SharePoint List Reader

This node reads a SharePoint list and outputs it as a KNIME table.

SharePoint list column type support
You can select to which KNIME types the SharePoint list column types should be transformed. The following describes the extent of the support for the different column types.

Fully supported column types:

  • Single line of text
  • Choice
  • Number
  • Yes/No
  • Date and time

Partially supported column types:

  • Multiple lines of text will contain HTML tags if the Use enhanced rich text option is enabled for the column in SharePoint.
  • Calculated columns are always Strings.
  • Currency columns are always Doubles. Thus the currency information is not displayed.
  • Person columns return a row ID in the "User Information List" (for more details see below).
  • Lookup columns return a row ID in linked list (for more details see below).

Unsupported column types:
For all unsupported column types the node will return the raw JSON value as String. The String can be transformed into the JSON type in the Transformation section if the KNIME JSON Processing extension is installed.

  • Location
  • Hyperlink
  • Image columns are encoded as a JSON string containing JSON so you have to convert twice to JSON.
  • Task Outcome
  • External Data
  • Managed Metadata

Working with Person and Lookup columns
Person and Lookup columns reference data from other SharePoint lists. Instead of containing the value in the other list they store the value of the "ID" column of the row in that list. To be able to access the content you can use another SharePoint List Reader to read the lookup list and then use the Joiner node to join both lists using the "ID" column of the lookup list.

If you are dealing with a Lookup column, you can get the name of the column you are trying to join from the settings of the Lookup column (which can for example be found in the old web interface). The name of any additional columns that are looked up can be found in the table specification as names of those columns.

Person columns reference entries in the so called "User Information List" (with the internal name "users"). This is a hidden system list in the Root of each SharePoint site. To find it, you must check the "Show system lists" option in the SharePoint List Reader node. The name may be localized to your language so you should search for the internal name.

Generated Columns
Apart from the columns you define in a SharePoint list there are some which are present in each list e.g. ID. In addition SharePoint generates columns for some specific column types such as Location. The Microsoft API does not provide information about these columns or any layout information. To deselect unwanted columns and reorder the retained columns go to the "Transformation" section.

Options

Connect via
Select how to connect to the SharePoint site.
  • Root site: Connect to the root site of the domain of the current user
  • Web URL: Specify the web URL of a SharePoint site.
  • Group site: Connect to the team site of a particular Office 365 group.
URL
The web URL of the SharePoint site, for example https://mycompany.sharepoint.com
Group
The Office 365 group whose team site to connect to.
Connect to subsite
A (nested) subsite of the SharePoint site specified above. If selected, the node will connect to the subsite instead of the parent site. Note that access is limited to content of the subsite, not those of the parent site(s).
List
An existing SharePoint list. The drop down menu shows lists in the format <display-name> (<internal-name>). The display name is a user-chosen name that is editable in SharePoint, whereas the internal name is fixed and auto-generated by SharePoint. The node stores a unique technical ID which is used to find the list.
Show system lists
Whether to show system lists (e.g., internal SharePoint lists) in the list selection. These are typically hidden as they are for internal SharePoint use.
Skip first data rows
If enabled, skip the specified number of data rows starting from the beginning of the list.
Limit number of rows
If enabled, only the specified number of data rows will be read after the skipped rows.
Connection timeout in seconds
The timeout in seconds to establish a connection, or 0 for an infinite timeout.
Read timeout in seconds
The timeout in seconds to read data from an established connection, or 0 for an infinite timeout.
Enforce types
Controls how columns whose type changes are dealt with. If selected, the mapping to the KNIME type you configured is attempted. The node will fail if that is not possible. If unselected, the KNIME type corresponding to the new type is used.
Transformations
This option allows modifying the structure of the output table. It supports reordering, filtering and renaming columns. Whether and where to add unknown columns during execution is specified via the special entry Any unknown column. It is also possible to change the type of the columns. Note that the node will fail if this conversion is not possible e.g. if the selected type is Integer but the new column is of type Double.

Input Ports

Icon
A JWT credential as provided by the Microsoft Authenticator node.

Output Ports

Icon
Read SharePoint list as a table.

Views

This node has no views

Workflows

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.