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

Update documentation to specify how custom field searcher references a custom field

XMLWordPrintable

    • 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.

      If a custom field is not part of the com.atlassian.jira package then adding searchers does not work. I have a class:

      package startrak.jira.plugin.customfields;
public class StarTrakIdCFType extends TextCFType

      and define the plugin as below. No exceptions occur in the log, but no searchers are displayed. If I had to bet, I'd guess that somewhere the loading code is mangling the completeKey/Key//package anem combinations and so not finding the class to load. Better logging would have helped to confirm or deny this suspicion.

      <atlassian-plugin key="startrak.jira.plugin" name="STARTRAK Plugin">
  <plugin-info>
    <description>Plugin for sending email to STARTRAK.</description>
    <version>1.0.0</version>
    <application-version min="3.5" max="3.11"/>
    <vendor name="Matt Doar, Consulting Toolsmiths" url="http://www.pobox.com/~doar"/>
  </plugin-info>

  <workflow-function key="startrak-workflow-sendmail" name="Send STARTRAK email - workflow" class="startrak.jira.plugin.functions.SendMailFunctionPluginFactory">
    <description>Sends email to related issues in STARTRAK when they change.</description>
    <function-class>startrak.jira.plugin.functions.SendMailFunction</function-class>
    <orderable>false</orderable>
    <unique>true</unique>
    <deletable>true</deletable>
    <weight>900</weight>
    <default>false</default>
    <resource type="velocity" name="view" location="startrak-function-view.vm"/>
  </workflow-function>

  <!-- The .class called by webwork has to be in one of the packages specified in webwork.xml, e.g. com.atlassian.jira.web.action -->
    <webwork1 key="startrak-webwork-sendmail" name="STARTRAK webwork plugin" class="java.lang.Object">
        <description>Send email to STARTRAK</description>
            <actions>
                <action name="issue.StartrakSendMail" alias="StartrakSendMail">
                    <view name="input">/secure/views/plugins/startraksendmail-start.jsp</view>
                    <view name="success">/secure/views/plugins/startraksendmail-start.jsp</view>
                </action>
            </actions>
    </webwork1>

    <customfield-type key="startrakissuefield" name="STARTRAK issues"
        class="startrak.jira.plugin.customfields.StarTrakIdCFType">
        <description>A custom field for STARTRAK issue ids that displays them as links and can track which ones have already been notified of this Jira issue.</description>
        <resource type="velocity" name="view" location="startrak-field-view.vm"/>
        <resource type="velocity" name="edit" location="startrak-field-edit.vm"/>
        <resource type="velocity" name="xml" location="startrak-field-xml.vm"/>
    </customfield-type>

    <customfield-searcher key="textsearcher" name="Free Text Searcher"
        i18n-name-key="admin.customfield.searcher.textsearcher.name"
        class="com.atlassian.jira.issue.customfields.searchers.TextSearcher">
        <description key="admin.customfield.searcher.textsearcher.desc">Search for values using a free text search.</description>

        <resource type="velocity" name="search" location="templates/plugins/fields/edit-searcher/search-basictext.vm"/>
        <resource type="velocity" name="view" location="templates/plugins/fields/view-searcher/view-searcher-basictext.vm"/>
        <valid-customfield-type package="startrak.jira.plugin.customfields" key="StarTrakIdCFType"/>
    </customfield-searcher>


</atlassian-plugin>

              rosie@atlassian.com Rosie Jameson [Atlassian] (Inactive)
              9f09c0888cad MattS
              Votes:
              2 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: