This is documentation for the current major version Apprenda 7.
Older versions are also available.

Managing the Platform Registry

Registry Settings are configuration settings internal to the Apprenda Cloud Platform that are available to the entire system. These settings are not isolated to a particular Tenant or application but are instead intended to affect behavior throughout your Platform. Registry Settings are managed by Platform Operators and can be viewed on the Configuration>Platform Registry page in the SOC.

Before changing a Registry Setting, you should understand how it will affect your Platform and make sure that all affected stakeholders are notified about the change. Changes to the Platform Registry will take affect immediately on your Platform.

Modify or Deleting Registry Setting

Note that some settings can't be altered due to the negative impact it could have on your Platform. Settings that can't be altered are listed on this page so you can see the values.

See a full list of available settings and their values.

To modify a Registry Setting,

  1. click on the one you wish to change from the list of settings on the Configuration>Platform Registry page in the SOC. This will open the edit window for that setting
  2. fill in the new value for the setting. See the list of registry settings for information about valid input values
  3. click Save

To delete a Registry Setting,

  1. click on the one you wish to change from the list of settings on the Configuration>Platform Registry page in the SOC. This will open the edit window for that setting
  2. click Remove and then read and agree to the confirmation prompt that appears (or Cancel if you want to close the window without removing the setting)

    Edit or delete a registry setting through this window.

    Adding a Registry Setting

    Some Registry Settings are configured during Platform installation, and some can be added at any point after installation to further configure your Platform. You can add any of the listed Registry Settings to your Platform to modify behavior.

    To add a new Registry Setting, click Add a Registry Setting.

    Click this button to Add a Regitsry Setting

    In the Add a Platform Registry Setting window,

    1. fill in the Setting Name. See available setting names
    2. fill in the Setting Value. For the setting to work correctly, you must input a valid value for the setting.For example, a setting which is expected to be a whole number must contain only digit characters
    3. select Encrypt Setting if the value for the setting is sensitive information that should be encrypted

    Click Save (or Cancel if you want to close the window without saving).

    Use this window to add a registry setting to your Platform

    List of Registry Settings

    The following list summarizes the Platform Registry Settings:

    Name Explanation Values
    AccountPortalCssOverrideUrls Inject CSS tags into the Account Portal master page. Comma-separated list of CSS files.
    AccountPortalExtServices Aliases of Account Portal extension services. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    AccountPortalJsOverrideUrls Inject JavaScript tags into the Account Portal master page Comma-separated list of JS files.
    AllowIdentityFederation Allow Identity Federation for the environment. True, False
    AllowPersistentSession Allow cookies to persist across browser sessions. True, False
    AllowUiDeploymentToExceedCeiling Allow the deployment of frontend workloads to exceed the ceiling. True, False

    Apprenda.DB.UseResourceGovernor

    Determines if Resource Throttling is enabled for Platform databases. Set to false at installation, database throttling can only be enabled if this setting is enabled and if the SQL Server Account is granted the sysadmin and serveradmin roles True, False (default)
    Apprenda.CitadelEnableAutoComplete Allow autocomplete for password fields True, False
    Apprenda.Kubernetes.Namespace Determines the Kubernetes namespace the Platform will manage on an added cluster. All Kubernetes applications deployed with the Platform will be in this namespace Any string, default: acp
    Apprenda.Security.EncryptInternalTraffic
     
    The Platform checks this setting when deciding whether internal web traffic must be encrypted or not. Currently can only be set at install or for some  upgrade scenarios. It is set by the installer and should not be modified by the Platform Operator. True, False
    Apprenda.Security.CertificateCreationEnabled
     
    When True, Apprenda will generate host certificates for Windows and Linux nodes within the Platform as necessary. Currently can only be set at install or upgrade time. It is set by the installer and should not be modified by the Platform Operator True, False
    Apprenda.Security.PlatformCACertificateThumbprint
     
    This setting only exists when Apprenda.Security.EncryptInternalTraffic has a value of True. When deploying new workloads, Apprenda checks the node the workload is being deployed to for a host certificate which has been signed by the Platform's issuer certificate. It does this by verifying the signer thumbprint of the host cert matches the GUID of this registry setting. GUID

    Apprenda.Security.SocApiAuthorizationToken

    Token to be used by JMX Proxy to gain access to the SOC and gather information about application workloads. string
    Apprenda.UpgradeInProgress Denotes if an upgrade is in progress. True, False

    Auditing.DatabaseConnectionString

    Database connection string for the audit database. SQL server connection string without password

    Auditing.DatabasePassword

    Password for the audit database. This setting should be encrypted. String, SQL server password
    Auditing.GroomingPeriodDays
     
    Time (in days) the Platform will begin to remove audit logs with a date older than the grooming period Any positive integer, default 365 days
    Authentication.AllowMultipleSessionsPerUser Allow Users to be logged in from multiple locations. True, False
    AuthenticationCssOverrideUrls Inject CSS tags into the Platform login page. Comma-separated list of CSS files.
    Authentication.DefaultSessionDurationInMinutes Set a Platform-wide inactive session duration. Any positive integer
    Authentication.ExpiredSession.PollingInterval Interval between each polling to purge expired User sessions Time formatted as hh:mm:ss ;
    defaults to 00:02:00
    (2 minutes)
    Authentication.ExpiredSession.Purge Purge expired User sessions from the Core DB True, False
    Authentication.ExternalProvider.Headers HTTP headers to be passed in to the External Authentication plugin. Comma-separated list of HTTP headers.
    Authentication.ExternalProvider.SessionCacheDurationInMinutes Set an inactive session duration for Platform-Level External Authentication. Any positive integer; the default value at installation is 1440.
    AuthenticationJsOverrideUrls Inject JavaScript tags into the Platform login page. Comma-separated list of JS files.
    BatchSizeForSubscriptionMigrations Number of subscriptions that will be migrated to the new version at a time when an application with authorization is patched. Any positive integer.

    Billing.DatabaseConnectionString

    Connection string for the billing database. SQL Server connection string without password

    Billing.DatabasePassword

    Password for the billing database SQl Server password
    Citadel.AccountLockoutEnabled Lock out account for a certain time after a certain number of failed login attempts. True, False
    Citadel.AccountLockoutTimeInMinutes Set lockout time for an account after a certain number of failed login attempts. Any positive integer; 0 means account will not be locked out
    Citadel.AdditionalApplicationOnboardList Set a standard list of guest applications that users get when added to a tenant. List of guest application aliases separated by commas, spaces, or semicolons
    Citadel.CustomLoginPageTitle Customize the Title for the Login and Account provisioning pages. String value

    Citadel.DisablePerTenantFederation

    Disable ability to edit federation settings on a per-Tenant basis, which allows for configuration of Platform-wide federation. True, False

    Citadel.EntitlementSweepInMinutes

    Time (in minutes) in between sweeps that the Platform performs to ensure that guest application subscription and entitlement status is refreshed/updated Any positive integer; defaults to 15 at Platform installation.
    CitadelExtServices Aliases of Citadel extension services. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    Citadel.FailedAttemptsBeforeLockout Set number of failed login attempts before an account is locked out for a set period of time. Any positive integer; 0 means account will not be locked out
    Citadel.Login.ForwardUrlOverride URL to which Users are forwarded upon login to the Platform Any URL valid for Platform users
    Citadel.LogoutRedirectUrl URL to which Users are forwarded upon Platform logout Any URL valid for Platform users
    Citadel.RemoveTenantsNotInEusSweepInMinutes When an external user store is enabled, time (in minutes) in between sweeps that the Platform performs to remove tenants that are no longer part of the EUS. Any positive integer; defaults to 1440 at Platform installation.
    Citadel.RemoveUsersWithoutAccessSweepInMinutes When an external user store is enabled, time (in minutes) in between sweeps that the Platform performs to remove users that are no longer part of the EUS. Any positive integer; defaults to 1440 at Platform installation.
    Citadel.Signup.DevelopmentTeamSignupUrlOverride URL to which Users are forwarded upon clicking on the "Create a Developer Account" link Any URL valid for Platform users
    Citadel.Signup.EndUserSignupUrlOverride URL to which Users are forwarded upon clicking on the "Create an Tenant Account" link Any URL valid for Platform users
    Citadel.Signup.ForwardUrlOverride URL to which Users are forwarded upon creating an Account for their Organization Any URL valid for Platform users

    ComponentCredentialSpecification

    Enable/require Developer specification of credentials for app components Forbidden, Allowed, Required
    CoreDbAdminPassword Platform Data SQL Server password SQL Server password
    CoreDbAdminUserName Platform Data SQL Server username SQL Server username
    CoreDbSqlInstance Platform Data SQl Server SQl Server instance

    DB.EnforceWindowsAuthentication

    When set to True, SQL Server databases for single-tenant .NET apps must be created on a server that supports SSPI (Windows Authentication). True, False

    DB.GrantSchemaAccessIn12C
     

    Applies to guest applications that leverage Oracle 12c on Apprenda-managed, on-Platform Oracle 12c CDBs. When set to True, Apprenda will automatically create and apply grants and open up all database-created-objects to the tenant and runtime users. When set to False, Apprenda no grants will be created or applied. True, False; the default value at installation is True.

    DefaultToLegacyDeveloperPortal

    When set to True, developers will be directed to the Legacy Portal upon logging in to the Developer Portal. True, False
    Deployment.AspNetPlacementExtServices Alias of Placement extension services for .NET user interface component host filtering. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    Deployment.DBPlacementExtServices Alias of Placement extension services for database component host filtering. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    Deployment.FailedInstanceMaxBackups Maximum number of failed instance directories retained per node. Any positive integer; defaults to 10 at Platform installation
    Deployment.MonitoringExtService Location of an application the Platform should use as a Monitoring Extension Service monitoringAppAlias/
    MonitoringExtensionService
    Deployment.ServicePlacementExtServices Alias of Placement extension services for WCF and Windows service component host filtering. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    Deployment.WarPlacementExtServices Alias of Placement extension services for war component host filtering. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    DeploymentSettings.AllowCloudAffinitySelection Enable Developer ability to set Cloud Affiny for apps True, False
    DeploymentSettings.ApplicationServices.Default Default Apprenda services for guest applications. None, Authentication, Authorization, Multitenancy, Billing
    DeploymentSettings.ApplicationServices.
    MaximumApplicationServiceLevel
    Maximum allowable Apprenda services for guest applications. None, Authentication, Authorization, Multitenancy, Billing
    DeploymentSettings.KubernetesPresentationDeploymentStrategy.Default Default UI deployment model for guest applications with Kubernetes Pods. This will override the value for DeploymentSettings.PresentationDeploymentStrategy.Default when a pod is present in an applicayion. CommingledRootApp, CommingledAppRoot (default)
    DeploymentSettings.PersistenceDataModel.Default Default database deployment model for guest applications. Commingled, Isolated
    DeploymentSettings.PipelineMode.Default Default pipeline mode for applications with no Platform services. Classic, Integrated
    DeploymentSettings.PresentationDeploymentStrategy.Default Default UI deployment model for guest applications. CommingledRootApp, CommingledAppRoot
    DeveloperPortal.RuleProcessingTimeoutInMinutes Timeout for rule processing in the Developer Portal (applicable when uploading an archive). Any positive integer; default at installation is 10
    DeveloperPortal.ArchiveRequestTimeoutInMinutes Timeout for requesting an archive via a URL in the Developer Portal (applicable when uploading an archive). Any positive integer; default at installation is 10
    DeveloperPortalCssOverrides Inject CSS tags into the New Developer Portal master page. Comma-separated list of CSS files.
    DeveloperPortalCssOverrideUrls Inject CSS tags into the Legacy Developer Portal master page. Comma-separated list of CSS files.
    DeveloperPortalExtServices Aliases of Developer Portal extension services. Comma-separated values of alias/class name (app1/extclass, app2/extclass...)
    DeveloperPortalJsOverrideUrls Inject JavaScript tags into the Legacy Developer Portal master page. Comma-separated list of JS files.

    Hosting.ApplyCookiesToRootUrl

    Determines whether authentication cookies are set to Apprenda's root URL or subdomain URL 

    True (default): cookies are set for the root URL

    False:cookies are set for the subdomain URL

    Hosting.Linux.AllowedRuntimeFlags List of allowed runtime flags for Java Web Application components List of comma delimited regex patterns

    Hosting.Linux.AutoChangeJMXCredentials

    Determines whether JMX credentials (RO and RW) change for a given component when application version and version stage change.

    True (default): JMX credentials (RO and RW) for a given component will change for each version of an application and when an application version is promoted from Sandbox to Published.

    False: JMX credentials for a given component will remain the same regardless of application version or version stage.

    Hosting.Linux.AutoCreateLinuxContainerWorkloadAccounts Enable the Platform's ability to create the run-as account set for a Java Web App workload if that account doesn't already exist. True, False
    Hosting.Linux.DefaultLinuxContainerWorkloadUserAccount Name of the default user account for running Java Web Applications. User account name
    Hosting.Linux.EnvironmentVariableBlacklist Environment variable values that cannot be set for Java components. List of values separated by commas, spaces, or semicolons
    Hosting.Linux.EnvVarPathBase Base path prepended to the $PATH environment variable for Java Web Application workloads. A valid path; if nothing is set, a default of /usr/local/sbin:/usr/local/bin:/sbin: /bin:/usr/sbin:/usr/bin:/root/bin will be used

    Hosting.Linux.JBoss.ProcessStartTimeoutSeconds

    Determines the amount of time (in seconds) the Platform will wait for JBoss to start before attempting to start the out of memory watcher Any positive integer; defaults to 10

    Hosting.Linux.ProcessMaxOpenFileDescriptors

    The maximum number of file descriptors per Java Web Application workload that can be opened at a time Any positive integer

    Hosting.Linux.TokenFilePatterns

    Sets the file patterns for which Apprenda will perform token switching when deploying Java components Comma-separated list; is set to **/*.xml,**/*.properties at Platform installation

    Hosting.Linux.TomcatClassLoaderDelegateList

    List of namespaces that are exposed from the common Tomcat classloader to the application. Semi-colon separate list of namespaces.

    Hosting.Linux.TomcatClassLoaderResourcesBlackList

    List of resourcs  that cannot be loaded for Tomcat Semi-colon separate list of resources.
    Hosting.Linux.WorkloadDeploymentTimeout Allotted timeout (in seconds) for workloads to deploy and start on Linux Servers. Any positive integer; default at installation is 60.
    Hosting.Linux.WorkloadDynamicPortRangeMax Highest port number allowable for Java Web Application components (WARs) for guest apps. Any valid port number; default at installation is 65535.
    Hosting.Linux.WorkloadDynamicPortRangeMin Lowest port number allowable for Java Web Application components (WARs) for guest apps. Any valid port number; default at installation is 1024.

    Hosting.LinuxService.MaxPortsPerComponent

    Maximum allowable number of ports per Linux Service component for guest apps. Any positive integer

    Hosting.LinuxService.Packing

    Influences server selection when deploying a Linux Services workload. When compressed (dense), workloads will deploy to machines that already have deployed workloads if space is available. If balanced (sparse), they will deploy to a host with the fewest workloads. Applies only when Resource Throttling is enabled, and does not apply to Linux Service components which have a Resource Policy with no limits for the corresponding packing type. Sparse, Dense (default)

    Hosting.LinuxService.PackingType

    When deploying Linux Services, the determination of which server to use is done by measuring CPU usage or memory usage. See Hosting.LinuxService.Packing for more information. Cpu, Memory(default)

    Hosting.LinuxService.PortRangeHighLimit

    Highest port number allowable for Linux Service  components for guest apps. Any valid port number

    Hosting.LinuxService.PortRangeLowLimit

    Lowest port number allowable for Linux Service  components for guest apps. Any valid port number

    Hosting.LinuxService.StopCompletionTimeoutSeconds

    Determines the length of time (in seconds) a Linux Container will wait for a stop.sh script to stop a Linux service before the process is killed. Any positive integer (defaults to 10)

    Hosting.PlatformHealing.Enabled

    Determines whether the Platform will perform sweeps to monitor for missing or corrupted workloads and take steps to repair any inconsistencies True (default),False

    Hosting.PlatformHealing.EnablePerNodeOverride

    Determines whether Platform Operators have the ability to enable/disable Platform healing on a per-Linux server basis. Platform healing must be enabled on the Platform in order for this setting to take affect True, False (default)

    Hosting.PlatformHealing.DetectionTimeoutMinutes

    Time (in minutes) the Platform will wait for the detection sweep for missing or corrupted workloads to run before timing out Any positive integer; defaults to 5 at installation

    Hosting. PlatformHealing.HealingTimeoutMinutes

    Time (in minutes) the Platform will wait for the process healing missing or corrupted workloads to run before timing out Any positive integer; defaults to 5 at installation

    Hosting.PlatformHealing.LongestExpectedTransactionMinutes

    Time (in minutes) the Platform will wait for a transaction to run before the Platform creates a log for a possible issue

    Any positive integer; default at installation is 60

    Hosting.PlatformHealing.SweepTimeMinutes

    Time (in minutes) in between sweeps the Platform performs to monitor for missing or corrupted workloads Any positive integer; defaults to 5 at installation

    Hosting.Services.EnforceSSL

    When True, Windows Services and Linux Services must serve over https unless they are on an exception list. When false, Windows Services and Linux Services will serve over http. True,False

    Hosting.Services.EnforceSSLExceptionList

    When Hosting.Services.EnforceSSL is set to True, the platform will check the appaliases on this list during deployment. If there is a match, and the app is either a Windows Service or a Linux Service, it will be allowed to serve http traffic. This list is ignored if Hosting.Services.EnforceSSL is set to False. List of application aliases separated by commas

    Hosting.Tomcat.ConnectorMaxThreads

    The maximum number of threads per Java Web Application workload allowed by the Tomcat deployer. Any positive integer (defaults to 200)
    Hosting.Wars.AllowWorkloadHorizontalScalingOnSingleNode Allow more than one instance of a Java Web Application component from a given application version to be hosted on the same Linux server. True,False
    Hosting.Wars.Packing Influences server selection when deploying a WAR workload. When compressed (dense), workloads will deploy to machines that already have deployed workloads if space is available. If balanced (sparse), they will deploy to a host with the fewest workloads. Applies only when Resource Throttling is enabled, and does not apply to WAR components which have a Resource Policy with no limits for the corresponding packing type. Sparse, Dense (default)
    Hosting.Wars.PackingType When deploying WARs, the determination of which server to use is done by measuring CPU usage or memory usage. See Hosting.Wars.Packing for more information. Cpu, Memory(default)
    Hosting.Wars.WebXmlValidationEnabled Enable or disable web.xml validation for war components True,False

    Hosting.WcfService.LostHeartbeatRecoveryTimeoutSeconds

    Time that a WCF service instance is unresponsive after which that process is ended and a recovery attempt is made. Any positive integer
    Hosting.Windows.EnvironmentVariableBlacklist Environment variable values that cannot be set for WCF service components. List of values separated by commas, spaces, or semicolons

    Hosting.Windows.TokenFilePatterns

    Sets the default file patterns for which Apprenda will perform token switching when deploying .NET components Comma-separated list; is set to **\*.config,**\*.xml,**\*.txt,**\*.js at Platform installation.

    Hosting.WindowsServices.DescriptionFormat

    Format for Descriptions for Windows Services.

    String value; defaults to
    Service Name={5}, 
    Lifecycle Stage={3}, 
    Executable={4}, 
    Application Id = {0}, 
    Version Id = {1}, 
    Developer Id={2}

    {0}: Maps to the application id
    (Guid)
    {1}: Maps to the version id
    (Guid)
    {2}: Maps to the developer id
    (Guid)
    {3}: Maps to the lifecycle stage (Sandbox,Published)
    {4}: Maps to the local file path of the executable
    {5}: Maps to the name of the folder used to package the windows service in the archive

    Example: /WinServices/ServiceName/some_files (in this case it would result in: ServiceName)

    Note: No other values are available for injection

    Hosting.WindowsServices.DisplayFormat

    Format for Display Names for Windows Services.

    String value; defaults to Apprenda Guest (AppAlias='{0}'; Id={1})

    {0}: Maps to the application alias (String)
    {1}: Maps to the instance id (Guid)

    Note: No other values are available for injection

    Hosting.WindowsServices.Enabled Enable Developer ability to include Windows Services in guest apps True, False
    Hosting.WindowsServices.MaxPortsPerComponent Maximum allowable number of ports per  Windows Service component for guest apps. Any positive integer
    Hosting.WindowsServices.NameFormat Format for  Names for Windows Services.

    String value; defaults to ApprendaGuest-{0}-{1}

    {0}: Maps to the application alias (String)
    {1}: Maps to the instance id (Guid)

    Note: No other values are available for injection

    Hosting.WindowsServices.PortRangeHighLimit Highest port number allowable for Windows Service components for guest apps. Any valid port number.
    Hosting.WindowsServices.PortRangeLowLimit Lowest port number allowable for Windows Service components for guest apps. Any valid port number.

    HttpRouting.VanityURLCertificateUpload

    Determines if uploading a TSL/SSL certificate is required, optional, or disabled for Application Archives and published applications when an application has a custom URL set.

    Required: (default) Applications with a custom URL need a valid certificate before they can be Published

    Optional: Developers may chose whether an application has a certificate for its custom URL

    Disabled: No certificates will be allowed for any application's custom URL

    Kubernetes.CapturePodLogs Allows the Platform Cluster Manager to monitor logs generated by Kubernetes pods True (default), False
    Kubernetes.CapturePodUtilization Allows the Platform Cluster Manager service to monitor resource utilization of Kubernetes pods for an added cluster True (default), False
    Kubernetes.ClusterSweepPeriodMinutes The time (in minutes) between Platform checks new or updated clusters Any positive integer grater than 1 (default: 1)
    Kubernetes.ContainerRegistryWhitelist Comma separated list of allowed Docker Container registries that can be used for pods deployment. If no values are provided, all registries will be allowed.  String
    Kubernetes.Enabled Determines if Kubernetes clusters can be added to the Platform True (default), False
    Kubernetes.PodUtilizationUpdatePeriodSeconds The time (in seconds) between Platform checks for pod resource utilization data on an added cluster Any positive integer greater than 1 (default 60)

    LoadManagement.DatabaseConnectionString

    Connection String to Load Management database SQL Server connection string without password

    LoadManagement.DatabasePassword

    Password to Load Management database SQL Server password
    LoadManagement.IndexOfFirstApprendaRule
     
    Specifies the starting index for Platform URL rewrite rules, allowing custom URL rewrite rules to execute first. Any integer greater to or equal to 0; number must correspond to the quantity of rules that should run prior to Platform rules

    Logging.Aggregation.Method

    Default aggregation method used to group log messages into e-mail notifications when log aggregation is enabled in a Log Override. This will only affect Log Overrides for Java Web Applications.

    Pre-processed: Log messages are aggregated based on the event message (%m) regardless of the log pattern set in the Developer Portal

    Post-processed: (default) Log messages are aggregated based on the log pattern set in the Developer Portal

    (values are case sensitive)

    Logging.AllowDevelopersToDeleteEntries
     
    Allow developers to delete log messages generated by their guest applications. True,False
    Logging.Application.MaxAgeDays
     
    Maximum number of days that logs will be retained for guest applications. Any positive integer or 0 (which indicates no limit)
    Logging.Application.MaxSizeMBs
     
    Maximum size (in MBs) of logs that will retained per guest application. Any positive integer or 0 (which indicates no limit)
    Logging.Application.PruningSweepBatchDelayTimeInSeconds
     
    Time (in seconds) that the Platform will pause in between processing batches of database tables when pruning logs. Any positive integer
    Logging.Application.PruningSweepBatchSize
     
    The maximum number of database tables where log pruning will occur at any one time. Any positive integer
    Logging.Application.PruningSweepInMinutes
     
    Time (in minutes) in between sweeps that the Platform performs to execute log pruning (delete guest application logs messages) when a non-zero value is set for the Logging.Application.MaxAgeDays or Logging.Application.MaxSizeMBs settings. Any positive integer

    Logging.DatabaseConnectionString

    Connection string to Logging database. SQL Server connection string without password

    Logging.DatabasePassword

    Password to Logging database SQl Server password
    Logging.MaxBatchSize
     
    Sets the maximum number of log messages log messages that the logging service will accumulate before sending the batch to the appropriate logging database; a batch will be sent once it reaches this size. Any positive integer
    Logging.MaxBatchTimeMs
     
    Time the Platform will wait in between sending batches of logs to the appropriate logging database. Any positive integer
    Logging.WriteLogFileOnPlatformLoggerFailure
     
    When set to True, the logging client will write Platform logs to a local file in the instances folder if it is unable to send the logs to the Platform for any reason. True,False
    Messaging.NmsProvider The class name, library name of the NMSProvider class. Class name and library name must be separated by a comma and a space
    Messaging.NmsUri The URL to connect to the messaging queue instance. The valid URL for your queue instance.
    MinInstance.HostRecoveryDelayInSeconds Specifies the amount of time allowed to elapse after the number of deployed instances for a component drops below its Minimum Instance Count before a recovery attempt is made Any positive integer
    MinInstance.RecoveryAttempts Specifies the number of attempts that will be made to redeploy a component instance to meet an app component's Minimum Instance Count setting Any positive integer
    MinInstance.RecoveryPauseBetweenAttemptsInSeconds Specifies the amount of time allowed to elapse between attempts to redeploy a component instance in order to meet an app component's Minimum Instance Count setting Any positive integer

    NodeHealth.CheckBlacklist

    List of Health Check names to be ignored during a Health Check on every server in the Platform Comma-separated list

    NodeHealth.CheckExceptionOutcome

    Determines how the Platform will handle a Health Check that has an exception Healthy (default), PreventDeployments, Unhealthy; case sensitive

    NodeHealth.CheckMaxParallelism

    The maximum number of checks a server will run at the same time while running a Health Check Any positive integer (defaults to  10 at Platform installation)

    NodeHealth.CheckTimeoutMinutes

    The maximum amount of time (in minutes) the server will wait for an individual check before it times out Any positive integer (defaults to 2 at Platform installation)

    NodeHealth.CheckTimeoutOutcome

    Determines how the Platform will handle a Health Check that has timed out Healthy, PreventDeployments (default),Unhealthy; case sensitive

    NodeHealth.Enabled

    Determines if Server Health Checks and reports are automatically run on each server in the Platform True (default),False

    NodeHealth.MaxReportWaitSeconds

    The amount of time (in seconds) the Platform will want for a Server Health report to finish Any positive integer (defaults to 120 at Platform installation)

    NodeHealth.ReportMaxAgeHours

    The amount of time (in hours) the Platform will consider a Server Health report as current before it is marked for deletion An positive integer (defaults to 72 on Platform installation)

    NodeHealth.ReportPruningSweepDelayHours

    The amount of time (in hours) the Platform will wait before performing a sweep to delete old Server Health reports Any positive integer (defaults to 24 on Platform installation)

    NodeHealth.ReportTimerDeplaySeconds

    The amount of time (in seconds) the Platform will wait between the last health report ending and starting another check on a server’s health Any positive integer (defaults to 300 on Platform installation)
    PasswordStrengthRequirementsRegex Specifies complexity requirements for passwords created for Platform User accounts. Regex pattern
    PasswordStrengthVerificationFailedMessage The message presented if a proposed password does not meet complexity requirements String value
    Persistence.ProviderPartition.MaxSize
     
    Maximum size allowed for a Provider database partition (in MBs). Any positive integer
    Persistence.TenantPartition.MaxSize Maximum size allowed for a Tenant database partition (in MBs). Any positive integer
    PhysicalHost.CpuThrottling.AllocationFactor Allocation factor for CPU throttling. number > 0 (1=100%)
    PhysicalHost.CpuThrottling.TotalCpuThreshold Percentage of total CPU needed to be reached in order to start throttling guest apps. 0-100 (represents %)
    PhysicalHost.MemoryThrottling.AllocationFactor Allocation factor for RAM allocation. number > 0 (1=100%)
    PhysicalHost.ResourceAllocation.DefaultLinuxServicePolicyId ID of the resource policy assigned by default to guest application Linux Service components. GUID of a service resource policy
    PhysicalHost.ResourceAllocation.DefaultPodPolicyId ID of the resource policy assigned by default to guest application pod components. GUID of a pod resource policy
    PhysicalHost.ResourceAllocation.DefaultServicePolicyId ID of the resource policy assigned by default to guest application WCF and Windows service components. GUID of a service resource policy
    PhysicalHost.ResourceAllocation.DefaultStoragePolicyId ID of the resource policy assigned by default to guest application database components. GUID of a storage resource policy
    PhysicalHost.ResourceAllocation.DefaultStorageQuotaId ID of the storage quota assigned by default to guest application .NET UI components. GUID of a storage quota
    PhysicalHost.ResourceAllocation.DefaultUIPolicyId ID of the resource policy assigned by default to guest application .NET UI components. GUID of a UI resource policy
    PhysicalHost.ResourceAllocation.DefaultWarPolicyId ID of the resource policy assigned by default to guest application Java Web Application (WAR) components. GUID of a war resource policy
    PhysicalHost.ResourceAllocation.MaxDeveloperCpuAllocation Sets the total amount, in MHz, of CPU that a given Developer's applications can collectively use on the Platform. For this setting to have any effect, Resource Throttling must be enabled. The total is calculated by measuring allocations against Resource Policies assigned to the applications. Applications deployed against an unlimited Resource Policy do not count towards the total. This setting is global to all Development Teams. To create a limit for a specific Development Team, create a new setting and append a Development Team alias to the end of this setting name (like "-devTeamAlias") -1 signifies no limit; otherwise any positive integer
    PhysicalHost.ResourceAllocation.MaxDeveloperMemoryAllocation Sets the total amount, in MB, of memory that a given Developer's applications can collectively use on the Platform. For this setting to have any effect, Resource Throttling must be enabled. The total is calculated by measuring allocations against Resource Policies assigned to the applications. Applications deployed against an unlimited Resource Policy do not count towards the total. This setting is global to all Development Teams. To create a limit for a specific Development Team, create a new setting and append a Development Team alias to the end of this setting name (like "-devTeamAlias") -1 signifies no limit; otherwise any positive integer
    PhysicalHost.ResourceAllocation.MaxDeveloperStorageAllocation Sets the total amount, in MB, of storage that a given Developer's applications can collectively use on the Platform. For this setting to have any effect, Resource Throttling must be enabled. The total is calculated by measuring allocations against Resource Policies assigned to the applications. Applications deployed against an unlimited Resource Policy do not count towards the total. This setting is global to all Development Teams. To create a limit for a specific Development Team, create a new setting and append a Development Team alias to the end of this setting name (like "-devTeamAlias") -1 signifies no limit; otherwise any positive integer
    PhysicalHost.ThrottlingEnabled Enable throttling for the Apprenda instance True, False
    PhysicalHost.TrackUtilization Track utilization data for the Apprenda instance True, False
    PhysicalHost.UtilizationPollingIntervalSeconds

    Interval between each polling for utilization data

    Time in seconds
    PhysicalHost.UtilizationReportingInterval Interval between each utilization data report Time in seconds
    Platform.ExternalUserStoreRoleAssignment Configures whether or not Roles assigned to individual Users are updated to match Role assignments in an External User Store (EUS).

    Ignore: Role assignments for Users on the Platform are not updated to match Role assignments in the EUS.

    Additive: Role assignments for Users on the Platform are updated only when Role assignments are added for a given User in the EUS

    Exact: Role assignments for Users on the Platform are updated when Role assignments are added or removed for a given User in the EUS

    (values are case sensitive)

    Platform.ExternalUserStoreRoleCreation

    Configures whether or not the Roles associated with Tenants on the Platform are updated when new Roles are added in an External User Store (EUS).

    This setting will take effect only if the value for the Platform.
    ExternalUserStoreRoleAssignment settings is Additive or Exact

    Ignore: Roles on the Platform are not updated to match Roles added in the EUS

    Additive: Roles on the Platform are updated to match Roles added in the EUS

     (values case sensitive)

    Platform.UpgradePending

    Blocks the same actions that are blocked during upgrades and show the upgrade alert banner. Should be used to prevent long running actions from being initiated too close to an upcoming upgrade True, False
    Presentation.Packing Influences server selection when deploying a UI. When compressed (dense), UIs will deploy to machines that already have user interfaces if space is available. If balanced (sparse), they will deploy to a host with the fewest user interfaces. Applies only when Resource Throttling is enabled, and does not apply to UIs which have a Resource Policy with no limits for the corresponding packing type. Sparse, Dense (default)
    Presentation.PackingType When deploying UIs, the determination of which server to use is done by measuring CPU usage or memory usage. See Presentation.Packing for more information. Cpu, Memory(default)
    Presentation.PathBasedUrlsEnabled Enable path-based URLs for guest applications. True, False
    ResourcePolicies.MaxCpuCores Maximum CPU cores available for Resource Policies. Number of cores
    ResourcePolicies.MaxCpuCoresInFractionOfCores Maximum CPU fraction of core limit for Resource Policies. Affects Kubernetes workloads only Any positive number (limit to 1 decimal place), (default 2.0)
    ResourcePolicies.MaxCpuSpeed Maximum CPU speed available for Resource Policies. In MHz
    ResourcePolicies.MaxMemory Maximum RAM cores available for Resource Policies. In MB
    ResourcePolicies.MinCpuCores Minimum CPU cores available for Resource Policies. Number of cores
    ResourcePolicies.MinCpuCoresInFractionOfCores Minium CPU fraction of core limit for Resource Policies. Affects Kubernetes workloads only Any positive number (limit to 1 decimal place), default 0.1
    ResourcePolicies.MinCpuSpeed Minimum CPU speed available for Resource Policies. In MHz
    ResourcePolicies.MinMemory Minimum RAM cores available for Resource Policies. In MB
    ResourcePolicies.StepCpuCores Increment between CPU cores when creating Resource Policies. Integer > 0
    ResourcePolicies.StepCpuCoresInFractionOfCores Increment between maximum and minimum limits for fraction of CPU cores when creating Resource Policies. Any positive number (limit to 1 decimal place), default 0.1
    ResourcePolicies.StepCpuSpeed Increment between CPU speeds when creating Resource Policies. Integer > 0
    ResourcePolicies.StepMemory Increment between RAM allocations when creating Resource Policies. Integer > 0
    Routing.AllowedForeignDomains Allowed foreign domains. Allowed domain names (comma-separated)

    SaaSGridDefaultServiceAccountDomain

    Domain of the default user account for running WCF services. Domain name

    SaaSGridDefaultServiceAccountPassword

    Password of the default user account for running WCF services. User account password

    SaaSGridDefaultServiceAccountUsername

    Username of the default user account for running WCF services. User account username

    SaaSGridSystemDomain

    Domain for the Apprenda System user account (initially configured at install) under which deployed .NET workloads will run. Domain name

    SaaSGridSystemPassword

    Password for the Apprenda System user account (initially configured at install) under which deployed .NET workloads will run. User account password

    SaaSGridSystemUsername

    Username for the Apprenda System user account (initially configured at install) under which deployed .NET workloads will run. User account username

    Scheduling.DatabaseConnectionString

    Connection string for Scheduling database SQl Server connection string without password

    Scheduling.DatabasePassword

    Password to Scheduling database SQL Server password
    Services.Packing Influences server selection when deploying a service. When compressed (dense), services will deploy to machines that already have services if space is available. If balanced (sparse), they will deploy to a host with the fewest services. Applies only when Resource Throttling is enabled, and does not apply to UIs which have an Resource Policy with no limits for the corresponding packing type. Note that services will only deploy to servers hosting UIs and databases when there is no other server available for the deployment. Sparse, Dense (default)
    Services.PackingType When deploying services, the determination of which server to use is done by measuring CPU usage or memory usage. See Services.Packing for more information. Cpu, Memory (default)

    Smtp.Hostname

    Hostname for the outgoing mail server to be used for email notifications SMTP hostname

    Smtp.Password

    Password for the outgoing mail server user SMTP user password

    Smtp.Port

    Port of the outgoing mail server SMTP port

    Smtp.Username

    Username for outgoing mail server SMTP user username

    Smtp.UseSsl

    Determines if the outgoing mail server will use SSL when sending emails True, False
    SslEnforced Determines if SSL will be enforced for all Platform URLs. If true, the Platform will replace inbound http URL prefixes with https. If false, the Platform will keep the URL regardless of protocol. This should always match the Platform's internal encryption settings.

    True, False

    default value configured at installation.

    StorageManager.SqlServerTarget.machine_name Setting used for remote management of databases. Name of remote SQL Server instance
    StoreFrontExtServices Aliases of StoreFront extension services. Comma-separated values of alias/class name (app1/extservice, app2/extservice2…)
    SystemAdministratorDomain Domain for the Apprenda  Administrator account (initially configured at install) under which actions that require administrative privileges will be performed. Domain name
    SystemAdministratorPassword Password for the Apprenda  Administrator account (initially configured at install) under which actions that require administrative privileges will be performed. User account password
    SystemAdministratorUsername Username for the Apprenda  Administrator account (initially configured at install) under which actions that require administrative privileges will be performed. User account name
    TenantOnboarding.TransactionTimeoutMinutes Time in minutes the Platform will attempt to onboard a tenant to the Developer Portal before timing out. Any positive integer, default is 10 minutes. 
    UiDeplymentCeiling Maximum frontend workloads that can be deployed to each frontend server. Integer > 0
    UiDeploymentThreshold Number of frontend workloads that need to be reached in order to automatically deploy to other frontend servers. Integer > 0

    UserInterface.DefaultAccountDomain

    Domain of the default user account for running user interfaces. Domain name

    UserInterface.DefaultAccountPassword

    Password of the default user account for running user interfaces. User account password

    UserInterface.DefaultAccountUsername

    Username of the default user account for running user interfaces. User account username
    UserStore.TenantInfoCacheTimeoutSeconds Interval of time (in seconds) between refreshes of the Apprenda User Store's Tenant Info Cache Time in seconds

    Utilization.DatabaseConnectionString

    Connection string to Utilization database SQL Server connection string without password

    Utilization.DatabasePassword

    Password to Utilization database SQL Server password

    Utilization.Throttling.Autoscale.ScaleDownThresholdPct

    Percentage of average CPU below which auto-scaling will cause a component instance to be scaled down. 0-100 (represents %)

    Utilization.Throttling.Autoscale.ScaleUpThresholdPct

    Percentage of average CPU above which auto-scaling will cause a component instance to be scaled up. 0-100 (represents %)

    Utilization.Throttling.Autoscale.WindowSizeInSeconds

    Interval of time (in seconds) over which usage data will be accumulated in order to make auto-scaling decisions. Time in seconds

    WindowsService.DefaultAccountDomain

    Domain of the default user account for running Windows Services. Domain name

    WindowsService.DefaultAccountPassword

    Password of the default user account for running Windows Services. User account password

    WindowsService.DefaultAccountUsername

    Username of the default user account for running Windows Services. User account username