Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-12608

Documentation and administration interface imply that custom fields can be searched in the same manner as non-custom fields, although Quick Search for custom fields is not implemented

    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      When editing or creating a custom field, the administration interface refers to a "Search Template" and a re-index option. There is no reference to how custom field searching differs from non-custom field searching, namely how custom field queries in the "Quick Search" field will not return results. This behavior should be explicitly noted in the documentation and on the interface, otherwise a user or administrator have the potential to be confused and frustrated when trying to implement and use custom fields.

      The documentation refers to a search template and to allowing searching through the issue navigator, but says nothing regarding quick search (http://www.atlassian.com/software/jira/docs/v3.8/customfields/overview.html#Search+templates):

      Search templates are responsible for indexing a custom field as well as making it searchable through the issue navigator. Each of the default custom field types have a related pre-configured search template.

      Suggested correction:

      Search templates are responsible for indexing a custom field as well as making it searchable through the issue navigator. Custom fields are not searchable through Quick Search. Each of the default custom field types have a related pre-configured search template.

      In the EditCustomField page where it states:

      Note that changing a custom field searcher may require a re-index.

      needs to be corrected as well. Suggested correction (can be here or in the other location on the page where it says to reindex):

      Note that custom fields cannot be searched through Quick Search, only from the Issue Navigator. Changing a custom field searcher may require a re-index.

      An alternative and preferable fix would be to implement JRA-7686.

            [JRASERVER-12608] Documentation and administration interface imply that custom fields can be searched in the same manner as non-custom fields, although Quick Search for custom fields is not implemented

            thank you, done

            AntonA added a comment -

            Jason,

            Thanks for the note. I think we definitely need to clarify that custom fields are not searchable through Quick Serach in the following pages:

            1. http://www.atlassian.com/software/jira/docs/latest/customfields/overview.html#Search+templates
            2. http://www.atlassian.com/software/jira/docs/latest/quicksearch.html

            Issue Navigator dispays check boxes for the fields that are searchable with quick search under the "Query" input field. Thease are: summary, description, environment and comments. I would prefer to leave the wording on the EditCustomField page the way it is, as its main point is to tell the user that reindex is required, rather than describe other points about how searching works.

            Cheers,
            Anton

            AntonA added a comment - Jason, Thanks for the note. I think we definitely need to clarify that custom fields are not searchable through Quick Serach in the following pages: http://www.atlassian.com/software/jira/docs/latest/customfields/overview.html#Search+templates http://www.atlassian.com/software/jira/docs/latest/quicksearch.html Issue Navigator dispays check boxes for the fields that are searchable with quick search under the "Query" input field. Thease are: summary, description, environment and comments. I would prefer to leave the wording on the EditCustomField page the way it is, as its main point is to tell the user that reindex is required, rather than describe other points about how searching works. Cheers, Anton

              rosie@atlassian.com Rosie Jameson [Atlassian] (Inactive)
              d46dc76b0c68 Jason R. Smith
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: