YouTrack Cloud 2022.2 Help

Import from Confluence

The import from Confluence lets you migrate one or more spaces including articles, comments, attachments, and users from a cloud or self-hosted Confluence service to YouTrack's Knowledge Base.

A setup wizard navigates you through the import configuration process. It prompts you to enter the connection settings and lets you map projects in YouTrack to spaces in Confluence. If your Confluence has a custom set of fields for articles, you can edit the import script in YouTrack directly.

Prerequisites

Before you import spaces from Confluence to YouTrack, check the following requirements:

  • Your Confluence version is 5.5.6 or later. The ability to import articles from earlier versions of Confluence has not been verified.

  • If you're importing content from a self-managed Confluence Server installation, the Confluence installation must be accessible over the internet. Specifically, you need to make sure that your network doesn't block connections between your Confluence installation and YouTrack.

  • Your user account in Confluence has administrative permissions.

Import Details

If the Confluence database contains references to entities that do not exist in YouTrack yet, they are created. The YouTrack user account you use to run the import should have enough permissions to create all imported entities. We recommend using an account with a System Admin role or the Low-level Admin Write permission to run the import.

Imported Entities

Here is the list of entities that are imported from Confluence and their mapping to YouTrack entities:

Entity in Confluence

Entity in YouTrack

Space

Project

Article

Article

Comment

Comment

User

User

Group

Group

Importing User Data

This integration also imports user accounts that are stored in the Confluence instance. The same values for users who created, updated, added comments to articles in Confluence are set to the corresponding user accounts in YouTrack.

  • Confluence Cloud limits the amount of user data that is accessible through a programmatic interface. In order to successfully map user activity in Confluence to imported articles in YouTrack, you need to upload a copy of the dataset for Confluence users to YouTrack before you start importing Confluence space data.

    During setup, you are asked to upload a CSV file that contains information about the user accounts that are currently stored in your Confluence database. If you don't have access to download this information, you will not be able to import data from your Confluence instance.

  • Self-hosted Confluence Server installations are not subject to this limitation. This means that you don't have to manually export and upload user data before you can import your articles into YouTrack.

To export user data for your Confluence instance:

  1. Navigate to the Directory section in Atlassian Administration and open the Users page.

  2. From the More menu in the upper-right corner of the header, click the Export users button.

    The option to export users in Atlassian Administration.
    • The Export users to CSV page opens.

    Select users to export page in Atlassian Administration.
  3. Use the following guidelines to configure the user selection for export:

    Setting

    Description

    Users

    Choose whether you want to export all users on the site or only from selected groups. Your selection should include all users who are associated with any issue-related events in the imported projects.

    User Status

    Choose whether you only want to export active users or all users. For best results, we suggest exporting all users.

    Additional Data

    Choose whether to export group membership and product access data. The data that is included in the user export file when these options are enabled are not required for importing issues into YouTrack.

  4. Click the Export users button.

    • Confluence generates a CSV file that contains user data from your Confluence instance and sends it to your email.

  5. Open your mailbox and download the CSV file with the user data.

Set up an Import from Confluence

Before you add a new import configuration, prepare the credentials that will grant access to your Confluence instance. You will need these credentials for authorization when setting up the import in YouTrack.

To configure an import from Confluence Cloud, you will need an API token. For details on creating an API token, see Create an API Token for Confluence Cloud.

Create an API Token for Confluence Cloud

To set up an import of articles from Confluence Cloud, first, you need to create an API token for your Atlassian account.

To create an API token for the Atlassian account:

  1. Log in to the Atlassian account settings with an account that is granted administrative permissions.

  2. Click the Create API token button and provide a label for the token.

  3. Click Create.

    • The new API token is added to the list.

The list of API tokens.

For more details on creating API keys for Atlassian products, refer to the Atlassian documentation.

Configure an Import from Confluence in YouTrack

The setup wizard guides you through the setup process.

To configure an import from Confluence:

  1. From the Administration menu, select Integrations > Imports.

  2. Click New import to open the setup dialog.

    New import dialog
  3. Select Confluence.

  4. Configure the import settings:

    Confluence import settings

    Setting

    Description

    Confluence URL

    Enter the base URL of the Confluence instance. For Confluence Cloud, make sure to include the /wiki path in the URL.

    Username or email

    Enter the username of the account that is used to log in to Confluence. This account must have access to the spaces that you need to import.

    Password

    Enter the password for the account that is used to log in to the Confluence instance.

    For Confluence Cloud, create an API token for your Atlassian account and paste it into the input field.

    If required by your Confluence instance, enable the Use SSL key for client authentication option.

    When done, click Next.

  5. Review the settings that you have provided.

    Select the Confluence spaces and target projects for import. For details, see Project Mapping.

    Confirm settings and start import.

    Optionally, you can also upload a CSV file with the user data from the source Confluence service. For details, see Importing User Data.

  6. When done, click Start import.

    • YouTrack will create new projects and import data to the existing ones according to the configured project mapping.

    • YouTrack will import articles, comments, and users to the target projects.

When you have set up an import project, it appears in the imports list. To view configuration and import details, select an import configuration from the list.

Import configuration details

In the details sidebar, YouTrack shows import status and details on the data that was imported. Click the Resume button in the toolbar to explicitly start polling for changes and importing updates from the source Confluence instance.

You can also download the import log file to study and investigate when needed.

Project Mapping

On the final step of the import setup, you have an option to select those Confluence spaces that you want to import to YouTrack. You can also choose whether to create a new project for the import or import data into an existing project in YouTrack.

Project Mapping

To configure project mapping:

  1. Locate those Confluence spaces that you want to import.

    Use the filter bar on the right to filter projects by name.

  2. Select the spaces that you want to import. Check the box on the top of the list to import all available Confluence spaces.

  3. Select a target YouTrack project for each Confluence space.

    • When loading the list of Confluence spaces for mapping, YouTrack checks for existing YouTrack projects with corresponding names. If it finds a YouTrack project with the same name as the Confluence space, YouTrack suggests it as the target project.

    • If there is no existing YouTrack project with the corresponding name, YouTrack suggests creating a new one.

  4. If you want to change a target project, select another option from the corresponding dropdown on the list.

  5. Click Start import to finalize import setup and start the import.

    • Import starts.

Import Options

After the initial import, the following controls are available in the sidebar:

Import Options

Control

Description

Resume

Immediately imports any changes made in the selected Confluence spaces after the previous import.

Edit

Opens the integration settings page in edit mode. Use this option to connect to a different Confluence instance, update the login credentials, or update project mapping.

Delete

Deletes the current import settings. Projects, articles, comments, users, and groups that were imported from the connected Confluence instance are not affected. If you delete the import settings and connect to the same Confluence instance, the articles are re-imported into existing projects with new IDs.

Last modified: 10 August 2022