Installation and setup

Before using the Helix Plan Jira integration in your production environment, we recommend testing the integration using a test Helix Plan server and a sample Jira instance. This makes implementation easier and reduces the amount of changes you may need to make in the production environment.

Prerequisites

The following components are required to use the Helix Plan Jira integration.

  • Helix Plan server with the SDK module enabled for your license. Contact Perforce Support for information about licenses.
  • Helix Plan Jira integration (Node.js application) installed on Windows 10 or later or Windows Server 2016 or later
  • Jira Cloud or Jira LTS Data Center 8.13 and later

The integration must be able to access the Helix Plan server on port 50256 and the port that the Jira instance uses.

If you use Jira Cloud next-gen projects, before setting up the integration, you must add a custom text field named Helix Plan URL in each project you want to sync to.

Installation overview

To encrypt all data stored on the Helix Plan Server, use an encrypted disk. If you do not use an encrypted disk, some data related to Helix Plan on the server will remain unencrypted. Only the user running the server should have access to the database, installation, and backup folders.

Perform the following tasks to install and configure the Helix Plan Jira integration.

1. Add an SDK user in Helix Plan.

2. Optional - Add a Jira user to use for the integration.

3. Run the integration installation script and configure the integration settings file.

4. Configure Jira authentication in Helix Plan.

5. Optional - Configure the integration to start automatically.