Control user guide

Control user guide

What is Control

With Control you have real-time technical monitoring capabilities for your complete ConnectPlaza run-time environment. Pro-active support is possible by checking metrics and notifications of the Agent. You can set thresholds on queue sizes, number of messages per component, etc. When installed a default configuration based on your environment is created. You can modify these settings, like Alerting, Message Notification, Error Handling, Events, Latency, etc. in the Control environment in your ConnectPlaza platform.

To use ConnectPlaza Control a separate license is necessary.

First look at Control

When you logged into your ConnectPlaza environment and you have a valid ConnectPlaza Control license, you will get an extra tab on your dashboard to access Control. If you select this tab, you will get the following screen:

This screen is divided in different sections.

Section Description
1 Selection of the agents available
2

This is the default button bar, which you can find in almost all of our applications.

You can select an agent, go to the home page, select all logged in users, add the tooltips and ask for some help.

3

In this section of the screen you see the application widgets. You can add more using the widget. You can only select prefabricated widgets. Use the button to remove the widget from this area.

4

Legend

5

Tab area. Here you can select your application.

 

Connection to your ConnectAgent

Select your ConnectAgent by using the left list on your screen

Or select the ConnectAgent with the ConnectAgent Drop Down list at to top right of the screen:

Agent details

After selecting the ConnectAgent you get an overview of the options you can select for your selected ConnectAgent in your menu-options:

This menu overview is divided into 3 different sections:

Section Description
1 ConnectAgent actions. These actions are focused on the ConnectAgent itself
2 Interface options. These options are focused on the separate interfaces running on the agent.
3 Legend, Her you can see the explanation of the colour code used with the ConnectAgents and the Interfaces.

 

At the top of the detail screen you will find some information about memory usage of your ConnectAgent, which is a Java process.

You will find the following information:

Property Description
CPU Percentage how busy this process is on your machine
HEAP

There are 2 values here. The total heap size and the usage of the heap at this time (not real time!!)

For more information about what heap sizes are, consult your Java professional, or check the internet.

Overview

Using the overview for the ConnectAgent will give you a detailed explanation of the metrics, events, operations and other settings of the ConnectAgent and all of its Interfaces. The whole implementation running in your ConnectAgent will be shown in this overview.

Here the overview of the Agent Metrics and Settings. You can also see Consumer information in this list, like this:

The following information is displayed for every level:

Name Description
Name Name of the property
Description Description of the property

Global Enabled

Is the property Global enabled
Private enabled Is the property only available in the selected phase
Type

Type of the property. You can find the following types:

  • Metric
  • Event
  • Operation

Metric: this is a value that can be measured. The value is not fixed.
Event: This is a setting for a specific property. For instance the setting ERROR for a logging.
Operation: This is more or less a state of the selected property, is it started or not.

Current value The value of the selected property. Remember, these values are static, they are not real time. So if you refresh the screen, some of these values may change.

 

Reset events

This option removes all notifications received during your work with Control. This is part because of the fact that the properties and the notifications also are not measured in real time.

So if there has been a restart of the agent, and some of the problems are fixed, you can reset all statuses.

Manage / Status

When selecting this option, you get an overview of your ConnectAgents properties current settings.

At this screen you will find all the properties of your ConnectAgent and the value at the time you opened this page. These values are not real time, so if you want to update these values, you have to select the button at the top of the screen.

The screen in divided by property type. For the ConnectAgent, this will be Events and Metrics

You see the following information at this screen:

Property Description
Global Enabled Is the property Global enabled
Private enabled Is the property only available in the selected phase
Name Name of the property
Current value The value of the selected property. Remember, these values are static, they are nog real time. So if you refresh the screen, some of these values may change.

 

Interface details

At the Interfaces section of Control, you will find your own created interfaces, but also the ConnectPlaza Backend Interfaces delivered by ConnectPlaza.

If you open the details of an interface, you will be presented with the following menu options:

Next to the name of the Interface you see a menu option . If you press this icon, you will be presented with some options, concerning the interface:

Manage / Status

Gives you an overview of the status your interface is in. This will be show in a separate tab with the name of the Interface:

The screen is also divided by the Property Types. The description of the properties here is the same as the Manage / Status screen of the ConnectAgent.

Attention: Changes to the settings are only available until the next restart of the agent!

Turn off

If you select this option you turn of the selected Interface. The indications on the screen will be modified accordingly.

You see that the selected flow is Off Line, and the Interface has a warning indication. Also the Manage / Status indicator is now in a warning state. In the Mange / Status overview you see now the warning caused by the issue.

Attention: Changes to the settings are only available until the next restart of the agent!

Flows

Open this section of the menu and you will see all the flows in this Interface, in our example this would be:

You see a green indication icon in front of the name of the flow, which indicates the specific flow is online. Check the legend for the other colour codes.

Pressing the ... button will open an options menu:

Here you can open, turn off the flow or manage the flow.

Log

Selecting this option will get you a log file overview of the selected Interface.

This is a static view of the last part of the log from the Interface. You can refresh this view using the button.

If you need to adjust the depth of your logging, you can select the depth via the selection box.

This option is automatically set in your environment and. After refreshing your logging the new setting will be active. This action also applies to the logging via ConnectPlaza Deploy.

Attention: Changes to the settings are only available until the next restart of the agent!

Manage / Status

Here you get an overview of the Interfaces status. You can also manage several properties within this screen:

De screen for the interface is devided into the different types. The following information shown in the sections are:

Property Description
Global Enabled Is the property Global enabled
Private enabled Is the property only available in the selected phase
Name Name of the property
Current value

The value of the selected property. Remember, these values are static, they are not real time. So if you refresh the screen, some of these values may change.

 

Attention: Changes to the settings are only available until the next restart of the agent!

Working with more than one tab

Using more than one tab in Control is no problem, You can close the tab using the  on the tab. If you right click with your mouse on one of the tabs, a menu will open:

With these options you can select to close all tabs at once, close all other tabs or just close the current tab.