YouTrack Standalone 2021.4 Help

Import from Confluence

The new option to import data 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.

In essence, an import configuration is a graphic UI representation of an import script. A setup wizard navigates you through the import configuration process, which covers standard articles settings in Confluence.

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 User Management section in Atlassian Administration and open the Users page.

  2. Click the Export users button in the header.

    • The Select users to export 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 Download file button.

    • The CSV file that contains user data from your Confluence instance downloads to your local directory.

Configure a New Import

To set up 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

    URL

    Enter the base URL of the Confluence instance.

    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 or API token

    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 installation, enable the Use SSL key for client authentication option.

    When done, click Next.

  5. 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 is shown in the imports list. To view configuration and import details, select an import configuration in the list.

Import configuration details

In the right sidebar, you see 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.

Edit Import Settings

To edit an existing import configuration:

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

  2. In the list of configured imports, select the one you need to edit.

    Details sidebar
  3. In the right sidebar, click Edit in the toolbar.

  4. While in the edit mode, change the import settings, including the connection settings.

    Edit import settings.
  5. When ready, click Resume import.

    • Your changes will be applied, and YouTrack will poll the source Confluence for updates.

Delete the Import Configuration

To delete an existing import configuration:

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

  2. In the list of configured imports, select the one you need to delete.

    Details sidebar
  3. Click the trash icon in the main toolbar of the page, or the Delete button in the right details sidebar. You can also delete an import configuration while in the Edit mode.

  4. In the shown dialog, confirm the operation by clicking Delete.

    Confirm delete operation
    • The selected import configuration is deleted.

    • Knowledge Base projects, articles, and users that are already imported remain in YouTrack.

Last modified: 14 July 2021