How to add a custom extended Dropdown property in Ignition using Module development

[Anurag]

I have a requirement where I want to populate and display the Ids (string/guid type) from the dropdown in Ignition Alarm Property Editor in designer.

For example, something like below I want to develop, like when I create notification pipelines I see the pipeline names in dropdown, similarly I should be able to select the String id from the dropdown given a source of Ids.
I checked the current implementation uses enums and if I try to provide class object from my Module project, it also receives some serialization error (however if I use Ignition package class(es) then it works, I am not sure how can I register my class, however primitive type use like String.class works)

Serialization error log

java.lang.RuntimeException: Error cloning object through serialization.
INFO   | jvm 3    | 2025/03/27 17:04:05 | 	at com.inductiveautomation.ignition.common.util.CloneUtil.cloneBySerialization(CloneUtil.java:126)
INFO   | jvm 3    | 2025/03/27 17:04:05 | 	at com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel.getModelSnapshot(BasicMutableConfigurationPropertyModel.java:46)
INFO   | jvm 3    | 2025/03/27 17:04:05 | 	at com.inductiveautomation.ignition.gateway.tags.TagConfigModelCache.getConfigPropertyModel(TagConfigModelCache.java:46)
INFO   | jvm 3    | 2025/03/27 17:04:05 | 	at com.inductiveautomation.ignition.gateway.tags.TagProviderImpl.getConfigPropertyModel(TagProviderImpl.java:536)
INFO   | jvm 3    | 2025/03/27 17:04:05 | 	at com.inductiveautomation.ignition.gateway.tags.TagProviderImpl.lambda$exec$4(TagProviderImpl.java:475)

[pturmel]

I'm not sure how it is done with alarm properties, but for regular tag properties, you use model.setAllowedValues() and possibly also model.setAllowCustomValue() from the PropertyModelContributor you register with the gateway's TagConfigurationManager.

You may have to do some reflection to figure out how the alarm property subset works. Start here: AlarmConfiguration

[Anurag]

Thank you very much for taking time and replying back.

I debugged the things but it looks like it is different for Alarm related configuration properties. The suggestion might work for Tag related config properties but I do not see the code may be its hidden for example, we have property ActivePipeline (it is of type String) in Alarm configuration definition but on Alarm property editor, it shows dropdown, looks like property is getting resolved/rendered by some logic at runtime.

I looked into the code where I see other properties derived from enums and for ActivePipeline it is just of type String. And as I mentioned previously, if I provide my Module project class, the Serialization fails (it seems Inductive Automation Module Framework code does not load or serialize the class outside of Inductive Automation base framework)

Please let me know, accordingly. Thanks!

public class CommonAlarmProperties<T extends Serializable> extends WellKnownAlarmProperties<T> {
...
ActivePipeline = new CommonAlarmProperties<String>("activePipeline", "Notification", String.class, "");
...
}

Adding some debug screenshots, I tried to check how pipeline names are shown and rendered but could not able to get more.

1. In this I can see the Alarm property of a particular Tag and some more inner details.
   
   
2. In this I can see the some property of a particular Tag which has ListValueSource of pipeline names and some more inner details.