As of June 1, 2015, the IDE Connector documentation will no longer be maintained by Atlassian. See https://developer.atlassian.com/blog/2015/06/discontinuing-ide-connectors-support/ for more information. We will also be making this documentation available for our open source community here: http://atlassian-docs.bitbucket.org/

This page tells you how to configure your Atlassian Connector within IntelliJ IDEA. Before following the steps below, please make sure that you have installed the connector, as described in the Installation Guide.

(info) The connector configuration panels display the version number and the SVN repository version of the Atlassian Connector that you are currently using.

The Atlassian Connector for IntelliJ IDEA stores configuration settings at two levels in IntelliJ IDEA:

  • Server connections are stored as project settings in IntelliJ IDEA. Project settings allow you to share the same server connections with other members of your project team. Additionally, if you work on more than one project, this allows you to configure different servers for each project. Project-level settings can be stored in your source control repository, so that the connector will load the settings at the same time as loading the project into IDEA.
  • Other options are stored as IDE settings in IntelliJ IDEA. IDE settings allow each developer to configure their own workspace-specific settings, such as polling intervals and the behavior of notification popups.

On this page:

Configuring your General Options

Screenshot: General tab of the connector's IDE Settings panel

The 'General' tab is used to define the upgrade options for your connector, configure an HTTP proxy and set other options as described below.

To access the general options:

  1. Go to the 'IDE Settings' for the 'Atlassian Connector', by doing one of the following:
    • Open the IDEA 'Settings' dialog, then go to the 'IDE Settings' section and click the 'Atlassian Connector' icon.
    • Or you can click the configuration icon on your connector window.
  2. Click the 'General' tab.

Automatic Upgrade

The connector's auto-upgrade feature, if enabled, will prompt you to install the most recent version of the connector when available.

To configure the connector's auto-upgrade feature:

  1. Put a tick in the 'Enabled (stable version)' checkbox to enable the connector auto-upgrade feature. The connector will check for the latest available stable (released) version of the connector.
  2. Put a tick in the 'Check snapshot versions' checkbox if the auto-upgrade should include unstable (development) versions of the connector as well as stable versions.

Manual Upgrade

To check immediately for the latest version of the connector:

  1. Select one of the radio buttons as follows:
    • Stable only — The connector will check for the latest available stable (released) version of the connector.
    • Stable + snapshot — The connector will check for the latest version, including unstable (development) versions of the connector as well as stable versions.
  2. Click the 'Check now' button.

For more details, refer to Upgrading the IntelliJ Connector.

HTTP Proxy

You can configure the connector to use IDEA's proxy settings or to bypass IDEA's proxy settings altogether. If the connector is using IDEA's proxy settings, you can configure the settings here too.

To use IDEA's proxy settings:

  1. Select the 'Use IDEA proxy settings' radio button.
  2. Click the 'Edit IDEA proxy settings' button. A dialog will appear, similar to this screenshot:
  3. Enter the required settings and click the 'OK' button. If your proxy requires a domain name in addition to username, enter the information in the format domain\user.
  4. Restart IDEA for your changes to take effect.

Direct Click Through

When the direct click through option is enabled, you can click through from Crucible to open a review directly at the relevant code line in IDEA.

Check the 'Enable Direct Click Through' checkbox.To configure the direct click through feature:

  1. Choose a different TCP/IP port if necessary. Note that if you change this setting, you will need to restart IDEA to apply the change. This will have the effect of starting and stopping the inbuilt HTTP server.

Collection of Statistics

Put a tick in the 'Report anonymous usage statistics' checkbox if you are happy for us to collect anonymous information on the way you use the connector. All the information we collect is anonymous and cannot be used to identify you. We do not collect any private information. We use a randomly generated unique ID to differentiate one installation from another. See Collecting Usage Statistics for the IntelliJ Connector.

Configuring a Default Username and Password

You can define a single username and password as default login credentials. You can then decide to use these default credentials for one or more of the servers that you configure for the connector.

Defining the Default Credentials (Username and Password)

There are two ways to define your default credentials:

  • When you supply your credentials for a server, the connector will ask whether you want to use these credentials as the default. Click 'Yes'.

Screenshot: Popup offering to use default credentials

  • Otherwise, you can define the default credentials on the 'Defaults' tab of the connector's 'Project Settings' panel:
    1. Open the IDEA 'Settings' dialog.
    2. Go to the 'Project Settings' section and click the 'Atlassian Connector' icon.
    3. Click the 'Defaults' tab.

Screenshot: Defaults tab with the default credentials at the bottom

 

Using the Default Credentials (Username and Password)

You can use your default credentials for one or more of the servers that you configure for the connector:

  1. Still on the connector's 'Project Settings' panel, click the 'Servers' tab.
  2. Select the relevant server.
  3. Put a tick in the 'Use Default Credentials' checkbox.

Configuring Servers and Display Options

Configuring your JIRA Server Connections

To configure your JIRA server connection(s):

  1. Go to the 'Project Settings' for the 'Atlassian Connector', by doing one of the following:
    • Open the IDEA 'Settings' dialog, then go to the 'Project Settings' section and click the 'Atlassian Connector' icon.
    • Or you can click the configuration icon on your connector window.
  2. Go to the 'Servers' tab.

To add a JIRA server:

  1. Click the plus icon on the configuration panel.
  2. A list of server types will appear. Select 'Add JIRA Server'.
  3. A form will appear. Enter the information as follows:
    • 'Server Enabled' — Leave this checkbox ticked (default). If necessary, you can remove the tick to disable particular servers without deleting them. This is useful if your servers are behind a firewall and you don't have access to them.
    • 'Server Name' — A description of your JIRA server.
    • 'Server URL' — The address of your JIRA server.
    • 'Username' and 'Password' — The login name and password you use to access the JIRA server.
    • Remember Password — Put a tick in the checkbox if you want to save your password on disk. Leave the checkbox unticked if you want to be asked for a password every time you start your IDE.
      (info) If you choose to remember the password, it is stored in a Base64 encoding, so it is not really secure.
    • 'Use Default Credentials' — Put a tick in the checkbox if you want to use the single username and password that you have defined as your default credentials. You can set the default credentials on the 'Defaults' tab.
  4. If you want to use basic HTTP authentication for your JIRA server, fill out the fields in the 'Additional Configuration' section as follows:
    • 'Use Basic HTTP authentication' — Tick this checkbox.
    • 'Username' and 'Password' — The login name and password you use to access the JIRA server.
  5. Click the 'Test Connection' button to check that the connection to the server works.
  6. Click 'Apply' to save your changes and continue with server configuration, or 'OK' to save your changes and close the configuration tab.
  7. Click the 'Defaults' tab to set your default server (if you have defined more than one JIRA server) and default project.
  8. Now you can configure the JIRA options, as described below.

(info) You can add more than one JIRA server.

Configuring your JIRA Options

  1. Open the IDEA 'Settings' dialog, then go to the 'IDE Settings' section and click the 'Atlassian Connector' icon.
  2. Define the maximum number of issues that the connector will show on each screen. At display time, if there are more issues than specified here, the connector will display a 'Get More Issues...' link allowing you to retrieve the next batch of issues from the server.

Screenshot: Configuring JIRA server connections

 

Screenshot: Configuring JIRA IDE options

Configuring your Bamboo Server Connections

To configure your Bamboo server connection(s):

  1. Go to the 'Project Settings' for the 'Atlassian Connector', by doing one of the following:
    • Open the IDEA 'Settings' dialog, then go to the 'Project Settings' section and click the 'Atlassian Connector' icon.
    • Or you can click the configuration icon on your connector window.
  2. Click the 'Servers' tab.

To add a Bamboo server:

  1. Click the plus icon on the configuration panel.
  2. A list of server types will appear. Select 'Add Bamboo Server'.
  3. A form will appear. Enter the information as follows:
    • 'Server Enabled' — Leave this checkbox ticked (default). If necessary, you can remove the tick to disable particular servers without deleting them. This is useful if your servers are behind a firewall and you don't have access to them.
    • 'Server Name' — A description of your Bamboo server.
    • 'Server URL' — The address of your Bamboo server.
    • 'Username' and 'Password' — The login name and password you use to access the Bamboo server.
    • Remember Password — Put a tick in the checkbox if you want to save your password on disk. Leave the checkbox unticked if you want to be asked for a password every time you start your IDE.
      (info) If you choose to remember the password, it is stored in a Base64 encoding, so it is not really secure.
    • 'Use Default Credentials' — Put a tick in the checkbox if you want to use the single username and password that you have defined as your default credentials. You can set the default credentials on the 'Defaults' tab.
  4. Click the 'Test Connection' button to check that the connection to the server works. A list of build plans will appear.
  5. If your Bamboo build server is located in a different time zone than you, you can manually adjust the 'Time Zone Difference'. You should specify a positive difference if your time is ahead of your build server (e.g. you are in Russia and the build server is in the UK). You should specify a negative difference if your time is behind your build server (e.g. you are in the US and your build server is in Spain).
  6. Now select the Build Plans that the connector will watch. You can either select plans manually from the list of plans defined on the Bamboo server, or simply use your favorite plans as defined on the server. Your favorite plans are marked with a yellow star .
  7. Click 'Apply' to save your changes and continue with server configuration, or 'OK' to save your changes and close the configuration tab.
  8. Now you can configure the Bamboo options, as described below.

(info) You can add more than one Bamboo server.

Configuring your Bamboo Options

  1. Open the IDEA 'Settings' dialog, then go to the 'IDE Settings' section and click the 'Atlassian Connector' icon.
  2. Define the behavior of the popup window that is shown when the status of the build changes. (See Working with Bamboo Builds in IDEA.)
  3. Set the polling interval that the connector will use to monitor build plans on all defined Bamboo servers. Specify the value in minutes.

Configuring your Crucible Server Connections

To configure your Crucible server connection(s):

  1. Go to the 'Project Settings' for the 'Atlassian Connector', by doing one of the following:
    • Open the IDEA 'Settings' dialog, then go to the 'Project Settings' section and click the 'Atlassian Connector' icon.
    • Or you can click the configuration icon on your connector window.
  2. Click the 'Servers' tab.

To add a Crucible server:

  1. Click the plus icon on the configuration panel.
  2. A list of server types will appear. Select 'Add Crucible Server'.
  3. A form will appear. Enter the information as follows:
    • 'Server Enabled' — Leave this checkbox ticked (default). If necessary, you can remove the tick to disable particular servers without deleting them. This is useful if your servers are behind a firewall and you don't have access to them.
    • 'Server Name' — A description of your Crucible server.
    • 'Server URL' — The address of your Crucible server.
    • 'Username' and 'Password' — The login name and password you use to access the Crucible server.
    • 'Remember Password' — Put a tick in the checkbox if you want to save your password on disk. Leave the checkbox unticked if you want to be asked for a password every time you start your IDE.
      (info) If you choose to remember the password, it is stored in a Base64 encoding, so it is not really secure.
    • 'Use Default Credentials' — Put a tick in the checkbox if you want to use the single username and password that you have defined as your default credentials. You can set the default credentials on the 'Defaults' tab.
  4. Click the 'Test Connection' button to check that the connection to the server works.
  5. Click 'Apply' to save your changes and continue with server configuration.
  6. Click the 'Defaults tab to set up a default Crucible server, project and repository. These defaults will be used when you create a review directly from your source within IDEA.
  7. Now you can configure the Crucible options, as described below.

(info) You can add more than one Crucible server.

Removing a Server Connection

To remove a server from the list:

  1. Select the server.
  2. Click the minus icon on the configuration panel.

Reporting Bugs and Requesting New Features

Click the following links on the Project Settings or IDE Settings panel:

  • Report Bug — This will open a bug-creation page in the connector's JIRA issue tracker. It will automatically populate the connector version number and details of the environment (Java version and vendor, OS details, build number of your IDE).
  • Request Feature — This will open an issue-creation page of the 'Story' type in the connector's JIRA issue tracker. Use this issue type to request new connector functionality.

Getting Help

Click the 'Help' link on the Project Settings or IDE Settings panel. This will open the online documentation page which tells you how to configure the connector — namely, this page. From here, you can click the links to view other online documentation pages.

If you're looking for support or other help, please take a look at the links on our documentation home page.

RELATED TOPICS

Installation and Upgrade Guide for the IntelliJ Connector
Using Bamboo in the IntelliJ Connector
Using Crucible in the IntelliJ Connector
Using FishEye in the IntelliJ Connector
Using JIRA in the IntelliJ Connector

  • No labels

8 Comments

  1. Ilya Tsarev

    Hello.

    Is it possible to use the following way of authentication in plugin?

    1. Connect to JIRA https URL.
    2. Redirect to another URL if no session (cookie).
    3. Authenticate with eToken certificate on this URL (eToken certificate can be added to JAVA keystore).
    4. Back to JIRA URL with valid session (cookie).

    If not, please provide this method in future versions, thanks.

  2. Anonymous

    This page says, "Direct click through is not yet available" however it does work with Fisheye/Crucible. Can you update this page?

    1. Piotr Maruszak

      Thanks for finding this inconsistency. I've removed the warning.

  3. David McClelland

    Every time I start IntelliJ I get an error message that my Atlassian plugin settings could not be restored and that I should use some other method to set them up intead of the plugin UI inside Intellij. using Win 64 12.1.5.

    "Error while loading the configuration for Atlassian Connector for InteliJ IDEA Empty configuration will be used. If you want to preserve settings stored in your configuraiton, do not edit your Atlassian Connector for IntelliJ IDEA configuration using IDEA, but instead close the project and try resolve the problem by modyfing dirtectly the configuration file

     

    Typos included.

     

    Please advise - this is incredibly annoying while on bug-hunt 

  4. Aaron Held

    This works well with Idea 13.1.3 and the onDemand instance BUT you cannot user your email login

    you must use the non-email username

    so aheld@mycompany.com does not work, but aheld does

     

     

  5. Ray Gouffe

    Our domain includes lots of references to names that match the same pattern as a jira, EG, "MSH-10". (HL7 is full of these segments that are named this way)

    It would be nice to have a filter to prevent the connector from turning those comments into links to links to our JIRA instance.

    1. Karol Lopacinski

      We've been working on this issue recently, and a snapshot version that deals with it should be ready and released shortly.

      Please refer to our Upgrading the IntelliJ Connector guide for information on how to check for snapshot updates.

      1. Ray Gouffe

        Thanks, I have upgraded to 3.0.14 and I can see that the plugin now only creates links for existing Jiras and comments containing MSH-XX no longer show up as links.

         

        Thanks