Skip to main content
Planview Customer Success Center

Microsoft SharePoint

Microsoft Logo




Microsoft SharePoint is a popular tool for sharing information and enhancing collaboration. Often, organizations use SharePoint’s custom development capabilities to create highly-tailored line-of-business applications to streamline collaboration across teams. 



Connector Setup Details

This section describes the basic steps needed to prepare your SharePoint instance for use with Viz.

Minimal User Permissions & Viz User

We recommend that you create a new user within your external tool, to be used only for Viz. This is the user information you will enter when setting up your tool connection within Planview Viz. By creating a new user, you will ensure that the correct permissions are granted.

In general, your user account should have sufficient permissions to read artifacts in your tool. 

Your user should have a secure password or token. Please be aware that Viz will not allow you to save a tool connection utilizing a weak password/token, such as 'tasktop.'

See Microsoft SharePoint User Guide to learn how to create a new user in Microsoft SharePoint.

Connecting to the Microsoft SharePoint Repository

Standard Authentication

Required Fields:

  • URL
  • Username
    • Example Format: domain\gu-sharepoint
  • Password


SharePoint Azure Active Directory OAuth2 via Certificate

Note: Access to SharePoint via Azure AD authentication is only supported via certificate support. Shared secret is not supported.

See the section below for steps on configuring this authentication method.

Required Fields:

  • URL

  • Token Location
    • This can be found on the App Registration overview in Azure AD.
  • Client ID
    • This can be found on the Overview page of your App Registration.
  • Scope
  • Client Assertion
    • This is the entire encoded JWT token .
    • You will need to generate a custom JWT token for client assertion.

App Registration

The first step in using the Azure AD authenticator is to set up an app registration for Planview Viz — to generate authentication tokens and control access. See the section below for setting up app registration.

After setting up the app registration, you must grant 'Sites.FullControl.All' and 'SharePoint' permissions.

Note: Due to a restriction that is dictated by Azure Active Directory, the app registration must be granted access to ALL SharePoint sites within a Tenant and cannot be restricted. Please note that this may conflict with your organization's security policies.

To learn more, refer to Microsoft documentation here.




Other Configuration Settings

SharePoint Azure Active Directory OAuth2 via Certificate Configuration 

This authentication method only works with SharePoint online and Azure Active directory.

See the steps below to set up the Azure Active Directory authentication method:

  1. Register an application for Viz on Azure Active directory 
    1. 94644751.png 
  2. Grant permissions to the application to allow it to access SharePoint online
    1. Grant the application the "Sites.FullControl.All" permission under "SharePoint" 94644752.png
  3. Generate a Public / Private X.509 certificate key pair according to your requirements
    1. Note: You must use either Windows or Linux as you likely will not be able to generate a certificate key pair using Mac OSx. 
  4. Add the certificate for Viz to Azure with the following steps:
    1. In the SharePoint application, click Certificates & secrets in the left sidebar.
    2. Then, add the public certificate to the Certificates section. 
      1. 94644753.png
  5. Generate a new JWT token

    1. Note: You must use either Windows or Linux as you likely will not be able to generate this token using Mac OSx.
    2. You can find additional information on the structure of the JWT token here and a tutorial on generating the JWT on Linux using Node here.

  6. Save the token to use in Viz.
  7. Fill in the Repository Connection fields in Planview Viz as follows:
    1. Token Location: This is the "Directory (tenant) ID" from your App Registration overview (see screenshot below)
      1. Example Format:<tenant-id>/oauth2/v2.0/token
    2. Client ID: This is the “Application (client) ID” from your App Registration overview (see screenshot below)
    3. Scope: This is your base SharePoint URL, <base-url>/.default
      1. Example Format:
    4. Client Assertion: This is the entire encoded JWT token 
      1. 94644754.png



Supported Artifacts

Supported Work Items

Supported Work Item Type

Applicable Repository Versions

Unique URL?

All list content types. For example:

  • Tasks

  • Items

  • Issue

  • Post

Note: Documentation Types and Items in a library list are not currently supported.

Any supported repository version:


Supported Containers

Containers that can be modeled as Flow Items

Applicable Repository Versions

Unique URL?




Containers used to define which artifacts are included in an Artifact Set




Any supported repository version:




Supported Field Types

Planview Viz supports configuring rule-based modeling (i.e., conditional modeling) using the field types shown below.

Note: If one field of a given type is supported, others that are also that type in theory should also work. However, sometimes there are instances in which this is not the case due to the repository. So, while we can claim support for fields at the type level, there is a chance that some specific fields of a given type will not function properly.

Standard Field Type

How is field type referenced in the repository?

Sample Repository Fields Supported

Particular Repository Fields NOT Supported

1checkicon.png String

Single line of text

Multiple lines of text





1checkicon.png Single Select

Choice (one choice)

Content type

Task Status


1checkicon.png Multi Select

Choice (multiple choices)



1checkicon.png Boolean

Yes/No Checkbox

Auto Update