Package com.inductiveautomation.ignition.gateway.model

Class SystemPropertiesRecord

java.lang.Object
simpleorm.dataset.SRecordInstance
com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord
com.inductiveautomation.ignition.gateway.model.SystemPropertiesRecord
All Implemented Interfaces:
Serializable
public class SystemPropertiesRecord extends PersistentRecord
See Also:

  • Field Details

    • META

      public static final RecordMeta<SystemPropertiesRecord> META

    • Id

      public static final LongField Id

    • SystemName

      public static final StringField SystemName

    • SystemAuthProfileId

      public static final LongField SystemAuthProfileId

    • SystemAuthProfile

      public static final ReferenceField<UserSourceProfileRecord> SystemAuthProfile

    • SystemIdentityProvider

      public static final StringField SystemIdentityProvider

    • ForceIdpAuth

      public static final BooleanField ForceIdpAuth

    • DesignerAuthStrategy

      public static final EnumField<AuthenticationStrategy> DesignerAuthStrategy

    • DesignerAuthTokenInactivityTimeout

      public static final LongField DesignerAuthTokenInactivityTimeout

    • DesignerAuthTokenTimeToLive

      public static final LongField DesignerAuthTokenTimeToLive

    • ConfigRoleName

      @Deprecated public static final StringField ConfigRoleName
      Deprecated.
      Deprecated. Use ConfigPermissions instead

    • StatusPageRoleName

      @Deprecated public static final StringField StatusPageRoleName
      Deprecated.
      Deprecated. Use StatusPagePermissions instead

    • HomePageRoleName

      @Deprecated public static final StringField HomePageRoleName
      Deprecated.
      Deprecated. Use HomePagePermissions instead

    • DesignerRoleName

      public static final StringField DesignerRoleName
      These roles are used when the DesignerAuthStrategy is set to AuthenticationStrategy.CLASSIC
      See Also:

    • CreateProjectRoleName

      @Deprecated(since="8.1.54", forRemoval=true) public static final StringField CreateProjectRoleName
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create project roles are now covered by designer roles.
      See Also:

    • DEFAULT_ADMIN_ROLE_PERMISSIONS

      public static final PermissionsConfig DEFAULT_ADMIN_ROLE_PERMISSIONS

    • ConfigPermissions

      public static final BlobField ConfigPermissions

    • StatusPagePermissions

      public static final BlobField StatusPagePermissions

    • HomePagePermissions

      public static final BlobField HomePagePermissions

    • DesignerPermissions

      public static final BlobField DesignerPermissions
      These permissions are used when the DesignerAuthStrategy is set to AuthenticationStrategy.IDENTITY_PROVIDER
      See Also:

    • CreateProjectPermissions

      @Deprecated(since="8.1.54", forRemoval=true) public static final BlobField CreateProjectPermissions
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create project permissions are now covered by designer permissions.
      See Also:

    • UserInactivityTimeout

      public static final LongField UserInactivityTimeout
      User Inactivity Timeout (in minutes). Default value is 10 minutes. A number less than or equal to zero disables the user inactivity timeout altogether.

    • AllowUserAdmin

      public static final BooleanField AllowUserAdmin

    • AllowDesignerSSO

      public static final BooleanField AllowDesignerSSO

    • UseSSL

      @Deprecated public static final BooleanField UseSSL
      Deprecated.

    • LaunchScriptingPolicy

      public static final EnumField<LaunchScriptPolicy> LaunchScriptingPolicy

    • LaunchJREs

      public static final StringField LaunchJREs

    • DesignerRAM

      public static final EnumField<RamOption> DesignerRAM

    • Disable3DPipeline

      public static final BooleanField Disable3DPipeline

    • DisableDirectDraw

      public static final BooleanField DisableDirectDraw

    • UseCondensedDialogFont

      public static final BooleanField UseCondensedDialogFont

    • HomepageUrl

      public static final StringField HomepageUrl

    • ClientFallbackEnabled

      public static final BooleanField ClientFallbackEnabled

    • SecondsBeforeFailover

      public static final IntField SecondsBeforeFailover

    • FallbackProjectId

      public static final LongField FallbackProjectId

    • FallbackProject

      public static final ReferenceField<ProjectRecord> FallbackProject

    • FallbackProjectName

      public static final StringField FallbackProjectName

    • ScheduledBackupsEnabled

      public static final BooleanField ScheduledBackupsEnabled

    • ScheduledBackupPath

      public static final StringField ScheduledBackupPath

    • ScheduledBackupTimes

      public static final StringField ScheduledBackupTimes

    • ScheduledBackupRetentionCount

      public static final IntField ScheduledBackupRetentionCount

    • ScheduledBackupFilename

      public static final StringField ScheduledBackupFilename

    • AutomaticThreadDumpsEnabled

      public static final BooleanField AutomaticThreadDumpsEnabled

    • AutomaticThreadDumpsIntervalSeconds

      public static final IntField AutomaticThreadDumpsIntervalSeconds

    • AutomaticThreadDumpsCPUThreshold

      public static final IntField AutomaticThreadDumpsCPUThreshold

    • AutomaticThreadDumpsCPUThresholdExceededDuration

      public static final IntField AutomaticThreadDumpsCPUThresholdExceededDuration

    • AutomaticThreadDumpsRetentionCount

      public static final IntField AutomaticThreadDumpsRetentionCount

    • ErrorReportSMTPServer

      public static final StringField ErrorReportSMTPServer

    • ErrorReportToEmail

      public static final StringField ErrorReportToEmail

    • ErrorReportFromEmail

      public static final StringField ErrorReportFromEmail

    • ErrorReportUsername

      public static final StringField ErrorReportUsername

    • ErrorReportPassword

      @Deprecated public static final StringField ErrorReportPassword
      Deprecated.

    • ErrorReportPasswordE

      public static final EncodedStringField ErrorReportPasswordE

    • MulticastEnabled

      public static final BooleanField MulticastEnabled

    • MulticastIPAddr

      public static final StringField MulticastIPAddr

    • MulticastSendPort

      public static final StringField MulticastSendPort

    • MulticastReceivePort

      public static final StringField MulticastReceivePort

    • MulticastIntervalMillis

      public static final StringField MulticastIntervalMillis

    • DemoTimeRemaining

      public static final IntField DemoTimeRemaining
      Represents the amount of demo time remaining, in seconds. Updated on shutdown, not kept up-to-date while the system is running.

    • SystemUID

      public static final StringField SystemUID

    • EnableUpdateNotifications

      public static final BooleanField EnableUpdateNotifications

    • GatewayScriptingProject

      public static final StringField GatewayScriptingProject

    • GatewayAuditProfile

      public static final StringField GatewayAuditProfile

    • EnableTagReferenceStore

      public static final BooleanField EnableTagReferenceStore

  • Constructor Details

    • SystemPropertiesRecord

      public SystemPropertiesRecord()

  • Method Details

    • getScheduledBackupFilename

      public String getScheduledBackupFilename()

    • getMeta

      public RecordMeta<?> getMeta()
      Description copied from class: SRecordInstance
      This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance. It is normally defined as:- 

       SRecord getMeta() {
   return meta;
 };

      The actual meta variable is thus not Serialized, but it would not be anyway as it is usually static.

      Specified by:
      getMeta in class PersistentRecord

    • getSystemAuthProfileId

      public Long getSystemAuthProfileId()

    • getSystemName

      public String getSystemName()

    • isUseSSL

      @Deprecated public boolean isUseSSL()
      Deprecated.

    • getSystemUID

      public String getSystemUID()

    • getHomepageUrl

      public String getHomepageUrl()

    • getGatewayScriptingProject

      public String getGatewayScriptingProject()

    • getEnableTagReferenceStore

      public boolean getEnableTagReferenceStore()

    • setEnableTagReferenceStore

      public void setEnableTagReferenceStore(boolean enable)

    • setGatewayScriptingProject

      public void setGatewayScriptingProject(String project)

    • getGatewayAuditProfile

      public String getGatewayAuditProfile()

    • setGatewayAuditProfile

      public void setGatewayAuditProfile(String profileName)

    • getPermissions

      public static PermissionsConfig getPermissions(SRecordInstance record, BlobField field, PermissionsConfig defaultPermissions)

    • getPermissions

      public PermissionsConfig getPermissions(BlobField field, PermissionsConfig defaultPermissions)

    • setPermissions

      public void setPermissions(BlobField field, PermissionsConfig permissions)

    • getConfigPermissions

      public PermissionsConfig getConfigPermissions()

    • setConfigPermissions

      public void setConfigPermissions(PermissionsConfig permissions)

    • getStatusPagePermissions

      public PermissionsConfig getStatusPagePermissions()

    • setStatusPagePermissions

      public void setStatusPagePermissions(PermissionsConfig permissions)

    • getHomePagePermissions

      public PermissionsConfig getHomePagePermissions()

    • setHomePagePermissions

      public void setHomePagePermissions(PermissionsConfig permissions)

    • getDesignerPermissions

      public PermissionsConfig getDesignerPermissions()

    • setDesignerPermissions

      public void setDesignerPermissions(PermissionsConfig permissions)

    • getCreateProjectPermissions

      @Deprecated(since="8.1.54", forRemoval=true) public PermissionsConfig getCreateProjectPermissions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create project permissions are now covered by designer permissions.
      See Also:

    • setCreateProjectPermissions

      @Deprecated(since="8.1.54", forRemoval=true) public void setCreateProjectPermissions(PermissionsConfig permissions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create project permissions are now covered by designer permissions.
      See Also:

    • useCondensedDialogFont

      public boolean useCondensedDialogFont()