System properties for caching

There are a couple of system properties that you can set which will inhibit the automatic caching functions. Useful for managing hierarchy caching on a platform with limited heap space.
  • niagara.hierarchy.caching.disableOnStationStarted

    In a situation where it appears that too much memory is being used (resulting in a station shutdown/crash), there is a system property that you can set (niagara.hierarchy.caching.disableOnStationStarted) for ignoring the Cache On Station Started property. The cache-related Actions will continue to work even if this system property is set. When this system property is set to “true” hierarchies will not be cached automatically when the station starts even if the Cache On Station Started property is “true”. The intention of this system property is to provide a method of preventing a reboot loop.

  • niagara.hierarchy.caching.disabled

    When set to “true”, this system property disables caching of any hierarchies. You can set this property. Additionally, it will be set automatically by the nre launcher for legacy platforms that do not have much heap space, such as the JACE-3 and JACE-6.

    The Create Cache action will still be present on hierarchies, but, when you try to invoke the action, an error window appears with the following message:

    “Hierarchy caching is disabled because the system property niagara.hierarchy.caching.disabled is set to true. This may be because the platform does not have sufficient station heap space.”

    This new system property is in addition to niagara.hierarchy.caching.disableOnStarted, which only affects whether caches for hierarchies will actually be built on station startup when with the CacheOnStationStarted property set to “true”. If the niagara.hierarchy.caching.disabled property is set, then the niagara.hierarchy.caching.disableOnStationStarted property is disregarded and hierarchy caches are not built on station startup or when requested by the Create Cache action.