RedmineCustomFields » History » Version 22

Anonymous, 2014-10-31 08:48
Updated to include some info on the new display styles for certain custom field formats

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