{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Portal Import","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":"portal-import","__idx":0},"children":["Portal Import"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"about-portals","__idx":1},"children":["About Portals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Portals allow users to publish selected content of the knowledge base as portals on the intranet, extranet, or website. A portal is created and customized with the help of topics, a template, and various properties. It has two editions: an agent portal and a customer portal."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.egain.com/help/knowledge/portals_about.htm"},"children":["Learn more about Portals"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"organizing-the-portal-structure","__idx":2},"children":["Organizing the Portal Structure"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Review Existing Topics"]},": Assess the created topics and understand how they are structured."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Determine Portal Categories"]},": Decide on the categories or sections the portal should have based on the topics."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Map Topics to Portal Sections"]},": Organize the topics into the appropriate sections within the portal and ensure a logical and user-friendly structure that aligns with the content strategy."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-portals","__idx":3},"children":["Creating Portals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To import topics into portals, a specific JSON format is required. This section explains the parameters used in the JSON structure."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"understanding-the-json-format","__idx":4},"children":["Understanding the JSON Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The JSON structure for importing topics into portals consists of a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"portals\""]}," array, with each portal represented by an object containing various properties."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":5},"children":["Parameters"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"1-portals-array","__idx":6},"children":["1. Portals Array"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["portals"]}," array contains all the portals to be created."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"portals\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"2-portal-object","__idx":7},"children":["2. Portal Object"]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The name of the portal"]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional description of the portal"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"portals\": [\n    {\n      \"name\": \"Name of portal\",\n      \"description\": \"Description of portal\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"3-fromtopics-array","__idx":8},"children":["3. fromTopics Array"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specify the exact path to the topic to be added to the portal. This ensures that the intended topics are successfully associated with the portal."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Continue adding each path to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"fromTopics\""]}," array, ensuring each entry follows the same format."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"fromTopics\": [\n    {\n      \"path\": \"Path of the Topic\"\n    },\n    {\n      \"path\": \"Path of the Topic/Sub Topic\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"4-fromfolders-array","__idx":9},"children":["4. fromFolders Array"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specify the exact path to the folder to be added to the portal. This ensures that the intended articles within the folders are successfully associated with the portal."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Continue adding each path to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"fromFolders\""]}," array, ensuring each entry follows the same format."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"fromFolders\": [\n    {\n      \"path\": \"Path of the folder\"\n    },\n    {\n      \"path\": \"Path of the folder/sub folder\"\n    }\n  ]\n}\n\n","lang":"json"},"children":[]}]},"headings":[{"value":"Portal Import","id":"portal-import","depth":1},{"value":"About Portals","id":"about-portals","depth":2},{"value":"Organizing the Portal Structure","id":"organizing-the-portal-structure","depth":2},{"value":"Creating Portals","id":"creating-portals","depth":2},{"value":"Understanding the JSON Format","id":"understanding-the-json-format","depth":3},{"value":"Parameters","id":"parameters","depth":3},{"value":"1. Portals Array","id":"1-portals-array","depth":4},{"value":"2. Portal Object","id":"2-portal-object","depth":4},{"value":"3. fromTopics Array","id":"3-fromtopics-array","depth":4},{"value":"4. fromFolders Array","id":"4-fromfolders-array","depth":4}],"frontmatter":{"seo":{"title":"Portal Import"}},"lastModified":"2026-04-23T22:35:09.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/guides/ingestion/portal-import-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}