YouTrack Server 2024.3 Help

Import from JetBrains Space

The import from JetBrains Space lets you migrate projects, issues, comments, users, documents, and other data from a Space organization to YouTrack.

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 projects in Space. If your Space has a custom set of fields for issues, you can edit the import script in YouTrack directly.

Prerequisites

Before you import projects from Space to YouTrack, check the following requirements:

  • Your YouTrack and Space installations are accessible to inbound connections. Specifically, you need to make sure that your network doesn't block connections between your Space and YouTrack.

  • The account you use to connect to Space has access to the Space project you want to import. This is the user account whose private access token is used for authentication.

  • You have direct access to log in to the source application using a password or token.

    YouTrack's import engine doesn't support authentication through external authentication modules.

Import Details

If the Space 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 Space and their mapping to YouTrack entities:

Entity in Space

Entity in YouTrack

Details

Projects

Projects

Issues

Issues

Issue custom fields and their values

Issue custom fields and their values

Values of issue-typed custom fields

Issue links

YouTrack imports linked issues with the relates to link type.

Comments

Comments

Tags

Tags

YouTrack imports only those tags that the imported issues are tagged with.

Documents

Knowledge base articles

Attachments

Attachments

Users

Users

YouTrack imports only those user accounts that are set in any fields in the imported issues.

Teams

User groups

YouTrack imports only those teams that are set as values in team-typed custom fields.

Issue subscribers

Issue watchers

Import Limitations

Here is the list of entities in Space that the default import script doesn't process:

  • Issue history

  • Boards

  • Blog posts

  • Checklists

To import these entities, customize the default import script.

Set up an Import from Space

Before you add a new import configuration, you need to create a personal access token that will grant access to the target project in Space. Then you can use the token for authorization when setting up the import in YouTrack.

Create a Personal Token in Space

To set up an import of items from Space, first, you need to create a personal token for your Space organization.

To create a personal token in Space:

  1. Log in to Space with an account that is granted administrative permissions.

  2. Navigate to Authentication > Personal Tokens and click New personal token.

  3. Enter a name and specify the access scope for the token.

    The API token in Space

    If you're creating a personal token with limited access, enable those permissions that allow read access to the entities you need to import. The list of required permissions may vary depending on the Space setup and on the import script.

    Here is the minimal list of permissions required for the import with default settings:

    • View member profiles

    • View member profile basic info

    • View teams

    • View project details

    • View languages

    • View project parameters

    • View folder metadata

    • View documents

    • View issues

    • View participants in issue comment threads

  4. Click Create.

    • The new personal token is created.

  5. Copy the token to enter it in the import setup wizard.

For more details on creating API keys, refer to the Space documentation.

Configure an Import from Space in YouTrack

The setup wizard guides you through the setup process.

To configure an import from Space:

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

  2. Click New import to open the setup dialog.

    New import dialog
  3. Select Space.

    • Settings for a New Import from Space are displayed.

    Space import settings
  4. Enter values for the following settings:

    Setting

    Description

    Space URL

    The URL of your Space organization.

    Token

    The personal token you have generated in Space for the user account you use to access the target issues and documents.

    If required by your Space organization, enable the Use SSL key for client authentication option.

  5. Click the Next button.

    • The second set of import settings is displayed.

    Confirm settings and start import.
  6. Expand the Manage import for optional datasets section. Here you can configure the import engine to ignore certain parts of the source database during import.

    Setting

    Description

    Issue history

    Disable this toggle to ignore historical changes of issues during import.

    Issue links

    Disable this toggle to ignore links between issues during import.

    By default, these toggles are enabled. This means that YouTrack will pull historical changes and issue links from the import source if the import script supports it.

  7. Select the source and the target YouTrack projects for the import. For more details about project mapping configuration, see Project Mapping.

    Optionally, enable the Continuous import. When enabled, YouTrack will periodically poll the issues and documents in the selected Space project and import updates made since the last sync.

  8. Click the Start import button.

    • YouTrack creates new projects and imports data to the existing ones according to the configured project mapping.

    • YouTrack imports issues, comments, documents, and users from the selected Space projects to the target YouTrack projects.

    • If the Continuous import option is enabled, YouTrack will periodically check target Space projects for updated and new issues, comments, and documents.

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

List of configured import projects.

In the details sidebar, YouTrack shows import status, the date and time of the last import, and details on the data that was imported. If there are any problems encountered during import, the error messages are displayed here.

Click the Resume button in the toolbar to explicitly start polling for changes and importing updates from the source Space project.

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 can select those Space projects 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.

YouTrack recognizes when a web address has already mapped a source project by a previous import. Imported source projects that have already been mapped in YouTrack aren't selectable. You can create multiple import jobs from the same source without importing duplicate data.

Project Mapping

To configure project mapping:

  1. Locate those Space projects that you want to import.

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

  2. Select the projects that you want to import. Select the option at the top of the list to import all available Space projects.

  3. Select a target YouTrack project for each Space project.

    • When loading the list of Space projects for mapping, YouTrack checks for existing YouTrack projects with corresponding names. If it finds a YouTrack project with the same name as the Space one, 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 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 Space projects after the previous import.

Edit

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

Delete

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

Download import log

Downloads the import log. Use this option to view and investigate errors that occurred during import.

Last modified: 07 June 2024