wiki:DynamicVariablesPlugin

Default and convert report dynamic variables to dropdowns

Description

This plugin applies to all reports that use dynamic variables. The plugin does the following for dynamic variables whose (uppercase) name exactly matches a built-in or custom (lowercase) select field name:

  • Dynamic variables are set to default values if unset.
  • The text fields for dynamic variables are converted to dropdown lists.

JavaScript is required for the latter feature.

Bugs/Feature Requests

Existing bugs and feature requests for DynamicVariablesPlugin are here.

If you have any issues, create a new ticket.

defect

4 / 4

enhancement

1 / 1

Download

Download the zipped source from here.

Source

You can check out DynamicVariablesPlugin from here using Subversion, or browse the source with Trac.

Installation and Configuration

  1. Install the plugin, after downloading and unzipping:
    cd dynamicvariablesplugin/0.12
    sudo python setup.py bdist_egg
    sudo cp dist/TracDynamicVariables*.egg /your/trac/location/plugins/
    

See TracPlugins for more installation details and options. You will likely need to restart Trac's web server after installation.

  1. Enable the plugin in your trac.ini file:
    [components]
    dynvars.* = enabled
    

You can alternatively use the Trac Web Admin GUI to enable any or all rules.

  1. (Optional) Set a [dynvars] section of field names with explicit option values:
    [dynvars]
    daysback.options = 7|30
    

In the above example, daysback is not a custom ticket field, but can set a DAYSBACK dynamic variable via a dropdown list with the specified options. A [dynvars] section is not needed to configure dynamic variables that exactly match built-in or custom field names as shown in the screenshots below.

  1. Create/modify reports so that the names used for dynamic variables exactly match the names of the select field that it corresponds to. See an example below.

Example

The only required configuration is in defining SQL reports. For example, a report for a specific milestone that also queries for a custom queue select field could be defined like this:

SELECT p.value AS __color__, t.id AS ticket, summary, component, severity, reporter
FROM ticket t
  LEFT OUTER JOIN milestone m ON t.milestone = m.name
  LEFT JOIN enum p ON p.name = t.severity AND p.type = 'severity'
  LEFT OUTER JOIN ticket_custom q ON q.ticket = t.id AND q.name = 'queue'
WHERE q.value = '$QUEUE'
  AND milestone = '$MILESTONE'
ORDER BY m.due ASC, p.value

The result is as follows:

Before

After

Completed milestones are omitted from the dropdown menu.

Recent Changes

15377 by rjollos on 2016-03-01 02:15:59
0.2.0dev: Fix empty select with Trac 0.12

Patch by Jun Omae.

Fixes #12679.

15376 by rjollos on 2016-03-01 02:04:23
Remove project files
15357 by rjollos on 2016-02-22 22:38:37
0.2.0dev: Make add_script_data usage compatible with Trac 0.12

Refs #12679.

(more)

Author/Contributors

Author: robguttman
Maintainer: Rob Guttman
Contributors:

Last modified 10 months ago Last modified on Dec 11, 2015, 11:42:03 AM

Attachments (2)

Download all attachments as: .zip