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.