# Default Settings for a custom ExtensionPoint **URL:** \ **Category:** Module Development\ **Tags:** ignition83\ **Created:** [April 2, 2026, 3:27pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866 "2026-04-02T15:27:33Z")\ **Posts on this page:** 20\ **Page:** 1
**Author:** ![djs](https://avatars.discourse-cdn.com/v4/letter/d/e47774/32.png) [@djs](https://forum.inductiveautomation.com/u/djs)\ **Post date:** [April 2, 2026, 3:27pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/1 "2026-04-02T15:27:33Z")
I'm building a custom historian module for 8.3. I want to have pre-filled-in values for some of the fields when creating it on the gateway config page. I've implemented `defaultSettings()` but the settings do not show up on the config page for whatever reason (I want the poll rate to default to 60000). This is what I have: In _REDACTEDExtentionPoint.java:_ ```python @Override public Optional defaultSettings() { REDACTEDSettings.Connectivity connectivity = new REDACTEDSettings.Connectivity(null); REDACTEDSettings.Advanced advanced = new REDACTEDSettings.Advanced(60000); REDACTEDSettings settings = new REDACTEDSettings(connectivity, advanced); return Optional.of(settings); } ``` _REDACTEDSettings.java:_ ```python public record REDACTEDSettings(Connectivity connectivity, Advanced advanced) implements HistorianSettings { public record Connectivity( @FormCategory("Connectivity") @FormField(FormFieldType.REFERENCE) @Label("Database Connection") @Required @Description("The database connection to use.") @FormReferenceType("ignition/database-connection") String databaseConnection ) {} public record Advanced( @FormCategory("Advanced") @FormField(FormFieldType.NUMBER) @Label("Poll Rate") @Required @Description("The rate (in milliseconds) at which the historian should query the datasource to check for updates") int pollRate ) {} ``` I've also tried the `@DefaultValue()` annotation which didn't work either. Looking at the docs, it seems to be meant for optional parameters and applied after the user fails to specify a value, which is not what I'm looking for. I've tried `@ExampleValue("60000")` as well, but that doesn't seem to fill it out either... When stepping through with the debugger, it looks like the default settings get created correctly and are stored with the list of extension points, but the _Create Historian_ popup doesn't use them... Am I misunderstanding the purpose of the `defaultSettings()` method? If so, what should I use instead? ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [April 2, 2026, 3:41pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/2 "2026-04-02T15:41:09Z")
Your config page is just an ExtensionPointResourceForm? Returning an instance with the desired values from `defaultSettings()` + the `@DefaultValue("60000")` annotation should be enough... ---
**Author:** ![djs](https://avatars.discourse-cdn.com/v4/letter/d/e47774/32.png) [@djs](https://forum.inductiveautomation.com/u/djs)\ **Post date:** [April 2, 2026, 6:53pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/3 "2026-04-02T18:53:24Z")
Thanks for replying so quickly! I added the default annotation back in: ```python public record Advanced( @FormCategory("Advanced") @FormField(FormFieldType.NUMBER) @Label("Poll Rate") @Required @DefaultValue("60000") @Description("The rate (in milliseconds) at which the historian should query the datasource to check for updates. Set the the value to anything less than or equal to 0 to only poll the values on the historian's startup.") int pollRate ) {} ``` And my config page should just be an ExtensionPointResourceForm: ```python @Override public Optional getWebUiComponent(ComponentType type) { return Optional.of(new ExtensionPointResourceForm( RESOURCE_TYPE, "Historian Settings", "REDACTED", SchemaUtil.fromType(HistorianProvider.class), SchemaUtil.fromType(REDACTEDSettings.class) )); } ``` Still no default value though: ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/5/9/598f177f94f176465ab4d4486705bba5bf041853.png) I fell like I'm missing something simple and I just can't see it... ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [April 2, 2026, 7:07pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/4 "2026-04-02T19:07:11Z")
I'm not seeing anything that stands out yet. We're using the same pattern all over with extension points to provide default values. Are you sure you've properly cleaned, rebuilt, reinstalled your module? Can you change something else (name, description, whatever) to make sure? ---
**Author:** ![djs](https://avatars.discourse-cdn.com/v4/letter/d/e47774/32.png) [@djs](https://forum.inductiveautomation.com/u/djs)\ **Post date:** [April 2, 2026, 8:24pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/5 "2026-04-02T20:24:26Z")
I changed stuff on it to make sure: ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/8/6/86d0af21b247489f12264805492788322db5cee9.png) Could it be because I don't have `defaultProfile()` implemented? ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [April 2, 2026, 8:57pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/6 "2026-04-02T20:57:57Z")
> [@djs](#): > > Could it be because I don't have `defaultProfile()` implemented? I don't think so, most/all of ours don't implement that. Maybe something to do with using `null` instead of empty string here? > [@djs](#): > > `REDACTEDSettings.Connectivity connectivity = new REDACTEDSettings.Connectivity(null);` ---
**Author:** ![djs](https://avatars.discourse-cdn.com/v4/letter/d/e47774/32.png) [@djs](https://forum.inductiveautomation.com/u/djs)\ **Post date:** [April 3, 2026, 5:42pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/7 "2026-04-03T17:42:27Z")
> [@Kevin.Herron](#): > > Maybe something to do with using `null` instead of empty string here? I set it to an empty string and still no luck. I tried changing the datatype to String to see if it was just failing to cast, but that didn't help either. I also restructured my settings to see if it made a difference and it didn't... I'm kind of out of ideas at the moment. I might come back to it in a few weeks with fresh eyes; perhaps see what I'm missing. It's good to know that the pattern I'm using is the intended one though. Really appreciated you helping me troubleshoot. ---
**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\ **Post date:** [April 3, 2026, 5:56pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/8 "2026-04-03T17:56:34Z")
I would expect to implement `defaultSettings()` **or** the annotations for defaults, not both. ---
**Author:** ![djs](https://avatars.discourse-cdn.com/v4/letter/d/e47774/32.png) [@djs](https://forum.inductiveautomation.com/u/djs)\ **Post date:** [April 7, 2026, 8:32pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/9 "2026-04-07T20:32:49Z")
Still not sure why the defaults don't work, but perhaps this is related: Implementing `defaultSettings()` breaks the editing functionality. I can create a historian, but can't edit: ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/b/a/bae1894dcb80298aebc483c449ded8159ba4d7ac.png) Simply commenting out the `defaultSettings()` implementation fixes this edit dock... ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [April 7, 2026, 8:41pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/10 "2026-04-07T20:41:19Z")
Share your full settings class and full definition of whatever you returned in `defaultSettings()`? ---
**Author:** ![Gabor\_Monostori](https://avatars.discourse-cdn.com/v4/letter/g/74df32/32.png) [@Gabor\_Monostori](https://forum.inductiveautomation.com/u/Gabor_Monostori)\ **Post date:** [April 8, 2026, 10:54am UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/11 "2026-04-08T10:54:12Z")
Hi All, I have exactly the same issue (Ignition version 8.3.3): The fields are always empty in the create form or it breaks if I try anything else. I share my code fragments below. Here is my settings class: ```python public class TimescaleDbHistorianSettings implements HistorianSettings { private String jdbcUrl ="jdbc:postgresql://timescaledb:5432/historian?currentSchema=public"; private String username = "postgres"; private SecretConfig password; private int timeoutMs = 5000; private int batchSize = 100; private int batchIntervalMs = 5000; private boolean debugLogging = false; private String storeAndForwardEngine = ""; public TimescaleDbHistorianSettings() { } // getters and setters ... } ``` Three versions I tried: - The one, which doesn’t break the form returns `Optional.empty()`. Of course fields are always empty: ```python public class TimescaleDbHistorianExtensionPoint extends HistorianExtensionPoint { @Override public Optional defaultSettings() { return Optional.empty(); } // ... } ``` - Returning `Optional.of(new TimescaleDbHistorianSettings())` breaks with "Extension Point Form Not Found": ```python public class TimescaleDbHistorianExtensionPoint extendsHistorianExtensionPoint { @Override public Optional defaultSettings() { return Optional.of(new TimescaleDbHistorianSettings()); } // ... } ``` - The third approach I tried was removing `getWebUiComponent()` entirely and putting the `@DefaultValueDefaultValue` annotations directly on the `TimescaleDbHistorianSettings` fields — like the core historian does. That gave me "Web UI Component type not found" Any pointers on how to get defaults are much appreciated! Best regards, Gabor ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [April 8, 2026, 1:28pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/12 "2026-04-08T13:28:29Z")
> [@Gabor\_Monostori](#): > > The third approach I tried was removing `getWebUiComponent()` entirely and > putting the `@DefaultValueDefaultValue` annotations directly on the `TimescaleDbHistorianSettings` fields — like the core historian does. That gave me "Web UI Component type not found" Well... removing `getWebUiComponent()` obviously should break. But you should have always been annotating the fields - were/are you annotating the getter methods instead? ---
**Author:** ![djs](https://avatars.discourse-cdn.com/v4/letter/d/e47774/32.png) [@djs](https://forum.inductiveautomation.com/u/djs)\ **Post date:** [April 8, 2026, 2:19pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/13 "2026-04-08T14:19:46Z")
I'll share the entirety of the extension point, it doesn't have much else in it. From what I can tell, the `ExtensionPoint` interface's default implementation of `settingsType()` uses `defaultSettings()` to figure out the class. So I need to have at least one of those methods implemented for things to work. (That is why they're both there). > **Historian Settings** > > ```python > package redacted.gateway; > > import com.inductiveautomation.historian.gateway.api.config.HistorianSettings; > import com.inductiveautomation.ignition.gateway.dataroutes.openapi.annotations.*; > import com.inductiveautomation.ignition.gateway.web.nav.FormFieldType; > > public record REDACTEDSettings( > @FormCategory("Connectivity") > @FormField(FormFieldType.REFERENCE) > @Label("Database Connection") > @Required > @Description("The database connection to use") > @FormReferenceType("ignition/database-connection") > String databaseConnection, > > @FormCategory("Advanced") > @Label("Poll Rate") > @FormField(FormFieldType.NUMBER) > @DefaultValue("60000") > @Required > @Description("The rate (in milliseconds) at which the historian should query the datasource to check for updates. Set the the value to anything less than or equal to 0 to only poll the values on the historian's startup.") > int pollRate > > ) implements HistorianSettings { > > public REDACTEDSettings copyWithDatabaseConnection(String newDatabaseConnection) { > return new REDACTEDSettings(newDatabaseConnection, this.pollRate); > } > > } > > ``` > **ExtensionPoint** > > ```python > package redacted.gateway; > > import com.inductiveautomation.historian.gateway.api.Historian; > import com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint; > import com.inductiveautomation.historian.gateway.api.HistorianProvider; > import com.inductiveautomation.historian.gateway.api.config.HistorianSettings; > import com.inductiveautomation.ignition.gateway.config.*; > import com.inductiveautomation.ignition.gateway.dataroutes.openapi.SchemaUtil; > import com.inductiveautomation.ignition.gateway.datasource.DatasourceManager; > import com.inductiveautomation.ignition.gateway.model.GatewayContext; > import com.inductiveautomation.ignition.gateway.web.nav.WebUiComponent; > import com.inductiveautomation.ignition.gateway.web.nav.ExtensionPointResourceForm; > import java.util.Optional; > > public class REDACTEDExtensionPoint extends HistorianExtensionPoint { > > public static final String TYPE_ID = "redacted.REDACTED"; > > public REDACTEDExtensionPoint() { > super(TYPE_ID, "REDACTED.Meta.Name", "REDACTED.Meta.Desc"); > } > > @Override > public Historian createHistorianProvider(GatewayContext gatewayContext, DecodedResource> decodedResource) throws Exception { > REDACTEDSettings settings = this.getSettings(decodedResource.config()).get(); > addReferenceProperty("databaseConnection", > ref -> ref > .targetType(DatasourceManager.DATABASE_CONNECTION_RESOURCE) > .value(REDACTEDSettings::databaseConnection) > .onUpdate(REDACTEDSettings::copyWithDatabaseConnection) > ); > return new REDACTED(gatewayContext, decodedResource.name(), settings); > } > > @Override > public Optional> settingsType() { > return Optional.of(REDACTEDSettings.class); > } > > @Override > public Optional defaultSettings() { > return Optional.of(new REDACTEDSettings("", 60000)); > } > > @Override > public boolean canCreate() { > return true; > } > > @Override > public Optional getWebUiComponent(ComponentType type) { > return Optional.of(new ExtensionPointResourceForm( > RESOURCE_TYPE, > "Historian", > TYPE_ID, > SchemaUtil.fromType(HistorianProvider.class), > SchemaUtil.fromType(REDACTEDSettings.class) > )); > } > > } > > ``` > **getExtensionPoints in module hook** > > ```python > @Override > public List> getExtensionPoints() { > return List.of(new REDACTEDExtensionPoint()); > } > > ``` The above code works for creating a historian, but breaks with `Extension Point Form Not Found` when trying to edit it. Looking at the SDK examples, some extension points implement the defaults in a constructor of the record class, in addition to implementing `defaultSettings()` and the `@Default` annotations. This is the case with: [User Source Profile](https://github.com/inductiveautomation/ignition-sdk-examples/blob/732874b3160cf38449879aa3528ad2903c485a67/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSourceResource.java), and [Secret Provider](https://github.com/inductiveautomation/ignition-sdk-examples/blob/732874b3160cf38449879aa3528ad2903c485a67/secret-provider/secret-provider-gateway/src/main/java/com/inductiveautomation/ignition/examples/secretprovider/mongodb/MongoDbSecretProviderResource.java). I tried this briefly as well, but no luck. Stepping through with a debugger, reveals some interesting things. On the historians page, in the list of extension points, `addComponent` and `editComponent` are nulls for all the IA historians, but instances of `ExtensionPointResourceForm` for my custom one: > **Screenshot** > > ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/f/4/f4ecf1af15e75658661a2f060905bec8594acc11.png) However, doing the same for the Secret Provider example reveals that all the extension points have `ExtensionPointResourceForm` instances (not just the example module): > **Screenshot** > > ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/1/1/11aa0eb832894a4d8cee19db4d3c642f4d0f589e.png) I'm not sure if that explains anything, but because of these inconsistencies compiling the example modules and comparing them to my own has not been as helpful as I hoped. In the screenshot, you can see that the default settings have been created with the correct values and (as far as I can tell) in the correct format: > **Screenshot** > > ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/5/f/5f5c967f76fc189663fc4c4dd5cc1c3b137e1d06.png) ---
**Author:** ![Gabor\_Monostori](https://avatars.discourse-cdn.com/v4/letter/g/74df32/32.png) [@Gabor\_Monostori](https://forum.inductiveautomation.com/u/Gabor_Monostori)\ **Post date:** [April 8, 2026, 2:19pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/14 "2026-04-08T14:19:53Z")
I had used a separate `public record TimescaleDbHistorianConfig` for annotations (similarly as in the example of djs above). I have just made an attempt to move the annotations to the fields on TimescaleDbHistorianSettings (not on getters). Fragment: public class TimescaleDbHistorianSettings implements HistorianSettings { ... @FormCategory("Connection") @Label("Username\*") @FormField(FormFieldType.TEXT) @DefaultValue("postgres") @Required @Description("Database username") private String username = "postgres"; ... and then ```python @Override public Optional defaultSettings() { return Optional.of(new TimescaleDbHistorianSettings()); } ``` The labels, descriptions, categories, and field types all render correctly. Only the `@DefaultValue` doesn't populate the input box. ---
**Author:** ![Gabor\_Monostori](https://avatars.discourse-cdn.com/v4/letter/g/74df32/32.png) [@Gabor\_Monostori](https://forum.inductiveautomation.com/u/Gabor_Monostori)\ **Post date:** [April 10, 2026, 9:19am UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/16 "2026-04-10T09:19:31Z")
Just a quick note: this isn't working because editing settings breaks when there isn't a separate record. Any pointers on how to fix this would be much appreciated. ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [April 10, 2026, 12:25pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/17 "2026-04-10T12:25:19Z")
I pinged somebody on the history team to look into this because I think there may be an issue specific to this system. ---
**Author:** ![Kurt.Larson](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kurt.larson/32/6426_2.png) [@Kurt.Larson](https://forum.inductiveautomation.com/u/Kurt.Larson)\ **Post date:** [April 10, 2026, 2:48pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/18 "2026-04-10T14:48:01Z")
Unfortunately, this will require fixes on our end. I’ll get it prioritized and update this thread once it’s merged into a nightly. ---
**Author:** ![Gabor\_Monostori](https://avatars.discourse-cdn.com/v4/letter/g/74df32/32.png) [@Gabor\_Monostori](https://forum.inductiveautomation.com/u/Gabor_Monostori)\ **Post date:** [June 16, 2026, 7:06pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/19 "2026-06-16T19:06:27Z")
Hi, Just retested on 8.3.6 — still broken: returning a populated defaultSettings() does not pre-fill the create form (it stays empty) but does break the re-edit page with "Extension Point Form Not Found", so Optional.empty() is the only usable option. Any idea when it will be fixed? Best regards, Gabor ---
**Author:** ![sam.donche](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/sam.donche/32/86269_2.png) [@sam.donche](https://forum.inductiveautomation.com/u/sam.donche)\ **Post date:** [July 5, 2026, 12:16pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/20 "2026-07-05T12:16:56Z")
Will this get updated in the next Ignition version? Just tested it in version 8.3.7 and it seems broken. Thanks for the feedback. ---
**Author:** ![Kurt.Larson](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kurt.larson/32/6426_2.png) [@Kurt.Larson](https://forum.inductiveautomation.com/u/Kurt.Larson)\ **Post date:** [July 5, 2026, 3:47pm UTC](https://forum.inductiveautomation.com/t/default-settings-for-a-custom-extensionpoint/114866/21 "2026-07-05T15:47:51Z")
It’s being worked on currently targeted for the 8.3.9 release.