WebUIConfig and GatewayHook communication

darren.steele · September 11, 2025, 12:06pm

Hi all,

I’ve integrated the example WebUIConfigModule into my Ignition Module but I’m struggling with data exchange.

How would I use my GatewayHook to query the data that is set in my WebUiConfig page?

Or indeed, how can I notify my GatewayHook when the user changes something in the WebUiConfig react app?

Thanks for any guidance.

paul-griffith · September 11, 2025, 3:33pm

8.1, or 8.3?

In 8.1 you set up a listener in your own code that will be notified by the platform whenever a configuration change is made:

github.com/inductiveautomation/ignition-sdk-examples

gateway-webpage/gateway-webpage-gateway/src/main/java/com/inductiveautomation/ignition/examples/hce/GatewayHook.java

276f89239


      
          HCSettingsRecord.META.addRecordListener(new IRecordListener<HCSettingsRecord>() {
              @Override
              public void recordUpdated(HCSettingsRecord hcSettingsRecord) {
                  log.info("recordUpdated()");
              }
          
              @Override
              public void recordAdded(HCSettingsRecord hcSettingsRecord) {
                  log.info("recordAdded()");
              }
          
              @Override
              public void recordDeleted(KeyValue keyValue) {
                  log.info("recordDeleted()");
              }
          });

In 8.3 the recommended pattern is to use a SingletonResourceHandler or NamedResourceHandler to react to changes in config so you don't have to set up all the listening infrastructure yourself:

github.com/inductiveautomation/ignition-sdk-examples

user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/GatewayHook.java

f9aa67377


      
          namedResourceHandler = NamedResourceHandler.newBuilder(MongoDbUserSourceResource.META)
                  .context(context)
                  .build();