{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Data Import Format","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"data-import-format","__idx":0},"children":["Data Import Format"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To import data into the eGain knowledge system from any external source, the data must be organized into a specific format. This guide and its related articles outline the required folder structure and file formats to ensure a successful data import."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"in-depth-guides","__idx":2},"children":["In-Depth Guides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For detailed instructions on creating each component, please refer to the following guides:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/ingestion/folder-import-guide"},"children":["Guide to Folder Import"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/ingestion/article-import-guide"},"children":["Guide to Article Import"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/ingestion/topic-import-guide"},"children":["Guide to Topic Import"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/ingestion/portal-import-guide"},"children":["Guide to Portal Import"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/ingestion/knowledge-import-guide"},"children":["Guide to assembling knowledgehub.json"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"folder-structure","__idx":3},"children":["Folder Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The complete knowledge package should be a folder containing the following structure:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"/package\n├── manifest.json\n└── /knowledgehub\n    ├── knowledgehub.json\n    └── /articles\n        ├── articles.json\n        ├── /content\n        │   └── sample_article.html\n        ├── /inline_resources\n        │   └── sample_image.jpg\n        └── /resources\n            └── Ref Guide.pdf\n"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["manifest.json"]},": Contains metadata about the data import package."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["knowledgehub.json"]},": Defines the knowledge base structure, including folders, topics, and portals."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["articles.json"]},": Contains the content and metadata of the knowledge articles."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["/content"]},": Contains the article body in HTML format."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["/inline_resources"]},": Contains inline attachments (like images) used in articles."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["/resources"]},": Contains downloadable attachments (like PDFs) used in articles."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow","__idx":4},"children":["Workflow"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create manifest.json"]},": Develop the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["manifest.json"]}," file to include essential metadata for the import package."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Establish Folder Structure"]},": Set up the necessary folder hierarchy within ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["knowledgehub.json"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Define Topic Structure"]},": Outline the topic structure that categorizes and organizes the articles in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["knowledgehub.json"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set Up Portals"]},": Configure the portal(s) to manage and display the knowledge content to end-users in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["knowledgehub.json"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integrate Structures into knowledgehub.json"]},": Combine the defined folder, topic, and portal structures into the single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["knowledgehub.json"]}," file."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Develop articles.json"]},": Create the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["articles.json"]}," file containing the detailed content of all knowledge articles."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-files","__idx":5},"children":["Required Files"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"manifestjson","__idx":6},"children":["manifest.json"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["manifest.json"]}," file provides essential metadata for the data import package, including the package name and the department to which the data will be imported."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"packageName\": \"Data import from Purple Nile Retail department\",\n    \"department\": {\n        \"name\": \"PurpleNile Retail\"\n    }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-manifestjson","__idx":7},"children":["Creating manifest.json"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a new JSON file named manifest.json."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the necessary parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["packageName"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Name of the package"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["department.name"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Name of department to import package"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"knowledgehubjson","__idx":8},"children":["knowledgehub.json"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This file defines the structure of the knowledge base, including folders, topics, and portals. See the dedicated guides for detailed instructions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-snippet","__idx":9},"children":["Example Snippet:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"knowledge\": {\n    \"folders\": [\n      {\n        \"name\": \"Purple Nile Retail - Sample Data\",\n        \"description\": \"\",\n        \"folders\": []\n      }\n    ],\n    \"topics\": [\n      {\n        \"name\": \"Credit Card and Payments\",\n        \"description\": \"\",\n        \"addArticles\": {\n          \"fromArticles\": [\n            {\n              \"path\": \"Purple Nile Retail - Sample Data/Credit Cards & Payments/E-Gift Cards\"\n            }\n          ]\n        }\n      }\n    ],\n    \"portals\": [\n      {\n        \"name\": \"Customer Portal\",\n        \"description\": \"\"\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"articlesjson","__idx":10},"children":["articles.json"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This file contains the content of the knowledge articles, including metadata, content, and references to resources such as images and documents."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Snippet:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"articles\": [\n    {\n      \"name\": \"Chat Links\",\n      \"folder\": {\n        \"path\": \"Reasoning Engine/Content/Shared\"\n      },\n      \"content\": \"content/order-history.html\",\n      \"availabilityDate\": \"2025-01-28T19:53:58Z\",\n      \"description\": \"Sample Article\",\n      \"summary\": \"Sample Article\",\n      \"keywords\": \"Chat\",\n      \"includeInGenAI\": true,\n      \"translations\": [\n        {\n          \"langCode\": \"es-ES\",\n          \"name\": \"Spanish\",\n          \"content\": \"content/order-history_es.html\"\n        }\n      ]\n    }\n  ]\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Data Import Format","id":"data-import-format","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"In-Depth Guides","id":"in-depth-guides","depth":3},{"value":"Folder Structure","id":"folder-structure","depth":2},{"value":"Workflow","id":"workflow","depth":2},{"value":"Required Files","id":"required-files","depth":2},{"value":"manifest.json","id":"manifestjson","depth":3},{"value":"Creating manifest.json","id":"creating-manifestjson","depth":3},{"value":"knowledgehub.json","id":"knowledgehubjson","depth":3},{"value":"Example Snippet:","id":"example-snippet","depth":3},{"value":"articles.json","id":"articlesjson","depth":3}],"frontmatter":{"seo":{"title":"Data Import Format"}},"lastModified":"2026-04-23T22:34:20.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/guides/ingestion/data-import-format-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}