Configuring the Plugin

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

Plugin configuration is available 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.

The plugin configuration panels display the version number and the SVN repository version of the plugin 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 plugin 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 Plugin Project Settings

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

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

The plugin Project Settings panel will open, as shown in the screenshot below.

Configuring your Server Connections

Screenshot: Configuring the plugin's servers on the Project Settings panel

The 'Servers' tab allows you to define the servers that the plugin connects to.

To add a server:

Click the plus icon on the configuration panel.
Select the server type: 'Bamboo', 'Crucible' or 'JIRA'.
Enter the server name, server URL and your username and password.
Click the 'Test Connection' button to check that the connection to the server works.

Other configuration options:

Server Enabled — You can enable or disable particular servers without deleting them. This is useful if your servers are behind a firewall and you don't have access to them.
Remember Password — You have an option to save your password on disk or to be asked for it every time you start your IDE.
If you choose to remember the password, it is stored in a Base64 encoding, so it is not really secure.
Build Plans — For Bamboo servers, you can select build plans that the plugin will watch. You can either select plans manually from the list of plans defined on the Bamboo server, or simply use your favourite plans defined on the server. Your favourite plans, as defined on the Bamboo server, are marked with a yellow star .

To remove a server from the list:

Select the server.
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 Plugin IDE Settings

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

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

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

Configuring the Plugin's Bamboo Options

Screenshot: Bamboo tab of the plugin 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 your Plugin.)
The polling interval that the plugin will use to monitor build plans on all defined Bamboo servers. Specify the value in minutes.

Configuring the Plugin's Crucible Options

Screenshot: Crucible tab of the plugin IDE Settings panel

The 'Crucible' tab is used to define:

The behaviour of the popup window that is shown when a Crucible review is added that affects you. (See Using Crucible in your Plugin.)
The polling interval that the plugin will use to monitor all defined Crucible servers. Specify the value in minutes.

Configuring the Plugin's JIRA Options

Screenshot: JIRA tab of the plugin IDE Settings panel

The 'JIRA' tab is used to:

Define the polling interval that the plugin will use to monitor all defined JIRA servers. Specify the value in minutes.
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 Plugin Options

Screenshot: General tab of the plugin IDE Settings panel

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

Automatic Upgrade

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

To configure the plugin's auto-upgrade feature:

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

Manual Upgrade

To check immediately for the latest version of the plugin:

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

For more details, refer to Upgrading the IDE Plugin for IDEA.

HTTP Proxy

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

To use IDEA's proxy settings:

Select the 'Use IDEA proxy settings' radio button.
Click the 'Edit IDEA proxy settings' button. A dialogue will appear, similar to this screenshot:
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.
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 plugin usage. If you agree to take part, the plugin will send Atlassian the unique ID generated by the plugin on its first installation. No other information is collected.

This feature is disabled by default. When you first open the plugin 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 plugin's JIRA issue tracker. It will automatically populate the plugin 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 plugin's JIRA issue tracker. Use this issue type to request new plugin 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 plugin — 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.

Page tree