Project

General

Profile

PtBRRedmineCustomFields » History » Version 1

Pedro Moritz de Carvalho Neto, 2015-07-27 21:51

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