Package com.inductiveautomation.ignition.gateway.tags.managed

Class ProviderConfiguration

  • public class ProviderConfiguration
extends java.lang.Object

    • Constructor Detail

      • ProviderConfiguration

        public ProviderConfiguration​(java.lang.String name)

    • Method Detail

      • getName

        public java.lang.String getName()

      • getAllowTagCustomization

        public boolean getAllowTagCustomization()
        If true, the provider will allow users to define additional properties on the tag, such as alarms, history, and so on. Default is TRUE.

      • getAllowTagDeletion

        public boolean getAllowTagDeletion()
        If true, the user will be allowed to delete tags. Otherwise the provider will be the only entity allowed to manage tag removal. Default is FALSE.

      • getPersistTags

        public boolean getPersistTags()
        If true, the system will store definitions for all tags that are created, so that they will be available on startup, even if the system does not create them again. This is useful for systems that build tag models on outside data that might take some time to acquire, or otherwise might not be available immediately on startup, and will be later reconciled. A few notes on compatibility with other settings: 1) If this property is FALSE, but AllowTagCustomizations is TRUE, only changes created by the user will be stored, and the tag will not be displayed until created by the manager. 2) If this is FALSE, PersistValues will be ignored.

      • getPersistValues

        public boolean getPersistValues()
        Indicates whether values of tags should be stored. Used in conjunction with PersistTags, as it is ignored if tags are not persisted. If TRUE, values will be stored and loaded on startup. If FALSE, loaded tags will have bad (stale) quality until they are updated by the manager.

      • getStaleTimeoutMS

        public long getStaleTimeoutMS()
        Indicates how often a tag must be updated before it is declared to be stale. In other words, the manager must update values (even to the same value) at least this often.

      • getMountPath

        public java.lang.String getMountPath()
        The mount path is a folder structure under which all tags for this provider will reside.

      • getAttributes

        public Flags getAttributes()