# Portal Import

## About Portals

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.

[Learn more about Portals](https://help.egain.com/help/knowledge/portals_about.htm)

## Organizing the Portal Structure

1. **Review Existing Topics**: Assess the created topics and understand how they are structured.
2. **Determine Portal Categories**: Decide on the categories or sections the portal should have based on the topics.
3. **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.


## Creating Portals

To import topics into portals, a specific JSON format is required. This section explains the parameters used in the JSON structure.

### Understanding the JSON Format

The JSON structure for importing topics into portals consists of a `"portals"` array, with each portal represented by an object containing various properties.

### Parameters

#### 1. Portals Array

The `portals` array contains all the portals to be created.


```json
{
  "portals": []
}
```

#### 2. Portal Object

| Parameter | Description | Type | Required |
|  --- | --- | --- | --- |
| `name` | The name of the portal | String | Yes |
| `description` | Optional description of the portal | String | Optional |
| `addTopics` | Specifies the topics and folders to be added to the portal | Object | Yes |



```json
{
  "portals": [
    {
      "name": "Name of portal",
      "description": "Description of portal",
      "addTopics": {
        "fromTopics": [],
        "fromFolders": []
      }
    }
  ]
}
```

#### 3. fromTopics Array

* 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.
* Continue adding each path to the `"fromTopics"` array, ensuring each entry follows the same format.



```json
{
  "fromTopics": [
    {
      "path": "Path of the Topic"
    },
    {
      "path": "Path of the Topic/Sub Topic"
    }
  ]
}
```

#### 4. fromFolders Array

* 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.
* Continue adding each path to the `"fromFolders"` array, ensuring each entry follows the same format.



```json
{
  "fromFolders": [
    {
      "path": "Path of the folder"
    },
    {
      "path": "Path of the folder/sub folder"
    }
  ]
}
```