| Version 4 (modified by trac, 13 years ago) (diff) |
|---|
Trac Ticket Queries
Table of Contents
In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of criteria.
To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.
Filters
When you first go to the query page the default filter will display tickets relevant to you:
- If logged in then all open tickets it will display open tickets assigned to you.
- If not logged in but you have specified a name or email address in the preferences then it will display all open tickets where your email (or name if email not defined) is in the CC list.
- If not logged and no name/email defined in the preferences then all open issues are displayed.
Current filters can be removed by clicking the button to the right with the minus sign on the label. New filters are added from the pulldown lists at the bottom corners of the filters box ('And' conditions on the left, 'Or' conditions on the right). Filters with either a text box or a pulldown menu of options can be added multiple times to perform an or of the criteria.
You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.
Once you've edited your filters click the Update button to refresh your results.
Navigating Tickets
Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.
You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which were edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.
The query results can be refreshed and cleared of these status indicators by clicking the Update button again.
Saving Queries
Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have Updated the view and then click the Save query button displayed beneath the results. You can also save references to queries in Wiki content, as described below.
Note: one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click Save query. This will build the query string for you. All you need to do is remove the extra line breaks.
Using TracLinks
You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page.
[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
Which is displayed as:
This uses a very simple query language to specify the criteria (see Query Language).
Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:
[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
Which is displayed as:
Using the [[TicketQuery]] Macro
The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
Example:
[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
This is displayed as:
Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language.
A more compact representation without the ticket summaries is also available:
[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
This is displayed as:
Finally if you wish to receive only the number of defects that match the query using the count parameter.
[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
This is displayed as:
2
Customizing the table format
You can also customize the columns displayed in the table format (format=table) by using col=<field> - you can specify multiple fields and what order they are displayed by placing pipes (|) between the columns like below:
[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
This is displayed as:
Results (1 - 3 of 332)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #447 | fixed | Installation / Setup issue with Ubuntu 20.04 / Trac 1.2.5 / Fetchmail | bas | anonymous |
| #444 | worksforme | having problem in installing email2trac on Ubuntu 14.04.6 LTS | bas | vinod27 |
| #428 | invalid | email2trac crashes with Python error | bas | anonymous |
Full rows
In table format you can also have full rows by using rows=<field> like below:
[[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 332)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #447 | fixed | Installation / Setup issue with Ubuntu 20.04 / Trac 1.2.5 / Fetchmail | bas | anonymous |
| Description |
Hello, I have problems installing email2trac with fetchmail and I hope you can help me. We are running a Trac 1.2.5 environment on Apache on an Ubuntu 20.04 machine and I would like to use email2trac on it. So first, I downloaded the latest version of email2trac from here, extracted it and installed/compiled with the following command: ./configure --with-mta_user=fetchmail --with-trac_user=www-data --prefix=/usr --sysconfdir=/etc make make install So I have both "email2trac" and "run_email2trac" in /usr/bin My /etc/email2trac.conf looks like this: [DEFAULT] project: /var/lib/trac/testproject debug: 0 black_list: MAILER-DAEMON@ drop_spam : 1 drop_alternative_html_version: 1 email_quote: > html2text_cmd: ignore_trac_user_settings: 0 inline_properties: 1 reply_all : 0 spam_level: 5 strip_quotes: 0 strip_signature: 0 ticket_update: 1 ticket_update_by_subject: 1 umask: 022 verbatim_format: 1 [bas] project: /var/lib/trac/testproject spam_level: 1 Afterwards, I installed fetchmail to grab the emails from our server and "move" them to Trac. I did "chmod 600 /etc/fetchmailrc" and "chown fetchmail /etc/fetchmailrc" My /etc/fetchmailrc looks like this: set daemon 30 poll imap.ionos.de with proto IMAP user 'address@domain.org' there with password 'password' is 'www-data' here ssl mda "/usr/bin/run_email2trac" In Syslog, I can see the following log - sorry it's in German, but it's basically saying:
Feb 15 14:27:54 andreas-VirtualBox fetchmail[6180]: 5 Nachrichten (4 gesehene) für address@domain.org bei imap.ionos.de. Feb 15 14:27:54 andreas-VirtualBox run_email2trac[6279]: initgroups failed Feb 15 14:27:54 andreas-VirtualBox fetchmail[6180]: Nachricht address@domain.org@imap.ionos.de:5 von 5 wird gelesen (9570 Bytes im Nachrichtenkopf) (10140 Bytes im Nachrichtenkörper) (Log-Meldung unvollständig) Feb 15 14:27:54 andreas-VirtualBox fetchmail[6180]: Fehler beim Schreiben des Nachrichtentextes Feb 15 14:27:54 andreas-VirtualBox fetchmail[6180]: MDA-Fehler beim Abholen von address@domain.org@imap.ionos.de Feb 15 14:27:54 andreas-VirtualBox fetchmail[6180]: Abfragestatus=6 (IOERR) Did I miss something during installation / configuration progress? Does anyone have an idea of what could be wrong? I'm thankful for every hint! Thank you! Best regards, Andreas |
|||
| #444 | worksforme | having problem in installing email2trac on Ubuntu 14.04.6 LTS | bas | vinod27 |
| Description |
I was trying to install email2trac on my Ubuntu 14.04.6 LTS os but i am unable to complete documentations to setup and work with it. |
|||
| #428 | invalid | email2trac crashes with Python error | bas | anonymous |
| Description |
When running email2trac 2.12.2 on CentOS7 with Python 2.7.5 and the commandline: email2trac -d -v < msg.txt using the msg.txt distributed with the application, parsing crashes. python does a trace dump as follows: 2018-05-06 16:54:59,457 email2trac test: function inline_properties 2018-05-06 16:54:59,457 email2trac test: function unique_attachment_names() 2018-05-06 16:54:59,457 email2trac test: function get_body_text() 2018-05-06 16:54:59,459 email2trac test: Traceback (most recent call last): 2018-05-06 16:54:59,459 email2trac test: File "/usr/local/bin/email2trac", line 2922, in <module>
2018-05-06 16:54:59,459 email2trac test: File "/usr/local/bin/email2trac", line 1863, in parse
2018-05-06 16:54:59,459 email2trac test: File "/usr/local/bin/email2trac", line 2008, in parse_subject_field
2018-05-06 16:54:59,459 email2trac test: File "/usr/local/bin/email2trac", line 1340, in new_ticket
2018-05-06 16:54:59,459 email2trac test: File "/usr/lib64/python2.7/site-packages/trac/ticket/model.py", line 261, in insert
2018-05-06 16:54:59,459 email2trac test: File "/usr/lib64/python2.7/site-packages/trac/ticket/model.py", line 405, in _to_db_types
2018-05-06 16:54:59,460 email2trac test: File "/usr/lib64/python2.7/site-packages/trac/ticket/model.py", line 63, in _datetime_to_db_str
2018-05-06 16:54:59,460 email2trac test: File "/usr/lib64/python2.7/site-packages/trac/util/datefmt.py", line 193, in to_utimestamp
2018-05-06 16:54:59,460 email2trac test: TypeError?: unsupported operand type(s) for -: 'unicode' and 'datetime.datetime' 2018-05-06 16:54:59,460 email2trac test: saving email to /tmp/test_DeEDc.email2trac 2018-05-06 16:54:59,461 email2trac test: function get_message_parts() 2018-05-06 16:54:59,461 email2trac test: Message part: Main-Type: multipart 2018-05-06 16:54:59,461 email2trac test: Message part: Content-Type: multipart/mixed 2018-05-06 16:54:59,461 email2trac test: Skipping multipart container 2018-05-06 16:54:59,461 email2trac test: Message part: Main-Type: text 2018-05-06 16:54:59,461 email2trac test: Message part: Content-Type: text/plain |
|||
Query Language
query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (&). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values. To include a litteral & or | in a value, escape the character with a backslash (\).
The available operators are:
| = | the field content exactly matches the one of the values |
| ~= | the field content contains one or more of the values |
| ^= | the field content starts with one of the values |
| $= | the field content ends with one of the values |
All of these operators can also be negated:
| != | the field content matches none of the values |
| !~= | the field content does not contain any of the values |
| !^= | the field content does not start with any of the values |
| !$= | the field content does not end with any of the values |
The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by two dots (..). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be left out to avoid having to quote the query string.
| created=2007-01-01..2008-01-01 | query tickets created in 2007 |
| created=lastmonth..thismonth | query tickets created during the previous month |
| modified=1weekago.. | query tickets that have been modified in the last week |
| modified=..30daysago | query tickets that have been inactive for the last 30 days |
See also: TracTickets, TracReports, TracGuide
