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.