Page History
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.architecture.
1.1 Installation Dependencies
...
The only dependency to build the aspire-confluence-plugin is to have installed the Atlassian SDK framework
...
.
1.2 Running Installation Dependencies
Currently, the The aspire-confluence-plugin is only supported by the connector Connector Framework version 4.0. You need to have the following components configured up and running to make sure requests send by the plugin are getting processed to by Aspire.
1.2.1 Aspire Updates Listener Service.
- Go to the aspire Aspire 4.0 distribution where requests are going to get the process and go to the Services tab. Ex
- Example: http://
- 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 reference the Servlet name this service is using configured when you update the aspire-confluence-pluginAspire Confluence Plugin.
1.2.2 Aspire Confluence Connector
The aspire-confluence-plugin Aspire Confluence Plugin requires to work a in parallel with the Confluence Connector, which can process the requests being sent by the Confluence server.
- On the Aspire Content Source Manager view, select the option Add Source.
- Click on the Confluence button and enter the information requested as shown in the example below.
Note: Keep in mind that Confluence Connector requires a specific configuration to include attachments and comments, so event when the aspire-plugin-listener will monitor comments and attachments events, content will not be added into the publisher , if the connector is not set up properly.
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 described in the files below to get a better understanding of the format and required parameters
pushPostConfluence-Spaces-Attachments-Blogs.json
1.3 Set up Aspire Confluence Code locally
- Go to bitbucket Bitbucket and 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 successfully and the jar is available at the target folder.
1.
...
4
...
Install and configure the plugin into Confluence
Note: To install the plugin, you need to have administration Administrator permissions within the Confluence Server.
...
- Login into Confluence.
- Click on the Cog button at the right upper corner and select “Manage apps”
- Once the Confluence administration page has loaded. Click on the button “Upload app”.
- You will get a prompt window. Click on Choose File and browse to the location where the aspire-confluence-plugin.jar (generated on section 5.3) is located and click Upload.
- Wait until the installation process is completed.
- When the installation process is completed, you will get a confirmation from Confluence as shown below.
- Make sure all modules are loaded and enable successfully before entering the configuration.
To configure the plugin parameters, click on the “Configure” button and enter the information requested.
- Aspire Listener URL (Make sure this value matches the Aspire Listener URL configured on section 5.2.1)
- Content Source (Make sure this value matches the Confluence Content Source configured on in section 5.2.2).
Currently, the The Content Source field supports a custom configuration to post requests within multiple content sources and as well filter by specific spaces. If this configuration is required Content Source name should be separated by “;” and the detail of which spaces to crawl by connector need to be between brackets and each space should be separated by a comma, as shown in the example below.
...
- Batch timeout (Milliseconds
- Batch size
- Include Attachments
- Include Comments
By default, the Confluence will install the plugin with the following parameters.
...
- To refresh configuration parameters, go back to Manage Apps selection, open the plugin configuration and click on the disable button.
- Finally, click back on Enable to finish the Plugin Configuration.
Overview
Content Tools