Project

General

Profile

RedmineCustomFields » History » Version 26

Go MAEDA, 2017-09-09 04:22
Link values setting is available for boolean, date, list, integer and text fields.

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