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

 

5 Star Rating

The Issue Rating add-on allows JIRA users to rate issues. You may be familar with the rating mechanism from the Amazon store. Each user has one vote and can rate the issue with 1 to 5 stars. One star means very poor, 5 stars means very good.

(info) Rating without personal rating. Shows the average of the ratings. In brackets you see the number of users who rated this issue.

 

(info) On mouse-over, you can click a star to provide your personal rating.

 

(info) If you have rated a field, you see the average of all ratings, the number of users who voted and your rating.

 

(info) If no one has voted yet, the stars are not filled in.

 

Who Can Rate

Every user can rate an issue, or several fields in an issue, if the following prerequisites are met:

  • A custom field of the type "Issue Rating" is configured for the project on at least one issue type 
  • The current user is logged into JIRA 
  • The user has read permissions for the issue 

Average Value

The stars always indicate the average of all ratings provided. If the user has rated the issue, their rating is displayed below the stars. The number of participating users is displayed in brackets behind the stars.

 

It is possible to configure several rating fields per issue to let JIRA users vote on different aspects. 

Ratings can also provided directly in the Issue Navigator.

Anonymous Rating

It is not possible to see how many stars a user gave. When voting, no entry is created in the Issue History. Therefore, it is possible for logged-in JIRA users to vote anonymously. Anonymous users cannot vote. 

Delete Rating

Every user who is allowed to vote can delete their own rating. Use the trashcan symbol displayed on mouse-over to delete your rating. 

Administrators cannot edit or delete ratings.

(info) If the user does not delete them beforehand, ratings from deactivated users will still be visible.

Issue Rating in the Issue Navigator

The JQL search has been expanded by an additional function to make it easier to search for ratings.

Operator

< 	- less than
<=	- less than or equal to
=	 - equal to
=>	- equal to or greater than
>	- greater than

Value

The Value of the JQL Function can only be a number or floating point number.

Number: 1  
Floating point number: 1.2  

Select Operation in Basic Mode

Select Average, Number of Ratings, My rating or Score to search for issues.

If you do not know the custom field ID used in the following JQL queries, you may complete the steps shown in the previous pictures for the field(s) you want to search for and change to "Advanced" Search. The ID will then appear in the resulting search query, as shown below. 

Search by Average

ratingSearch(CUSTOM_FIELD, average, OPERATOR, NUMBERVALUE)

(info) All issues with a rating average equal to or greater than 3

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, average, ">=", 3)

Search by My Rating

ratingSearch(CUSTOM_FIELD, myRating, OPERATOR, NUMBERVALUE)

(info) All issues I rated 4 stars or more

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, myRating, ">=", 4)

Search by Number of Ratings

ratingSearch(CUSTOM_FIELD, numberOfRatings, OPERATOR, NUMBERVALUE)

(info) All issues with less than 10 ratings

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, numberOfRatings, "<", 10)

Search by Score

The score is the sum of all votes from all users. 

For example:

Ratings: 2, 2, 5, 4  

The score is 2 + 2 + 5 + 4 = 13

 

The same result is the average multiplied by number of ratings.

For Example: 

Ratings: 2, 2, 5, 4

Average = 3,25

Number of ratings = 4

3,25 * 4 = 13

 

So you don't need a calculated field in this case.

ratingSearch(CUSTOM_FIELD, score, OPERATOR, NUMBERVALUE)

 

(info) All issues with a score greater than 350

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, score, ">=", 350)

The custom field is available in REST calls.

Using JIRA Gadgets

The custom field "Issue Rating" can be used in the following standard gadgets:

  • Assigned to Me
  • Issues in Progress
  • Voted Issues
  • Filter Result

It is not possible to rate issues directly in the gadgets.

Integration into Confluence

In Confluence, the standard JIRA macros can be used. The rating can be displayed with the "JIRA" macro. However, you cannot rate issues directly in Confluence. 

Search Samples  

Show all issues I have not rated yet

project = INNOVATION AND issuetype = Idea AND NOT (Rating in ratingSearch(customfield_12500, myRating, "<=", 5))

Show all issues that have at least 10 ratings and an average greater than 3 

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, numberOfRatings, ">=", 10) AND Rating in ratingSearch(customfield_12500, average, ">", 3)

Alternatively, you can use the score to create a request more comfortably.

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, score, ">=", 30)

Show all issues that have at least 10 votes and an average less than or equal to 3

project = INNOVATION AND issuetype = Idea AND Rating in ratingSearch(customfield_12500, numberOfRatings, ">=", 10) AND Rating in ratingSearch(customfield_12500, average, "<=", 3)

Known Problems

Display on Agile Boards

The field type can currently not be used on boards of the Agile JIRA add-on.

Only the number of ratings will be displayed in brackets.

It is not possible to add the new field types in detail view either. But you can define Quickfilters to filter your issues.

Notification for New Ratings on Your Issues

It is not possible to be notified when someone rates a specific issue.

 

 

  • No labels