Integrate a repository using a custom integration
- 05 Jun 2024
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Integrate a repository using a custom integration
- Updated On 05 Jun 2024
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
In addition to out-of-the-box integrations, Whatfix also enables you to integrate other repositories using a custom integration.
Whatfix uses a proprietary crawler that can index all the pages of your repository and automatically create repository links for each of them. Once crawled, you can add them to Whatfix widgets like Self Help and Task List. In Self Help, your repository links are searchable by the content inside them, making it easier for end users to find relevant content.
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 widget that appears in Salesforce.
Note
- The content fetched from your repository is encrypted at all times, that is, while fetching the content from your knowledge base (during transfer), and when receiving the content on the Whatfix servers.
- Only an Account Manager can integrate repositories. For more information about available roles, see Whatfix User Roles.
- Whatfix enables you to integrate up to 5 repositories and crawl up to 5000 links per Whatfix account. To integrate more repository content, contact support@whatfix.com
- Whatfix supports HTML-based repositories hosted over the internet. PDF and XML content are currently not supported in custom integrations.
- Whatfix can also crawl authenticated repositories and repositories that are accessed via SSO. However, repositories that use multi-factor authentication are not supported.
Use the following steps to integrate a repository using a custom integration:
-
On the Whatfix Guidance dashboard, click Settings.
-
Click Repositories.
-
Click Custom Repository.
-
Enter the title and URL of your repository, and then click Next.
your title goes here
- If the URL is password-protected, choose Yes next to the Is the URL password protected? field. Enter the username and password, and then click Next.
- 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 Crawler options, choose from the following options:
All content
The All content option fetches all the content from the repository.
Specific content
The Specific content crawl option enables you to configure conditions to fetch content from specific URLs in your repository.
The following table lists all the conditions used while configuring the repository to crawl specific content: These conditions determine which content is fetched from the repository.
| Condition | Description | Example: support.whatfix.com |
|---|---|---|
| Starts With | Set value is at the beginning of the URL | support.whatfix |
| Ends With | Set value is at the end of the URL | whatfix.com |
| Equals | Set URL is an exact match | https://support.whatfix.com/docs/content-repository-process |
| Not Equals | Doesn't equal the value | https://support.whatfix.com/docs/content-repository-process |
| Contains | Set value is present anywhere in the URL | whatfix.com/docs |
| Not Contains | Set value is not present anywhere in the URL | whatfix.com/docs |
your title goes here
-
Click Add More to add more conditions.
-
Use the AND or OR operator to join conditions.
- AND: Only content satisfying all the conditions joined by AND operators is crawled.
- OR: Content satisfying any one of the conditions joined by OR operators is crawled.
- Click Integrate.
Once you have created an Integration request, your repository is listed under Integrated Repositories in the Processing state. The sync takes approximately 36 hours for every 2000 links in your repository. Repository links can be added to Whatfix widgets the same way links are added.
- 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
- Repository links are available in the Ready stage once your repository is integrated.
- Repository links cannot be moved to Draft or edited.
Was this article helpful?