Custom fields¶

• Table of contents
• Custom fields
  • Custom field types
  • Custom field supporting data types
    • Fields for Issues
    • Fields for Spent time entries
    • Fields for Projects
    • Fields for Versions
    • Fields for Users
    • Fields for Groups
    • Fields for Activities (time tracking)
    • Fields for Issue priorities
    • Fields for Document categories

Custom fields allow you to add additional information to several types of data used in Redmine. See '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 certain type.

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.

Custom field supporting data types¶

Fields for Issues¶

Data in issue custom fields can be used and/or displayed in issues, issue lists and custom 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 Project settings).
• Used as a filter: TBD
• Searchable: field which is searchable using the Redmine search function

Fields for Spent time entries¶

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

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

Fields for Projects¶

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

• Required: field which is required in order to create/save a project
• Searchable: field which is searchable using the Redmine search function

Fields for Versions¶

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

Fields for Users¶

• Required: field which is required in order to create/save a user
• Editable: field which is editable by Redmine users

Fields for Groups¶

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

Fields for Activities (time tracking)¶

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

Fields for Issue priorities¶

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

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

Fields for Document categories¶

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

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