Top
SharePoint Integration Process
  • 05 May 2025
  • 4 Minutes To Read
  • Dark
    Light
  • PDF

SharePoint Integration Process

  • Dark
    Light
  • PDF

Article summary

Whatfix-SharePoint integration enables you to fetch and display articles in SharePoint as contextual links within the Self Help widget. Fetch all content or only articles from specific folders.

Use the following steps to integrate a SharePoint Repository:

With Full Access using One-click Integration

Note:

With one-click integration, Whatfix crawls content only from the subsites that you specify but it still has access to other subsites in your Repository.

  1. On the Whatfix Guidance dashboard, click Settings.
    ia_left_nav_settings

  2. Click Repositories.
    ia_left%20nav_repositories%20

  1. Click the SharePoint tile.
    RB_DB_CaggintegrateSP

  2. Enter a title and the URL of your SharePoint Repository.
    RB_DB_reposharepoint

Info:

The title you provide is used as the tag name for the default tag attached to all content fetched.

  1. Click Next.
    RB_DB_reponextSP

  2. Select the type of SharePoint content that you want to fetch from the repository and then click + Add.
    RB_DB_repoSPaddbutton

Note:

Add multiple content types to integrate.

  1. Based on the content type you select, enter the necessary details in the fields that appear.
  • Article: List Name
  • Documents: List Name, Library Name, Folder Absolute Path (optional)
  • Site Page: List Name
Note:

To know how to generate this information in your SharePoint application, see Generating information for SharePoint subsite integration.

  1. Click Integrate.
    RB_DB_repointegrateSP

  2. Once the SharePoint login page loads, enter your credentials and then click Log In.

Info:
  • After you create an Integration request, Whatfix lists your Repository under Integrated Applications in the PROCESSING state.
    SP_processing_state
  • Once all the content is indexed, access it on the Whatfix Dashboard.
    RB_DB_CRclickrepo
  • The content fetched can be added to the Self Help widget in the same way as any other Whatfix content.
  • If Smart is Context enabled, you must add the global-page tag for the content to appear in the Self Help widget on your application. For more information, see Add Repository Content to Self Help and Task List.
  • If you click Cancel or close the integration pop-up, the integration request is Saved as draft in the Integrated Repositories section.
    RB_DB_CaggSavedasdraft
Note:
  • The Repository links are available in the Ready stage once the Repository is crawled into Whatfix.
  • You cannot move the links to the Draft stage or edit them. In the Ready stage, you can only edit tags and search keywords.
  • Once you push the Repository links to the Production stage, you cannot move them back to the Ready or Draft stages like the other Whatfix content and widgets.
  • Unlike other content and widgets that you can tag in the Draft stage, you can tag the Repository links only in the Ready stage.
Info:

If you face any issues while integrating your Repository, contact support@whatfix.com.

With Restricted Access

Note:

In this method of integration, Whatfix crawls and has access only to the subsites that you specify and not to any other subsites in your Repository.

To enable SharePoint integration with restricted access to subsites, you must first generate the following credentials and keep them handy.

  • Client ID
  • Client Secret Key
Note:

Use the following steps to create a SharePoint integration,

  1. On the Whatfix Guidance dashboard, click Settings.
    ia_left_nav_settings

  2. Click Repositories.
    ia_left%20nav_repositories%20

  1. Click the SharePoint tile.
    RB_DB_CaggintegrateSP

  2. Enter a title and the URL of your SharePoint Repository.
    RB_DB_reposharepoint

Info:

The title you provide is used as the tag name for the default tag attached to all the content fetched.

  1. Select the checkbox to restrict access to the sub-site.
    RB_DB_repoclickfraccessSP

  2. Click Next.

  3. Enter the Client ID and Client Secret in the respective fields.
    RB_DB_repoclientinfo

  4. Click Next.
    RB_DB_reponextSP

  5. Select the type of SharePoint content that you want to fetch from the repository and then click the + Add button.
    RB_DB_repoSPaddbutton

Note:

Add multiple content types to integrate.

  1. Based on the content type you select, enter the necessary
    details in the fields that appear.
  • Article: List Name
  • Documents: List Name, Library Name, Folder Absolute Path (optional)
  • Site Page: List Name
    integ.png
Note:

To know how to generate this information in your SharePoint application, see Generating information for SharePoint subsite integration.

  1. Click Integrate.
    RB_DB_repointegrateSP

  2. Once the SharePoint login page loads, enter your credentials and then click Log In.

Info:
  • After you create an Integration request, your Repository is listed under Integrated Applications in the PROCESSING state.
    SP_processing_state

  • Depending on how big your Repository is, the content sync might take between 24 - 72 hours to complete.
    RB_DB_CRclickrepo

  • Once all the content is indexed, access it on the Whatfix Dashboard.

  • The content fetched can be added to the Self Help widget in the same way as any other Whatfix content.

  • If Smart Context is enabled, you must add the global-page tag for the content to appear in the Self Help widget on your application. For more information, see Add Repository Content to Self Help and Task List.

  • If you click Cancel or close the integration pop-up, the integration request is Saved as draft in the Integrated Repositories section.

Note:
  • The Repository links are available in the Ready stage once the Repository articles are crawled through and brought into Whatfix.
  • You cannot move the links to the Draft stage or edit them. In the Ready stage, you can only edit tags and search keywords.
  • Once you push the Repository links to the Production stage, you cannot move them back to the Ready or Draft stages like the other Whatfix content and widgets.
  • Unlike other content and widgets that you can tag in the Draft stage, you can tag the Repository links only in the Ready stage.
Info:

If you face any issues while integrating your Repository, contact support@whatfix.com.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.