Project

General

Profile

Documentation - Redmine Computable Custom Field

Simple calculations with issue custom fields

Redmine Plugin Version Redmine Version Language Support Version Stage

Redmine Computable Custom Field is a plugin which lets the administrator define some simple formula for calculating with issue custom fields.

Redmine Computable Custom Field Example

Getting Started

This quick introduction shows you the most convenient way for trying out the plugin with your Redmine instance.

IMPORTANT

Make sure your Redmine version is fixed as explained here. Otherwise, calculation results won't be as expected when using key/value fields.

Dependencies

To run the plugin you need the following dependencies installed:

Downloading the plugin

Navigate into the plugins directory of your Redmine instance.

Download the latest development state as redmine_computable_custom_field folder
into your plugin directory.

cd (REDMINE_ROOT_DIR)/plugins
git clone -b master https://github.com/xmera-circle/redmine_computable_custom_field.git

Restart Redmine

Navigate into your Redmine root directoy.

Run the restart Rake task. This will touch restart.txt in order to force Redmine's application server to restart and load
everything from scratch. This will register the new plugin.

cd (REDMINE_ROOT_DIR)
rake restart

Plugin Usage

Before you can create a computable field you need some fields which you can use to calculate with.

Navigate to Administration -> Custom Fields. Make sure that there are some issue custom fields either of format int, float, list, or key/value pair which you can use for calculations.

Note

  • A list must have integer or float entries to get reasonable results. All other text strings will render as zero in a calculation.
  • A key/value pair field is calculated via its position number. You get the position number by counting the entries in the list.

When you have the required fields for your calculation, then you can create a new issue custom field. Choose a supported format for your calculation which is one of int, float, list, or key/value pair.

Check the field computable and start to type the formula you like to use into the formula field. You can enter the fields you wish to use in the formula by double clicking on the respective field name in the box you find below.

Computable custom field

Note

All formulas, except custom(), need a comma as delimiter between two custom fields.

Save your field and navigate to an issue where you would like to use the newly created computable custom field. Click on edit and enter some values in the fields you wish to use in the formula and save the issue.

Important

You always need to save the issue when you like to execute the calculation.

Limitations

You cannot use lists with multiple values enabled when they are integrated into the calculation.

Changelog

Every release comes along with a list of notable changes in order to make it easier to follow up on the progress of Redmine Table Calculation.

All those changes are documented in source:CHANGELOG.md.

Credits

This plugin is based on Redmine Computed Custom Field 1.0.7 of Yakov Annikov.

This plugin is heavily reengineered to make its usage as secure as possible. Therefore it is not compatible with the original plugin named Redmine Computed Custom Field.

Thanks to Yakov Annikov for the great idea of making custom fields computable.

Licence

Copyright © 2021-2023 Liane Hampe (), xmera Solutions GmbH.
Copyright © 2015-2021 Yakov Annikov.

This plugin is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.