Requirements: For using the Confluence Integration both Communote and Confluence must be accessible via http (or https).
The Confluence Plugin for version 3.x and 4.x is available here: https://marketplace.atlassian.com/1210903 You also can find the plugin using the Confluence Plugin Search searching for "communote". In case you have an older version of confluence please contact us.
First you have to install the jar file on your confluence.
- Open the Admin Panel of Confluence (Menu -> Browse -> Confluence Admin)
- Within the Admin Panel on the left side below the point Configuration -> Plug-in you find the management of the Confluence plug-ins
- If the plug-in is already installed (named "Communote Widget Plug-in"), deinstall it
- Now you can use the form to upload the JAR file
Figure 1 1: Admin view in Confluence 4.1
2.1 Configuration in Confluence
- Choose the plug-in "Communote Widget Plug-in" within the Admin Panel Configuration -> Plug-in
- Choose the option "Configure plug-in"
Insert the path to your Communote Client into the field "Communote URL"
This path must contain your Enterprise account ID . For standalone installations, this is global by default. The URL is composed of the following components: HTTP (s) :/ / <HOST> / microblog / <ENTERPRISE_ACCOUNT_ID>
Here are some examples
Figure 2 1: Configuration of the Communote Plugin
With the configuration options "Standard Widget Parameters" and "Specific CSS" You can specify how the macro pasted on a wiki page looks by default. In the macro itself, the user can override the default configuration.
2.2 Configuration in Communote
Tell Communote where to find Confluence
- Open the Admin Panel of Communote (follow the link "Administration" in the top navigation)
- Below the point "Integration" > "Confluence Configuration" you will find the settings for the integration of Confluence
Figure 2 2: Confluence Integration
Insert the URL of your confluence in the field "URL to confluence installation" under the heading "Confluence configuration", for example http://your.confluence.com
Optional: When rendering the widget in Confluence you can choose if user photos should be loaded from Confluence. For using this options you just have to activate the option "Load user photos from Confluence"
For saving the configuration you have to provide a Confluence login (either email or alias and password). This login will not be stored; it is only user for validating the configuration you provided. Check the field "Allow external authentication"
Login with your Confluence credentials
To be able to let users login themselves using their Conflunce login, you must set Confluence as your "Primary Directory". For this
- Navigate within the administration area to "Integration" -> "Overview"
- Activate the checkbox in front of "Confluence Integration"
- Save your settings
You should always have at least one local administration account and may leave the checkbox for "Allow authentication against internal database" enabled. Else it might happen, that you won't be able to login into Communote, if Confluence isn't available anymore.
If you already have configured a LDAP or Active Directory as your primary directory you might leave it as it is, as your Confluence will probably use the same LDAP/AD as its user base.
Activate new users automatically
Normally new users must be activated explicitly by an system administrator. To avoid this and let Confluence users be activated automatically you can enable automatic user activation:
- Navigate to "User Management" -> "Settings"
- Enable "
Include the following macro on your wiki page:
Figure 3 1: Communote Macro
To use the macro without the macro browser (i.e. Confluence 3.5) use the following notation:
Figure 3 2: Macrosettings
You can use the following Parameters to configure the Communote Macro via the Macrosettings.
|Parameter name||Possible values||Default value||Description|
|edShowCreate||true/false||true||Show the editor area for creating new notes|
|edInitLines||1 ... 50||2||The initial height of the editor|
|edShowTopicChooser||true/false||true||Show the topic selection, is used for adding new notes|
|edTopicList||-||A comma separated list of topic aliases, shown in the topic chooser Default: all writeable topics of the user|
|edPreselectedTopic||-||A preselected topic for writing|
|edShowTag||true/false||false||Show the tagging function for notes|
|edShowTagField||true/false||false||Show the tagging text field for notes (Communote Version 2.2)|
|edAddDefaultTags||-||A comma separated list of tags that are added to the notes by default|
|edShowUpload||true/false||false||Show the file upload function for notes (Communote Version 2.2)|
|Message Stream (msg)|
|msgShowMessages||true/false||true||Show the message stream|
|msgShowEdit||true/false||true||Show the note action link "edit"|
|msgShowReply||true/false||true||Show the note action link "reply"|
|msgShowDelete||true/false||true||Show the note action link "delete"|
|msgShowLike||true/false||true||Show the note action link "like"|
|msgShowFavor||true/false||true||Show the note action link "bookmark"|
|msgShowAuthorImg||true/false||true||Show the author images at notes and anwers|
|msgMaxCount||0 ... 50||10||The count of notes that are loaded at once|
|msgShowViews||all/following/me/favorites||all||The available views for the message stream (comma seperated list)|
|msgViewSelected||all/following/me/favorites||all||When multiple views are provided a special view can be preselected|
|msgFollowButton||true/false||true||Show a button to follow a single topic|
|msgHomeButton||true/false||false||Show a button to open the full application in a new window|
|fiShowFilter||true/false||true||Show the note filter area|
|fiShowSearch||true/false||true||Show the keyword search|
|fiShowTopic||true/false||true||Show the topic filter|
|fiShowTagCloud||true/false||true||Show the tag cloud|
|fiShowAuthor||true/false||true||Show the author filter|
|fiPreselectedSearch||-||To initialize the text search filter with a predefined string|
|fiPreselectedTopics||-||To initialize the topic filter with a comma separated list of topic aliases, shown in the topic filter (default: all readable for the user) Default: all readable topics for the user|
|fiPreselectedTopicIds||-||Like fiPreselectedTopics, but with the database id of topics|
|fiPreselectedTagIds||-||To initialize the tag filter with a comma separated list with the database id of tags|
|fiPreselectedAuthors||-||To initialize the author filter with a comma separated list of user aliases|
|fiPreselectedAuthorIds||-||To initialize the topic filter with a comma separated list of the database id of users|
|fiPreselectedNoteId||-||To initialize the note filter with the database id of a note|
|fiTopicPageSize||1 ... 50||10||The count of topics per page the user can filter by (topic filter)|
|fiAuthorPageSize||1 ... 50||14||The count of authors per page the user can filter by (author filter)|
|acShow||true/false||true||Show activities in the message stream (Communote Version 2.2)|
|acShowFilter||true/false||true||Show the activity filter (Communote Version 2.2)|
|utcTimeZoneOffset||-720 ... +840||0||Sets the timezone offset in minutes|
|doPublicAccess||true/false||false||Read access for anonymous users. Precondition: For the Communote instance the option for anonymous access has been activated (Administration > Security > Permissions) and there are topics that allow for anonymous access.|