Quickstart Guide

Overview

This document helps you get started with Active Console 2. It provides more details about the basic features and tools that you can use when configuring Active Console 2. Also, it gives you a list of recommended activities when you start configuring your workspace and shows a list of advanced features for experience users.

Experienced users may wish to skip ahead to other specific guides available for Active Console 2 in the Active Console 2 Documentation Home.

Intended audience

This guide is intended for users who already have an Active Console 2 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 and Download and Setup topics.

Open Active Console 2

Run the ActiveConsole.exe executable that is located in the directory you installed the files in or unzipped them to.

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.
  • Workspace History — Displays the recently accessed workspaces. If the file name is already greyed out, then it is not accessible.
Import Imports a component from the source file.
Exit Gives you the option to save your workspace, and then closes the Active Console 2.
   

View menu bar

The main application level View menu bar have the following functions:

Icon View menu Description
Not applicable 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.
Not applicable Search Bar Displays the Find search item field if it is hidden or closed.
Welcome to Geneos Displays the getting started guide with Active Console 2.
State Tree Displays the State Tree component if it is hidden or closed.
Gateways Displays the Gateways component if it is hidden or closed.
EventTickers Displays the EventTickers component if it is hidden or closed.
Output Displays the Output component if it is hidden or closed.
Metrics Displays the Metrics component if it is hidden or closed.
Search Results Displays the Search Results component if it is hidden or closed.
Commands Displays the Command component if it is hidden or closed.
Paths Displays the Paths dockable if it is hidden or closed.
Active Dashboard Palette

Displays the Active Dashboard Palette component if it is hidden or closed.

Adds content, such as background, line, shapes, and widgets into Active Dashboard.

Geneos Architecture Health Displays the Geneos Architecture Health component if it is hidden or closed.
Items of interest Displays the Items of interest component if it is hidden or closed.
Managed Entities Displays the Managed Entities component if it is hidden or closed.
Active Dashboards Displays the Active Dashboards component if it is hidden or closed.
Dockable Manager Allows access to the Dockable Manager screen.
     

Tools menu bar

The main application level Tools menu bar has the following functions:

Icon Tools menu Description
Settings Describes the configuration settings of the current workspace.
Create Metric Overview Allows you to quickly create a metrics overview.
Not applicable Diagnostics Opens a diagnostic page in the web browser.
Search Defines a search over the data items.
Reporting Opens the Reports component.
Notifier Manager Launches the Notifier Manager screen.
Time Definitions Opens the time Definition Manager screen.
Workspace Level List View Settings Allows you to define the settings used by all the list views in the workspace.
Gateway Setup Editor Launches the Gateway Setup Editor (GSE).
Table Column Settings Editor Displays the workspace level column settings models.
Not applicable Path Editor Allows access to the path editor. It has the DataItem Path Editor or the Geneos URL Editor as option.
Re-factor paths Opens the Refactor Tool screen.
Not applicable Custom Modifier Manager Allows you to supplement the hard-coded modifiers that exist in the workspace with your own custom modifiers.
Not applicable Show all windows Displays all active windows or screen connected to Active Console 2.
Not applicable Attach all windows All detached windows or screen returns to Active Console 2.
     

Help menu bar

The main application level Help menu bar has the following functions:

Help menu Description
Geneos Online Documentation Directs you to the Resources online documentation site to access the Geneos' User Guide, Technical Reference, and How to guides.
About

Launches the Geneos Active Console screen with version information.

You can also create a diagnostic file to send to ITRS Support in case of any technical problems.

   

Toolbar

The Toolbar displays the commonly used functions in Active Console 2:

Icon Name Description
Save Saves the current workspace.
Workspace History Displays recently accessed workspaces. If the file name is already greyed out, then it is not accessible.
State Tree mode

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

Opens the Configure Gateway screen that lists all active and connected Gateways to your Active Console 2.

From this list, you can configure the selected Gateway through Gateway Setup Editor.

Metrics Overview Allows you to easily create a metrics view by selecting the sampler available in your Gateway.
Workspace Settings Opens the Active Console settings.
Reporting Tool Launches the Reports screen.
Notifier Manager Displays the Notifier Manager screen.
Search for data items Defines a search over the data items.
Not applicable SSO Login Connects and disconnects to SSO.
Not applicable Find (search term) Search a term in the current workspace.
     

Configure your workspace

Once you are familiar with the Active Console 2 interface, here are a few things you can do:

Customise your dockable layout

Active Console 2 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.

Configure the Active Console 2 settings

The Workspace Settings allows you to configure the settings of the current workspace. This includes the following settings:

  • General
  • Connection
  • Database
  • Gateway Hub
  • System Tray
  • Tooltips
  • Advanced

Select your workspace

When you start up the Active Console 2, it allows you to select the workspace that you want to use. The Workspace Selection  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.

To display the results of commands that generate output, see Output Dockable.

Create your own dashboard

You can create your own dashboard in Active Console 2. For more information, see Introduction to Active Dashboard.

Advanced features

This section walks you through the advanced configurations and operations that the Active Console 2 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.

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.

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.

Evaluate the XPaths

A path's score represents how expensive an XPath is, or how long it takes for the Active Console 2 to evaluate the XPath. To know more about the element paths, see Paths Dockable and Scoring.

Import historical events from database

The Active Console 2 is capable of retrieving events and chart data from database. For more information, see Import historical events from database in Event Tickers Dockable.

Manage your dockables list

To display and manage the list of all dockables in your workspace, see Dockable Manager.

Search data items

To define a search over all the data items known the Active Console 2, see Search Function and Search Dockable.

Schedule queries to take snapshots

The Reporting Tool provides information on how to schedule queries that can take snapshots of the system state.