Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Currently, the Aspire Confluence Plugin considers the following structure. Below is the detail of the required classes and implementation proposed for version 1 of the plugin.


1.1        Installation Dependencies

  • Currently, the only dependency to build the aspire-confluence-plugin is to have installed the Atlassian SDK framework described in section 4.

1.2        Running Installation Dependencies

Currently, the aspire-confluence-plugin is only supported by the connector Framework 4.0. You need to have the following components configured and running to make sure requests send by the plugin are getting processed to Aspire.

1.2.1       Aspire Updates Listener Service.

  • Go to the aspire 4.0 distribution where requests are going to get the process and go to the Services tab. Ex http://10.89.26.135:50505/aspire/admin/ui/files/#/svmanager
  • Click on Add Service and look for “Aspire Updates Listener”. If this option is not available, click on the Custom button and complete the information requested as follows.

...

This listener does not require any additional configuration, however make sure you use the Servlet name this service is using when you update the aspire-confluence-plugin.



1.2.2       Aspire Confluence Connector

The aspire-confluence-plugin requires to work a Confluence Connector, which can process the requests being sent by Confluence.

...

Also, keep in mind you need to use the same connector name in the plugin configuration so Confluence can publish its changes as expected.


1.2.3       Test dependencies setup

You can use Postman to test the setup of the plugin and connector.  You can follow the examples described on the files below to get a better understanding of the format and required parameters



1.3        Set up Aspire Confluence Code locally

  • Go to bitbucket clone the aspire-confluence-connector project. Make sure you use the proper branch. (Currently, plugin code is part of the implement-batch processing tab)
  • Navigate to the aspire-confluence-plugin folder and run the atlas-package command

  • Make sure the plugin was built success fully and jar is available at the target folder.



1.3        Install and configure the plugin into Confluence


Note: To install the plugin, you need to have administration permissions within the Confluence Server.

...