Integrate your Content Repository with Whatfix
- 28 May 2024
- 4 Minutes To Read
-
Print
-
DarkLight
-
PDF
Integrate your Content Repository with Whatfix
- Updated On 28 May 2024
- 4 Minutes To Read
-
Print
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Note
The content fetched from your content repository is encrypted at all times, that is, while fetching the content from your knowledge base (during transfer) and upon receiving the content on Whatfix servers.
Whatfix enables you to integrate your existing content repository such as Confluence, Zendesk, Freshdesk, SharePoint, etc., and display the articles you have created in these repositories as contextual links in the Self Help widget that appears on your application.
Whatfix Desktop uses a proprietary crawler that can index all the pages of your repository and make them available for search inside 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 following procedure.
Note
Only an Account Manager can perform the following task. For more information about available user roles, see Whatfix User Roles.
Note
- You can integrate up to 5 repositories and crawl 1000 articles per Whatfix account. To integrate more repository content, contact support@whatfix.com.
- Whatfix supports any HTML-based repository hosted over the Internet. 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
-
On the Whatfix Guidance dashboard, click Settings.
-
Click Repositories.
-
Click Custom Repository.
-
Enter the title and URL of your repository and specify if the URL is password-protected, and then click Next.
your title goes here
If the URL is password-protected, enter the username and password, and then click Next.
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.
- Whatfix automatically converts the URL to lowercase before integration.
- Under Crawl Settings, choose from the following options,
- All Content - This option fetches all the content from the whole repository.
- Specific Content - This option lets you configure conditions to fetch content from specific folders or spaces of the repository.
- Click Integrate.
your title goes here
- Once you have created an Integration request, your repository is listed under Applications in the Processing state.
- Depending on how big your repository is, the content sync might take between 24 - 72 hours to complete.
- 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.
Steps to Integrate an Additional Repository
Use the following steps if you have already integrated a repository and want to integrate another one with Whatfix:
-
On the Whatfix Guidance dashboard, click Settings.
-
Click Repositories.
-
Under Integrate Additional Repositories section, select the repository you want to integrate.
-
Enter the title, URL of your repository, specify if the URL is password-protected, and then click Next.
your title goes here
If the URL is password-protected, enter the username and password, and then click Next.
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.
- Whatfix automatically converts the URL to lowercase before integration.
- Under Crawl Settings, choose from the following options:
- All Content - This option fetches all the content from the whole repository.
- Specific Content - This option lets you configure conditions to fetch content from specific folders or spaces of the repository.
- Click Integrate.
your title goes here
- Once you have created an Integration request, your repository is listed under Integrated Repositories in the Processing state.
- Depending on how big your repository is, the content sync may take between 24 - 72 hours to complete.
- 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.
- If you click Cancel or close the integration pop-up, the integration request is Saved as a draft in the Integrated Repositories section.
Note
- The Content Repository links are available in the Ready Stage only after you perform a crawl from your repository to Whatfix.
- The Content Repository links can’t be pushed to the Draft Stage and you can’t make any edits to the Content Repository links using Whatfix.
- Once you push the Content Repository links to the Production Stage and you can’t move them back to the Ready or Draft stages like the other Whatfix content and widgets.
- Unlike other content and widgets that can be tagged in the Draft stage, the repository links can be tagged only in the Ready Stage.
Was this article helpful?