RedmineCustomFields » History » Version 20

Luqman Mahmud, 2014-02-24 21:30

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