- 1. QuickStart
Confluence Data Import
- 2025-12-01 14:17:25
- Sanplex Content
- 149
- Last edited by WANG JING on 2026-01-06 02:29:25
- Share links
I. Supported editions
- Sanplex provides Confluence data import for self-hosted deployments of Standard Version and above.
- Confluence versions: Confluence 6.x / 7.x / 8.x (Server) are supported. If your environment is outside this range, please contact us.
- Deployment types: Sanplex supports importing data from Confluence Server / Data Center and Confluence Cloud into a self-hosted Sanplex deployment.
II. Overview of Confluence import
【视频介绍】
1. Data compatibility
| Confluence data type | Supported | Imported into Sanplex as |
|---|---|---|
| Space | Yes | Document library |
| Page | Yes | Document |
| Folder | Yes | Chapter (original structure and titles are preserved) |
| Attachment | Yes | Attachments uploaded on pages are preserved |
| Macros | Yes | See 2.2 |
| Blog post | Yes | Document |
| User | Yes | All users are imported; nickname and email are preserved |
| Permissions | Yes | Space/folder/page/blog permissions are preserved, including user-related permission data |
2. Supported macros / plugins
| Confluence macro / plugin | Imported result | Notes |
|---|---|---|
| Attachments macro | Attachment data is preserved and downloadable; rendered in Sanplex attachment style | Cross-page attachment references require manual link updates |
| Link-type macros | Preserved as regular hyperlinks or attachment links | Internal links remain traceable; verify external links |
| Columns macro | Column layout and content are preserved | |
| Jira Issue macro | Converted to a hyperlink for a single issue; link remains traceable | Real-time status sync is not supported |
| Children display macro | Converted to a static list of hyperlinks; links remain traceable | |
| Quote / excerpt macros | Text and some functions are preserved | Some styles may be lost |
| Attachments list macro | Converted to a static attachment list; downloadable | |
| Code macro | Code blocks are preserved; syntax highlighting requires manual configuration; only basic rendering is supported | |
| HTML macro | HTML is converted to plain text or removed | Script execution is restricted by security policies; styles may be lost |
| Markdown macro | Markdown content is preserved as plain text | Complex layout may require adjustment in the Sanplex editor |
| Expand macro | Text content is preserved; interactive collapse/expand is kept | |
| Info panel macro | Text content is preserved, including visual indicators such as colors/icons | |
| Blog macro | Imported as a Sanplex document | |
| Draw.io plugin | Images are preserved; source files are stored as attachments and downloadable | Re-edit and re-upload manually to update diagrams |
| @Mention macro | Mentions are converted to plain text |
III. Pre-import preparation
1. Import method
- Confluence import is performed via API calls, importing Confluence pages, attachments, and page hierarchy into the Sanplex Docs module.
- Export a backup of Confluence attachments. The backup approach is shown below:
图1
2. Import considerations
- No volume limit: Sanplex does not impose a hard limit on the amount of Confluence data imported.
- Import duration: Parsing and processing time increases with data volume. For large migrations, run the import during off-peak hours to minimize performance impact.
3. Imported content
- Spaces: All spaces and user access permissions.
- Pages: Page content, page tree structure, and user access permissions.
- Attachments: All attachments.
- Users: All Confluence users are imported. Importing Confluence user groups and group permissions is not supported at this time.
Notes
- Confirm that your Confluence version and deployment type are compatible with your Sanplex deployment to ensure a successful import.
- Verify Confluence data integrity and format to meet API import requirements.
- For a unified migration plan, use a dedicated migration account with sufficient permissions.
- Ensure the account used has API access permissions.
- Back up existing Sanplex data before importing to prevent data loss or conflicts.
- If Confluence is still active, switch it to maintenance mode before exporting to prevent new data from being created during export.
- Because the import relies on network transmission, use a stable network to avoid interruptions.
IV. Start importing
Sign in as a Sanplex administrator. In Admin > Data Import, select Confluence Import.
图2
Click Import Confluence to enter the Confluence information confirmation page. (This import uses REST APIs—ensure reliable network connectivity to the Confluence server.)
图3
1. Connect to Confluence
1.1 Enter Confluence information (Confluence Cloud)
-
Confluence domain: The domain used to access Confluence Cloud in your browser address bar.
-
Confluence admin account: An account with site administrator privileges.
-
Confluence password / token: Use an API token to call Confluence APIs. Create a token on the Confluence API token management page, then paste it into the input field. See: how to create a Confluence API token.
- Token management:
https://id.atlassian.com/manage-profile/ - Token guide:
https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
- Token management:
1.2 Enter Confluence information (Server / Data Center)
-
Confluence domain: For self-hosted Confluence, the domain is typically composed of a server IP, hostname, or custom domain (for example:
http://confluence.yourcompany.com:8090), depending on your network configuration.- Default access after installation is usually via server IP/hostname, for example:
http://<server-ip>:<port>(such ashttp://192.168.1.100:8090). - If a custom domain is configured, confirm the domain with your deployment/IT team and verify reverse proxy (Nginx/Apache) or DNS settings.
- Default access after installation is usually via server IP/hostname, for example:
-
Confluence admin account: Typically created during installation (often the first admin user, commonly named
admin), or created later by administrators. You can also check Confluence user management or contact the Confluence deployment owner/team for account details.
图4
- Confluence password / token: The admin password is set during installation. If forgotten, reset it via database or recovery mode. Click Next to complete the connection and proceed to importing Confluence users.
图5
2. Import Confluence users
Import Confluence users into Sanplex. You can view and manage users in Admin > User Management > Users.
When importing users, the selected permission group determines the users’ default permission group after import. You can view and maintain permission groups in Admin > User Management > Permissions.
Click Previous to revise the Confluence connection information, or click Next to proceed to the data import page.
Note: If users already exist in the system, importing by Confluence email is recommended. If an email cannot be retrieved, Sanplex will generate usernames such as Confluence1, Confluence2, etc., and users can sign in using those usernames.
图6
图7
3. Import Confluence data
On the import page, click Start Import. Data will be imported automatically into Sanplex.
图8
Do not leave this page during the import. The process may take a long time depending on data volume—please wait patiently.
After all data types are imported successfully, the system will display Import successful. Confluence data import is then complete.
图9
V. Mapping tables
1. Mapping between Confluence and Sanplex Docs
| Confluence | Sanplex Docs | |
|---|---|---|
| Space | mapped to | Document library |
| Folder | mapped to | Chapter |
| Page | mapped to | Document |
| Database | mapped to | Document (original structure and hierarchy are preserved; content data is not imported at this time) |
| Smart link | mapped to | Document (stored as a link in the document) |
| Blog post | mapped to | Document |
Notes:
- Personal spaces in Confluence (permission set to “Only me”) are imported to Docs > My Space > Confluence Spaces > [library named after the space] by default.
- Non-personal spaces are imported to Docs > Team Space > Confluence Spaces > [library named after the space] by default.
- Archived spaces and pages can be imported. Archived folders are not supported at this time.
2. Permission mapping between Confluence and Sanplex Docs
| Confluence permission configuration | Sanplex Docs access control | |
|---|---|---|
| Space permissions | mapped to | Library access control |
| Folder permissions | mapped to | Chapter access control |
| Page permissions | mapped to | Document access control |
| Blog permissions | mapped to | Document access control |
| Database permissions | mapped to | Document access control |
| Smart link (no separate permissions) | mapped to | Document access control — default public |
Notes:
- Space-level user and group permissions are imported into Library private access control > Whitelist.
- Folder-level permissions (viewable by everyone, editable by specific users) are imported into Chapter private access control > Whitelist.
- Page-level permissions are imported into Document private access control > Read-only whitelist or Document private access control > Editable whitelist.
VI. Structure and page content
6.1 Tree navigation structure
After import, Confluence content is displayed in Sanplex Docs as follows:
图10
6.2 Imported spaces
图11
6.3 Imported folders
图12
6.4 Imported pages
图13
6.5 Imported blog posts
图14
6.6 Page content
After import, the page content is displayed in the Sanplex document editor as follows:
图15
Support
- Book a Demo
- Tech Forum
- GitHub
- SourceForge
About Us
- Company
- Privacy Policy
- Term of Use
- Blogs
- Partners
Contact Us
- Leave a Message
- Email Us: [email protected]