How to add application links using Jira Command Line Interface

This article explains how to add other Confluence application link to Jira and the reciprocal link of Jira in Confluence using Command Line Interface (CLI)

Confluence application link must be added in Jira and vice versa, simultaneously to establish a successful connection between the two applications. Use Atlassian Command Line Interface v8.6 to connect the two applications.

Instructions

Use addApplicationLink action to add the application links and establish a successful connection. By default, both incoming and outgoing links are enabled.

  1. Make sure the acli.properties file in the CLI client folder is filled with server details of both Jira and Confluence applications. Refer to the CLI Client Installation and Use for the installation guide.
  2. Comment out the default application in the acli.properties file as the actions are performed in Jira and Confluence simultaneously. Here is a sample properties file for your reference: 
  3. In a text file (say command.txt), add the following action commands with the respective server URLs:

    myconfluence --action addApplicationLink --url "http://jirasso.bobfire.com:8284/" --name "Jira" 
    myjira --action addApplicationLink --url "http://dockerhost2.bobfire.com:8180/" --name "Confluence 80" 

    In this example, myjira and myconfluence are names assumed for Jira and Confluence instances. You must replace these values with the names of your instances.

  4. Execute the file (created in the previous step) from the terminal using the run action.

    --action run --file "command.txt"

The links are established as shown:

  • From Confluence to Jira:

  • From Jira to Confluence:

     

If required, you can disable the incoming and outgoing links. Use the '--options disableIncoming' and '--options disableOutgoing' parameters along with the action command. A sample action command for the same is as follows:

myconfluence --action addApplicationLink --url "http://jirasso.bobfire.com:8284/" --name "Jira" --options disableIncoming --options disableOutgoing
myjira --action addApplicationLink --url "http://dockerhost2.bobfire.com:8180/" --name "Confluence 80" --options disableIncoming --options disableOutgoing

The application link URL uses the base URL, that is configured in your application, to connect to the respective application.

  • Make sure the server base URL is same as the application URL.
  • Use '--options impersonate' with the addApplicationLink action to enable shared users.
  • It is recommended to test this scenario in a non-production environment or run the action with the --simulate parameter to verify the behavior before deploying.