Work in IntelliJ IDEA

You can do your ALM Octane work directly from the IntelliJ IDEA IDE. To do so, install the ALM Octane plugin for IntelliJ IDEA.

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

About the ALM Octane plugin for IntelliJ IDEA

Using the plugin, developers can connect to an ALM Octane workspace, view ALM Octane items, and make updates.

The plugin is open source. To access the source code, see https://github.com/MicroFocus/octane-intellij-plugin.

The plugins support two-way integration:

  • The plugin updates all data in the host IntelliJ IDEA application.

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

Back to top

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

Back to top

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.

Back to top

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 space and the workspace. The format is: 

    https://<server>:<port>/ui/?p=<spaceID>/<workspaceID>
  3. Either log in with a browser or directly from the IDE:

    • Login using a browser. The ALM Octane login window displays and you can enter your credentials. Use this option in for both non-SSO and SSO, federated environments, and for session timeouts.

      Tip: In the login window, you can also click the Click here to use your system default browser link to open an authentication page for logging in. Enter your credentials, close the browser, and you will be logged into ALM Octane.

    • Login with username and password. Enter your credentials for logging into ALM Octane directly. This option retains your credentials so you do not have to enter them each time.

  4. Click Test connection.

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

Back to top

Work on your ALM Octane items

This section describes how to do your ALM Octane from ALM Octane's My Work tab.

  1. Open the ALM Octane My Work tab

    On the bottom left, click and select ALM Octane. The tab for My Work opens, displaying work assigned to you, grouped by category.

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

    Most ALM Octane items are available from the IDE.

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

    Tip: To indicate that you are working on a particular item, and associate code changes with the item, right-click the item in the My Work list, and choose Start work. When you are done, right-click and choose Stop work.

  2. View an item's details

    Double-click most items to open their details in a separate pane.

    Click to choose which fields to see. You can also choose None or All. These settings only affect you. When you start another session, the ALM Octane IntelliJ IDEA plugin remembers your field selection.

    To display the details of an item in ALM Octane, click the item name, which is a link.

  3. Search for items

    You can search the list of items in My Work. 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.

    Tip: The search looks through all ALM Octane items, not just the ones assigned to you. You can use the search to assign an item to yourself.

  4. Update your items

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

    • Move the status of an item from one phase to another, according to the defined ALM Octane workflow.

    • Update field values.

      Limitation:  You cannot edit the Feature field.

      If a rule exists that makes a field read-only, and you modify its value, the plugin notifies you when you save the item.

    • Click Comments to view and add comments.

    Make sure to save .

  5. Download Gherkin test scripts to implement automation

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

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

    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.

  6. Start work and commit changes

    You can declare to the SCM system, such as Git, that you have started work on an item.

    You can commit changes for user stories, quality stories, defects, or tasks.

    1. In My Work, right-click a user story, a quality story, a defect, or a task and choose Start work.

      • A triangular "play button" appears on the icon for the item.

      • The item appears as a button in the toolbar in IntelliJ IDEA. You can click this button to open the item's details in a tab.

    2. In My Work, right-click a user story, a quality story, a defect, or a task and choose Copy Commit Message. Alternatively, you can also click in the toolbar in IntelliJ IDEA.

      Tip: You do not have to "start work" to copy the commit message.

      For details about editing commit messages, see Track changes committed to your Source Control Management system.

      A notification appears to let you know that the commit message has been copied to the clipboard. You can paste it into your Source Control Management (SCM) system.

    3. If you chose to Start work, click Stop work in the toolbar in IntelliJ IDEA.

Back to top

See also: