RedmineCustomFields » History » Version 24

Go MAEDA, 2017-09-01 00:27
Added headings.

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 24 Go MAEDA
h3. Format
11 24 Go MAEDA
12 24 Go MAEDA
A custom field can be of one the following types:
13 1 Jean-Philippe Lang
* *Boolean*: checkbox
14 21 @ go2null
* *Date*: date
15 21 @ go2null
* *Float*: floating point number
16 21 @ go2null
* *Integer*: positive or negative number
17 21 @ go2null
* *Link*: URL
18 1 Jean-Philippe Lang
* *List*: drop down list
19 21 @ go2null
* *Long Text*: resizeable multiple lines of text (supports rich text formatting as of 2.50)
20 21 @ go2null
* *Text*: multiple lines text (supports rich text formatting as of 2.50)
21 1 Jean-Philippe Lang
* *User* custom field format that can be used to reference a project member
22 1 Jean-Philippe Lang
* *Version* custom field format that can be used to reference version
23 1 Jean-Philippe Lang
24 24 Go MAEDA
h3. Validation
25 24 Go MAEDA
26 1 Jean-Philippe Lang
Some validations can be defined for each custom field:
27 1 Jean-Philippe Lang
* *Min - max length*: minimum and maximum length for the field (0 means that there is no restriction)
28 1 Jean-Philippe Lang
* *Regular Expression*: a regular expression can be used to validate the field content. Examples:
29 1 Jean-Philippe Lang
## _4 capital letters followed by one or several digits_
30 1 Jean-Philippe Lang
<pre>^\[A-Z]{4}\d+$</pre>
31 1 Jean-Philippe Lang
## _characters only, no digits_
32 1 Jean-Philippe Lang
<pre>^[^0-9]*$</pre>
33 21 @ go2null
* A full list of regular expressions can be found in the Ruby Users Guide.
34 1 Jean-Philippe Lang
35 24 Go MAEDA
h3. Values
36 24 Go MAEDA
37 21 @ go2null
Some field support multiple values and default values.
38 22 Anonymous
* *Multiple values*: while enabled, more than one item may be selected.
39 1 Jean-Philippe Lang
* *Possible values*: possible values for the "List" fields. One line for each value.
40 21 @ go2null
* *Default value*: default value to apply if none selected.
41 1 Jean-Philippe Lang
42 24 Go MAEDA
h3. Text formatting
43 24 Go MAEDA
44 21 @ go2null
Some fields support text formatting.
45 21 @ go2null
* *Text formatting*: whether to wikify the text.  If enabled, then _locks_ the *Link values to URL* field.
46 21 @ go2null
* *Link values to URL*: creates a URL using the following variables.
47 21 @ go2null
**   @%value%@ => the custom field value
48 21 @ go2null
**   @%id%@ => id of the customized object
49 21 @ go2null
**   @%project_id%@ => id of the project of the customized object if defined
50 21 @ go2null
**   @%project_identifier%@ => identifier of the project of the customized object if defined
51 22 Anonymous
**   @%m1%, %m2%...@ => capture groups matches of the custom field regexp if defined
52 1 Jean-Philippe Lang
53 24 Go MAEDA
h3. Input field styling
54 24 Go MAEDA
55 22 Anonymous
(2.5.2+) Some fields may be displayed as radio buttons or checkboxes, with slightly different behaviour based on the selected "Format":
56 22 Anonymous
* *Boolean*: checkbox (enabled/disabled) or radio buttons (null/yes/no)
57 22 Anonymous
* *List*, *User* and *Version*:
58 22 Anonymous
** checkboxes (if *Multiple values* is enabled)
59 21 @ go2null
** radio buttons (if *Multiple values* is disabled)
60 1 Jean-Philippe Lang
61 1 Jean-Philippe Lang
h2. Custom field supporting data types
62 1 Jean-Philippe Lang
63 4 Mischa The Evil
h3. Fields for Issues
64 4 Mischa The Evil
65 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]].
66 5 Mischa The Evil
67 11 Mischa The Evil
* *Trackers*: TODO
68 4 Mischa The Evil
* *Required*: field which is required in order to create/save an issue
69 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]]).
70 11 Mischa The Evil
* *Used as a filter*: TODO
71 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
72 1 Jean-Philippe Lang
73 4 Mischa The Evil
h3. Fields for Spent time entries
74 1 Jean-Philippe Lang
75 10 Mischa The Evil
Data in spent time entry custom fields can be used and/or will be displayed in the [[RedmineTimelogReport|Timelog report]].
76 5 Mischa The Evil
77 4 Mischa The Evil
* *Required*: field which is required in order to create/save a spent time entry
78 1 Jean-Philippe Lang
79 4 Mischa The Evil
h3. Fields for Projects
80 1 Jean-Philippe Lang
81 10 Mischa The Evil
Data in project custom fields can be used and/or will be displayed in the [[RedmineProjectOverview|Project overview]].
82 5 Mischa The Evil
83 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a project
84 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
85 1 Jean-Philippe Lang
86 4 Mischa The Evil
h3. Fields for Versions
87 1 Jean-Philippe Lang
88 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]].
89 6 Mischa The Evil
90 4 Mischa The Evil
* *Required*: field which is required in order to create/save a version
91 4 Mischa The Evil
92 4 Mischa The Evil
h3. Fields for Users
93 4 Mischa The Evil
94 10 Mischa The Evil
Data in user custom fields can be used and/or will be displayed in the [[RedmineUserProfiles|user profiles]].
95 6 Mischa The Evil
96 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a user
97 19 Etienne Massip
* *Visible*: field which is displayed in the [[RedmineUserProfiles|user profile]]
98 6 Mischa The Evil
* *Editable*: field which is editable by the [[RedmineAccounts|Redmine user]] owning the user account
99 4 Mischa The Evil
100 4 Mischa The Evil
h3. Fields for Groups
101 1 Jean-Philippe Lang
102 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.
103 4 Mischa The Evil
104 1 Jean-Philippe Lang
h3. Fields for Activities (time tracking)
105 1 Jean-Philippe Lang
106 23 Mischa The Evil
Data in time tracking activity custom fields can be used and/or will be displayed[1] in the [[RedmineTimelogReport|Timelog report]] and the [[RedmineProjectSettings#Activities-time-tracking|Project settings]]. See also #4077 for some details about this nifty feature.
107 7 Mischa The Evil
108 4 Mischa The Evil
* *Required*: field which is required in order to create/save an activity
109 1 Jean-Philippe Lang
110 1 Jean-Philippe Lang
h3. Fields for Issue priorities
111 4 Mischa The Evil
112 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.
113 8 Felix Schäfer
114 7 Mischa The Evil
h3. Fields for Document categories
115 4 Mischa The Evil
116 1 Jean-Philippe Lang
*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.
117 23 Mischa The Evil
118 23 Mischa The Evil
fn1. there are some exceptions, see #19121#note-1.