Page tree
Skip to end of metadata
Go to start of metadata

1. Installation

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: 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. Configuration

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

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

  1. Navigate within the administration area to "Integration" -> "Overview"
  2. Activate the checkbox in front of "Confluence Integration"
  3. Save your settings

(warning) 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.

(warning) 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:

  1. Navigate to "User Management" -> "Settings"
  2. Enable "

3. Usage

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: {communote-html-client:additionalParameters=edShowCreate=false;msgHomeButton=true}

Figure 3 2: Macrosettings

You can use the following Parameters to configure the Communote Macro via the Macrosettings.

Parameter namePossible valuesDefault valueDescription
Editor  (ed)   
edShowCreatetrue/falsetrueShow the editor area for creating new notes
edInitLines1 ... 502The initial height of the editor
edShowTopicChoosertrue/falsetrueShow 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
edShowTagtrue/falsefalseShow the tagging function for notes
edShowTagFieldtrue/falsefalseShow 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
edShowUploadtrue/falsefalseShow the file upload function for notes (Communote Version 2.2)
Message  Stream  (msg)   
msgShowMessagestrue/falsetrueShow the message stream
msgShowEdittrue/falsetrueShow the note action link "edit"
msgShowReplytrue/falsetrueShow the note action link "reply"
msgShowDeletetrue/falsetrueShow the note action link "delete"
msgShowLiketrue/falsetrueShow the note action link "like"
msgShowFavortrue/falsetrueShow the note action link "bookmark"
msgShowAuthorImgtrue/falsetrueShow the author images at notes and anwers
msgMaxCount0 ... 5010The count of notes that are loaded at once
msgShowViewsall/following/me/favoritesallThe available views for the message stream (comma seperated list)
msgViewSelectedall/following/me/favoritesallWhen multiple views are provided a special view can be preselected
msgFollowButtontrue/falsetrueShow a button to follow a single topic
msgHomeButtontrue/falsefalseShow a button to open the full application in a new window
Filter  (fi)   
fiShowFiltertrue/falsetrueShow the note filter area
fiShowSearchtrue/falsetrueShow the keyword search
fiShowTopictrue/falsetrueShow the topic filter
fiShowTagCloudtrue/falsetrueShow the tag cloud
fiShowAuthortrue/falsetrueShow 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
fiTopicPageSize1 ... 5010The count of topics per page the user can filter by (topic filter)
fiAuthorPageSize1 ... 5014The count of authors per page the user can filter by (author filter)
Activities  (ac)   
acShowtrue/falsetrueShow activities in the message stream (Communote Version 2.2)
acShowFiltertrue/falsetrueShow the activity filter (Communote Version 2.2)
utcTimeZoneOffset-720 ... +8400Sets the timezone offset in minutes
doPublicAccesstrue/falsefalseRead 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.

  • No labels