| Name | Survey Plugin |
|---|---|
| Vendor | Confluence Community |
| Authors | Matt Wizeman, Frank Stiller |
| Homepage | http://confluence.atlassian.com/display/CONFEXT/Survey+Macro |
| Issue Management | http://developer.atlassian.com/jira/browse/CSRVY |
| Categories | Content Macros |
| Version | 1.1.6 |
| Availability | Confluence v2.1.3 to v2.10-m1 |
| State | Stable |
| Support |
|
| License | Freeware / Open Source (BSD) |
| Price | Free |
| Release Docs | http://confluence.atlassian.com/display/CONFEXT/Survey+Macro |
| Java API Docs | n/a |
| Download Source | http://svn.atlassian.com/svn/public/contrib/confluence/survey-plugin/tags/1.1.6 |
| Download JAR | nic-survey-macro-1.1.6.jar |
Overview
 | This plugin is accessible through the Confluence Repository Client. |
1.1.6
Resolved
Description/Features
Like the vote macro but need to collect data and comments on many issues at once? The Survey Macro is perfect for performance reviews and multi-question surveys.
This entry includes two parts: an enhanced version of the original vote macro, and a new multi-question Survey Macro, which builds on the Vote Macro. The Vote Macro can still be used on its own.
Compatibility Matrix (confluence vs plugin version)
| v macro \ confluence > | v2.1.3 | v2.5.6 | v2.8.* |
|---|---|---|---|
| v. 1.0.0 | |
||
| v. 1.1.3 | |
|
|
| v. 1.1.4 | |
|
|
| v. 1.1.5 | |
|
|
| v. 1.1.6 | |
|
 | Upgrading from v.1.0.0 or from the Vote-Plugin to 1.1.*+ Due to the necessary change of saving data to the text-field in 1.1.* you have to update your old data in the database accordingly. See the MySQL-Command sample posted directly under this list: |
--this will change the value and type from string to text update os_propertyentry set key_type=6, text_val=string_val where entity_key like 'vote.%' --this nulls the old stringvals update os_propertyentry set string_val=null where entity_key like 'vote.%' --comments handling: --this will change the value and type from string to text update os_propertyentry set key_type=6, text_val=string_val where entity_key like 'survey.%.commenters'; --this nulls the old stringvals update os_propertyentry set string_val=null where entity_key like 'survey.%.commenters';
If you cant see some old values, maybe you have some unnecessary Html-Tags in your data, try (under MySQL):
--this will cut the occurance on the right of the html tag </p> update os_propertyentry set entity_key=left(entity_key,length(entity_key)-4) where entity_key like 'vote.%' and right(entity_key,4)='</p>' --this will cut the occurance on the right of the html tag <br/> update os_propertyentry set entity_key=left(entity_key,length(entity_key)-5) where entity_key like 'vote.%' and right(entity_key,5)='<br/>' --this will cut the occurance of the html tag <p> which can occur within the vote-saved string update os_propertyentry set entity_key=REPLACE(entity_key,'<p>','') where entity_key like 'vote.%<p>%'
You can run the sql-commands without restarting confluence, but it will take some time till the macros render it correctly, so a restart cant be bad. I would recommend:
- Shut down Confluence
- run the sql-commands on the database (here it was mysql)
- startup confluence
- uninstall the vote or old survey plugin
- upload the new plugin via the admin console
Vote Macro
New features added to the Vote Macro include:
- Upgraded to work on newer versions of Confluence.
- The summary display now shows the user which option they voted for.
- Added the ability to let users change their votes.
- Added the ability to specify a list of users allowed to cast votes.
- Added the ability to specify a list of users allowed to view the results.
Survey Macro
The survey macro allows Confluence users to be polled on several issues by creating a new vote macro instance for each issue. The user casts a single vote per issue and can submit a comment with their vote. Once finished, they're shown a summary of everyone's votes (depending on their access level).
In addition to the functionality of the Vote Macro described above, the survey macro also provides:
- The ability to store user comments for each issue. Visibility of user comments is controlled by the "viewers" parameter in the same way that votes are.
- A rolled-up summary of the voting on each issue. Viewing of this summary data is also controlled by the viewers parameter.
Installation
- Install the plugin jar using the admin interface
- You're done!
Usage
Full documentation on the use of these two macros can be found in your Confluence "full notation guide" after installing the macros.
Using the Vote Macro
Using this macro is largely the same as in its previous version, and it's backward-compatible – all existing instances will still operate as expected. The new functionality is made available through a set of macro parameters.
The body of the macro defines the options that the users will be allowed to vote on. Each new line is considered a new ballot entry.
The parameters supported by this macro are:
| Parameter | Required | Default | Description |
|---|---|---|---|
| true | This is the title of the ballot and must be the first parameter. | ||
| voters | false | all users | This is a comma separated list of usernames who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters. |
| viewers | false | all users | This is a comma separated list of usernames who are allowed to see the vote results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results. |
| changeableVotes | false | false | This parameter, if set to true, will allow the voters to change their vote after it has been cast. |
| locked | false | false | Dont allow any further voting. Show a lock Symbol to indicate that. |
Using the Survey Macro
The body of this macro defines the categories that the users will be polled on. Each line of the body is treated as a separate category and should be written in the format "title - description". The title is always required, but the dash and the description are optional.
The parameters supported by this macro are:
| Parameter | Required | Default | Description |
|---|---|---|---|
| voters | false | all users | This is a comma separated list of usernames who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters. |
| viewers | false | all users | This is a comma separated list of usernames who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results. |
| changeableVotes | false | false | This parameter, if set to true, will allow the voters to change their votes after they have been cast. |
| choices | false | default-List (1-5) | Add a comma separated list which will be used for each survey line, can still be overriden in each line |
| showSummary | false | true | shall the Summary be displayed? |
| title | false | default: none | If a title is specified a lightgrey box will be shown around the whole survey (more compact) and it will perform better if you have more than one survey-macro on the same page |
| showComments | false | true | Shall Comments-Handling be enabled? (show, add, edit, delete) |
| locked | false | false | Dont allow any further voting. Show a lock Symbol to indicate that. Image for Survey will only be displayed if you have the title-flag also. (It is still shown on the vote-elements) |
Examples
This is a survey where users can change their votes. User1 and user2 are allowed to vote and only user3 can see the results.
{survey:changeableVotes=true|voters=user1,user2|viewers=user3}
Overall Experience - How useful is this macro?
Ease of Use - Please rate the ease of using this macro in your page.
Quality - Did you encounter any errors when using this macro?
{survey}
This is a survey where users can change their votes. All users with access to the page are allowed to vote and only user3 can see the results.
{survey:changeableVotes=true|viewers=user3}
Overall Experience - How useful is this macro?
Ease of Use - Please rate the ease of using this macro in your page.
Quality - Did you encounter any errors when using this macro?
{survey}
This is a survey where users can change their votes. The choices Parameter has been given and so in each 3 the default is replaced by these choices. At the second Vote this Parameter is overriden and the inline is used (low, medium, high).
{survey:changeableVotes=true|choices=1 - High, 2 - Medium, 3 - Low}
Overall Experience - How useful is this macro?
Ease of Use - Please rate the ease of using this macro in your page. - Low - Medium - High
Quality - Did you encounter any errors when using this macro?
{survey}
This is the traditional use of the vote macro.
{vote:What is your favorite color?}
Red
Green
Blue
{vote}
This will produce a vote where only user1 is allowed to see the results.
{vote:What is your favorite color?|viewers=user1}
Red
Green
Blue
{vote}
This is a vote where only user2 and user3 can vote. Again, only user1 can see the results.
{vote:What is your favorite color?|voters=user2,user3|viewers=user1}
Red
Green
Blue
{vote}
Screenshots
Screenshots |
||
|---|---|---|
|
|
|
|
a simple rendered survey-macro with inline custom choices and survey-title
|
This is the view of the macro for a user not allowed to see results.
|
This is the view of the macro after the survey has been completed.
|
|
|
|
|
This is the display after the user has cast a vote and entered a comment.
|
This is the initial view of the survey. No votes have been cast yet.
|
|
Open Issues / Future Version-Requests
Atlassian Developer Network JIRA
(7 issues)
|
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| T | Key | Summary | Assignee | Reporter | Pr | Status | Res | Created | Updated | Due |
|
CSRVY-11 | Survey plugin query results | Frank Stiller | Jamie |
|
 Open
|
UNRESOLVED | Jul 30, 2008 | Aug 01, 2008 | |
|
CSRVY-10 | Create an upgrade manager like in the dynamictasklist macro | Frank Stiller | Frank Stiller |
|
Open
|
UNRESOLVED | Jul 17, 2008 | Jul 17, 2008 | |
|
|
CSRVY-9 | Make body elements of survey-macro self-explaining vote macros | Frank Stiller | Frank Stiller |
|
Open
|
UNRESOLVED | Jul 17, 2008 | Jul 17, 2008 | |
|
|
CSRVY-6 | Open question option | Frank Stiller | hajo van Ravenswaay |
|
Open
|
UNRESOLVED | Jun 04, 2008 | Jun 06, 2008 | |
|
|
CSRVY-4 | Skip option/subquestions | Frank Stiller | hajo van Ravenswaay |
|
Open
|
UNRESOLVED | Jun 03, 2008 | Jun 06, 2008 | |
|
CSRVY-5 | Pulldown menu instead of multiple answer lines | Frank Stiller | hajo van Ravenswaay |
|
Open
|
UNRESOLVED | Jun 03, 2008 | Jun 03, 2008 | |
|
|
CSRVY-3 | Vote macro; possibility to tick multiple answers. | Frank Stiller | hajo van Ravenswaay |
|
Open
|
UNRESOLVED | Jun 03, 2008 | Jun 03, 2008 | |
Comments (83)
Apr 11, 2006
Andrew Miller says:
While I really like this and it is compatible with the vote macro syntax, it unf...While I really like this and it is compatible with the vote macro syntax, it unfortunately doesn't display the results of ballots made with the vote macro.
That makes it kind of hard for us to migrate to it (although I'd like to) as all previous voting resulst will be gone.
May 16
Frank Stiller says:
Just for completeness. That is a problem how values are fetched. So there is som...Just for completeness. That is a problem how values are fetched. So there is sometimes an html tag like <br/> or </p> which is then not correctly fitting to the current state on the page. Maybe this can be caught and truncated in a future release.
Same thing is when you change a Answer-Line, you will loose the votes for that answer (as he cant identify this line anymore, even if you just change one character). Could probably be fixed while giving an id in the first few chars of a line, but that would be a redesign of the architecture and maybe for a release 2.0
May 11, 2006
Dick says:
This is exactly what we are looking for. Thanks for this brilliant plugin. But ...This is exactly what we are looking for. Thanks for this brilliant plugin.
But I would like to ask one thing, if I have more than one question under a heading, is there anyway to do it?
Will that be something like:
Overall Experience - How useful the macro is?|How often do you use it?
Thanks
Jul 10, 2006
Matt Wizeman says:
That shouldn't be a difficult change to make. Have you already modified the code...That shouldn't be a difficult change to make. Have you already modified the code to do this? If not, I can go ahead and make the update for you and post the new version.
Feb 21, 2007
Jenine Wech says:
Is this change in the latest version? If so, what is the syntax for creating mul...Is this change in the latest version? If so, what is the syntax for creating multiple questions under the same heading?
Jul 10, 2006
patrice saint-louis says:
There is problem with the macro. Everytime on saves the survey after editing, th...There is problem with the macro.
Everytime on saves the survey after editing, the CR/LF are gone!. We have to reformat everytime.
?? is this a bug?
Jul 10, 2006
Matt Wizeman says:
I'm not sure if this is a bug with the macro or not. We have noticed here that m...I'm not sure if this is a bug with the macro or not. We have noticed here that many of the macros that depends on CR/LF (like the survey and vote macro) don't do well with the rich text editor. Have you tried using the wiki editor on those pages to see if that clears it up?
Jul 12, 2006
patrice saint-louis says:
Yes, even with the WIKI editor. Once saved it is OK. But as soon as you ed...Yes, even with the WIKI editor. Once saved it is OK. But as soon as you edit the page again it goes back to:
Very High High Medium Low
instead of
Very High
High
Medium
Low
Sep 23, 2006
Michael Redinger says:
Same problem here (on Confluence 2.2.9).Same problem here (on Confluence 2.2.9).
Oct 04, 2007
Rene Duquesnoy says:
Same problem with 2.6 Same problem with 2.6
Nov 14, 2007
Dave Jones says:
Has anyone found a solution to this problem? We'd like to use the survey m...Has anyone found a solution to this problem? We'd like to use the survey macro, but this is a show-stopper for us.
Nov 14, 2007
Dave Jones says:
I discovered a workaround that works for my site:\\ As with most Confluence wiki...I discovered a workaround that works for my site:
As with most Confluence wiki sites, our site is set up so that 'Rich Text' is the default markup style. That seems to be what is causing the problem.
Here's how to workaround the issue on a page that includes CR/LF-dependent macros:
* edit the page -- the 'Rich Text' edit page will appear with the text deformatted
* select the 'Wiki Markup' tab -- the text will still be deformatted
* click on 'Make Wiki Markup Default' to the right of the tabs
* click on the 'Cancel' button
* edit the page again -- the edit page will open in 'Wiki Markup' mode with the formatting you are expecting.
* do NOT, under any condition, click on the 'Rich Text' tab
(Alternatively, you could ask your wiki administartor to reconfigure the wiki so that 'Wiki Markup' was the default editing style for all pages. Or, better yet, have him disable 'Rich Text' editing -- does anyone ever use that?)
May 21
Scott Leslie says:
Did this problem ever get fixed? We are running Confluence 2.4.4and the Survey M...Did this problem ever get fixed? We are running Confluence 2.4.4and the Survey Macro 1.5 and every page edit causes the CR/LF to disappear within the vote macro. The above workaround is just that, a workaround, and not a fix. Asking my users to edit pages in wiki mode is not an option.
May 23
Frank Stiller says:
Scott i never used the wysiwig Editor as it is to limited, but i checked the ren...