Documentation Knowledgebase

This area helps us show you how to use our features to grow your business.

Knowledge Base Manager

Import and Export Knowledge Base Articles

Superusers and elevated users export Knowledge Base articles, categories, tags, and files as a validated ZIP package and import it into another website, choosing to skip or update matching articles or import them as drafts.

Updated

Who can do it

Only a superuser or an elevated user can export or import articles. The Import/Export button is hidden from everyone else, and the server refuses their requests.

Export articles

  1. Open the Knowledge Base Manager and confirm the website shown at the top is the one you want to export.
  2. Select Import/Export.
  3. On the Export tab, choose All articles, Published, Draft, or Archived.
  4. Select Download export.
  5. Keep the downloaded .zip file unchanged. The import refuses a package whose files were edited, added, or removed.

The package always includes every category and tag of the website, even when you export only one status.

Import articles

  1. Open the Knowledge Base Manager on the website that should receive the articles.
  2. Select Import/Export, then the Import tab.
  3. Drag the .zip package into the landing zone, or select Choose package.
  4. Read the check report. Nothing has changed on the website yet.
  5. Choose what happens when an article with the same friendly URL already exists:
    • Skip it (default) keeps the existing article unchanged.
    • Update it replaces the existing article with the package version.
  6. Select Import every article as a draft if nothing should become visible to visitors right away.
  7. Select Import. If any article will be updated, confirm the update.
  8. Read the result. A package that imported without problems is removed from the landing zone.

Packages wait in the landing zone for 24 hours. Use Check and import to come back to one, or the remove button to delete it.

What the import does and does not do

  • New categories and tags are created; existing ones are matched by friendly URL and left unchanged.
  • Featured images, attachments, and files used inside article content are uploaded into each article's own folder. The website's allowed file types and maximum upload size apply.
  • The publish date is set by this website when an article is published. The original publish date is not kept.
  • New categories are added after the existing categories. Reorder them on the Categories page if needed.
  • When an article is updated, the files it used before stay in its folder.
  • An article whose friendly URL was used before by another article on this website is skipped.

If the import fails

Record the reference shown in the result (it starts with KBI-), the final message, and the article results. Fix the problems the check report lists in the source website, export again, and upload the new package. Do not edit the files inside the package.

Ask a superuser to search the administrator event log for the reference when the result reports an internal failure.

Package format (version 1)

A package is a .zip file with these entries. Paths use /, are relative, and never contain ...

Entry Contents
manifest.json format (upendo-kb-articles), formatVersion (1), generator, exportedOnUtc, sourcePortalId, options.status, counts, notes, and files: the path, bytes, and sha256 of every other entry.
categories.csv Slug, Name, ParentSlug, Description, SortOrder, IsActive
tags.csv Slug, Name, IsActive
articles.csv Slug, Title, Status, CategorySlug, TagSlugs, Summary, ContentFile, Keywords, IsFeatured, ImageFile, ImageAltText, SeoTitle, SeoTitleIsAuto, SeoDescription, SeoDescriptionIsAuto, Indexing, CanonicalUrl, PublishedOnUtc, Attachments
content/{slug}.html The HTML content of one article.
files/{slug}/{name} The featured image, attachments, and inline files of one article.
README.txt A plain-text description of the package and this format.

Rules:

  • CSV files are UTF-8 with a byte order mark and RFC 4180 quoting. The first row holds the column names.
  • Categories, tags, and articles are matched by Slug. A blank ParentSlug means a top-level category.
  • Status is Draft, Published, or Archived. Booleans are true or false. Indexing is index or noindex.
  • TagSlugs and Attachments hold several values separated by |. Attachments are in display order.
  • ContentFile, ImageFile, and Attachments are paths inside the package.
  • In article HTML, kbfile:files/{slug}/{name} refers to a package file. The import uploads the file and replaces the reference with its address on the receiving website.
  • Text that starts with =, +, -, or @ is written with a leading apostrophe so spreadsheets do not run it as a formula. The import removes that apostrophe.
  • PublishedOnUtc is for reference only.

Limits checked before anything is imported: at most 5,000 articles, 10,000 entries, 1 GB uncompressed, 512 MB per package (or the website's maximum upload size when smaller), 50 MB per CSV file, and 10 MB per article content file.