Structure.Pages provides integration between Jira and Confluence, so it requires additional steps to install than a typical app that only works with one system. The following guide will walk you through the process of configuring both systems. If you have any issues with this process, please don't hesitate to contact us at firstname.lastname@example.org.
Steps to installing Structure.Pages:
1. Make sure you have a compatible version of Structure
In order to run Structure.Pages, you must also have Structure installed. Structure provides a way to organize issues and other items into hierarchical lists. It's our base product that Structure.Pages extends.
If you have Structure installed, please check that you have a version compatible with your version of Structure.Pages. The latest Structure is typically compatible with the latest Structure.Pages.
2. Configure Application Links between your Jira and Confluence
Application Links must be set up to make your Jira and Confluence work together and exchange data. You can learn more about Application Links and how to set them up in the Atlassian documentation.
Atlassian recommends using OAuth protocol for greater security. Structure.Pages supports OAuth, as well as other available protocols.
3. Install the special Confluence Helper app and configure Confluence
Now that Jira and Confluence can work together, we need to make sure Structure and Confluence can do the same. This requires an additional app for Confluence, which is free to download from the Atlassian Marketplace.
Install the free Confluence Helper for Structure app from the Atlassian Marketplace or by uploading the add-on from our Download page (see add-on upload documentation for Confluence). This add-on does not require any additional configuration. Once installed, it will take care of the integration with Structure on the Confluence side.
- Enable Remote API (XML-RPC & SOAP) in Confluence, via Administration | Further Configuration. This is necessary, because Structure.Pages needs XML-RPC to access methods not available through the REST API.
4. Install Structure.Pages and configure the integration
To install and configure Structure.Pages in Jira:
Install the Structure.Pages app from the Atlassian Marketplace or our Download page.
Obtain a license either from Atlassian Marketplace or ALM Works. 30-day evaluation licenses are available.
If you have a license from ALM Works, use the Administration | Structure | Structure.Pages License menu to install it.
If you received a license from ALM Works, the Add-On Manager may show Structure.Pages as Unlicensed and will suggest getting a free trial license. You can ignore this, since you have a license from ALM Works.
- Once Structure.Pages is installed, go to Administration | Structure and select Confluence Integration in the menu on the left.
- You'll see the list of Confluence instances you can connect to. These are the instances for which you have configured Application Links.
- Click Configure Integration next to the Confluence you want to work with.
Select the System Authentication method. The drop-down shows all authentication types you have configured in the Application Links. OAuth method is preferred, and it's recommended to use a user account with administrative privileges for this type of authentication.
It's recommended to choose the method that will allow Structure.Pages to see the most pages in Confluence. Users who will work with Confluence via Structure.Pages will only see pages that System Authentication permits, so if System Authentication permissions are more restrictive than a user's permissions, they won't be able to see some pages that should actually be visible.
- Select the User Authentication method. These settings are used when a specific user is working with Confluence through Structure: looking at the search results, creating or editing a page or changing links between issues and pages. Structure.Pages offers authentication methods in order of preference, so the default one is usually the best.
- Click Verify & Save Settings to apply the selected options. If you haven't enabled Remote API in Confluence, you'll get a message with instructions for how to to do that. Once it's enabled, click Verify & Save Settings again to save the settings.
- Once you are done with the configuration, you can start working with Confluence in Structure.