Add your help center website to the portal agent's knowledge

Updated

Who can do this: Super Admins

Connect your public help center so the portal agent can answer customers from it. We crawl the site on a schedule, and the agent cites the page it answered from.

This feature is available when it's turned on for your organization. If you don't see the Website knowledge card, contact your OnRamp team.

Before you begin

  • Your help center must be at a public address. We can't crawl a private or internal address.

  • Your organization must own the site or be authorized to have OnRamp crawl it. Every crawled page becomes available to the portal agent for all your customers.

  • You can connect one website at a time. Saving a new address replaces the current one.

Add your website

  1. Go to Settings > Aero. If the page shows tabs, select the Portal agent tab.

  2. Find the Website knowledge card. Until you add a site, it shows No website connected. The card appears when this feature is turned on for your organization. If you don't see it, contact your OnRamp team.

  3. In Help center or sitemap address, enter your help center's public address or its sitemap, for example https://docs.example.com/sitemap.xml.

  4. Optional: To limit what's crawled, enter path patterns in Only crawl paths matching or Never crawl paths matching, one per line, for example /help/*. If a page matches both, it's excluded. Each list holds up to 20 patterns of up to 300 characters.

  5. Optional: In Hosts your pages may redirect to, enter one host name per line, for example documentation.example.com. You can list up to 10 hosts, and each must be a public host name. A page that redirects to a listed host is crawled at its new address if that host's robots.txt allows it. Links on those pages aren't followed.

  6. In Sync frequency, choose Weekly, Daily or Monthly. Weekly is the default.

  7. Check the box confirming your organization owns the site and any hosts listed under Hosts your pages may redirect to, or is authorized to have OnRamp crawl them. Every crawled page is available to the portal agent for all your customers. Save website stays disabled until the box is checked.

  8. Select Save website.

The first time you save, you'll see that the first sync starts within the hour. If the address can't be crawled, you'll see That address cannot be crawled. Enter the public address of your help center.

You need to check the confirmation box again each time you save. If you change the address, the path patterns or the hosts under Hosts your pages may redirect to later, a new sync is scheduled right away. Changing only the frequency can bring the next sync sooner, but it doesn't restart it.

Check sync status

The card shows Last sync, Next sync, Indexed, Unchanged in last sync, Held back and Failed. It refreshes itself every 30 seconds while a sync is active.

  • Sync queued. It starts within the hour means a sync is due. If it still hasn't started two hours after it was due, the card tells you it's overdue. Contact OnRamp support if it doesn't start soon.

  • Sync running since shows when the current sync began. Pages and counts update when it finishes.

  • The last sync failed appears with the error if a sync fails.

To start a sync yourself, select Sync now. You need permission to edit the portal agent to do this. You can do this once an hour. You can't sync while a sync is already queued or running, or while the card shows Applying the approved changes.

To see each crawled page, select View pages. You can also select a count under Indexed, Held back or Failed when it's above zero. The Website pages panel opens. It lists each page with its Status and a Reason, 25 pages at a time. You can filter the list by status. Held back counts pages that weren't added:

Status

Meaning

Too short

The page has under 200 characters of text.

Blocked

The page couldn't be crawled because the site blocks it.

Noindex

The page is marked not to be indexed.

Over page limit

Your organization reached its limit of 5,000 web pages. Pages from your other web sources count toward it, so this can happen before the site itself reaches 5,000 pages.

Pages can also show Indexed, Failed or Missing. A page someone excluded with Exclude this page shows an Excluded tag. A page whose own sync is pending shows a Sync queued tag.

Let OnRamp past robots.txt

If your site's robots.txt blocks OnRamp, the card shows The site's robots.txt blocks OnRamp and how many pages were skipped. This message appears when no sync is queued, running or applying approved changes. To include those pages, add these lines to your robots.txt and sync again:

User-agent: OnRampBot Allow: /

Or exclude those paths in Never crawl paths matching.

Review a held sync

If a later sync would change or remove 45% or more of the indexed pages, it's held under Needs review. The first sync is never held.

  1. To accept it, select Apply, then Apply changes. The card shows Applying the approved changes while it works.

  2. To reject it, select Discard.

Remove your website

  1. Select Remove website.

  2. Select Remove website again to confirm.

Every page from the site leaves the portal agent's knowledge right away.

More in OnRamp Aero