JIRA 4.0 : Specifying Field Behaviour
This page last changed on Aug 31, 2009 by rosie@atlassian.com.
On this page: What is a 'Field Configuration'?A Field Configuration provides the ability to change field behaviour. For each field, a Field Configuration specifies:
A Field Configuration specifies individual behaviour for every issue field, including both standard fields and custom fields. You can create multiple Field Configurations (see below). You can then associate different Field Configurations with different issue types by creating a Field Configuration Scheme. Once created, a Field Configuration Scheme can be associated with one or more projects, allowing you to control field behaviour on a per project, per issue type basis.
Editing a Field ConfigurationTo change the behaviour of fields, you first need to navigate to the Field Configuration. The way this is done depends on the edition of JIRA:
The "View Field Configuration" page lists all system and custom fields in a table as shown below. The "Operations" column lists all the operations that are available for each field. These operations could be:
Editing a Field's DescriptionFields can be given descriptions to better identify the meaning of the field. These descriptions are usually displayed under the field on the creation of an issue and whenever it is edited. An example of this, is shown below. To edit the description of a field:
Hiding/Showing a fieldIf your organisation or project has no use for a particular field, you have the option to hide it. Hiding a field will ensure that the the field does not appear on any Screens (i.e. issue operation Screens, workflow transition Screens) where the Field Configuration applies. Hiding a field in the Field Configuration is distinct from not adding a field to a Screen. Fields hidden through the Field Configuration will be hidden in all applicable Screens, regardless of whether or not they have been added to the Screen.
To hide a field:
Required/Optional fieldsCertain fields within your organisation may be compulsory for issues. In this case you can set a field to be required, so that JIRA validates that the field has been given a value whenever an issue is edited. If a required field has not been given a value, JIRA will return an error informing the user that the field should be filled, e.g.:
To make a field required:
Renderers
The "View Field Configuration" page indicates which renderers are currently enabled for all renderable fields. In the above screenshot you will notice the grey text 'Wiki Style Renderer' under the Description field's name. This indicates that the field is currently configured to use the Atlassian Wiki Renderer. The grey text 'Default Text Renderer' under the Comment field's name indicates that the field is currently configured to use the Default Text Renderer. To change the renderer type for a specific field, click on the 'Renderers' link in the 'Operations' column of the screen for the field you want to change. This will take you to a page where you will have the option to select a renderer from all configured and available renderers. As shown above, this page will warn you if there are issues that will be affected by the change. If no issues will be affected then the warning does not show. From this page, choose the renderer you wish to use and click 'Update'. You are then presented with a confirmation page, shown below. Click the 'Update' button to finish setting the new renderer on the field.
Managing Multiple Field ConfigurationsYou can create multiple field configurations for use on separate projects and issue types.
To create, edit, delete and copy individual field configurations, go to the "View Field Configuration" page as follows:
Default Field ConfigurationWhen JIRA is installed, the 'Default Field Configuration' is created automatically. All new projects are associated with this configuration. This configuration is also used for projects that are not associated with a Field Configuration Scheme..
Adding a Field Configuration
Editing a Field Configuration
Deleting a Field Configuration
Copying a Field Configuration
Activating a Field ConfigurationTo activate a Field Configuration:
For details of both procedures, see 'Associating field behaviour with Issue Types'. ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
![]() |
Document generated by Confluence on Oct 06, 2009 00:25 |