RedmineCustomFields » History » Version 14

Stephen Lewis, 2011-07-29 22:43

1 13 Jim Kovacs
h1. Custom fields
2 1 Jean-Philippe Lang
3 4 Mischa The Evil
{{>toc}}
4 1 Jean-Philippe Lang
5 4 Mischa The Evil
Custom fields allow you to add additional information to several types of data used in Redmine. See '[[RedmineCustomFields#Custom-field-types|custom field types]]' for all types of data which come with support for custom fields.
6 4 Mischa The Evil
Each custom field can be defined to be of a [[RedmineCustomFields#Custom-field-supporting-data-types|certain type]].
7 4 Mischa The Evil
8 4 Mischa The Evil
h2. Custom field types
9 4 Mischa The Evil
10 4 Mischa The Evil
A custom field can be of one the following types:
11 4 Mischa The Evil
12 1 Jean-Philippe Lang
* *Integer*: positive or negative number
13 1 Jean-Philippe Lang
* *String*: one single line of input
14 1 Jean-Philippe Lang
* *Text*: multiple lines text
15 1 Jean-Philippe Lang
* *Date*: date
16 1 Jean-Philippe Lang
* *Boolean*: checkbox
17 1 Jean-Philippe Lang
* *List*: drop down list
18 11 Mischa The Evil
* TODO, update list...
19 1 Jean-Philippe Lang
20 1 Jean-Philippe Lang
Some validations can be defined for each custom field:
21 1 Jean-Philippe Lang
22 11 Mischa The Evil
* *Min - max length*: minimum and maximum length for the field (0 means that there is no restriction)
23 11 Mischa The Evil
* *Regular Expression*: a regular expression can be used to validate the field content. Examples:
24 11 Mischa The Evil
## _4 capital letters followed by one or several digits_
25 11 Mischa The Evil
<pre>^\[A-Z]{4}\d+$</pre>
26 11 Mischa The Evil
## _characters only, no digits_
27 11 Mischa The Evil
<pre>^[^0-9]*$</pre>
28 1 Jean-Philippe Lang
29 14 Stephen Lewis
A full list of regular expressions can be found in the Ruby Users Guide
30 14 Stephen Lewis
31 1 Jean-Philippe Lang
* *Possible values*: possible values for the "List" fields. One line for each value.
32 1 Jean-Philippe Lang
33 1 Jean-Philippe Lang
h2. Custom field supporting data types
34 1 Jean-Philippe Lang
35 4 Mischa The Evil
h3. Fields for Issues
36 4 Mischa The Evil
37 10 Mischa The Evil
Data in issue custom fields can be used and/or will be displayed in [[RedmineIssues|issues]], [[RedmineIssueList|issue lists]], [[RedmineIssueList#Custom-queries|custom queries]] and the [[RedmineTimelogReport|Timelog report]].
38 5 Mischa The Evil
39 11 Mischa The Evil
* *Trackers*: TODO
40 4 Mischa The Evil
* *Required*: field which is required in order to create/save an issue
41 4 Mischa The Evil
* *For all projects*: if checked, this field is used for the issues of all the projects. If unchecked, each project can choose whether or not to use the field for its issues (see [[RedmineProjectSettings|Project settings]]).
42 11 Mischa The Evil
* *Used as a filter*: TODO
43 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
44 1 Jean-Philippe Lang
45 4 Mischa The Evil
h3. Fields for Spent time entries
46 1 Jean-Philippe Lang
47 10 Mischa The Evil
Data in spent time entry custom fields can be used and/or will be displayed in the [[RedmineTimelogReport|Timelog report]].
48 5 Mischa The Evil
49 4 Mischa The Evil
* *Required*: field which is required in order to create/save a spent time entry
50 1 Jean-Philippe Lang
51 4 Mischa The Evil
h3. Fields for Projects
52 1 Jean-Philippe Lang
53 10 Mischa The Evil
Data in project custom fields can be used and/or will be displayed in the [[RedmineProjectOverview|Project overview]].
54 5 Mischa The Evil
55 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a project
56 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
57 1 Jean-Philippe Lang
58 4 Mischa The Evil
h3. Fields for Versions
59 1 Jean-Philippe Lang
60 10 Mischa The Evil
Data in version custom fields can be used and/or will be displayed in the [[RedmineRoadmap|Roadmap]] and the [[RedmineVersion|Version overview]].
61 6 Mischa The Evil
62 4 Mischa The Evil
* *Required*: field which is required in order to create/save a version
63 4 Mischa The Evil
64 4 Mischa The Evil
h3. Fields for Users
65 4 Mischa The Evil
66 10 Mischa The Evil
Data in user custom fields can be used and/or will be displayed in the [[RedmineUserProfiles|user profiles]].
67 6 Mischa The Evil
68 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a user
69 6 Mischa The Evil
* *Editable*: field which is editable by the [[RedmineAccounts|Redmine user]] owning the user account
70 4 Mischa The Evil
71 4 Mischa The Evil
h3. Fields for Groups
72 1 Jean-Philippe Lang
73 9 Mischa The Evil
*Note*: group custom fields are not (yet) used in the Redmine core, though other plugins or themes _can/may_ use them. No setting here has any effect on any other parts of Redmine for the time being.
74 4 Mischa The Evil
75 1 Jean-Philippe Lang
h3. Fields for Activities (time tracking)
76 1 Jean-Philippe Lang
77 10 Mischa The Evil
Data in time tracking activity custom fields can be used and/or will be displayed in the [[RedmineTimelogReport|Timelog report]] and the [[RedmineProjectSettings#Activities-time-tracking|Project settings]]. See also #4077 for some details about this nifty feature.
78 7 Mischa The Evil
79 4 Mischa The Evil
* *Required*: field which is required in order to create/save an activity
80 1 Jean-Philippe Lang
81 1 Jean-Philippe Lang
h3. Fields for Issue priorities
82 4 Mischa The Evil
83 9 Mischa The Evil
*Note*: issue priority custom fields are not (yet) used in the Redmine core, though other plugins or themes _can/may_ use them. No setting here has any effect on any other parts of Redmine for the time being.
84 8 Felix Schäfer
85 7 Mischa The Evil
h3. Fields for Document categories
86 4 Mischa The Evil
87 9 Mischa The Evil
*Note*: document category custom fields are not (yet) used in the Redmine core, though other plugins or themes _can/may_ use them. No setting here has any effect on any other parts of Redmine for the time being.