--- title: "Quickstart guide" description: "" url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/quickstart-guide/index.html" ---## Overview This document helps you get started with Active Console. It provides more details about the basic features and tools that you can use when configuring Active Console. Also, it gives you a list of recommended activities when you start configuring your workspace and shows a list of advanced features for experienced users. ## Intended audience This guide is intended for users who already have an Active Console setup in their local machines, and want to get familiar with using the application. Before you proceed, we recommend that you read the [System Requirements](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/system-requirements/index.html) and [Download and Setup](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/download-and-setup/index.html) topics. ## Open Active Console Run the `ActiveConsole.exe` executable that is located in the directory you installed the files in or unzipped them to. When you open it the first time, the Active Console displays the **Select Workspace** screen: ![Default workspace selection](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-workspace-selection-screen.png) To know more about workspace, see [Workspace Selection](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/configuration/workspace-selection/index.html). Creating a new workspace displays the default dockables: ![Active Console default user interface](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-basic-user-interface.png) ### Menu bar The **Menu** bar contains the **File**, **View**, **Tools**, and **Help** buttons. #### File menu bar The main application level **File** menu bar has the following functions:
File menu Description
Configure Gateway

Displays the list of all other Gateways that you are connected to.

Selecting one of the Gateways from the list opens the Gateway Setup Editor.
Connect to all Gateways

Enables all Gateways.

Disconnect from all Gateways Disables all Gateways.
Workspace

Lists the names of workspaces you have previously used.

A sub-menu that contains the following options:

  • New — Gives you an option to save or not the current workspace configuration and loads a new default workspace.
  • Open — Opens the workspace you selected from your directory.
  • Open from URL — Opens the workspace using a URL.
  • Save — Saves the current workspace back to the source file.
  • Save As — Saves the current workspace as a new file.
  • Save Copy As — Saves the workspace to the defined file. This does not make this file the current workspace. This is useful when you want to save a workspace for a third party without using it as your own workspace.
  • Revert — Reloads the current workspace from its file without saving first. This resets your workspace to the time of the last saved.
Import Imports a component from the source file.
Exit Gives you the option to save your workspace, and then closes the Active Console.
#### View menu bar The main application level **View** menu bar have the following functions:
Name and Icon View menu Description
Layout Layout

Lists the names of workspaces you have previously used.

A sub-menu that contains the following options:

  • Default — loads the default window layout.
  • From workspace — opens an existing workspace layout from your directory.
  • Workspace History — displays the recently accessed workspaces. If the file name is already greyed out, then it is not accessible.
Show/Attach all windows

Displays all active windows, and all detached windows return in the workspace.

  • Click CTRL + W to show all windows.
  • Click CTRL + A to attach all windows.
State Tree State Tree Displays the State Tree component if it is hidden or closed.
Gateways Gateways Displays the Gateways component if it is hidden or closed.
Event Tickers Event Tickers Displays the Event Tickers component if it is hidden or closed.

Output

 Output Displays the Output Dockable component if it is hidden or closed.
Metrics Metrics Displays the Metrics component if it is hidden or closed.
Search Results Search Results Displays the Search Results component if it is hidden or closed.
Commands Commands Displays the Command component if it is hidden or closed.
Paths Paths Displays the Paths dockable if it is hidden or closed.
Managed Entities Managed Entities Displays the Managed Entities component if it is hidden or closed.
Active Dashboard Active Dashboard Displays the Active Dashboards component if it is hidden or closed.
Status Overview Displays the Critical and Warning (Under Selection), Netprobe Issues, and Sampling Errors.
Dockable Manager Dockable Manager Allows access to the Dockable Manager screen.
#### Tools menu bar The main application level **Tools** menu bar has the following functions:
Name and Icon Tools menu Description
Settings Settings Describes the configuration settings of the current workspace.
Create Metric Overview Metrics Overview Allows you to quickly create a metrics overview.
Search Search Defines a search over the data items.
Reporting Reporting Opens the Reports component.
Notifier Manager Notifier Launches the Notifier screen.
Time Definitions Time Definitions Opens the Time Definition Manager screen.
Workspace level Listview Settings Workspace level Listview Settings Allows you to define the settings used by all the list views in the workspace.
Gateway Setup Editor Gateway Setup Editor Launches the Gateway Setup Editor (GSE).
Table Column Settings Editor Table Column Settings Editor Displays the workspace level column settings models.
Path Editor Path Editor Allows access to the path editor. It has the DataItem Path Editor or the Geneos URL Editor as option.
Refactor Paths Refactor Paths Opens the Refactor Tool screen.
Custom Modifiers Manager Custom Modifiers Allows you to supplement the hard-coded modifiers that exist in the workspace with your own custom modifiers.
Show all windows Show all windows Displays all active windows or screen connected to Active Console.
#### Help menu bar The main application level **Help** menu bar has the following functions:
Help menu Description
Get started with Active Console Launches the onboarding screen for Active Console.
Geneos Online Documentation Directs you to the Resources online documentation site to access the Geneos' User Guide, Technical Reference, and How to guides.
View Diagnostics Page Displays the Orb Diagnostic Mode in a new browser.
Create Diagnostics File Creates a diagnostic file that can be used by ITRS Support in case of any technical problems.
About

Launches the Geneos Active Console screen with version information.

### Toolbar The **Toolbar** displays the commonly used functions in Active Console: | Name and Icon | Description | |-------|-------| | Save ![Save](https://docscdn.itrsgroup.com/geneos/images/Icons/save16x16.png) | Saves the current workspace. | | Workspace History ![Workspace history](https://docscdn.itrsgroup.com/geneos/images/Icons/workspace16x16.png) | Displays recently accessed workspaces. If the file name is already greyed out, then it is not accessible. | | State Tree ![State tree](https://docscdn.itrsgroup.com/geneos/images/Icons/toggleStateTreeMode16x16.png) | Displays Gateways and their directory components in a hierarchical structure. You can choose between a physical view (Gateway/Netprobe) or a logical view (ordered by Managed entity metadata) to display the lists. | | Configure Gateway ![Configure Gateway](https://docscdn.itrsgroup.com/geneos/images/Icons/gatewaySetupEditor16x16x.png) | Opens the Configure Gateway screen that lists all active and connected Gateways to your Active Console. From this list, you can configure the selected Gateway through Gateway Setup Editor. | | Metrics Overview ![Metrics overview](https://docscdn.itrsgroup.com/geneos/images/Icons/metricOverviewWizard22x22.png) | Allows you to easily create a metrics view by selecting the sampler available in your Gateway. | | Workspace Settings ![Workspace settings](https://docscdn.itrsgroup.com/geneos/images/Icons/settings22x22.png) | Opens the Active Console settings. | | Reporting Tool ![Reporting tool](https://docscdn.itrsgroup.com/geneos/images/Icons/reporting32x32.png) | Launches the Reports screen. | | Notifier Manager ![Notifier Manager](https://docscdn.itrsgroup.com/geneos/images/Icons/notify22x22.png) | Displays the Notifier Manager screen. | | Search for data items ![Search for data items](https://docscdn.itrsgroup.com/geneos/images/Icons/search16x16.png) | Defines a search over the data items. | | SSO Login/Logout ![SSO login](https://docscdn.itrsgroup.com/geneos/images/Icons/ssoLogin.png) | Connects and disconnects to SSO. | | Find ![Find](https://docscdn.itrsgroup.com/geneos/images/Icons/find.png) | Search a term in the current workspace. | ## Configure your workspace Once you are familiar with the Active Console interface, here are a few things you can do: Beginning Geneos 5.8.x, the undo and redo key functions, `CTRL + Z` and `CTRL + Y`, are supported in Active Console and Gateway Setup Editor for the following: text fields, multiline texts, and editable drop-down fields. ### Customise your dockable layout Active Console user interface uses a docking component that allows you to customise its layout. This section walks you through the steps on how to move, combine, collapse, and unhide a dockable. For more information, see [Customise a Dockable](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/customise-dockable/index.html). ### Configure the I settings The [Workspace Settings](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/configuration/workspace-settings/index.html) allows you to configure the settings of the current workspace. This includes the following settings: - General - Connection - Database - Gateway Hub - ITRS Analytics - System Tray - Tooltips - Advanced ### Select your workspace When you start up the Active Console, it allows you to select the workspace that you want to use. The [Workspace Selection](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/configuration/workspace-selection/index.html)  presents some standard workspace options, and a list of the recent workspace files that you have used. You can also see the common errors that you may encounter. ### Display and execute commands To view the list of the recent and currently executing commands, see [Commands Dockable](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/commands-dockable/index.html). To display the results of commands that generate output, see [Output Dockable](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/output-dockable/index.html). ### Create your own dashboard You can create your own dashboard in Active Console. For more information, see [Introduction to Active Dashboard](/visualization/active-console/../active-dashboard/intro-to-active-dashboard/). ## Advanced features This section walks you through the advanced configurations and operations that the Active Console is capable of. You can follow the instructions that include detailed help for you to customise the settings, list views, dockables, and other configurations: ### Configure the list view This section can help you display all the critical managed entities connected to Gateway, all data items that are snoozed, and all data items that are assigned to a user. Also, to know more about the list view settings hierarchy and workspace level list view, see [List View](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/tools/list-view/index.html). ### Configure the table settings in the Metrics view To configure the table settings in the Metrics view, see [Table column settings editor in Metrics Dockable](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/metrics-dockable/index.html#table-column-settings-editor). ### Edit Geneos URL and data item paths The **Path Editor** allows you to modify the Geneos URL and data item paths. For more information, see [Path Editor](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/tools/path-editor/index.html). ### Evaluate the XPaths A path's score represents how expensive an XPath is, or how long it takes for the Active Console to evaluate the XPath. To know more about the element paths, see [Paths Dockable and Scoring](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/tools/paths-dockable-and-scoring/index.html). ### Import historical events from database The Active Console is capable of retrieving events and chart data from database. For more information, see [Import historical events from database in Event Tickers Dockable](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/event-tickers-dockable/index.html#import-historical-events-from-database). ### Manage your dockables list To display and manage the list of all dockables in your workspace, see [Dockable Manager](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/dockable-manager/index.html). ### Search data items To define a search over all the data items known the Active Console, see [Search Function and Search Dockable](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/search-function-and-search-dockable/index.html). ### Schedule queries to take snapshots The [Reporting Tool](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/tools/reporting-tool/index.html) provides information on how to schedule queries that can take snapshots of the system state. ## Further reading Here is the list of changes in the buttons, components, and functions beginning with Active Console 5.0:
Before version 5.0 Beginning with version 5.0
File > Workspace > Workspace History > Select Workspace Workspace History on the Toolbar > Select Workspace
Tools > Create Metric Overview Tools > Metrics Overview
Tools > Notifier Manager Tools > Notifier
Tools > Custom Modifier Manager Tools > Custom Modifiers
Select Workspace > Create a new workspace Select Workspace > Create New
Select Workspace > Browse for a workspace Select Workspace > Open From File
Select Workspace > Open workspace from url Select Workspace > Open From URL
View > Geneos Architecture Health View > Status Overview

Status Overview only displays if a new workspace is created. Otherwise, the Active Console displays the former Geneos Architecture Health and Items of interest dockable.

Status Overview also contains the tabs for:

  • Critical and Warning (Under Selection)
  • Netprobe Issues
  • Sampling Errors
View > Paths dockable Tools > Evaluate Paths
Tools > Re-factor paths > Refactor Tool Tools > Refactor Paths
Tools > Custom Modifier Manager Tools > Custom Modifiers
Active Dashboard > Active Chart Active Dashboard > Line Chart