Share this page

# Work in IntelliJ IDEA

You can do your OpenText Software Delivery Management work directly from the IntelliJ IDEA IDE.

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

In this topic:

## About the plugin for IntelliJ IDEA

Using the plugin, developers can connect to a workspace, view OpenText Software Delivery Management 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 OpenText Software Delivery Management.

## Prerequisites

This section describes the prerequisites for the IntelliJ IDEA plugin.

### Supported operating systems

Operating system | supported version
--- | ---
Windows | 10, 8, 7 (Normal and Dracula themes)
Ubuntu | 16.04
macOS | 10.12

### Supported software

App / Plugin | Version
--- | ---
OpenText Software Delivery Management IntelliJ IDEA plugin | 12.53.21 and later
OpenText Software Delivery Management | 12.53.20 and later
IntelliJ IDEA | 2017.1 and later

## Install the plugin for IntelliJ IDEA

This section describes how to download and install the plugin for IntelliJ IDEA.

To install the plugin:

1. Download the OpenText Software Delivery Management IntelliJ plugin from the JetBrains Plugins store.

2. After installing the plugin, restart IntelliJ IDEA.

## Configure the connection

After installation, a new category of settings is available in IntelliJ IDEA. This category contains the fields you need to connect IntelliJ IDEA to OpenText Software Delivery Management.

To configure the connection:

1. In IntelliJ IDEA, choose File -> Settings -> OpenText Software Delivery Management Settings.

2. Enter the URL for the OpenText Software Delivery Management server. The URL can include the query parameters for the relevant space and the workspace, in which case the Space and Workspace fields are automatically populated. Either of the following formats is valid:

   -     https://<server>:<port>

   -     https://<server>:<port>/ui/?p=<spaceID>/<workspaceID>

3. Log in with a browser or directly from the IDE.

   Log in method | Description
   --- | ---
   Browser | The login window opens, enabling you to enter your credentials. Use this option for both SSO and non-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 in.
   Username and password | Enter your credentials for logging in 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 OpenText Software Delivery Management from within IntelliJ IDEA.

## Work on your items

You can perform the following actions on your items from the My Work tab.

Action | Details
--- | ---
Open the My Work tab | In IntelliJ IDEA, click and select OpenText Software Delivery Management. The My Work tab opens, displaying work assigned to you, grouped by category. Use the check boxes in the My Work tab to filter which items you can see. When you start another session, the IntelliJ IDEA plugin remembers what you were working on last time, and opens tabs in the OpenText Software Delivery Management pane accordingly. Most OpenText Software Delivery Management items are available from the IDE. You can use the Refresh button , Expand button , and the Collapse button to refresh the display and to expand or collapse the My Work categories. 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 select Start work. When you are done, right-click and select Stop work.
View an item's details | Double-click an item to open its details in a separate pane. Click the Select fields button to select which fields to display. These settings only affect you. When you start another session, the IntelliJ IDEA plugin remembers your field selection. To display the details of an item in OpenText Software Delivery Management, click the item name, which is a link.
Search for items | You can search all OpenText Software Delivery Management items and display the results, showing only the relevant items based on search criteria. Tip: The search looks through all items, not just the ones assigned to you. You can use the search to assign an item to yourself, or click Add to My Work from the context menu. Enter a search string in the search box. The search results are opened in a list. The plugin remembers the last five searches you ran. Click the search arrow to select one and re-run the search.
Update your items | As you implement stories and fix defects in IntelliJ IDEA, update your items. Move the status of an item from one phase to another, according to the defined 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.
Download Gherkin test scripts to implement automation | Gherkin tests can be initially created in OpenText Software Delivery Management, and then automated using IntelliJ IDEA. In the My Work pane, right-click a Gherkin test, and select Download script. The downloaded script name is in the format `<TestName>-<TestID>.feature`.
Download BDD scenarios to implement automation | This is supported with IntelliJ 2020.2 (plugin version 2020.2-15.1.40.1) and later. You can create and run BDD (behavior-driven development) tests in OpenText Software Delivery Management using Gherkin scenarios, using the Cucumber-JVM framework. In the My Work pane, right-click a BDD scenario, and select Download script. The downloaded script name is in the format: <BDD Name>_<BDD ID>
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. In the My Work pane, right-click a user story, a quality story, a defect, or a task and select Start work. A "play button" is displayed on the item icon. The item is displayed as a button in the toolbar in IntelliJ IDEA. You can click this button to open the item's details on a tab. In the My Work pane, right-click a user story, a quality story, a defect, or a task and select Copy Commit Message. You do not have to "start work" to copy the commit message. For details about editing commit messages, see Track commits to your SCM 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. If you chose to Start work, click the Stop work button in the toolbar in IntelliJ IDEA. You can also manually edit commit messages, without using auto-complete. For details, see Track commits to your SCM system.
Dismiss items | Remove items from your My Work list if they are no longer relevant. Right-click the item and select Dismiss. The items are removed from My Work, but are not deleted in OpenText Software Delivery Management.

## Add navigation links to work items

You can configure IntelliJ to add navigation links to the Version Control Log and History tab. These links open OpenText Software Delivery Management work items in your browser.

To add navigation links:

1. Open the IntelliJ settings.
2. Go to Version Control > Issue Navigation, or search for 'issue navigation' using the search bar.

3. In the Issue Navigation window, click the Add issue button +.

   The Add Issue Navigation Link dialog box opens.

4. Enter the issue details.

   Field | Value
   --- | ---
   Issue ID | Enter the following regular expression to instruct IntelliJ to parse the version control log and highlight the links to OpenText Software Delivery Management items: `([Dd][Ee][Ff][Ee][Cc][Tt]|[Ss][Tt][Oo][Rr][Yy]|[Uu][Ss]|[Qq][Ss]).*#(\d+)`
   Issue links | Enter a URL for the OpenText Software Delivery Management items. https://<serverURL>:<serverport>/ui/entity-navigation?&p=1001/1002&entityType=work_item&id=$2 For example: `https://acme.com:8080/ui/entity-navigation?&p=1001/1002&entityType=work_item&id=$2`
   Example | Displays the result of your input.

5. Click OK.

6. Open the Control log. It contains direct links to the OpenText Software Delivery Management items, such as defects and user stories.

## See also

- Integrations
- IDE integrations

https://admhelp.microfocus.com Software Delivery Management 8942
Tips to improve your search results... OpenText™ Software Delivery Management Help Center OpenText™ Software Delivery Management Help 26.3 All View Local Help Center View Online Help Center Version: