wiki:TicketQuery

Version 1 (modified by trac, 4 years ago) (diff)

--

TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed
  • rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table -- a view similar to the custom query view (but without the controls)
  • progress -- a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 2 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 51 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 10 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 15 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 4 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 21 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 19 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 1301 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 2 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 1423 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 2 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 0 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 0 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 0 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 0 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #1423, #1420, #1419 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 Jari Häkkinen Jari Häkkinen
Summary Reformat plug-ins archive/download page to look like the rest of the trac environment.

Format: list

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

#4
Spike Lowess
#5
Center on assay
#6
QQPlot
#7
Merge on genesymbol
#8
COPA
#9
Error in ReplicateError
#10
ReplicateError
#11
Pinbaes normalization
#16
BasicReporter and BasicSpot
#18
AnnotationFiletr
#19
RMA plugin should check that cel files are assigned to correct cdf.
#20
extra values pass through
#92
Create Illumina SNP raw data type
#125
MeV ... files are now supported (by the BASEcore) in the BASE analysis tree
#192
MeV unable to launch appplication ... class not found exception
#245
net.sf.basedb.illumina: Detection P-value fails if there is no negative controls in bioassayset
#296
VirtualArray plug-in can't be installed
#347
Exception when trying to register more than one specimen tube for a case
#393
Change default value for protocol in "RNA quality control - create aliquots" wizard step 2
#634
Retraction wizard
#866
Implement the "Start page" extension

[[TicketQuery(id=123)]]

This is displayed as:

#123
Update BasePlug-ins' firstpage

Format: compact

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

#4, #5, #6, #7, #8, #9, #10, #11, #16, #18, #19, #20, #92, #125, #192, #245, #296, #347, #393, #634, #866

Format: count

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

21

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed by placing pipes (|) between the columns:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 1360)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1422 fixed Add default configuration options for the new Slurm cluster Nicklas Nordborg Nicklas Nordborg
#1421 fixed NullPointerException in extraction registration wizard Nicklas Nordborg Nicklas Nordborg
#1420 fixed Updates to registration of specimen handled by external lab Nicklas Nordborg Nicklas Nordborg
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can specify full rows using rows=<field>:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 1360)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1422 fixed Add default configuration options for the new Slurm cluster Nicklas Nordborg Nicklas Nordborg
Description

This should be usable now and we should enable it in Reggie so that we can start testing.

#1421 fixed NullPointerException in extraction registration wizard Nicklas Nordborg Nicklas Nordborg
Description

This happened in the second step:

Error: Cannot invoke "net.sf.basedb.reggie.dao.Lysate.loadAnnotations(
net.sf.basedb.core.DbControl, String, 
net.sf.basedb.reggie.dao.Annotationtype, net.sf.basedb.reggie.converter.ValueConverter)"
because "lysate" is null

The log file contains a full stracktrace:

java.lang.NullPointerException: Cannot invoke "net.sf.basedb.reggie.dao.Lysate.loadAnnotations(net.sf.basedb.core.DbControl, String, net.sf.basedb.reggie.dao.Annotationtype, net.sf.basedb.reggie.converter.ValueConverter)" because "lysate" is null
        at net.sf.basedb.reggie.servlet.ExtractionServlet.doGet(ExtractionServlet.java:287)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:626)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:733)
...

The error happens in the GetLatestReagentLotNumbers command and is caused by an RNA item that doesn't have a Lysate parent item. In this case it was an external RNA that had been registered with an extraction date that was the "latest" date. Normally, external RNA doesn't have any extraction date at all or their extraction date or longer back to not interfere with the latest local extraction date. The external RNA should of course not be considered at all for this functionality.

#1420 fixed Updates to registration of specimen handled by external lab Nicklas Nordborg Nicklas Nordborg
Description

See #1349, #1347 and #1295 for background information about earlier updates. This time the following things are needed:

  • Create Tag items from JSON. Barcoding scheme has changed to IDT10 UDI. There are close to 4000 different combinations. Instead of creating them all beforehand, it should be possible to create new Tag items when needed. The barcode in the JSON file is typically of the format: 03B IDT10_UDI_Adapter2018 (ATCTGGCCAT-CCGCTGTCTA). The first part (03B) can be ignored, the second part IDT10_UDI_Adapter2018 should be the name of the barcode, and the two sequences are the BacodeSequence/BarcodeSequence2 annotations.
  • I see some warnings about Old date in JSON for partition date, extraction date, etc. and a reference to another date that is not found in the JSON. For example: Old date in JSON: Lysate.Partition date=2021-11-11 (expected after 2021-11-24). 2021-11-24 seems to be the registration date of the Patient item which doesn't make sense. This should be investigated.
  • The queue with items to import is very long now. This could potentially be problematic since the GUI is not optimized for this. It may take a very long time to load and check all JSON files and if that doesn't fail it will be difficult to select/de-select items for importing.
1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports