Project

General

Profile

RedmineCustomFields » History » Revision 7

Revision 6 (Mischa The Evil, 2010-10-12 05:07) → Revision 7/29 (Mischa The Evil, 2010-10-12 05:32)

h1. Custom fields 

 {{>toc}} 

 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. 
 Each custom field can be defined to be of a [[RedmineCustomFields#Custom-field-supporting-data-types|certain type]]. 

 h2. Custom field types 

 A custom field can be of one the following types: 

 * *Integer*: positive or negative number 
 * *String*: one single line of input 
 * *Text*: multiple lines text 
 * *Date*: date 
 * *Boolean*: checkbox 
 * *List*: drop down list 

 Some validations can be defined for each custom field: 

 * *Min - max length* : minimum and maximum length for the field (0 means that there is no restriction) 
 * *Regular Expression* : a regular expression can be used to validate the field content 

 Examples: 

   ^\[A-Z]{4}\d+$ : 4 capital letters followed by one or several digits 

   ^[^0-9]*$ : characters only - no digits 

 * *Possible values*: possible values for the "List" fields. One line for each value. 

 h2. Custom field supporting data types 

 h3. Fields for Issues 

 Data in issue custom fields can be used and/or displayed in [[RedmineIssues|issues]], [[RedmineIssueList|issue lists]], lists]] and [[RedmineIssueList#Custom-queries|custom queries]] and the [[RedmineTimelogReport|Timelog report]]. queries]]. 

 * *Trackers*: TBD 
 * *Required*: field which is required in order to create/save an issue 
 * *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]]). 
 * *Used as a filter*: TBD 
 * *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]] 

 h3. Fields for Spent time entries 

 Data in spent time entry custom fields can be used and/or displayed in the [[RedmineTimelogReport|Timelog report]]. 

 * *Required*: field which is required in order to create/save a spent time entry 

 h3. Fields for Projects 

 Data in project custom fields can be used and/or displayed in the [[RedmineProjectOverview|Project overview]]. 

 * *Required*: field which is required in order to create/save a project 
 * *Searchable*: field which is searchable using the Redmine [[RedmineSearch|search function]] 

 h3. Fields for Versions 

 Data in version custom fields can be used and/or displayed in the [[RedmineRoadmap|Roadmap]] and the [[RedmineVersion|Version overview]]. 

 * *Required*: field which is required in order to create/save a version 

 h3. Fields for Users 

 Data in user custom fields can be used and/or displayed in the [[RedmineUserProfiles|user profiles]]. 

 * *Required*: field which is required in order to create/save a user 
 * *Editable*: field which is editable by the [[RedmineAccounts|Redmine user]] owning the user account 

 h3. Fields for Groups 

 *Note*: group custom fields are not (yet) used in the Redmine core, though other plugins or themes _can/may_ use them. them 

 * *Required*: field which is required in order to create/save a group 

 h3. Fields for Activities (time tracking) 

 Data in time tracking activity custom fields can be used and/or displayed in the [[RedmineTimelogReport|Timelog report]] and the [[RedmineProjectSettings#Activities-time-tracking|Project settings]]. See also #4077 for some details about this nifty feature. 

 * *Required*: field which is required in order to create/save an activity 

 h3. Fields for Issue priorities 

 *Note*: issue priority custom fields are not (yet) used in the Redmine core, though other plugins or themes _can/may_ use them. them 

 * *Required*: field which is required in order to create/save an issue priority 

 h3. Fields for Document categories 

 *Note*: document category custom fields are not (yet) used in the Redmine core, though other plugins or themes _can/may_ use them. them 

 * *Required*: field which is required in order to create/save a document category