RedmineCustomFields » History » Version 19

Etienne Massip, 2012-08-22 16:29

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 16 Terence Mill
* *User* custom field format that can be used to reference a project member
19 16 Terence Mill
* *Version* custom field format that can be used to reference version
20 1 Jean-Philippe Lang
21 16 Terence Mill
* TODO, update list...
22 1 Jean-Philippe Lang
Some validations can be defined for each custom field:
23 1 Jean-Philippe Lang
24 11 Mischa The Evil
* *Min - max length*: minimum and maximum length for the field (0 means that there is no restriction)
25 11 Mischa The Evil
* *Regular Expression*: a regular expression can be used to validate the field content. Examples:
26 11 Mischa The Evil
## _4 capital letters followed by one or several digits_
27 11 Mischa The Evil
<pre>^\[A-Z]{4}\d+$</pre>
28 11 Mischa The Evil
## _characters only, no digits_
29 11 Mischa The Evil
<pre>^[^0-9]*$</pre>
30 1 Jean-Philippe Lang
31 15 Stephen Lewis
A full list of regular expressions can be found in the Ruby Users Guide.
32 14 Stephen Lewis
33 1 Jean-Philippe Lang
* *Possible values*: possible values for the "List" fields. One line for each value.
34 1 Jean-Philippe Lang
35 1 Jean-Philippe Lang
h2. Custom field supporting data types
36 1 Jean-Philippe Lang
37 4 Mischa The Evil
h3. Fields for Issues
38 4 Mischa The Evil
39 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]].
40 5 Mischa The Evil
41 11 Mischa The Evil
* *Trackers*: TODO
42 4 Mischa The Evil
* *Required*: field which is required in order to create/save an issue
43 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]]).
44 11 Mischa The Evil
* *Used as a filter*: TODO
45 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
46 1 Jean-Philippe Lang
47 4 Mischa The Evil
h3. Fields for Spent time entries
48 1 Jean-Philippe Lang
49 10 Mischa The Evil
Data in spent time entry custom fields can be used and/or will be displayed in the [[RedmineTimelogReport|Timelog report]].
50 5 Mischa The Evil
51 4 Mischa The Evil
* *Required*: field which is required in order to create/save a spent time entry
52 1 Jean-Philippe Lang
53 4 Mischa The Evil
h3. Fields for Projects
54 1 Jean-Philippe Lang
55 10 Mischa The Evil
Data in project custom fields can be used and/or will be displayed in the [[RedmineProjectOverview|Project overview]].
56 5 Mischa The Evil
57 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a project
58 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
59 1 Jean-Philippe Lang
60 4 Mischa The Evil
h3. Fields for Versions
61 1 Jean-Philippe Lang
62 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]].
63 6 Mischa The Evil
64 4 Mischa The Evil
* *Required*: field which is required in order to create/save a version
65 4 Mischa The Evil
66 4 Mischa The Evil
h3. Fields for Users
67 4 Mischa The Evil
68 10 Mischa The Evil
Data in user custom fields can be used and/or will be displayed in the [[RedmineUserProfiles|user profiles]].
69 6 Mischa The Evil
70 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a user
71 19 Etienne Massip
* *Visible*: field which is displayed in the [[RedmineUserProfiles|user profile]]
72 6 Mischa The Evil
* *Editable*: field which is editable by the [[RedmineAccounts|Redmine user]] owning the user account
73 4 Mischa The Evil
74 4 Mischa The Evil
h3. Fields for Groups
75 1 Jean-Philippe Lang
76 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.
77 4 Mischa The Evil
78 1 Jean-Philippe Lang
h3. Fields for Activities (time tracking)
79 1 Jean-Philippe Lang
80 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.
81 7 Mischa The Evil
82 4 Mischa The Evil
* *Required*: field which is required in order to create/save an activity
83 1 Jean-Philippe Lang
84 1 Jean-Philippe Lang
h3. Fields for Issue priorities
85 4 Mischa The Evil
86 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.
87 8 Felix Schäfer
88 7 Mischa The Evil
h3. Fields for Document categories
89 4 Mischa The Evil
90 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.