Work in IntelliJ IDEA

With ALM Octane IDE plugins, you can do your ALM Octane work (on stories, defects, tasks, and so on) directly within the development framework, including the IntelliJ IDEA IDE.

Limitation: User-defined fields are not accessible from IntelliJ IDEA.

About the ALM Octane plugin for IntelliJ IDEA

With ALM Octane IDE plugins, you can do your ALM Octane work (on stories, defects, tasks, and so on) directly within the development framework, including IntelliJ IDEA.

The ALM Octane IDE plugins utilize the ALM Octane REST API. Using the plugins, developers can connect to an ALM Octane workspace, view ALM Octane entities, and make updates.

The plugins support two-way integration:

  • The ALM Octane REST API updates all data in the host IntelliJ IDEA application.

  • Changes made in the IntelliJ IDEA impact data in ALM Octane.

Prerequisites

  1. Verify that your operating system is supported: 

    • Windows 10 (Normal and Darcula themes)

    • Windows 8 (Normal and Darcula themes)

    • Windows 7 (Normal and Darcula themes)

    • Ubuntu 16.04

    • macOS 10.12

  2. Verify that your software is supported:

    App / Plugin Version
    ALM Octane IntelliJ IDEA plugin

    12.53.21 and later

    ALM Octane 12.53.20 and later
    IntelliJ IDEA 2016.2 and later

Download and install the ALM Octane plugin for IntelliJ IDEA

  1. Go to the JetBrains Plugins store: https://plugins.jetbrains.com/idea/plugin/9540-alm-octane.

    Click Download.

  2. In IntelliJ IDEA, choose File -> Settings -> Plugins.

  3. Click Install plugin from disk...

  4. Navigate to, and select, the zip file that you downloaded.

  5. Click Apply and OK.

  6. Restart IntelliJ IDEA.

Tip: You can also look for the plugin in the IntelliJ store and install it directly using the Browse Repositories… button.

Connect to ALM Octane

After installing, a new category of settings is available in IntelliJ IDEA. We use this area to connect IntelliJ IDEA to ALM Octane.

  1. In IntelliJ IDEA, choose File -> Settings -> ALM Octane Settings.

  2. Enter the URL for the ALM Octane server. The URL should include the query parameters for the relevant shared space and the workspace. The format is: 

    https://<server>:<port>/ui/?p=<sharedspaceID>/<workspaceID>
    Example: http://MyServer.MyDomain.MyNet:8080/ui/?p=1000/5000
  3. Enter the user name and password for logging into ALM Octane.

  4. Click Test connection.

  5. Click OK.

You can now work with ALM Octane from within IntelliJ IDEA.

See your ALM Octane work

To open the ALM Octane pane:

  • In IntelliJ IDEA, click and select ALM Octane.

The tab for My Work opens, displaying work assigned to you.

You can see the following items that are assigned to you, grouped by category: 

Category Items / Description

Tasks

  • Tasks

    From a task you can navigate to its parent by right-clicking and choosing View parent details.

Backlog
  • User stories

  • Quality stories

  • Defects

Tests
  • Manual tests

  • Test suites

  • Gherkin tests

Runs
  • Non-completed or blocked runs for: 

    • Manual test runs

    • Suite runs

Comments

You can see the comments in which you are mentioned.

From a comment, you can navigate to the entity that has the comment. To do this, double-click. Alternatively, right-click and choose View parent details.

The ALM Octane IntelliJ IDEA plugin remembers what you were working on last time, and opens tabs in the ALM Octane pane accordingly.

You can use the buttons to refresh the display, and to expand or collapse the My Work categories. 

Tip: Do you want to indicate that you are working on a particular item? Right-click the item in My Work list, and choose Start work. When you are done, right-click and choose Stop work.

View details

Double-click any entity to open its details in a separate tab. For example, double-clicking a defect opens these details: 

Tip: You can also open the item in a browser directly in ALM Octane. Right-click an item in My Work list, and choose View in Browser. Alternatively, click the entity name, which is a link to ALM Octane.

Search

You can search the list of items in My Work and display, in a new tab, the relevant items based on search criteria.

To search, enter a search string in the search box.

The search results are opened in a new tab.

The plugin remembers the last five searches you ran. Click to select one and re-run the search.

The search runs in the scope of the current IntelliJ IDEA project only.

Update your items

As you implement stories and fix defects in IntelliJ IDEA, you can update your ALM Octane items.

  • Move the status of an entity from one phase (such as New) to another phase (such as Opened) as defined by ALM Octane workflow. Make sure to save .

  • Click Comments to view existing comments and to add a comment.

Download Gherkin test scripts to implement automation

Gherkin tests can be initially created in ALM Octane, and then automated using IntelliJ IDEA.

  1. From My Work, right-click a Gherkin test, and choose Download script.

  2. Select the folder into which you want to download the Gherkin test. Click OK.

    The downloaded script name is in the following format: 

    <TestName>-<TestID>.feature

    If the file already exists, you are prompted to overwrite it. Alternatively, you can cancel, and first rename the original script.

Commit changes with auto-complete

You can declare to the SCM system, such as Git, that you have started work on a story, defect, or task. This means that when you commit your changes for that entity, the commit message is auto-completed.

  1. In My Work, right-click a story, defect, or task.

  2. Choose Start work. A "play button" appears on the icon for the entity.

    Also, the entity appears as a button in the toolbar in IntelliJ IDEA. You can click this button to open the entity's details in a tab.

The auto-complete format for the commit message contains the type, entity name, and the entity ID. If committing tasks, the entity related to the task (such as a story or defect) is also included.

To cancel the auto-complete of the commit message, in My Work, right-click the entity and choose Stop work.

Tip: You can also manually edit commit messages, without using auto-complete. For details, see Track changes committed to your Source Control Management system.