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