AX2015

System configuration settings

The Axiom Software database stores several system configuration settings that can be edited if needed. The settings are defined per system.

These settings can be edited for a system in one of the following ways:

  • By using the Axiom Software Manager, using the Installation Manager > Configure System Properties feature. For assistance with the Software Manager, please see the Installation Guide or contact Axiom Support.

  • By using Save Type 4 in an Axiom file.

  • By using the System Configuration page in the System Administration area of the Web Client. Only certain settings can be modified here, mostly relating to the launch page or the login page.

After making any changes to the system configuration settings, you must reset the cache for the Axiom Application Server before the changes will take effect. The Software Manager will attempt to reset the cache automatically when you save changes to the system configuration settings. However, if you need to do this manually, you can use the Reset Server Cache feature in the Software Manager, or on the administration web page for Axiom Software.

The following system configuration settings are available:

ADONetBatchSize

Default True
100
Description

Specifies the batch size for update statements. This should only be changed on the advice of Axiom Support.

AllowAmbiguousAlternateAggregationAndColumnFilterFieldDefinitions

Default value
False
Description

This configuration setting is no longer relevant, since the limitations affecting use of certain alternate aggregations with column filters have been removed.

AllowBlanksToBeDataRowSeparators InAQDataUpdate

Default value
True
Description

Specifies whether blank rows cause duplicate records in an Axiom query data range to be treated as contiguous or not (True/False). This is for purposes of determining update behavior for duplicate records. By default, blank rows are treated as data separators and each duplicate row will be updated.

If disabled, then blank rows are ignored and the duplicate records are treated as contiguous, which means only the first row in the contiguous block will be updated.

AllowShowExcel

Default value
True
Description

Specifies whether the icon to install / launch the Axiom Excel Client shows in the Axiom Web Client (True/False). By default the icon is available.

If disabled, the icon will be hidden and therefore users cannot launch the Excel Client from the Web Client. Users can still launch the client via other means if it is installed (such as a desktop shortcut or a dedicated URL).

This setting can be modified using the System Configuration page in the Web Client.

AllowShowPowerPoint

Default value
True
Description

Specifies whether the icon to install / launch the PowerPoint Add-In shows in the Axiom Web Client (True/False). By default the icon is available.

If disabled, the icon will be hidden and therefore users cannot install or launch the PowerPoint add-in from the Web Client. Users can still install and launch the add-in via other means (such as by opening a PowerPoint file saved within the Axiom Software database).

This setting can be modified using the System Configuration page in the Web Client.

AllowShowWord

Default value
True
Description

Specifies whether the icon to install / launch the Word Add-In shows in the Axiom Web Client (True/False). By default the icon is available.

If disabled, the icon will be hidden and therefore users cannot install or launch the Word add-in from the Web Client. Users can still install and launch the add-in via other means (such as by opening a Word file saved within the Axiom Software database).

This setting can be modified using the System Configuration page in the Web Client.

AuthenticationDomainSelectionListRequired

Default value
False
Description

Specifies whether the authentication domain selection list always displays on the login screen (True/False). By default, the selection list only displays when it is necessary (meaning only when there are duplicate user names defined in Axiom that use different domains). If you want the domain selection list to always show, then set this to True.

AutoCastFloatColumnsDuringAggregation

Default value
False
Description

Specifies treatment of numeric columns when data is aggregated by a query to the database. This should only be changed on the advice of Axiom Support.

AutoUpdateProcessTaskPane

Default value
True
Description

Specifies whether the Process task pane automatically refreshes in response to process updates that affect the user (True/False). By default the task pane automatically refreshes.

If disabled, then the Process task pane does not automatically refresh. Instead, a message displays at the top of the task pane to inform the user that the process has updates and the user should refresh the task pane to see them. The user can click the message to refresh.

This setting should only be changed to False if system performance is being affected by the automatic process updates, which should be rare.

AxiomSignalRServerAddress

Default value
<Blank>
Description

The URI of the server used to control IPC traffic for Axiom Software. By default, when no value is specified here, the Axiom Application Server for the installation is used.

This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

BatchedAQsEnabled

Default value
True
Description

Specifies whether Axiom queries assigned to a batch are run using batch processing (True/False). By default, this is enabled so that queries run in their configured batches. If disabled, then batch processing is not performed and all queries are run in their normal sequential order, whether or not they are assigned to a batch. This setting is meant to be used as a stopgap in case batched Axiom queries are not configured correctly, so that the file(s) can be used while the configuration is evaluated and corrected.

BI_FiscalyearStartMonth

Default value
1
Description

The starting month of the fiscal year for purposes of fiscal year measures in Axiom Business Intelligence reports. This setting only applies in systems with an Axiom Business Intelligence license.

ClickOnceClientNameExcel

Default value
Axiom Excel Client
Description

The name of the shortcut for the Excel Client when using ClickOnce installations. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

ClickOnceClientNameWindows

Default value
Axiom Windows Client
Description

The name of the shortcut for the Windows Client when using ClickOnce installations. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

ClickOnceShortcutLocation

Default value
DesktopAndStartMenu
Description

The location where Axiom shortcuts will be placed when using ClickOnce installations. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

Available options are: DesktopAndStartMenu, DesktopOnly, StartMenuOnly.

ClickOnceShortcutType

Default value
CurrentClient
Description

Specifies whether shortcuts are created when using ClickOnce installations, and if so what type. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

Available options are: None, Generic, CurrentClient, Both. See the Installation Guide for more information on what these options mean.

CreateKeyIndexesOnTemporaryTables

Default value
True
Description

Specifies whether indexes are created for key columns of temporary tables (True/False). This should only be disabled on the advice of Axiom Support.

CreateNonKeyIndexesOnTemporaryTables

Default value
True
Description

Specifies whether indexes are created for non-key columns of the import temp table. This should only be disabled on the advice of Axiom Support.

CriticalErrorRegularExpression

Default value
Object reference not set
Description

Defines error text to match on for purposes of flagging critical errors in server logs. By default, any error messages containing this text are considered critical. This should only be changed on the advice of Axiom Support.

DatabaseIsCaseSensitive

Default value
False
Description

Specifies whether case-sensitivity should be recognized for SQL Server databases. This should only be enabled if your SQL Server database collation is case-sensitive.

DefaultColumnValue_Boolean

Default value

0 (meaning False)

Description

Defines the default value for Boolean columns. You can change this to 1 for True, or blank for null. It is not recommended to use null as the default for Boolean columns unless you have a particular use case that requires it.

If changed, the new value only applies to new columns created going forward. Existing columns will continue to use the default value that was set when they were created. For more information, see About default column values.

DefaultColumnValue_Date

Default value
<Blank> (meaning null)
Description

Defines the default value for Date columns. You can change this to any valid default value for Date columns.

If changed, the new value only applies to new columns created going forward. Existing columns will continue to use the default value that was set when they were created. For more information, see About default column values.

DefaultColumnValue_DateTime

Default value
<Blank> (meaning null)
Description

Defines the default value for DateTime columns. You can change this to any valid default value for DateTime columns.

If changed, the new value only applies to new columns created going forward. Existing columns will continue to use the default value that was set when they were created. For more information, see About default column values.

DefaultColumnValue_Number

Default value
0
Description

Defines the default value for Integer columns (all types) and Numeric columns. You can change this to any valid default value, including blank for null. It is not recommended to use null as the default for number-based columns unless you have a particular use case that requires it.

If changed, the new value only applies to new columns created going forward. Existing columns will continue to use the default value that was set when they were created. For more information, see About default column values.

DefaultColumnValue_String

Default value
''
Description

Defines the default value for String columns. You can change this to any valid string value. If a value is specified, it must be enclosed in single quote marks.

NOTE: Although it is possible to set the String column default to blank for null, Axiom Software does not differentiate between null values and empty string values in String columns within the spreadsheet environment. Therefore it is strongly recommended to leave the default of empty string if you do not want to use a specific string.

If changed, the new value only applies to new columns created going forward. Existing columns will continue to use the default value that was set when they were created. For more information, see About default column values.

DefaultEmailClientName

Default value
Outlook
Description

Specifies a custom name for the default email client, as displayed when using the Email Workbook feature.

If desired, you can change this name to a different email client used by your organization, or you can clear out the setting and leave it blank. If blank, then the text "Default E-Mail Client" will display in the dialog for this option.

DefaultFilterType

Default value
Includes
Description

Specifies the default comparison method for filtering "simple view" pick lists, such as when using Choose Data Element. Available options are: BeginsWith or Includes.

DefaultGetDataNoValueErrorMessage

Default value
<Blank>
Description

Specifies the return value when the parameters of a GetData function use valid syntax but the function does not return any data. You can change this to any text that you want to display in this situation. This return value can be overridden within each individual GetData function.

DefaultGetDataSQLErrorMessage

Default value
#ERR
Description

Specifies the return value when the parameters of a GetData function use invalid syntax, resulting in a SQL error. You can change this to any text that you want to display in this situation. This return value can be overridden within each individual GetData function.

DisableHashBytesCheck

Default value
False
Description

Specifies whether the hashbytes check is disabled. This should only be changed on the advice of Axiom Support.

EllucianEnabled

Default value
False
Description

Specifies whether Ellucian is available as an import source in the Import Wizard. If enabled, you can create imports that read data directly from a specified Ellucian Banner system, using an Ellucian Ethos key. By default, this is disabled. The intent is that the setting is enabled as needed when a higher education client wants to import data from Ellucian.

This setting is not returned when querying Axiom.SystemConfiguration. If you want to view and edit the setting, you can use the Axiom Software Manager.

EmailDistributionAllowedDomainList

Default value
<Blank>
Description

Defines a list of allowed email domains for Axiom Software. If a list is defined, then emails can only be sent from Axiom Software if the recipients are in the allowed domains. If any recipients are not in the allowed domains, then the email is flagged as blocked and is not sent by the System.SMTPMessageDelivery Scheduler job. By default, the list is blank, which means all email domains are allowed. For more information, see Defining allowed email domains for Axiom Software.

EnableFreeThreadingInUserFunctions

Default value
True
Description

Specifies locking behavior for Axiom functions. This should only be disabled on the advice of Axiom Support.

EnableLegacyAQMode

Default value
False
Description

Specifies whether to use the legacy method for creating database queries for Axiom queries (True/False). This is for backward-compatibility only and should never be manually enabled.

If enabled, then the database queries for Axiom queries are created using the rules in place prior to version 5.1. When you upgrade from a pre-5.1 system to the current version, your system will be automatically set to this mode if the upgrade script detects that your system has the potential for a certain type of query ambiguity (where a specified lookup column potentially exists on more than one lookup table). In order to disable legacy mode, you must modify any affected files to use fully qualified syntax to specify the intended lookup table. Please contact Axiom Support for more information.

EnableLegacyWorkflowEngine

Default value
False
Description

Specifies whether the legacy Workflow feature is visible in the system (True/False). By default, the Workflow feature is hidden and cannot be used. Plan file processes in Process Management should be used to manage plan files through a set of defined steps.

If enabled, then the Workflow feature is visible and can be used. This should only be enabled in older systems with existing workflows, where clients have not yet had the opportunity to convert to using plan file processes. When older systems are upgraded to version 2016.2 or later, this setting is automatically set to True if the system has existing workflows.

EnableODataAPI

Default value
False
Description

Specifies whether the OData API is enabled for use (True/False). If False, the OData API is not available and the associated URIs will return 404 errors. If True, the OData API is enabled and available for use as normal.

EnablePasswordPolicy

Default value
True
Description

Specifies whether password rules are enforced (True/False). By default, passwords must meet the rules defined in the PasswordRegularExpression setting. If disabled, then any password is valid.

NOTE: If enabled, password rules are only enforced when defining new passwords. If the system contains existing passwords that not meet the rules when this setting is enabled, these existing passwords will continue to be valid.

ETLMaxRows

Default value
500
Description

Defines the maximum number of temp table rows that will be displayed to the user when running an import using the Allow Pauses option. This setting should only be changed on the recommendation of Axiom Support. The value cannot be higher than 5,000.

ExcelAddinStartupTimeout

Default value
00:01:00 (meaning one minute)
Description

Defines the timeout value when starting up the Excel Client and the Windows Client. If the client does not start within this length of time, the startup routine is canceled and an error message displays to the user. This should only be changed on the advice of Axiom Support.

ExcelWorksheetPasswordProtectionEnabled

Default value
True
Description

Specifies whether or not worksheet protection is applied with a password (True/False). By default, when a sheet is designated as protected via the Control Sheet, the protection requires a password to remove it manually (Axiom-controlled features can be used to remove the protection without entering a password).

If disabled, then the sheet is still protected but the protection can be removed manually without a password. For more information, see Configuring worksheet protection for Axiom files.

ExtendedDBCommandTimeout

Default value
216000
Description

Defines the timeout value, in seconds, before terminating an attempt to execute a SQL command. This should only be changed on the advice of Axiom Support.

FileProcessingSaveDataDefaultBatchSize

Default value
7000
Description

Defines the number of records to process at a time when performing a save-to-database using file processing. This setting should only be changed on the advice of Axiom Support.

FileWatcherEnabled

Default value
False
Description

Specifies whether File Watcher features are available in the Scheduler dialog. This should only be set to True for backward-compatibility purposes, for clients who are actively using the feature and have not yet had a chance to implement a different solution. The feature is deprecated for new installations.

GetCachedDataEnabled

Default value
False
Description

Specifies whether a pre-release feature is enabled in the system for testing purposes. This setting should only be changed on the advice of Axiom Support.

ImportSaveBatchSize

Default value
25000000
Description

Defines the number of rows to save in each batch when importing data. This setting applies when inserting or updating rows in the destination table. This setting should only be changed on the advice of Axiom Support.

IncludeNonKeysColumnsOnTemporaryTable Index

Default value
True
Description

Specifies whether non-key columns are included in the non-clustered index on temporary tables. This setting should only be changed on the advice of Axiom Support.

IntacctPageSize

Default value
500
Description

Defines the number of records to be processed per batch when importing data from Intacct. The value can be set from 100 to 1000. This setting should only be changed on the advice of Axiom Support.

InvalidPasswordErrorMessage

Default value
<Blank>
Description

Defines the message to display when creating a new password if that password does not meet the rules. This should be left blank to use the default message which details the default password rules. If the rules have been customized with the assistance of Axiom Support, then you can define a custom message that details these rules.

IsPackageIntegrationServer

Default value
False
Description

This setting relates to an internal Axiom Software tool and is not for client use.

LDAPAllowedSuffixes

Default value
<Blank>
Description

Defines the allowed suffixes for LDAP Authentication, used if LDAP Authentication is enabled. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

LDAPAuthEnabled

Default value
False
Description

Specifies whether LDAP Authentication is enabled for the system (True/False). If enabled, then the LDAPConnectionString must be specified. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

LDAPConnectionString

Default value
<Blank>
Description

Defines the connection string to the LDAP server, used if LDAP Authentication is enabled. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

LegacyWorkflowAdminMode

Default value
False
Description

Specifies whether admin are treated using pre-7.2 behavior for purposes of determining workflow stage owners when the assignment is through a role. This is for backward-compatibility only and should not be manually enabled.

By default, administrators are treated the same way as other users for this purpose. If enabled, then administrators will automatically be stage owners if they are members of the assigned role, regardless of whether they have a permission set with Interacts with Process Management enabled.

MapF9ToAxiom

Default value
True
Description

Specifies whether F9 performs an Axiom refresh in addition to calculating the workbook. By default, F9 will refresh all sheets in the workbook, and Shift+F9 will refresh the current sheet.

If disabled, then the native F9 behavior of the Microsoft Excel version or the Windows Client applies.

MaxAQRows

Default value
10000
Description

Defines the maximum number of rows to return for an Axiom query. This setting is intended to prevent users from accidentally bringing in an extremely large number of rows, potentially resulting in excessive processing times or system errors. If the number of rows in the query exceeds the MaxAQRows setting, the user is warned of this and asked if they want to continue.

NOTES:  

  • The only user options are to cancel the query or continue with the full number of rows. This setting defines the threshold for the warning, it does not limit the query to the specified number of rows.
  • The warning only applies when users manually refresh Axiom queries. If the query is processed by Scheduler, then processing will fail if the query exceeds the threshold.

This setting can be overridden on a per query basis, on the Control Sheet.

MaxChooseValueRows

Default value
1000
Description

Defines the maximum number of rows that can be displayed in the Choose Value dialog. This dialog is used by several features to present a list of values for user selection, such as the GetDataElement function and refresh variables. The limit only applies when the dialog is showing the "full grid view"—meaning, the dialog shows more columns than just the key column and description.

MaxConsecutiveCutnPasteWithoutWaiting

Default value
50
Description

Defines how many consecutive cut and paste actions can occur before the system stops and pauses for a second. This setting has to do with system-controlled cut and paste actions such as when creating snapshot copies. Too many consecutive actions may cause certain environments to experience memory quota errors. This setting should only be changed on the advice of Axiom Support.

MaxExcelCellsToProcessInAQBatch

Default value
10000
Description

Defines the maximum number of cells to process at a time when refreshing a vertical Axiom query. This setting should only be changed on the advice of Axiom Support.

MaxExcelCellsToProcessInSingleArray

Default value
100000
Description

Defines the number of cells in a workbook that are processed at a time when saving to the database. This setting should only be changed on the advice of Axiom Support.

MaxFileAttachmentSizeKB

Default value
10000
Description

Defines the maximum size for a single file attachment. This limit is enforced when users upload attachments for plan files.

When uploading multiple attachments at a time in the Web Client, the total size of all attachments must be less than 50MB. This can be configured separately if needed by using the maxRequestLength property in the web.config file for the Axiom Application Server.

MaxHierarchyRowSize

Default value
50000
Description

Defines the maximum row size for a hierarchy. If a hierarchy is created for a table with greater than 50,000 rows, then the hierarchy name will display in the Filter Wizard and Quick Filter, but when expanded a message will display to the user explaining that the hierarchy has too many rows and therefore the individual elements cannot be displayed.

If needed you can change this setting to a larger row size, however, large numbers of rows in a hierarchy may cause out-of-memory errors on the client.

MaximumErrorsToReturnFromSaveOperations

Default value
10000
Description

Defines the maximum number of errors to return when a save-to-database operation occurs. This setting should only be changed on the advice of Axiom Support.

MaximumRowsAllowedThroughCopyTableData

Default value
250000
Description

Defines the maximum number of rows that can be copied when using the Copy Table Data feature. Copying tables with larger numbers of rows may cause performance issues. This setting should only be changed on the advice of Axiom Support.

MaxLoginAttempts

Default value
0 (meaning unlimited)
Description

Defines the maximum number of login attempts before a user is locked out. By default, users have unlimited login attempts. You can change this to a set number of login attempts to comply with your organization's security policies.

MaxRecursionCount

Default value
10
Description

Defines the maximum number of recursive calculations for GetData functions. This setting should only be changed on the advice of Axiom Support.

MaxSaveDataRowsInClientMemory

Default value
34000
Description

Defines the maximum number of save data rows that are stored in memory on the client. If the maximum is reached, the data rows are sent to the server and cleared from the client, and then the save process continues. The intent of this setting is to prevent out of memory errors on the client when saving very large sets of data. This setting should only be changed on the advice of Axiom Support.

MaxSaveDataToOutputSheetRowsInClient Memory

Default value
250000
Description

Defines the maximum number of save data rows that are stored in memory on the client, for purposes of placing them on an output sheet in the file. This setting only applies when using multipass file processing with the Save to Output Sheet option. If Axiom Software determines that the total number of rows for the process will exceed this limit, a message is presented to the user and the process is stopped. This setting should only be changed on the advice of Axiom Support.

MaxSystemCurrentPeriod

Default value
12
Description

Defines the maximum number that the system current period can be set to. Individual tables can be set to higher current periods if necessary. For example, most tables may use 12 periods, but you may have a table with payroll data that uses 26 periods.

MaxTableColumnNameLength

Default value
0 (meaning use system default)
Description

Defines the maximum length of table and column names. The system default is 50 characters. You can specify a different maximum size if needed. However, these names will be used in Axiom queries and Axiom functions to query data, so they should be descriptive and short.

MaxTableRowsToOpenInSpreadsheet

Default value
50000
Description

Defines the maximum number of records to be returned within Open Table in Spreadsheet. This can be set to a larger number if desired, however, returning larger amounts may result in significant performance issues.

NumberOfPrincipalFiltersToValidateForBulkSave

Default value
5
Description

Specifies the number of filters that are validated when saving user permissions in bulk via Open Security in Spreadsheet. This setting should only be changed on the advice of Axiom Support.

OpenIDAuthenticationEnabled

Default value
<Blank>
Description

Specifies whether OpenID Authentication is enabled for the system (True/False). This option is initially configured during the Axiom Application Server installation, and can be subsequently changed by repairing the installation.

PackageIntegrationServerURL

Default value
50000
Description

This setting relates to an internal Axiom Software tool and is not for client use.

PackageManagerAutoIntegrationNotificationsEmailList

Default value
<Blank>
Description

This setting relates to an internal Axiom Software tool and is not for client use.

PackageManagerDefaultValuesThreshold

Default value
0
Description

This setting relates to an internal Axiom Software tool and is not for client use.

ParallelSaveEnabled

Default value
TRUE
Description

Specifies whether parallel processing of save-to-database blocks is enabled (True/False). It is recommended to leave this enabled for improved performance. If you identify a particular file configuration that does not operate as expected with parallel saves enabled, you can disable the behavior on a per file basis by setting Enable Parallel Save Data to Off. For more information, see How Save Type 1 works.

PasswordRegularExpression

Default value
<Custom string used to define default rules>
Description

Defines the password rules to be enforced if EnablePasswordPolicy is set to True. The built-in rules are as follows:

  • Must be at least 8 characters long
  • Must contain at least 1 upper-case letter and at least 1 lower-case letter
  • Must contain at least 1 non-alphabetic character (a number or a symbol)

Axiom Software does not provide functionality for clients to change these rules. If you need to enforce password rules and use different rules, please contact Axiom Support for assistance.

PlatformUpdateURL

Default value
<URL to software support portal>
Description

Defines the URL to check for platform updates. This value should not be manually changed except as directed by Axiom Support.

ProductUpdateURL

Default value
<Blank>
Description

Defines the URL to check for product updates. This value should not be manually changed except as directed by Axiom Support.

ReleaseJobLocksOnMIAScheduler

Default value
False
Description

Specifies whether Axiom Software can break a Scheduler Server's lock on a job if that server reports as MIA (True/False). This should only be changed on the advice of Axiom Support.

RemoteDataConnectionBatchSize

Default value
10000
Description

Defines the number of rows to be sent in each batch between the Axiom Application Server and the Axiom Cloud Integration Service. This setting should only be changed on the advice of Axiom Support.

RestrictSaveAsLocalForManagedDocs

Default value
False
Description

Specifies whether Save As (Local) is available for managed documents (True/False). By default, Save As (Local) is available for eligible documents.

If you want to remove this option for Axiom managed documents, change this setting to True. When a managed document is active, the Save As (Local) option will no longer appear on the Save menu of the Axiom ribbon, or when right-clicking the file tab in the navigation pane.

Administrators can still save a file locally by using the Export option in Axiom Explorer.

SAMLAuthenticationEnabled

Default value
False
Description

Specifies whether SAML Authentication is enabled for the system (True/False). If enabled, then the SAMLUserNameHeader must be specified. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed by repairing the installation.

SAMLUsernameHeader

Default value
HTTP_EPPN
Description

Specifies the user name header for SAML when SAML Authentication is enabled. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

SAMLUsernameSuffixPreserved

Default value
False
Description

Specifies whether user names defined in Axiom include an @suffix for the SAML identity provider (True/False). By default, it is assumed that Axiom user names do not include a suffix. Set this to True if Axiom user names include a suffix. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

SaveRetryCountOnDeadlock

Default value
3
Description

Specifies how many times the system will attempt to save data to the database after encountering a deadlock error. This setting should only be changed on the advice of Axiom Support.

Scheduler_AutomationEngine

Default value
WebPreferred
Description

Specifies when the Web Engine should be used for Scheduler job processing:

  • WebAlways: The Web Engine is always used for Scheduler job processing.
  • WebPreferred: The Web Engine is the preferred spreadsheet processing engine, but Excel can optionally be chosen for specific tasks. The Web Engine will be selected for all spreadsheet tasks by default (except for those tasks which require Excel).
  • WebOptional: Excel is the preferred spreadsheet engine, but the Web Engine can optionally be chosen for specific tasks. Excel will be selected for all spreadsheet tasks by default.

NOTE: Using Excel on the Scheduler server is no longer officially supported. This configuration setting refers to an obsolete feature.

Scheduler_ContainerIdleLinger

Default value
120
Description

How long (in seconds) a Scheduler container waits in an idle state for more jobs before it shuts down. This value only applies to cloud service systems and is configured by Axiom Support.

Scheduler_ContainerLoggingLevel

Default value
Warning
Description

The logging level for Scheduler containers. This value only applies to cloud service systems and is configured by Axiom Support.

Scheduler_ContainerPollRate

Default value
60
Description

The rate (in seconds) at which Scheduler polls the job queue. This value only applies to cloud service systems and is configured by Axiom Support.

Scheduler_ContainerProcessorWorkerThreads

Default value
2
Description

The number of worker threads per Scheduler container. This value only applies to cloud service systems and is configured by Axiom Support.

Scheduler_FromEmailAddress

Default value
noreply@axiomepm.com
Description

Defines the "From" email address to use for any email notifications that do not have a separate specified "From" email address (for example, process management email notifications).

This email address must be specified in order to enable these email notifications. If no email address is specified, the SMTP Email Delivery task will experience an error when attempting to deliver the notifications.

NOTE: For installations that are using subsystems, the system variable {Scheduler.FromEmailAddress} may resolve to a subsystem administrator email address instead of the Scheduler "from" email address. For more information, see Using job variables.

Scheduler_MaxContainerInstances

Default value
0
Description

The number of Scheduler containers that can run concurrently. This value only applies to cloud service systems and is configured by Axiom Support.

Scheduler_ServiceClusterName

Default value
<Blank>
Description

The name of the service cluster for Scheduler processing. This value only applies to cloud service systems and is configured by Axiom Support.

SchedulingBehaviorTimezone

Default value
<Blank>
Description

The time zone used when determining the next execution of a scheduled job. By default, if this setting is left blank, the local time zone of the Scheduler server is used. This setting is primarily for use in Axiom cloud service systems and will be configured by Axiom Support. Click to view the list of valid time zone names.

Dateline Standard Time: (UTC-12:00) International Date Line West

UTC-11: (UTC-11:00) Coordinated Universal Time-11

Hawaiian Standard Time: (UTC-10:00) Hawaii

Alaskan Standard Time: (UTC-09:00) Alaska

Pacific Standard Time (Mexico): (UTC-08:00) Baja California

Pacific Standard Time: (UTC-08:00) Pacific Time (US & Canada)

US Mountain Standard Time: (UTC-07:00) Arizona

Mountain Standard Time (Mexico): (UTC-07:00) Chihuahua, La Paz, Mazatlan

Mountain Standard Time: (UTC-07:00) Mountain Time (US & Canada)

Central America Standard Time: (UTC-06:00) Central America

Canada Central Standard Time: (UTC-06:00) Saskatchewan

Central Standard Time: (UTC-06:00) Central Time (US & Canada)

Central Standard Time (Mexico): (UTC-06:00) Guadalajara, Mexico City, Monterrey

SA Pacific Standard Time: (UTC-05:00) Bogota, Lima, Quito

Venezuela Standard Time: (UTC-04:30) Caracas

Eastern Standard Time: (UTC-05:00) Eastern Time (US & Canada)

US Eastern Standard Time: (UTC-05:00) Indiana (East)

Paraguay Standard Time: (UTC-04:00) Asuncion

Central Brazilian Standard Time: (UTC-04:00) Cuiaba

SA Western Standard Time: (UTC-04:00) Georgetown, La Paz, Manaus, San Juan

Pacific SA Standard Time: (UTC-04:00) Santiago

Atlantic Standard Time: (UTC-04:00) Atlantic Time (Canada)

E. South America Standard Time: (UTC-03:00) Brasilia

Argentina Standard Time: (UTC-03:00) Buenos Aires

SA Eastern Standard Time: (UTC-03:00) Cayenne, Fortaleza

Montevideo Standard Time: (UTC-03:00) Montevideo

Bahia Standard Time: (UTC-03:00) Salvador

Newfoundland Standard Time: (UTC-03:30) Newfoundland

Greenland Standard Time: (UTC-03:00) Greenland

UTC-02: (UTC-02:00) Coordinated Universal Time-02

Mid-Atlantic Standard Time: (UTC-02:00) Mid-Atlantic - Old

Cape Verde Standard Time: (UTC-01:00) Cape Verde Is.

Azores Standard Time: (UTC-01:00) Azores

UTC: (UTC)

Greenwich Standard Time: (UTC) Monrovia, Reykjavik

Morocco Standard Time: (UTC) Casablanca

GMT Standard Time: (UTC) Dublin, Edinburgh, Lisbon, London

W. Central Africa Standard Time: (UTC+01:00) West Central Africa

Namibia Standard Time: (UTC+01:00) Windhoek

W. Europe Standard Time: (UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna

Central Europe Standard Time: (UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague

Romance Standard Time: (UTC+01:00) Brussels, Copenhagen, Madrid, Paris

Central European Standard Time: (UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb

Egypt Standard Time: (UTC+02:00) Cairo

South Africa Standard Time: (UTC+02:00) Harare, Pretoria

Libya Standard Time: (UTC+02:00) Tripoli

GTB Standard Time: (UTC+02:00) Athens, Bucharest

Middle East Standard Time: (UTC+02:00) Beirut

Syria Standard Time: (UTC+02:00) Damascus

E. Europe Standard Time: (UTC+02:00) E. Europe

FLE Standard Time: (UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius

Turkey Standard Time: (UTC+02:00) Istanbul

Jerusalem Standard Time: (UTC+02:00) Jerusalem

Jordan Standard Time: (UTC+03:00) Amman

Arabic Standard Time: (UTC+03:00) Baghdad

Kaliningrad Standard Time: (UTC+03:00) Kaliningrad, Minsk

Arab Standard Time: (UTC+03:00) Kuwait, Riyadh

E. Africa Standard Time: (UTC+03:00) Nairobi

Arabian Standard Time: (UTC+04:00) Abu Dhabi, Muscat

Russian Standard Time: (UTC+04:00) Moscow, St. Petersburg, Volgograd

Mauritius Standard Time: (UTC+04:00) Port Louis

Georgian Standard Time: (UTC+04:00) Tbilisi

Caucasus Standard Time: (UTC+04:00) Yerevan

Iran Standard Time: (UTC+03:30) Tehran

Afghanistan Standard Time: (UTC+04:30) Kabul

Azerbaijan Standard Time: (UTC+04:00) Baku

West Asia Standard Time: (UTC+05:00) Ashgabat, Tashkent

Pakistan Standard Time: (UTC+05:00) Islamabad, Karachi

India Standard Time: (UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi

Sri Lanka Standard Time: (UTC+05:30) Sri Jayawardenepura

Nepal Standard Time: (UTC+05:45) Kathmandu

Central Asia Standard Time: (UTC+06:00) Astana

Bangladesh Standard Time: (UTC+06:00) Dhaka

Ekaterinburg Standard Time: (UTC+06:00) Ekaterinburg

Myanmar Standard Time: (UTC+06:30) Yangon (Rangoon)

SE Asia Standard Time: (UTC+07:00) Bangkok, Hanoi, Jakarta

N. Central Asia Standard Time: (UTC+07:00) Novosibirsk

China Standard Time: (UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi

North Asia Standard Time: (UTC+08:00) Krasnoyarsk

Malay Peninsula Standard Time: (UTC+08:00) Kuala Lumpur, Singapore

W. Australia Standard Time: (UTC+08:00) Perth

Taipei Standard Time: (UTC+08:00) Taipei

Ulaanbaatar Standard Time: (UTC+08:00) Ulaanbaatar

North Asia East Standard Time: (UTC+09:00) Irkutsk

Tokyo Standard Time: (UTC+09:00) Osaka, Sapporo, Tokyo

Korea Standard Time: (UTC+09:00) Seoul

Cen. Australia Standard Time: (UTC+09:30) Adelaide

AUS Central Standard Time: (UTC+09:30) Darwin

E. Australia Standard Time: (UTC+10:00) Brisbane

AUS Eastern Standard Time: (UTC+10:00) Canberra, Melbourne, Sydney

West Pacific Standard Time: (UTC+10:00) Guam, Port Moresby

Tasmania Standard Time: (UTC+10:00) Hobart

Yakutsk Standard Time: (UTC+10:00) Yakutsk

Central Pacific Standard Time: (UTC+11:00) Solomon Is., New Caledonia

Vladivostok Standard Time: (UTC+11:00) Vladivostok

New Zealand Standard Time: (UTC+12:00) Auckland, Wellington

UTC+12: (UTC+12:00) Coordinated Universal Time+12

Fiji Standard Time: (UTC+12:00) Fiji

Magadan Standard Time: (UTC+12:00) Magadan

Kamchatka Standard Time: (UTC+12:00) Petropavlovsk-Kamchatsky - Old

Tonga Standard Time: (UTC+13:00) Nuku'alofa

Samoa Standard Time: (UTC+13:00) Samoa

For on-premise installations, you may want to set the SchedulingBehaviorTimezone if your Scheduler Server and your client workstations are not on the same time zone. For example, if client workstations are on Pacific Standard Time but the Scheduler Server is on UTC, then job execution times will be scheduled using UTC. In this case you can set the SchedulingBehaviorTimezone to Pacific Standard Time, so that job execution times are set using the same time zone as client workstations.

ShowRememberMe

Default value
True
Description

Specifies whether the Remember Me option is present on login screens (True/False). By default, this option is available. If disabled, then Remember Me will be hidden on login screens, meaning that users must enter their credentials each time they launch Axiom Software.

If you disable this option after users have already used Remember Me, their current settings will not be cleared. Each user's credentials will continue to be remembered until they clear the credentials by logging out. Credentials are stored separately for the Web Client versus the Desktop Client, so if a user has saved credentials for both environments then they must log out of both. For the Desktop Client, the only way to log out is to use the Word or PowerPoint add-in, because the Excel and Windows Clients do not have a log out feature.

This setting can be modified using the System Configuration page in the Web Client.

ShowWarningIfMissingAQTags

Default value
True
Description

Specifies whether missing [aq#] tags for active Axiom queries trigger a warning on refresh (True/False).

The False setting is intended for backward-compatibility only. If warnings are being triggered in many existing files, you can disable this setting until you are able to correct the Axiom query configuration within the affected files. If the [aq#] tag was deliberately hidden using a formula as a means of dynamically disabling a query, the file should be updated to instead use the Active setting for the query. Please contact Axiom Support for assistance as needed.

ShowWarningOnGetDataProcessingFailure

Default value
True
Description

Specifies whether the circular reference warning displays when Axiom Software detects a failure in processing GetData functions. If disabled, then no warning message displays. This setting should only be changed on the advice of Axiom Support.

SignalRClientInvalidationLagTime

Default value
1000
Description

Specifies the time zone used when determining the next execution of a scheduled job. By default, if this setting is left blank, the local time zone is used. This setting is primarily for use in Axiom cloud service systems and will be configured by Axiom Support.

SubsystemsEnabled

Default value
False
Description

Specifies whether the security subsystem feature is enabled (True/False). By default, security subsystem features do not appear in the user interface, and subsystems cannot be created.

If enabled, then the security subsystem features become available in the user interface.

NOTE: If you set this option to True, create subsystems and make user assignments, and then set it back to False, the existing subsystem restrictions will still apply to assigned users. This option simply hides the feature in the user interface; it does not stop any existing subsystems from being enforced. If you do not want to use subsystems anymore, you should remove all user assignments and delete the subsystems before disabling the feature.

SuppressLegacyCardinalityHint

Default value
False
Description

Specifies whether the SQL legacy cardinality estimator is disabled. By default, this SQL feature is applied automatically to queries where it is detected that using the behavior would improve performance. This setting should only be changed on the advice of Axiom Support.

SuspendDrawingWhileScreenUpdatingOff

Default value
False
Description

This configuration setting is used to assist in troubleshooting screen drawing issues. This setting should only be changed on the advice of Axiom Support.

SystemCurrencySymbol

Default value
<Blank>
Description

Defines the currency symbol used by columns that are configured as Currency numeric type. If left blank, the currency symbol for the current locale is used.

The Numeric Type is defined in the column properties. Currently, this symbol is only used by file group display columns. For more information, see Using numeric type for column formatting.

SystemCurrentPeriod

Default value
1
Description

Defines the current period for the system. To change the current period, you can use the user interface in the software (Administration > Tables > Table Administration > System Current Period / Year).

SystemCurrentYear

Default value
1
Description

Defines the current year for the system. To change the current year, you can use the user interface in the software (Administration > Tables > Table Administration > System Current Period / Year).

SystemName

Default value
Axiom
Description

Defines the name of the system. You can change this name as desired.

This setting can be modified using the System Configuration page in the Web Client.

TableRepartitioningRowLimit

Default value
2000000
Description

Specifies the row limit for repartitioning a table as part of saving the table properties. If the table data exceeds this row limit, then the table will not be repartitioned and instead you will be prompted to process the table repartitioning using Scheduler.

TiePlanFileSaveToWorkflowTaskSubmit

Default value
True
Description

Specifies whether users can complete tasks for plan file processes when saving plan files (True/False). By default, when a user saves a file for which they have an active process task, the user is given the option to complete the task as part of the save. The "complete on save" option only applies when the user opens the file as read/write.

If disabled, then no process prompt displays on save. This setting also applies to the legacy workflow feature.

TranslateFrenchKeyboardDecimalSeparator

Default value
False
Description

Specifies whether special decimal translation behavior applies to the Web Client and Windows Client (True/False). If enabled, then pressing the decimal key on a numeric keypad is interpreted as a comma when the following are true: the current locale's number format is comma, and the number format for the cell is one of Number, General, Percent, Scientific, or Currency. Note that the number format only applies to the Web Client; in the Windows Client, the behavior applies regardless of the number format.

UpdateStatisticsDuringSave

Default value
False
Description

Specifies whether statistics are rebuilt as part of save-to-database processes (True/False). This applies to both the temporary table (if saving more than 10,000 rows) and the destination table. This should only be enabled on the advice of Axiom Support.

UseLegacyColumnAggregation

Default value
False
Description

Specifies whether to use the legacy default aggregation behavior for Integer and Numeric columns in data queries. This should only be enabled on the advice of Axiom Support.

UseLegacySQLParser

Default value
False
Description

Specifies whether to use the legacy SQL parser (True/False). This should only be enabled on the advice of Axiom Support.

UseRestrictedWebModeForNonAdmins

Default value
True
Description

Specifies whether to use a special restricted mode in the Windows Client for non-admin users (True/False). If enabled, then certain file features are explicitly tied to read-write rights. For more information please contact Axiom Support.

This setting exists for backward-compatibility only and should not be manually enabled in systems where it is not already enabled.

UseStickSessionServerHash

Default value
False
Description

Specifies how sticky sessions are handled for Cloud Service systems. This setting should only be changed on the advice of Axiom Support.

VBA_RunMacroDisabled

Default value
True
Description

Specifies whether VBA custom solutions can be run while in the Axiom Excel Client (True/False). By default, the system does not check for VBA custom solutions, and AxiomVBA.xlam is not loaded when the system is run.

If set to False, then the system uses the designated event handlers to check for VBA custom solutions, and runs them if found. This setting should only be changed to False if your system is specifically designed to use VBA custom solutions. Enabling custom solutions may unnecessarily impact system performance for systems that do not use VBA.

WebClientSkin

Default value
<Blank>
Description

Specifies the default skin to be applied to Axiom forms. If the Skin property for a form is blank, the default skin defined here is used.

By default, this setting is blank, which means the default Axiom skin is used. If desired, you can specify any skin that is available to be selected for an Axiom form, including any custom skin defined for your organization. For the list of available skin names, check the Skin property on an Axiom form.

If you have defined a specific skin name and then want to return to using the default Axiom skin, clear this setting so that it is blank again.

WebPageTabItemBackground

Default value
#FFFFFF
Description

Specifies the background color of web tabs and form dialogs while the "loading" spinner displays. You can specify a different color using a hexadecimal code.

WindowsAuthAllowedDomains

Default value
<Blank>
Description

Specifies the allowed domains for Windows Authentication, if enabled. Separate multiple domain names with a comma. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

This setting can be modified using the System Configuration page in the Web Client.

WindowsAuthEnabled

Default value
True
Description

Specifies whether Windows Authentication is enabled for the system (True/False). By default this is enabled, which means that the allowed domains must be specified using WindowsAuthAllowedDomains. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

If disabled, then Windows Authentication is not used.

WindowsAuthUserSyncEnabled

Default value
False
Description

Specifies whether Active Directory Synchronization is enabled for the system (True/False), allowing users to be imported from and synchronized with Active Directory. This option is only applicable if Windows User Authentication is enabled for the system. This option is initially configured during the Axiom Application Server installation, and can be subsequently changed using the system configuration settings or by repairing the installation.

WorkflowChunkingSize

Default value
5000
Description

Defines the number of workflow tasks and instances to be returned from the server to the client at a time. This data is chunked to avoid using up too much memory per request. This setting should only be changed on the advice of Axiom Support.