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/

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 35 Next »

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

You can configure the connector at two levels in IDEA:

  • Project settings allow you to share the same server connections with other members of your project team.
  • IDE settings allow each developer to configure their own workspace-specific settings, such as polling intervals and the behaviour of notification popups.

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

On this page:

Configuring the Project Settings

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. Settings which are specific to the developer (such as username, password, filters and layout options) as stored as private settings and should not be committed to the repository.

Accessing the Atlassian IntelliJ Connector Project Settings

There are a number of ways to open the connector Project Settings panel:

  • If you have not yet configured any settings after installing the connector, the connector window will be empty except for two links. Click the link titled 'Configure Project Settings'.
  • Or you can open the IDEA 'Settings' dialogue, then go to the 'Project Settings' section and click the 'Atlassian IntelliJ Connector' icon.
  • Or you can click the configuration icon on your connector window.

The connector Project Settings panel will open, as shown in the screenshots below.

Configuring a Bamboo Server Connection

Screenshot: Configuring the connector's Bamboo servers on the Project Settings panel


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.
  4. Click the 'Test Connection' button to check that the connection to the server works. A list of build plans will appear.
  5. 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 favourite plans as defined on the server. Your favourite plans are marked with a yellow star .
  6. Click 'Apply' to save your changes and continue with server configuration, or 'OK' to save your changes and close the configuration tab.

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

Configuring a Crucible Server Connection

Screenshot: Configuring the connector's Crucible servers on the Project Settings panel


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.
  4. Click the 'Test Connection' button to check that the connection to the server works.
  5. Click the 'Refresh button. This will populate the 'Project' and 'Repository' dropdown lists, so that you select a default project and repository.
  6. Put a tick in the 'Fisheye instance' checkbox, if your Crucible server is linked to a FishEye server.
    (info) Don't worry if you do not have a FishEye server. There is very little effect on the connector's functionality. The only think you will not be able to do, is to access a FishEye diff view of the source code under review.
  7. Click 'Apply' to save your changes and continue with server configuration, or 'OK' to save your changes and close the configuration tab.

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

Configuring a JIRA Server Connection

Screenshot: Configuring the connector's JIRA servers on the Project Settings panel


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 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.
  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, or 'OK' to save your changes and close the configuration tab.

(info) You can add more than one JIRA 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.

Configuring the IDE Settings

IDE settings allow each developer to configure their own workspace-specific settings, such as polling intervals and the behaviour of notification popups.

Accessing the Atlassian IntelliJ Connector IDE Settings

There are a number of ways to open the Atlassian IntelliJ Connector IDE Settings panel:

  • If you have not yet configured any settings after installing the connector, the connector window will be empty except for two links. Click the link titled 'Configure IDE Settings'.
  • Or you can open the IDEA 'Settings' dialogue, then go to the 'IDE Settings' section and click the 'Atlassian IntelliJ Connector' icon.

The connector IDE Settings panel for Bamboo will open, as shown in the screenshot below.

Configuring the Connector's Bamboo Options

Screenshot: Bamboo tab of the connector IDE Settings panel


The 'Bamboo' tab is used to define:

  • The behaviour of the popup window that is shown when the status of the build changes. (See Using Bamboo in the IntelliJ Connector.)
  • The polling interval that the connector will use to monitor build plans on all defined Bamboo servers. Specify the value in minutes.

Configuring the Connector's Crucible Options

Screenshot: Crucible tab of the connector IDE Settings panel


The 'Crucible' tab is used to define:

  • The behaviour of the popup window that is shown when someone adds a Crucible review that affects you. (See Using Crucible in the IntelliJ Connector.)
  • The polling interval that the connector will use to monitor all defined Crucible servers. Specify the value in minutes.

Configuring the Connector's JIRA Options

Screenshot: JIRA tab of the connector IDE Settings panel


The 'JIRA' tab is used to:

  • Define the polling interval that the connector will use to monitor all defined JIRA servers. Specify the value in minutes.
    (info) This feature is not currently used.
  • Determine whether a textual description of the JIRA issue type, status and priority should be shown next to their icons in the JIRA issue list.

Configuring General Options

Screenshot: General tab of the connector 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.

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 Atlassian 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 dialogue 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.

Collection of Statistics

Put a tick in the 'Report anonymous usage statistics' checkbox if you are happy for us to collect information on the connector usage. If you agree to take part, the connector will send Atlassian the unique ID generated by the connector on its first installation. No other information is collected.

This feature is disabled by default. When you first open the connector configuration panel, we also ask you to decide whether you agree to participate in the statistics collection.

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

Installing the Atlassian IntelliJ Connector
User Guide for the Atlassian IntelliJ Connector
IDE Connector Documentation

  • No labels