RedmineCustomFields » History » Version 5

Mischa The Evil, 2010-10-12 04:31
Some more documentation (more to come...)

1 1 Jean-Philippe Lang
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 4 Mischa The Evil
A custom field can be of one the following types:
11 4 Mischa The Evil
12 1 Jean-Philippe Lang
* *Integer*: positive or negative number
13 1 Jean-Philippe Lang
* *String*: one single line of input
14 1 Jean-Philippe Lang
* *Text*: multiple lines text
15 1 Jean-Philippe Lang
* *Date*: date
16 1 Jean-Philippe Lang
* *Boolean*: checkbox
17 1 Jean-Philippe Lang
* *List*: drop down list
18 1 Jean-Philippe Lang
19 1 Jean-Philippe Lang
Some validations can be defined for each custom field:
20 1 Jean-Philippe Lang
21 1 Jean-Philippe Lang
* *Min - max length* : minimum and maximum length for the field (0 means that there is no restriction)
22 1 Jean-Philippe Lang
* *Regular Expression* : a regular expression can be used to validate the field content
23 1 Jean-Philippe Lang
24 1 Jean-Philippe Lang
Examples:
25 1 Jean-Philippe Lang
26 1 Jean-Philippe Lang
  ^\[A-Z]{4}\d+$ : 4 capital letters followed by one or several digits
27 3 Tharuka Pathirana
28 1 Jean-Philippe Lang
  ^[^0-9]*$ : characters only - no digits
29 1 Jean-Philippe Lang
30 1 Jean-Philippe Lang
* *Possible values*: possible values for the "List" fields. One line for each value.
31 1 Jean-Philippe Lang
32 4 Mischa The Evil
h2. Custom field supporting data types
33 1 Jean-Philippe Lang
34 4 Mischa The Evil
h3. Fields for Issues
35 4 Mischa The Evil
36 5 Mischa The Evil
Data in issue custom fields can be used and/or displayed in [[RedmineIssues|issues]], [[RedmineIssueList|issue lists]] and [[RedmineIssueList#Custom-queries|custom queries]].
37 5 Mischa The Evil
38 4 Mischa The Evil
* *Trackers*: TBD
39 4 Mischa The Evil
* *Required*: field which is required in order to create/save an issue
40 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]]).
41 1 Jean-Philippe Lang
* *Used as a filter*: TBD
42 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
43 1 Jean-Philippe Lang
44 4 Mischa The Evil
h3. Fields for Spent time entries
45 1 Jean-Philippe Lang
46 5 Mischa The Evil
Data in spent time entry custom fields can be used and/or displayed in the [[RedmineTimelogReport|Timelog report]].
47 5 Mischa The Evil
48 4 Mischa The Evil
* *Required*: field which is required in order to create/save a spent time entry
49 1 Jean-Philippe Lang
50 4 Mischa The Evil
h3. Fields for Projects
51 1 Jean-Philippe Lang
52 5 Mischa The Evil
Data in project custom fields can be used and/or displayed in the [[RedmineProjectOverview|Project overview]].
53 5 Mischa The Evil
54 1 Jean-Philippe Lang
* *Required*: field which is required in order to create/save a project
55 5 Mischa The Evil
* *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]]
56 1 Jean-Philippe Lang
57 4 Mischa The Evil
h3. Fields for Versions
58 1 Jean-Philippe Lang
59 4 Mischa The Evil
* *Required*: field which is required in order to create/save a version
60 4 Mischa The Evil
61 4 Mischa The Evil
h3. Fields for Users
62 4 Mischa The Evil
63 4 Mischa The Evil
* *Required*: field which is required in order to create/save a user
64 4 Mischa The Evil
* *Editable*: field which is editable by [[RedmineAccounts|Redmine users]]
65 4 Mischa The Evil
66 4 Mischa The Evil
h3. Fields for Groups
67 4 Mischa The Evil
68 4 Mischa The Evil
* *Required*: field which is required in order to create/save a group
69 4 Mischa The Evil
70 4 Mischa The Evil
h3. Fields for Activities (time tracking)
71 4 Mischa The Evil
72 4 Mischa The Evil
* *Required*: field which is required in order to create/save an activity
73 4 Mischa The Evil
74 4 Mischa The Evil
h3. Fields for Issue priorities
75 4 Mischa The Evil
76 4 Mischa The Evil
*Note*: issue priority custom fields are not (yet) used in the Redmine core, though other plugins or themes _can_ use them
77 4 Mischa The Evil
78 4 Mischa The Evil
* *Required*: field which is required in order to create/save an issue priority
79 4 Mischa The Evil
80 4 Mischa The Evil
h3. Fields for Document categories
81 4 Mischa The Evil
82 4 Mischa The Evil
*Note*: document category custom fields are not (yet) used in the Redmine core, though other plugins or themes _can_ use them
83 4 Mischa The Evil
84 4 Mischa The Evil
* *Required*: field which is required in order to create/save a document category