Top
Integrating your Content Repository with Whatfix
  • 4 Minutes To Read
  • Print
  • Dark
    Light

Integrating your Content Repository with Whatfix

  • Print
  • Dark
    Light

Whatfix allows you to integrate your existing Content Repository such as Confluence, Zendesk, Freshdesk, SharePoint, etc. and display the articles that you have created in these Repositories as contextual links in the Self Help widget that appears on your application.

Whatfix uses a proprietary crawler that can index all the pages of your Repository and make them available for search in side Self Help on your application.

For example, if you have your help content in Confluence and your application is Salesforce then the Confluence articles can be shown as links in the Self Help that appears in Salesforce.

Once the Repository has been enabled, you can define the Repository that Whatfix needs to index using the procedure below.

Note
  • You need to be an Account Manager to perform Repository Integration. To see more information about available roles, see Whatfix User Roles.
  • Whatfix supports any HTML Repository. PDF content or XML content is currently not supported.
  • Whatfix can also crawl authenticated Repositories and those that are accessed via SSO.
Steps to integrate a Repository for the first time

  1. Navigate to the Whatfix Dashboard.
    gotoDashboard%20%282%29.png

  2. Click Repositories.
    repo_dashbaord

  3. Select the repository that you want to integrate.
    Repo_select_new

  4. Enter the title, URL of your repository and specify if the URL is password protected, and then click Next.
    repo_custom_Kb

your title goes here
  • The title you provide here is used as the tag name for the default tag attached to all the content fetched.
  • If the URL is password protected, enter the username and password and then click Next.
    repo_credentails
  1. Under Crawl Settings, you have the following two options to choose from.

    • Crawl through entire Repository- This option fetches all the content from the whole repository.
    • Crawl only specific links- This options lets you configure conditions to fetch content from specific folders or spaces of the repository.
      Repo_crawl_settings
  2. After the Crawl Settings is configured, click Integrate.
    repo_integrate_button

  3. Once you have created an Integration request, your Repository is listed under Integrated Applications in processing state.
    int_applications

your title goes here
  • Depending on how big your Repository is, the content sync might take between 24 - 78 hours to complete.
  • Once all the content are indexed, you can access them on the Whatfix Dashboard.
    repo_dashbaord
  • The content fetched can be added to the Self Help widget, in the same way as you would add any other Whatfix content.
  • If you have Smart Context enabled, you must add the global-page tag for the content to reflect in the Self Help widget on your application. For more information, see
    Adding tags to Repository Content

Steps to integrate an additional Repository

For users who have already integrated a Repository and want to integrate another one with Whatfix, follow the steps below.

  1. Navigate to the Whatfix Dashboard.
    dashboard.png
  2. On the top right, click the Settings icon.
    New_settings_icon
  3. Click Manage Repositories.
    manage_repo
  4. Under Select another App to Integrate section, select the repository you want to integrate.
    repo_select_app
  5. Enter the title, URL of your repository and specify if the URL is password protected, and then click Next.
    repo_custom_Kb
your title goes here
  • The title you provide here is used as the tag name for the default tag attached to all the content fetched.
  • If the URL is password protected, enter the username and password and then click Next.
    repo_credentails
  1. Under Crawl Settings, you have the following two options to choose from.
    • Crawl through entire Repository- This option fetches all the content from the whole repository.
    • Crawl only specific links- This options lets you configure conditions to fetch content from specific folders or spaces of the repository.
      Repo_crawl_settings
  2. After the Crawl Settings is configured, click Integrate.
    repo_integrate_button
  3. Once you have created an Integration request, your Repository is listed under Integrated Applications in processing state.
    int_applications
your title goes here
  • Depending on how big your Repository is, the content sync might take between 24 - 78 hours to complete.
  • Once all the content are indexed, you can access them on the Whatfix Dashboard.
    repo_dashbaord
  • The content fetched can be added to the Self Help widget, in the same way as you would add any other Whatfix content.
  • If you have Smart Context enabled, you must add the global-page tag for the content to reflect in the Self Help widget on your application. For more information, see
    Adding tags to Repository Content

Content Repository Actions

After a successful integration, you can perform various actions on your Repository.

To access the Action menu,

  1. Navigate to the Whatfix Dashboard.
    dashboard.png

  2. On the top right, click the Settings icon.
    New_settings_icon

  3. Click Manage Repositories.
    manage_repo

  4. In the Integrated Applications section, navigate to the application for which you want to access the action menu.

  5. Under Actions, click the Ellipsis icon.
    repo_ellipsis_icon

  6. The various actions that you can perform are listed below.

  • Sync Now- Performs a force sync.
  • View & Edit- Displays Repository title, URL, tags associated, and other sync details. You can also add tags and change the Sync Frequency.
  • Pause- Pauses content sync. Subsequently, you see a Resume button to continue the sync.
  • Delete- Deletes the Repository.
    repo_action_menu
Was This Article Helpful?