--- title: "Startup settings" description: "" url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/configuration/startup-settings/index.html" --- ## Overview There are a number of startup flags and settings that you can define which modify the behaviour and configuration of the Active Console while it is running. These settings are configured by modifying the `ActiveConsole.gci` file that resides in the same directory as the `ActiveConsole.exe`. This file is a text file which can be edited in any text editor. In addition, there is a default directory information in the Active Console for `config.xml` and logs folder that can be used to troubleshoot common errors, such as when the Gateway keeps disconnecting, or when the Active Console keeps crashing. The hidden directory where you can open these files vary depending on the operating system platform: - Windows — `\User\[username]\AppData\Roaming\ActiveConsole` - Linux (Ubuntu) — `\home\[username]\.activeconsole\ or in ~\.activeconsole` - macOS — `~\Library\Application Support\ActiveConsole` ## Settings This is similar to the GCI file that is shipped within the Active Console: ``` ############################################################ #### The java class that has 'main' ############################################################ -mainclass com.itrsgroup.activeconsole.ActiveConsole ############################################################ #### The JVM to use and arguments ############################################################ -jvm .\JRE\bin\client\jvm.dll -jvmargs Xmx128M Ddocking.floatingContainerType=frame ############################################################ #### For the Gateway Setup Editor (GW2) ############################################################ -schema .\schema\gateway.xsd -gsedir .\gse -alwayssavable `############################################################ #### For the Active Console (AC) ############################################################ -EMF2ListenPort **** Allows you to change the listening port through the .gci file` ############################################################ #### Misc ############################################################ -logexceptions ``` The file is new line delimited and each flag starts with a hyphen. Any arguments for a given flag are separated by a new line. Any lines that begin with a `#` or are empty, are ignored. ``` #comment1 -…#comment2 -… ``` ### Active Console without JRE If you are running the Active Console package without JRE, you must point the Active Console to the Java installed on your machine. - Ensure that your machine is using Java 17 or higher for the Active Console to successfully start up. Refer to the [Java support compatibility matrix](https://docs.itrsgroup.com/docs/all/geneos/7x-geneos-compat-matrix/index.html#java-support) for more information. - If you are using a Mac with Apple silicon, ensure that you use x64 Java. The Active Console currently supports only x64 Java. **Important** On Windows, starting from Geneos 7.7.0, Active Console and Gateway Setup Editor validate the Java runtime library before loading it at startup. This does not apply to Linux or macOS. The Java installation must meet the following requirements: - Do not use path traversal to point to a Java installation. For example, do not use paths like `C:\myfolder\..\otherFolder\jvm.dll`. - The path must not contain a folder named `Downloads`, `Temp`, or `Tmp` at any level. For example, `C:\Users\\Downloads\...` and `C:\ITRS\temp\...` are not allowed. This can be done through any of the following methods: - Add the `jvm` argument in the `ActiveConsole.gci` file based on your operating system: | Operating system | Java file path | |------------------|----------------| | Windows | `\bin\server\jvm.dll` | | Linux | `/lib/server/libjvm.so` | | macOS | `/lib/libjli.dylib` | - Set the `JAVA_HOME` environment variable that points to the Java installation directory. - Define the Java in the `Path` environment variable by adding the Java installation folder with the `bin` subfolder. The Active Console will look for the Java installed on your machine following the above order: 1. In the `jvm` argument in the `ActiveConsole.gci` file. 2. If `-jvm` is not defined in the `ActiveConsole.gci` file, it will look for the `JAVA_HOME` environment variable. 3. If no `JAVA_HOME` is defined, it will look for the Java defined in the `Path` environment variable. **Success** The Active Console will successfully run once it detects a compatible Java version on your machine. You can check the Java version used by the Active Console by clicking the **Help** tab and selecting **About**. ![Java version in AC](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-java-version-7-3-0.png) **Error** The Active Console will not run if no Java is detected on the machine. The Active Console will display an error dialog box (shown below) stating that no Java is installed in the system. ![Java error in AC](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-no-java-installed-error-7-3-0.png) ## Debug mode When you run the Active Console in debug mode, you can monitor the memory status and use other debug options for diagnostic purposes: - Database queries. - Evaluate XPaths. - List of all running commands. - List of all event commands. - List metadata. - Active Path model that includes options such as Dump, Summary, Refresh, Running, and Set EmfModel filters. To put the Active Console in the debug mode: 1. Close all running Active Console applications. 2. Locate the `ActiveConsole.gci` in your installation directory. 3. Edit the file in a text editor to add the `-debug` flag at the bottom of the file. 4. Save the file and open the Active Console. When debug mode is enabled, the **Debug** option appears on the menu bar. In addition, you might get the `You are running low on Java memory. Percentage used xx.xxx` message when in debug mode. This means that the `x%` of the virtual memory has been used in the Java Virtual Machine (JVM), and that the JVM has not run the garbage collect yet. **Note** This message only appears when the Active Console is in debug mode. ## Log masking Active Console logging uses Log4j2 and [log masking](https://docs.itrsgroup.com/docs/geneos/7.11.0/administration/log-masking/index.html) can be enabled. The provided `ActiveConsole.gci` file defines optional JVM system properties under `-jvmargs`. To enable masking: 1. Open `ActiveConsole.gci`. 2. Uncomment the line that sets `-Dgeneos.logMasking.rules` (this points to `resources/geneos-log-masking/log-masking-rules.yaml` by default), or update the value to point to your own rules file. Log4j2 is already configured to use `LogMaskingPatternLayout` when the property is set (see `log4j2-log-masking.template.xml`). The same configuration applies to Gateway Setup Editor settings embedded in the same `ActiveConsole.gci`, which runs in the same process and uses the same JVM arguments. ## Total cell count across connected Gateways Active Console periodically records the total cell count across all connected Gateways its application log as a metric. The metric represents the total number of table cells and headline cells that Active Console receives from all connected Gateways. It provides a lightweight indicator of the volume of data being processed by Active Console. Use this metric to: - Monitor changes in the volume of data delivered from connected Gateways. - Correlate increases in data volume with changes in Active Console performance or responsiveness. - Compare historical values when investigating performance-related issues. The metric is written to the log every 10 minutes. The log message uses this format: ```log YYYY-MM-DD HH:MM:SS.sss DataViewCellCounter [INFO] Total Cell Count Across All Connected Gateways= (table_cells= + headlines=) ``` For example: ```log 2026-05-21 17:32:40.640 DataViewCellCounter [INFO] Total Cell Count Across All Connected Gateways=21794 (table_cells=20724 + headlines=1070) ``` The reported value is informational only and does not affect the operation of Active Console. **Note** The same total cell count across all connected Gateways metric is recorded in the [Web Server logs](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/web-dashboard/index.html#total-cell-count-across-connected-gateways). ## ActiveConsole.exe flags All of the arguments are passed to the Active Console Java application. However, there are some special arguments that are used by the `ActiveConsole.exe` application. | Flag | Arguments | Description | Example | | --- | --- | --- | --- | | ssoIdleAutoLogoutTime | Number of seconds | Specifies the idle timeout in seconds before an SSO user is automatically logged out. The Active Console monitors user activity, such as mouse clicks, movements, and keyboard presses, and logs out the user if no activity is detected for the specified duration. Minimizing the Active Console and Gateway Setup Editor windows also counts as inactivity. Timeouts events are recorded as `INFO` logs in the log file. The maximum value is `86400` seconds (24 hours). When set to `0`, idle detection is disabled. Default: Disabled **Important** In Active Console 7.9.0, this setting defaults to `1800` seconds (30 minutes) if it isn’t defined in the `gci` file. Starting with Active Console 7.9.1, the setting is disabled unless explicitly defined in the `gci` file. | -ssoIdleAutoLogoutTime 1800 | | ssoIdleShowWarningTime | Number of seconds | Specifies when to display a warning dialog before the SSO user is logged out due to inactivity. The warning dialog shows the remaining time before logout and allows the user to stay logged in or log out immediately. Log out events are recorded as `INFO` logs in the log file. The maximum value is `3600` seconds (one hour). When set to `0`, the warning dialog is disabled. This value must be less than or equal to `ssoIdleAutoLogoutTime`. - When set equal to `ssoIdleAutoLogoutTime`, the warning dialog is displayed immediately. - When set greater than `ssoIdleAutoLogoutTime`, the warning dialog will not be displayed. Default: Disabled **Important** In Active Console 7.9.0, this setting defaults to `60` seconds if it isn’t defined in the `gci` file. Starting with Active Console 7.9.1, the setting is disabled unless explicitly defined in the `gci` file. | -ssoIdleShowWarningTime 60 | | autoClearSSOCredentials | `true` or `false` | Controls whether the SSO username and password fields are cleared after use. When set to `true`, the fields are always cleared. When set to `false`, the last entered credentials are cached. **Important** In Active Console 7.9.0, this setting defaults to `true` if it isn’t defined in the `gci` file. Ensure your credentials are stored securely. Starting with Active Console 7.9.1, the last entered credentials are cached if this setting is not defined in the `gci` file. | -autoClearSSOCredentials true | | activeSessionTimeout | Number of seconds | Specifies the maximum duration, in seconds, of an Active Console or standalone Gateway Setup Editor session, regardless of user activity. The timer starts when the application starts. When the timeout expires: - All connected Gateways are disconnected. - If an SSO user is logged in, the SSO user is logged out. - A dialog informs you that the session has timed out. - If the workspace isn't read-only, a **Save Workspace** dialog opens without a **Cancel** button. If the workspace is read-only, no save dialog appears. To start a new session and reconnect to Gateways, restart the application. If you save the workspace after a session timeout and then restart by using the same workspace, Gateways that were connected before the timeout reconnect. The maximum value is `86400` seconds (24 hours). Values greater than `86400` are capped at `86400`. When set to `0` or a negative value, the session timeout is disabled. Default: Disabled | -activeSessionTimeout 43200 | | mainclass | Java class | Tells the launcher which class to look for a 'main' function. | -mainclass com.itrsgroup.activeconsole.ActiveConsole | | jvm | Path to the jvm library | Specifies the jvm to use. If this flag is not specified, launcher will attempt to discover this from the system. **Important** On Windows, starting from Geneos 7.7.0, Active Console and Gateway Setup Editor validate the Java runtime library before loading it at startup. This does not apply to Linux or macOS. The Java installation must meet the following requirements: - Do not use path traversal to point to a Java installation. For example, do not use paths like `C:\myfolder\..\otherFolder\jvm.dll`. - The path must not contain a folder named `Downloads`, `Temp`, or `Tmp` at any level. For example, `C:\Users\\Downloads\...` and `C:\ITRS\temp\...` are not allowed. | -jvm C:\Program Files\Java\jre1.4.2\bin\client\jvm.dll | | jvmargs | See java documentation | Arguments that are passed to the jvm. For more information, run `java.exe -?` from the command line. The arguments should not include a hyphen. The default values can be modified in the listed examples. | -jvmargs Xms64m Xmx128m Dmy.sys.prop=foo Dfile.encoding=UTF-8 Djdk.tls.maxCertificateChainLength=15 | | classpath | Any number of classpath entries | These arguments will be combined with the `CLASSPATH` environment variable, and any file with a `.jar` extension in the 'jars' directory, and passed to the jvm using the `-Djava.class.path` system property. | -classpath C:\MyProject.jar C:\JDBCMyJDBC.jar | | libpath | Any number of directory entries | These arguments will be combined with the 'lib' directory and passed to the jvm using `-Djava.library.path`. **Important** Starting from Geneos 7.7.0, the arguments under the `-libpath` parameter is validated: - The arguments must point to a folder. - Do not use path traversal. For example, do not use paths like `..\..\mylib`. | -libpath C:\MyLibs Z:\ThirdPartyLibs | | path | Any number of path entries | **Note** Starting from Geneos 7.7.0, the `-path` parameter in the ActiveConsole.gci will no longer work. These arguments will be combined with the 'lib' directory and the `PATH` environment variable and used to set the `PATH` environment variable for the ActiveConsole process. | -path C:\MyPath C:\Another\Path\On\Disk | | jarscan | Any number of directories | Every directory specified will be scanned for files with a `.jar` extension. Any files found will be added to the `classpath`. | -jarscan C:\MyJavaClasses Z:\ThirdPartyLibsJava | | putenv | Any number of name value pairs | This will set environment variables for the ActiveConsole process. | -putenv DEBUG_MSG_FILTER=record PATH=C:\ | | nolog | None | Prevents the ActiveConsole from writing to a log. | -nolog | | gsedir | A directory | Specifies the resource directory of the Gateway 2 Setup Editor where images, sounds and property files are stored. | -gsedir .\gse | | gse-wsp | Full path to the working directory of the GSE | Specifies the location of the working directory of the Gateway Setup Editor. This is where log files, cached schema, and auto-save files are stored. If this flag is not set, the GSE working directory defaults to `%APPDATA%/GatewaySetupEditor`. | -gse-wsp C:\gseWorkingDir | | logexceptions | None | If present any uncaught exceptions thrown by Java will be logged to a file `exception.log`. | -logexceptions | | licwarning | Number of days | Specifies the number of days for a warning about a Gateway licence expiry. Defaults to 30. | -licwarning 50 | | nonotifier | None | Turns off notifications. This flag is only provided for AC users in a Citrix environment. | -nonotifier | | dialogStartLocation | A fully qualified directory | This determines the location that the first save or open dialog you use in a session will appear. After the first, it always remembers the last directory you are in. | -dialogStartLocation C:/exampledir | | repeatlicwarning | None | If specified, the ActiveConsole repeats licence expiry and grace period warnings every 24 hours. | -repeatlicwarning | | wsp | Full path to the working directory of the console | This tells the Active Console where to locate the AC User Directory in order to write its configuration and temp files. Beginning Geneos 5.5.x, the `-wsp` flag supports environment variables in specifying paths in the `ActiveConsole.gci` file. For example: ``` -wsp %HOMEDRIVE%\ActiveConsole\version\Test ``` Ensure that all environment variables listed on `-wsp` are set. Otherwise, if there is at least one environment variable that is not properly set or empty, the Active Console automatically uses the default user directory. On Linux, when you double-click `ActiveConsole.exe`, Active Console can only recognize global variables. However, Active Console can also recognize user-specific environment variables if you open the application using the terminal. On macOS, Active Console only supports the system variables set by macOS. | -wsp C:\ac2userDir | | ws | A full path to the selected AWS file | This specifies the workspace to load without using the workspace selector. The Active Console ignores the workspaces included in the `configuration.xml` file located in the AC User Directory. Beginning Geneos 5.5.x, the `-ws` flag supports environment variables in specifying paths in the `ActiveConsole.gci` file. | -ws C:\aaa.awx | | wsurl | A URL to a selected AWS file | This specifies the workspace to load from a URL without using the workspace selector. The Active Console ignores the workspaces included in the `.xml` file located in the AC User Directory. **Note** If both this flag and the `ws` flag are used, then the `ws` flag takes precedence. | -wsurl | | newWorkspaceLocation | Path to a directory | New workspaces created through the Active Console are created in this directory. | -newWorkspaceLocation c:/test | | showgw1editoroutput | None | If specified, the Active Console shows the output of the legacy Gateway editor in the output window. | -showgw1editoroutput | | maxlogsize | Size in megabytes | The maximum size of the log file before rolling the file. The default is 10MB. | -maxlogsize 100 | | autoAcceptLicense | Name of licence (ADB for dashboard licence) | Auto accepts the licence without offering the user a trial period. | -autoAcceptLicense ADB | | fastDVActivation | None | Makes the loading of dashboard significantly faster, but will only work for dashboards created after the `GA2009.1 081222` build of the AC. | -fastDVActivation | | doNotValidatePathsOnStartUp | None | Stops the Active Console from validating the user defined XPaths on startup, by default it will. Turning this on will increase the speed of startup. | -doNotValidatePathsOnStartUp | | showlocalcommands | None | Shows the command and its arguments passed to the shell for any local commands. | -showlocalcommands | | rolllogwithdatetime | None | When if this flag is set when `maxlogsize` is reached, the current log will be copied to `.`. Otherwise it will be copied to `.old`. | -rolllogwithdatetime | | maximumDatabaseConnections | Number of database connections | The Active Console database connection pool uses this flag to change maximum number of simultaneous database connections. If nothing is supplied, then default value is 5. | -maximumDatabaseConnections 10 | | patheditorconfig | Path to the Path Editor Configuration | | -patheditorconfig ./resources/configuration | | userResourcesDirectory | Path to the user resources directory | | -userResourcesDirectory ./UserResources | | ApmEmfModelFilter | | | -ApmEmfModelFilter DataItemUpdateFilter(Property=SampleTime) | | fastShutdown | | | -fastShutdown | | bdosync | A list of subscription modes for a bdo | This setting enables the subscription mode for syncing the bdos (example, based on severity). | -bdosync DataView,BDOSyncType_Level,DV1_SyncLevel_RedAmberCells | | splash | | | -splash gse-splashscreen.png | | connections | Different settings | Settings for the connections. | -connections show enabled | | locking | | | -locking enabled | | includes | | | -includes enabled | | appname | The application name | The application name. | -appname GatewaySetupEditor | | appdisplayname | The application display name | The application display name. | -appdisplayname Gateway Setup Editor | | quickcreate | | | -quickcreate probes.probe managedEntities.managedEntity samplers.sampler | | schemaroot | | | -schemaroot gateway | | helpjars | List of jars used for loading GSE help | List of jars used for loading GSE help. | -helpjars gse.help.jar gateway.help.jar plugins.help.jar | | autosave | The time interval | The time intervals when the Gateway Setup Editor is automatically saving the setup file. | -autosave | | disableautosave | None | Prevents GSE from automatically saving setup file at regular intervals. | -disableautosave | | disablehistory | None | Disables logging history of setup files. | -disablehistory | | loadIncludesWithMain | None | Loads all include files and the main Gateway setup file when loaded. | -loadIncludesWithMain enabled | | connect | Primary host Primary port Logon method Secondary host Secondary port Secure URL-encoded SSO Agent URL | This setting enables Gateway connection details to be passed to the Gateway Setup Editor. The arguments must be declared in the following format: ``` -connect "::::::" ``` For example: ``` -connect "192.168.1.110:10090:Ask once::0:SECURE:https:server.example.itrs:443" -connect "192.168.1.110:10070:Use system:192.168.1.210:10080:INSECURE" ``` This setting is only in effect if the GSE is run standalone. If the GSE is launched from the Active Console as a separate process, the Active Console provides this argument to the GSE process. On Windows, the GSE uses a single `GatewaySetupEditor.gci` regardless of whether the GSE is opened from the Active Console, or as a standalone application. On macOS, the GSE uses two separate `GatewaySetupEditor.gci` files: - If opened from the Active Console, the GSE uses the `GatewaySetupEditor.gci` from the Active Console directory. - If opened as a standalone application, the GSE uses the `GatewaySetupEditor.gci` from the Gateway Setup Editor directory. **Note** This information overrides the -`SSOAgentURL` flag in the `GatewaySetupEditor.gci` file (if present) when the GSE is launched as external process from the Active Console. | -connect | | answers | A list of x=y | | -answers | | advancedSearch | None | Makes GSE search dialog field available. | -advancedSearch | | nonamedlists | | | -nonamedlists | | debug | | | -debug | | noconfirm | None | Prevents GSE the Confirm Save dialog from displaying. | -noconfirm | | alwayssavable | | | -alwayssavable | | novalidateonsave | None | Prevents GSE from doing setup validation on save. | -novalidateonsave | | keepschemaxml | | | -keepschemaxml | | newdoc | | TBD. This setting is ignored if the Gateway Setup Editor is not run standalone. | -newdoc | | open | | TBD. This setting is ignored if the Gateway Setup Editor is not run standalone. | -open | | autoSort | ascending, descending, none | Sorts items with sections of the setup. Sorts in the order given by argument. None is the default. | -autoSort ascending descending none | | dashboardDisplayFont | A valid system font | This will be the font used to display charts and gauge headers and will also be the default selected font for newly created dashboard object with Text Layout Settings. | -dashboardDisplayFont Arial Unicode MS | | enableApproxDataviewSorting | None | A gci flag that is used to turn on optimized sorting for dataviews. | -enableApproxDataviewSorting true (Set the flag parameter to true) | | cshHost | Path to documentation | Path that the GSE uses for the context sensitive help. | -cshHost https://docs.itrsgroup.com/docs/geneos | | cyberarkAppID cyberarksdk | | Beginning Geneos 5.6.x, CyberArk Local Credential Provider support is available for Active Console on Windows to access historical data. For more information, see [Gateway setup is CyberArk Local Credential Provider](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/configuration/enable-cyberark-in-active-console/index.html#gateway-setup-is-cyberark-local-credential-provider). | | | enableCertificateValidation | | Enables certificate validation for HTTPS connections. The default value is false. If set to true, then the file URL will only be accepted when the following conditions are met: - The certificate is added to the `cacerts` file located in `JRE/lib/security folder`. - The certificate should be valid and not expired. | -enableCertificateValidation false | ### Automatic classpath and librarypath In addition to the values specified in the classpath and libpath arguments, these paths are added automatically: - Full path to the lib directory is added to the `java.library.path` system property. - Any file with `.jar` extension inside the jars directory is added to the `java.class.path` system property.