HCK - Health Check Kit

Quick Start

VScode openedge HCK

Getting Started

Below you can find a quick start guide for the VS Code extension or the native HCK application.

Extension

Use this version if you want to work inside VS Code.

Install the Extension

1. Open the Extensions view in VS Code.
2. Search for OpenEdge HCK.
3. Select the extension.
4. Click Install.

Connect to a Database

1. Open the HCK extension view from the sidebar.

2. Open the connection settings (top right gear icon).

3. Click Add Connection.

4. Select a context you want to save your connection to (User settings, Folder settings or workspace settings).
5. Enter a connection string (Example -db mydb -S 10001).
6. Enter a name for the connection (if left blank the name of the database will be used).
7. If required enter your user credentials (user and password).
8. Choose how you want to save your user password (Save as secret is recommended).

9. Click Test Connection.

10. Click Add.
11. The new connection should appear in the connection list.
12. Click Done.

Start Using HCK

1. Open the HCK view.

2. Choose your connection.

3. Select a database.

4. Select a monitoring screen.
5. Review activity, database status, replication, or statistics information.
6. Use refresh or switch screens to inspect the data you need.

Native

Use this version if you want to run HCK as a standalone desktop application.

Install the Application

1. Download the native HCK application from https://releases.rm-worx.be/install.
2. Find the correct version for your operating system (Windows or Linux).

   Windows

   

   Linux

   [picture]

3. Install the package for your operating system:

   Windows (.msix)

   • Double click the HCK .msix file.
   • The Windows installer will open. Click Install.

• Wait until the installation is completed.

  Linux (.deb)

  • Double click the HCK .deb file.
  • A package installer will open. Click Install (for example, App Center on Ubuntu).

    

  • If your system asks for confirmation or administrator permissions, approve the installation.
  • Wait until the installation is completed.
  • The application should now be available in your applications menu.

4. Open the application.
5. On first startup you will be prompted to set the DLC path for your OpenEdge installation.

   

6. Enter the path into the text field, you will be notified if the path is valid or not.

   

7. Click Save.

Connect to a Database

Connecting to a database is the same in the extension and native versions

1. Open the connection settings (top right gear icon).
2. Click Add Connection.
3. Select a context you want to save your connection to (User settings, Folder settings or workspace settings).
4. Enter a connection string (Example -db mydb -S 10001).
5. Enter a name for the connection (if left blank the name of the database will be used).
6. If required enter your user credentials (user and password).
7. Choose how you want to save your user password (Save as secret is recommended).
8. Click Test Connection.
9. Click Add.
10. Click Done.
11. The new connection should appear in the connection list.

Start Using HCK

1. Launch the application.
2. Select your connection from the dropdown.
3. Select a database.
4. Open a monitoring screen from the navigation sidebar.
5. Review the information shown for the selected database.

Example Connection Information

A full connection string might look like this:

Name: Sports Database
Connect: -db sports2020 -H 127.0.0.1 -S 10001

Troubleshooting

• The extension or app opens, but no data is shown

  Check that you selected the correct connection and that the database is available.

• I cannot connect to the database

  Verify the connection details and confirm that your database server is running.

• I can't add a new connection after pressing Add

  Make sure you have tested the connection with Test Connection first.

User Guide

OpenEdge HCK — User Guide This guide explains how to use OpenEdge HCK in the VS Code extension and the native application. It will help you connect to a database, work with the monitoring screens, and understand the main features through simple examples and common user workflows.

Interface Overview This section explains the main areas of the HCK interface and how they work together during normal use.

This is useful if you want a clearer understanding of what each part of the screen is used for before you start monitoring a database.

Read the full Interface Overview documentation

Connection Management In this section we will cover how to connect to a database and manage connections.

Connection Management explains how to create, test, save, and reuse database connections in both the extension and the native application. It also covers the different save locations, password options, project profiles, and the basic steps to switch between connections when you work with more than one database.

Read the full Connection Management documentation

Working with Records This section explains how to work with the data shown in HCK tables.

Working with Records covers how to review monitoring and statistics data, sort and filter table contents, configure visible columns, work with incremental refresh on supported screens, and use the limited row-based navigation actions that HCK provides.

Read the full Working With Records documentation

Interface Overview

Interface Overview

Overview

This guide explains the main parts of the OpenEdge HCK interface in both the VS Code extension and the native application.

The overall layout is designed to help you move from selecting a connection context and database to opening the monitoring screen you need in a simple and predictable flow.

Header Area

The header is the main control area at the top of HCK.

From here, you can:

• choose the context you want to work in
• choose a project profile when you are working in a project context
• choose a folder when you are working in a folder context
• choose the active database
• refresh the current view
• use incremental refresh on supported screens
• open the connection settings

In the native application, the header can also open the app settings for native runtime setup, including the OpenEdge DLC path.

In practice, the header is where you decide which connection source and which database you want to use before you start monitoring.

Navigation Sidebar

The navigation sidebar is shown on the left side of the screen.

This area lets you:

• move between the main monitoring sections
• open the screen you want to inspect
• see which screen is currently selected

The sidebar contains grouped links for the main monitoring areas:

Statistics

• Table/Index
• User I/O
• User Table/Index

Activity

• Buffer
• Locks
• Page Writers
• Server
• Summary

Status & DB

• Areas
• Buffer Status
• Checkpoints
• Connections
• Files
• Locks
• Transactions Replication
• Agents
• Servers

When HCK is loading a screen, navigation is temporarily disabled to prevent conflicting actions.

Dashboard Area

The dashboard area is shown on the right side of the screen.

This is where HCK displays the information for the selected monitoring screen.

In this area, you can:

• review the selected monitoring data
• switch between different dashboard screens by using the sidebar
• refresh the current screen when you want newer information
• use incremental refresh on supported statistics screens

Many screens show database information at the top of the page, followed by one or more data tables.

For example:

• User I/O can open a user-specific table/index statistics screen
• Connections can open related user table/index details for a selected connection context

This is the main working area when you want to inspect activity, status, replication, or statistics for the selected database.

Screen Groups

The screens in HCK are grouped by monitoring purpose.

Statistics

This section is used to inspect usage counts and workload patterns.

It includes:

• Table/Index
• User I/O
• User Table/Index

These are the main screens that support incremental refresh.

Activity

This section is used to inspect live operational behavior.

It includes:

• Buffer
• Locks
• Page Writers
• Server
• Summary

Status & DB

This section is used to inspect the current database state.

It includes:

• Areas
• Buffer Status
• Checkpoints
• Connections
• Files
• Locks
• Transactions

Replication

This section is used to inspect replication monitoring information.

It includes:

• Agents
• Servers

Demo video

Tips

• If you do not see the expected database, check the selected context first.
• If you work with project profiles, make sure the correct profile is active.
• If the interface does not show recent changes yet, refresh or reopen HCK.

Connection Management

Connection Management

This section explains how to create, test, save, and manage database connections in OpenEdge HCK. It covers the connection settings used in both the VS Code extension and the native application, so you can quickly connect to the right database and switch between saved connections when needed.

Good connection management makes it easier to work with different environments such as development, test, and production, while keeping your connection details organized and easy to reuse. In the sections below, you will learn how to add a new connection, choose where it should be saved, work with user names and passwords, test whether a connection is valid, and manage existing connections after they have been created.

Whether you use HCK inside VS Code or as a native desktop application, the overall connection flow is designed to stay familiar and straightforward.

Choosing Where to Save a Connection

When you create a connection, you can choose where it should be stored.

User settings

• Best when the connection is only meant for your own use.

Workspace settings

• Useful when the connection should be available in the current workspace.

Folder settings

• Useful when one specific folder needs its own connection settings.

Choose the save location carefully, because it determines where the connection will be available later.

In the native application, connections are managed as native user connections, so workspace and folder save scopes are not shown there.

Password and Security Notes

If your connection requires a password, HCK allows you to choose how it should be stored.

Save as secret

• Recommended for normal use.
• Helps keep the password stored more securely.

Save as plain text

• Use this only if it fits your environment and security requirements.
• This is intended for cases where you explicitly want to share plaintext credentials during connection export or reuse.

If you are not sure which option to use, leave it as a secret.

Switching Between Contexts and Databases

HCK lets you switch between different connection sources and then choose the database you want to work with.

Switching context changes where HCK reads available connections from, such as User settings, Workspace settings, Folder settings, or a Project.

Switching database changes the active database within the currently selected context.

When you switch to a project context, you may also need to select a project profile. If you switch to a folder context, you may need to choose the correct folder first. These selections affect which connections and databases are shown in the database list.

To switch databases, use the database selector in the header and choose the connection or database you want to open. If the database you expect is missing, first check whether the selected context, folder, or project profile is correct.

If you recently changed your saved connections, refreshing or reopening HCK may be needed before the updated list is shown.

Adding Database Connections

In this step by step guide you can follow along to learn how to add a new database connection. A full demonstration video can be added later.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the HCK window.

Step 2: Click "Add Connection"

• A window will open displaying a list of all the current connections. Click the Add Connection button at the bottom to open the connection creation form.

Step 3: Fill in Connection Details

• Select a context you want to save your connection to (User settings, Folder settings or Workspace settings) when you are using HCK inside VS Code.
• In the native application, connections are saved as user connections.
• Enter a connection string.
• Enter a name for the connection. If left blank, HCK will use the database name.
• If required, enter your user credentials.
• Choose how you want to save your password.

Step 4: Test the Connection

• Before you add a connection, test it to make sure it is valid.
• Click the Test Connection button to verify that the connection details are correct and the database is accessible.

Step 5: Save the Connection

• Click the Add button to save the connection.
• Click Done to close the connection manager.
• The new connection should now appear in the connection list.

Full Demo Video

Editing Database Connections

Editing an existing database connection is just as simple as adding one. You can edit a connection by clicking on the edit button next to the connection name in the connections list.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the HCK window.

Step 2: Click "Edit Connection"

• A window will open displaying a list of all the current connections. Click the Edit Connection pencil icon to the right of the connection name to open the connection editing form.
• Here you can edit the connection details and test the connection again.

Step 3: Update the Connection

• Update the connection details as needed.
• Click the Update button to save the changes.
• Click Done to close the connection manager.
• The updated connection should now appear in the connection list.

Full Demo Video

Duplicating Database Connections

An existing database connection can be easily duplicated, saving you time and effort. You can duplicate a connection by clicking on the duplicate icon between the pencil icon and the trashcan icon.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the HCK window.
• A window will open displaying a list of all the current connections.

Step 2: Click "Duplicate Connection"

• Click the Duplicate Connection icon to the right of the connection name to open the connection duplication form.
• HCK copies the existing values into a new connection form and appends Copy to the duplicated name when a name already exists.
• Here you can edit the copied connection details and test the connection.

Step 3: Update the Connection

• Update the copied connection details as needed.
• Click the Add button to save the duplicated connection.
• Click Done to close the connection manager.
• The duplicated connection should now appear in the connection list.

Full Demo Video

Removing Database Connections

You can remove a connection by clicking on the trashcan icon to the right of the connection name.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the HCK window.
• A window will open displaying a list of all the current connections.

Step 2: Click "Delete Connection"

• Click the Remove Connection trashcan icon to the right of the connection name.
• Click Done to close the connection manager.
• The connection is now removed.

Full Demo Video

Importing and Exporting Connections

HCK also supports importing and exporting saved connections.

Importing Connections

• Open the connection manager.
• Choose the import action.
• Select the exported connections file.
• If HCK detects duplicate connections, it will ask you how to handle them before the import is completed.

Exporting Connections

• Open the connection manager.
• Choose the export action.
• Review the export warning carefully before continuing.
• Save the exported file.

When exporting, HCK can warn you before secured passwords are included in the export.

Using Project Profiles

If your project uses openedge-project.json, you can define profiles with different database connection sets. This is useful when one project needs separate connections for different situations, such as development, testing, or customer-specific environments.

Working with Profiles

To use profiles, your project configuration should contain:

• a top-level dbConnections section for the default project connections
• a profiles array
• a name for each profile
• a dbConnections section inside a profile when that profile should define its own connections

If you do not see a newly added profile immediately, refreshing or reopening HCK may be required.

Example Structure

{
  "dbConnections": [
    {
      "name": "HCK DEV",
      "connect": "-db sports_dev -H server1 -S 10001"
    }
  ],
  "profiles": [
    {
      "name": "Development",
      "dbConnections": [
        {
          "name": "HCK DEV",
          "connect": "-db sports_dev -H server1 -S 10001"
        }
      ]
    },
    {
      "name": "Test",
      "dbConnections": [
        {
          "name": "HCK TEST",
          "connect": "-db sports_test -H server2 -S 10002"
        }
      ]
    }
  ]
}

How HCK Uses This

• When you select a profile, HCK applies that profile's dbConnections list.
• If a selected profile has no valid dbConnections, HCK may not show any project connections for that profile.
• If no profile is selected, HCK can continue using the top-level project connections.

If you do not see the connections you expect, check whether the currently selected project profile is the correct one and whether the profile contains valid dbConnections.

Additional Information

Choosing the Right Save Location

The save location determines where the connection will be available later.

• User settings are best when the connection is only meant for your own use.
• Workspace settings are useful when the connection should be available in the current workspace.
• Folder settings are useful when a specific project folder needs its own connection configuration.
• In the native application, connections are stored as native user connections.

Choosing the correct save location helps avoid confusion when a connection does not appear where you expect it.

Notes

• Testing the connection is required before saving it.
• If you leave the connection name empty, HCK will use the database name instead.
• If you change connection details, it is a good idea to test the connection again before saving the update.

Troubleshooting Tips

• The connection test fails
  • Verify the connection string and credentials.
  • Confirm that the database is accessible.
• The connection does not appear where expected
  • Check to which context the connection was saved.
  • Check whether the selected context, folder, or project profile is correct.
• A profile does not show any connections
  • Confirm that the selected profile contains valid dbConnections.

Working With Records

Working with Records

Overview

This guide explains how to work with data rows in OpenEdge HCK after you have selected a database and opened one of the available monitoring or statistics screens.

Where Interface Overview explains what each part of the screen is for, this guide focuses on what you can do with the table data shown in the selected screen.

Read the full Interface Overview documentation

The available actions are intended to stay consistent between the VS Code extension and the native application unless noted otherwise.

Before You Start

Before you begin, make sure:

• HCK is open
• the correct context is selected
• the correct database is selected
• the screen you want to work with is open

Unlike DataDigger, HCK does not provide general record maintenance for table rows. The data shown in these screens is intended for monitoring, inspection, filtering, sorting, and navigation.

The Records Area

After you open a monitoring or statistics screen, the main table area becomes the place where you work with the returned rows.

Here you can:

• review the returned rows for the selected screen
• sort data by column
• filter data by column on screens that support column filtering
• move through large result sets with paging controls
• show and hide columns
• use screen-specific navigation actions where available
• compare values during incremental refresh on supported screens

Loading and Refreshing Data

HCK loads data for the currently selected screen and database from its backend endpoints.

Depending on the screen, HCK can:

• load the current data set for the selected database
• reload the data after you switch screens or databases
• show an incremental refresh state on supported screens
• show a message when no changes were detected during an incremental refresh

This is useful when you want to monitor how activity or statistics change over time rather than maintain application records.

Viewing Table Data

HCK presents returned data in configurable tables. These tables are designed for inspection and comparison.

From the table, you can:

• review the current rows returned by the active screen
• sort rows by clicking a column header
• move between pages using the paging controls
• change the number of rows shown per page
• review incremental values on supported screens

For example:

• User I/O Data includes a row action that can open the related User Table/Index Statistics view for that user
• User Table Statistics can be linked to the Index Statistics table so that selecting a table filters the related index rows

Filtering and Sorting Data

HCK supports column sorting across its configurable tables, and some screens also support column filters.

Depending on the screen, you can:

• click a column header to sort ascending or descending
• open a column filter for supported columns
• clear a column filter by removing its value
• review how many rows remain after filtering

At the moment, column filtering is not enabled on every HCK screen. For example, the User I/O Data table supports column filters, while other screens may provide sorting without per-column filters.

Configuring Visible Columns

HCK allows you to configure which columns are visible in each table.

When you open the column configuration:

• you can enable or disable individual columns for that screen
• you can save the updated column layout
• you can reset the column layout to the defaults for that screen

This is useful when a screen contains many fields and you only want to focus on the values that matter for your current investigation.

Working with Incremental Data

Some HCK screens support incremental refresh. In that mode, HCK compares the latest values with the previously loaded values and shows the differences for supported numeric fields.

This is especially useful for screens such as:

• User I/O Data
• User Table Statistics
• User Index Statistics

When incremental mode is active:

• HCK marks the screen as incremental
• changed numeric values are shown as deltas
• identity and metadata fields continue to show their normal values
• HCK can show a message when no data changes were detected since the last reload

This helps you focus on what changed between refreshes instead of re-reading the entire result set.

Screen-Specific Row Actions

Some HCK screens provide limited row-based actions that help you navigate related monitoring data.

Examples include:

• opening User Table/Index Statistics from a row in User I/O Data
• linking a selected table to the related index information in User Table/Index Statistics

These actions are navigation and analysis helpers. They are not record-editing actions.

Troubleshooting Tips

No rows are shown

• Confirm that the correct database is selected.
• Confirm that the screen you opened returns data for the current database.
• Refresh the screen if needed.

The data is difficult to read

• Hide columns you do not need.
• Sort the data by the column that is most relevant.

Incremental mode does not show changes

• Refresh the screen again after activity has changed.
• If HCK reports that no data changes were detected, the source values may not have changed since the previous reload.