---
title: "Clearvision Status"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/collection/clearvision-status/index.html"
---
## Introduction

The ClearVision status plug-in reads the status webpage as produced by a GL ClearVision server, making the values produced available within the Geneos monitoring framework. Once available these values can then be used for rules and alerts as normal.

Each instance of the plug-in will produce two views for the configured server. Multiple servers can be monitored by running multiple plug-in instances - one plug-in per server required.

## Views

### Server View

The server view displays general server state information as reported by the ClearVision status page. An example view is shown below.

![clearvision2](https://docscdn.itrsgroup.com/geneos/images/netprobe/trading-images/image2_geneos_-_clearvision-status_plug-in.png)

**Server Table Legend**

### Exchange View

The exchange view displays statistics relating to the ClearVision exchange. An example view is shown below.

![clearvision3](https://docscdn.itrsgroup.com/geneos/images/netprobe/trading-images/image3_geneos_-_clearvision-status_plug-in.png)

**Exchange Table Legend**

<div class="table-container">
<table class="legacy-table"   style="margin-left: 0;margin-right: auto;width: 100%;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" cellspacing="0">
                        <col width="32%" class="TableStyle-ref_2_col_table-Column-Column1"/>
                        <col width="68%" class="TableStyle-ref_2_col_table-Column-Column1"/>
                        <thead>
                            <tr class="TableStyle-ref_2_col_table-Head-Header1">
                                <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Name</th>
                                <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                            </tr>
                        </thead>
                        <tbody valign="top">
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">averageClearingTime</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">The average time to clear a trade, in
 seconds.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">averageReadingTime</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Average time to read from the
 exchange.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">lastClearingTime</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Time of the last trade cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">lastReadingTime</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Last read time from the exchange.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">lastUnclearingTime</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Time of the last trade not cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">nextReadingTime</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Next read time from the exchange.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">ticketRead</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of tickets read.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">totalCleared</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Total number of trades cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">totalUncleared</td>
                                <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Total number of trades not cleared.</td>
                            </tr>
                        </tbody>
                    </table>
                
</div>

### Tickets View

The tickets view displays metrics on the tickets and orders being processed by the ClearVision server. An example view is shown below.

![clearvision4](https://docscdn.itrsgroup.com/geneos/images/netprobe/trading-images/image4_geneos_-_clearvision-status_plug-in.png)

**Tickets Table Legend**

<div class="table-container">
<table class="legacy-table"   style="margin-left: 0;margin-right: auto;width: 100%;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" cellspacing="0">
                        <col width="32%" class="TableStyle-ref_2_col_table-Column-Column1"/>
                        <col width="68%" class="TableStyle-ref_2_col_table-Column-Column1"/>
                        <thead>
                            <tr class="TableStyle-ref_2_col_table-Head-Header1">
                                <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Name</th>
                                <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                            </tr>
                        </thead>
                        <tbody valign="top">
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">clearinginprogress</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of tickets currently being
 cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">exchangeTickets</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of tickets read from the
 exchange.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">ordersCleared</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of orders cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">ordersToClear</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of orders to clear.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">ticketsCleared</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of tickets cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">ticketsUnknownExtCode</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of tickets with an unknown external
 code.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">totalOrders</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Total number of orders.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">totalOrdersCleared</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Total number of orders cleared.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">totalTicketsCleared</td>
                                <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Total number of tickets cleared.</td>
                            </tr>
                        </tbody>
                    </table>
                
</div>

<div class="table-container">
<table class="legacy-table"   style="margin-left: 0;margin-right: auto;width: 100%;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" cellspacing="0">
                    <col width="32%" class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <col width="68%" class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Name</th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody valign="top">
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">connectedMarketWatchs</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of connected Market Watch
 processes.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">DBMS</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">DBMS status.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">DBMSactiveConnections</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Number of active connections to the
 DBMS.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">exchange</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Exchange connection status.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">lastSQLError</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Last SQL error encountered, if any.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">lastUpdate</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Last update time.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">serverName</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Name of the GL Clearvision server being
 monitored.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">startButton</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Start button status.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">stations</td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Stations status (e.g. GL-Win).</td>
                        </tr>
                    </tbody>
                </table>
                
</div>

## Plug-in Configuration

The ClearVision status plug-in is only available when running a Windows Netprobe. The plug-in reads information from the status webpage generated by the ClearVision server, and so must be able to access this file to operate correctly.

The plug-in may optionally read the location of the status file from the Windows registry. In this case the Netprobe must run on the same host as the ClearVision server, and have read access to the registry to read these values.

Configuration for this plug-in is placed in the clearvision-status configuration section.

### serverName

Specifies the name of the server to monitor. The plug-in will then use this name to access the following registry key where (by default) the status file location is stored in the "path" value.

```
HKEY_CURRENT_USER\Software\ClearVision\Server\<name>\Options\Web page\Server status
```

Mandatory: No (however one of [serverName](#servername), [fileLocation](#filelocation) or
[registry](#registry) must be specified).

### fileLocation

Specifies the location of the ClearVision status file as a path - this can be a UNC path if required. When using this parameter the Netprobe does not have to be on the same host as the ClearVision server, provided the file is still accessible.

Mandatory: No (however one of [serverName](#servername), [fileLocation](#filelocation) or
[registry](#registry) must be specified).

### registry

Specifies a registry key containing the location of the ClearVision status file. When using this setting the Netprobe must be running on the host that holds the registry entry (typically the ClearVision server host).

Mandatory: No (however one of [serverName](#servername), [fileLocation](#filelocation) or
[registry](#registry) must be specified).

### registry > key

Specifies the location of the registry key to read a [value](#registry--value) from. This key must be a sub-path from HKEY\_CURRENT\_USER. E.g. specifying path "Software\Windows" will open the key "HKEY\_CURRENT\_USER\Software\Windows".

Mandatory: Yes

### registry > value

The value to read inside the specified [registry > key](#registry--key).

Mandatory: Yes

