User Guide
- László Czomba
- 1 Introduction
- 2 Parameters
- 2.1 Jira link
- 2.2 Search
- 2.3 Maximum issues
- 2.4 Columns to display
- 3 Add a comment column
- 4 Parameters of the comments
- 4.1 Title
- 4.2 Text filter
- 4.3 Creator filter
- 4.4 Date from filter
- 4.5 Date to filter
- 4.6 Day of week filter
- 4.7 Max comment(s)
- 4.8 Order by
To use the ‘CommentBrowse for Confluence’ first you need to install the ‘CommentBrowse REST API Extender for Jira’ addon on the target Jira instances.
Introduction
CommentBrowse for Confluence makes it possible to list Jira issues with comments. The comments can be filtered by various options, such as creator, time of creation, etc.
Parameters
With the following parameters you can define the result of the table, including both the issues and the columns.
Jira link
This setting is not always visible. It becomes necessary if more than one Jira applications are connected to Confluence. If only one link exists, that will be used and the parameter will be hidden.
Search
In this input you can define a JQL expression to search the relevant Jira issues.
Maximum issues
With this input you can define a maximum count of the displayed issues.
Columns to display
You can select Jira fields to be displayed in the table.
Add a comment column
With this button you can add columns to the table containing the expected comments. You can define even more columns, if you need to display comments in different columns with different search filters. For example you need to see the last comment from the PM and the all comments which have been created by an other user.
Parameters of the comments
The filters are executed with logical and relation. So if you fill more than one filter, comments that meet all the given search criteria will be displayed.
Title
This title will be shown in the result table for the comment column.
Text filter
Comments can be filtered by the text typed into this input.
Creator filter
Comments can be filtered by the creator.
Date from filter
Comments can be filtered by date from the creation.
Date to filter
Comments can be filtered by date to the creation.
Day of week filter
Comments can be filtered by which day of the week was the comment created.
Max comment(s)
In this input you can define the max count of the displayed comments for one issue. The default is 1, so if you leave this empty 1 comment will be displayed. The max value for this filed is 20.
Order by
The comment can be ordered ascending and descending.
With the following 3 checkbox can be controled wether the cration date, time and creator will be shown:
Show date
Show timestamp
Show creator