Ever get a question like "Does your product integrate with Slack?", and you think to yourself, "Our Product Documentation would be a great resource on this!"

Now you can link public or private Confluence pages as a source to Conveyor. Public pages could be your help site, public documentation, or marketing website. You can add your entire private Confluence site or select specific Confluence spaces to add to the knowledge base.

Doing so can increase ConveyorAI's ability to answer questions on your questionnaires and RFPs, without adding maintenance burden to Conveyor itself.

Note: Public external sources refresh every week and private external sources refresh every day!

🎥 Here's a one-minute overview! 🎥

Adding external sources

🎥 Here's a two-minute instructional video about how to set up Public External Sources (yes, it's that easy!) 🎥

External sources are managed in the Knowledge Base section of Conveyor, under the External Sources sub-tab:

Adding Public Sites

Click "Add a Public Site" or "Add new source --> Public Site" to add a new source.

In the next modal, you'll see the following fields:

• Name (required): Give your external source a memorable name, like "Slack Reference Page."
• Product Scope (optional, only appears if you have Product Linesset up). If this page only applies to one or a subset of your products, you can select the applicable products here. If it applies to all your products, leave this field blank.
• URL (required): The page to be included, or the root URL of the site to include.
• Also source from this URL's sub-pages. (Optional): Check this box if you are providing the root URL of a larger source, such as a marketing site or help documentation. All sub-pages will be crawled and included, up to a max of 1,000 sub-pages. We will recursively crawl to a max depth of 20 for sub-pages. Please note that large sites will increase the time it takes for the source to sync.

Once you hit "Save and Sync," the source will sync, and then appear as "Active":

Adding Private Confluence Sites

👍

What does Conveyor import from my Confluence site?

Conveyor imports knowledge from your Confluence pages on a per space basis. Knowledge is refreshed daily for changes. We do not support Confluence whiteboards, databases, smart links or blog posts within a space as a knowledge source.

Pre-requisites

You'll need to create an account and an API token to allow Conveyor to access your private Confluence site.

Follow this guide to manage API tokens for your Atlassian account.

Steps

Click "Add a Confluence Site" or "Add new source --> Confluence Site" to add a new source.

In the next modal, you'll connect to your private Confluence site. You'll see the following fields:

• URL (required): The base URL to your Confluence site. Usually this is in the format "https://yourcompanyname.atlassian.net/wiki"
• Description: Add an optional description for your Confluence site. Later, you can also change the description for each of the Confluence spaces that you select as knowledge sources.
• Username (required): The user account that you've created to allow Conveyor to access your private Confluence content.
• API Token (required): The API token associated with the username.

Then click "Next: Configure Spaces". If Conveyor is able to connect to your Confluence site, the next modal will show you a list of your active Confluence spaces.

Select the Confluence spaces that you want to add as knowledge sources. You can tag any of your Confluence spaces with your product scopes.

Once you hit "Save," the sources will sync, and then appear as "Active" in the knowledge base.

We create an external source for every Confluence space that you add. If you hover over the "Active" badge in the card, you'll see the number of Confluence pages that we've synced for each space.

Editing Confluence Spaces

You can click "Edit Source" on a card for a Confluence space to edit the name (this will only change the name of the card that you see on Conveyor, it won't change the name of your Confluence space), product scope and description.

You won't be able to edit the username or API Token of your Confluence site.

Toggling External Sources for ConveyorAI

You can toggle External Source as in or out of scope for ConveyorAi by hitting the gear icon on the Questionnaires page:

External Sources in ConveyorAI

Once you have External Sources active and enabled for answer generation, you'll start seeing them pop up as sources!

Hint: Click the "link" icon to insert a link to the cited page in the answer.