Knowledge Porter Runner Addon

Unknown
Unknown
edited October 2021 in Support Agents

This is a support-focused distillation of the Knowledge Porter doc here: Knowledge porter from Zendesk API for developers - Vanilla Staff

Knowledge Porter is a command-line tool used to migrate - or port - content from another site to Vanilla via API. Initially it was built to transfer discussions, comments, and UserIDs, but its functionality was expanded to include Knowledge Base articles.

Knowledge Porter allows for an easier transfer process than the old method of database transfers, which required a lot of manual massaging of data.

The Knowledge Porter Runner addon was created to allow customers to regularly import KB articles from ZenDesk. In theory, it could be expanded - likely as a service - to import articles from other sources.

Ops is currently responsible for configuring this plugin and ensuring it runs on an interval determined by the client (King Games, for example, is every 2 hours). Under the hood, this is still being run as a commend-line utility on the server via a chron job.

Snag_348c54ef.png Snag_348c720c.png
  1. This is an arbitrary name used to define the connection. Multiple connections can be configured.
  2. What platform are we connecting to?
  3. The URLs - and likely the ZD category or site ID? - we'll be pulling articles from.
  4. This is information you obtained by following the ZenDesk steps here: Zendesk - Vanilla Success (don't do the Vanilla steps there).
  5. ZenDesk locale you're copying from.
  6. How many records per page? Which page do you start with? How many pages will you pull? This particular config will pull 100,000 articles.
  7. Which information are we importing?
  8. Locale mapping for Vanilla. I'm not sure this is used for ZD?
  9. Vanilla API information, including a bearer token.
  10. Patch? Awaiting information. Only sync articles with matching emails in Vanilla?
  11. lastFull is a complete pull of ZD articles. lastDelete is cleanup. Timestamps are the last time the sync was run.
  12. This token is created when you activate the plugin and allows connection to Knowledge Porter.

Categories