PyCharm 2019.2 Help

Configuring Generic Task Server

PyCharm supports integration with many task trackers out of the box. However, if you use a tracker that PyCharm does not support yet, you can still integrate it configuring a so called generic server.

This tutorial describes how to:

  • Connect to JIRA Cloud as a generic server

  • Obtain the list of issues assigned to you

  • For each issue, get its ID, title, description, date and time when the issue was created and updated

Before you start configuring a connection to your tracker, note that PyCharm:

  • Supports only services with REST API.

  • Supports either Basic HTTP authentication or sending preliminary requests to the server.

  • Supports GET and POST requests.

  • Does not support pagination in server responses.

Specify server URL and credentials

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Tools | Tasks | Servers.

  2. Click the Add button and select Generic.

  3. On the General tab, specify the URL of your task tracker, connection credentials and select the Use HTTP authentication checkbox. The {serverUrl} is a variable that stands for the URL you have specified on the General tab.

    Specifying server URL and credentials

    You can enter an API token value in the Password field instead of your password.

Configure server settings

  1. Switch to the Server Configuration tab. Note that the Login URL field will be disabled, as you are using HTTP authentication.

  2. In the Tasks List URL, enter the URL for obtaining issues from the server. You can use variables or enter the full URL:

    {serverUrl}/rest/api/2/search or

    You can use code completion in the Login URL, Tasks List URL and Single Task URL fields.

  3. Add the ?jql={JQL_Query} expression to your task list URL: {serverUrl}/rest/api/2/search?jql={JQL_Query}.

    Configuring server settings

  4. Click Manage Template Variables at the bottom of the window to configure the JQL_Query variable.

  5. Click the Add button in the top right-hand corner.

  6. In the new field, specify variable name JQL_Query, and add its value assignee = currentUser() and resolution = Unresolved.
    This will let you obtain unresolved issues assigned to you.

  7. Click OK.

    Specifying template variables

Configure response type and specify selectors

  1. In the Server Configuration dialog, select the JSON response type.

  2. Specify selectors in the table to get IDs and titles of issues, and to obtain their description. You can also learn date and time when issues were created and updated:

    • tasks: $.issues

    • id: key

    • summary: fields.summary

    • description: fields.description

    • updated: fields.updated

    • created: fields.created

  3. Click Test to make sure all parameters are configured correctly.

    Configuring a response type and specifying selectors

Upload issues from the server

  1. Click the tasks combo and select Open Task. PyCharm will load from the server all issues that match your configuration.

  2. Select the necessary issue from the list.

  3. Press Ctrl+Q to open issue description and make sure all required details are obtained.

Last modified: 6 November 2019