AppCode 2017.3 Help

Configuring Generic Task Server

AppCode supports integration with many task trackers out of the box. However, if you use a tracker that AppCode 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

1. Specify server URL and credentials

  1. Navigate to File | Settings | Tools | Tasks | Servers.
  2. Click new and select Generic.
  3. On the General tab, specify the URL of your task tracker, connection credentials and select the Use HTTP authentication checkbox.
    tutorial generic general tab

2. Configure server settings

  1. Switch to the Server Configuration tab.
  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 https://serverurl.atlassian.net/rest/api/2/search
  3. Add the ?jql={JQL_Query} expression to your task list URL: {serverUrl}/rest/api/2/search?jql={JQL_Query}.
    tutorial generic task list url
  4. Click Manage Template Variables at the bottom of the window to configure the JQL_Query variable.
  5. Click new in the top right-hand corner.
  6. In the new filed, 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.
    tutorial generic template variables

3. Configure response type and specify selectors

  1. In the Server Configuration window, 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: field.summary
    • description: field.description
    • updated: field.updated
    • created: field.created
  3. Click Test to make sure all parameters are configured correctly.
    tutorial generic configuration selectors

4. Upload issues from server

  1. Click the tasks combo and select Open Task. AppCode will load from the server all issues that match your configuration.
    tutorial generic open task combo
  2. Select the necessary issue from the list.
  3. Press N/A to open issue description and make sure all required details are obtained.
    tutorial generic open task
Last modified: 5 December 2017

See Also