nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to register Custom Field Plugin to the JIRA's 'Custom Fileds'

Akira Tsuchiya

I created a Custom Field Plugin and installed it successfully.

But the custome field does not appear in the JIRA [Administration] -> [Issues] -> [Fields] -> [Custom Fileds].

How can I do it programmtically?

Accepted answers

Nic Brough -Adaptavist-

To be clear here, have you developed a "Custom field", or a "custom field type"?

Most custom field plugins provide a field type, not a field, as you usually want to let the administrators add the actual field (they decide on name, screens, context and so-on), and often you want more than one.

To clarify, do you see your field type when you go to

JIRA [Administration] -> [Issues] -> [Fields] -> [Custom Fileds] -> add new field ?

Or did you really write a new hardcoded field?

All comments

Nic Brough -Adaptavist-

To be clear here, have you developed a "Custom field", or a "custom field type"?

To clarify, do you see your field type when you go to

JIRA [Administration] -> [Issues] -> [Fields] -> [Custom Fileds] -> add new field ?

Or did you really write a new hardcoded field?

Akira Tsuchiya

Probably I created a 'Custom Field Type' without knowing it.

I created the plugin module referencing to the page below.

https://developer.atlassian.com/display/JIRADEV/Custom+Field+Plugin+Module

I described the tag belowin the atlassian-plugin.xml.

<customfield-type/>

There is no entry in the [Administration]'s [Custom Fields].

Nic Brough -Adaptavist-

I thought that might be the case - plugin *types* are quite common and are what is listed in the example codes, even if the target system only needs a single instance of them. Because they're more common, we're more familiar with the debugging of them.

The things to check are:

That you are offered the type of field when you add a custom field (you've just done this, and you're not offered it)
That the plugin appears on the list when you go Admin -> Plugins, to check it's installed ok
That the plugin appears on the list when you go Admin -> Plugins, and shows as "enabled"
- If it is not enabled, try clicking enable and read any error messages as they'll tell you why it's not enabled
Read the log file, specifically for
- The times around when you tried any of the above
- When Jira started up, as it will try to load all the plugins at that point and error on failures
- Search for the name of your plugin classes

Akira Tsuchiya

1. The Plugin is successfully installed.

2. The Plugin is successfully enabled.

3. There is no error in the log.

4. But JIRA Administration does not detect the Custom Field.

So I suspect that there is something missing in the source code.

I list the full source below.

Please tell me where I misunderstand.

1. Java Class

public class LuminousTextArea extends TextAreaCFType {

public LuminousTextArea(
CustomFieldValuePersister customFieldValuePersister,
GenericConfigManager genericConfigManager) {
super(customFieldValuePersister, genericConfigManager);
}
}

2. atlassian-plugin.xml

<customfield-type key="customFieldTest"
name="Custom Field Test"
class="***.LuminousTextArea">
<resource type="velocity" name="view"
location="templates/view.vm"/>
<resource type="velocity" name="edit"
location="templates/edit.vm"/>
</customfield-type>