DataDigger

Quick Start

VScode openedge DataDigger

Getting Started

Below you can find a quick start guide for the VS Code extension or the native DataDigger 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 DataDigger.
3. Select the extension.
4. Click Install.

   

Connect to a Database

1. Open the DataDigger 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 DataDigger

1. Open the DataDigger view.
2. Select a context.

   

3. Select a database.

   

4. Select a table.
5. Browse fields and records.
6. Use query or filtering to find the data you need.

Native

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

Install the Application

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

   Windows

   

   Linux

   

3. Install the package for your operating system:

   Windows (.msix)

   • Double click the AI4YOU-OpenEdge-DataDigger.msix file.
   • The Windows installer will open. Click Install.
   • Wait until the installation is completed.

     Linux (.deb)

   • Double click the openedge-datadigger_x.x.x_amd64.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 DataDigger

1. Launch the application.
2. Select your connection from the dropdown.
3. Open a table or browse the available schema.
4. View records and inspect field values.
5. Use filters or searches to narrow the results.

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

User Guide

This guide explains how to use OpenEdge DataDigger in the VS Code extension and the native application. It will help you connect to a database, browse tables and records, and understand the main features through simple examples and common user workflows.

Interface Overview

This section explains the main areas of the DataDigger 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 working with data.

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, 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 of a selected table.

Working with Records covers how to query table data, inspect full records, add records, copy existing records, edit one or more records, delete records, and use import and export features.

Read the full Working With Records documentation

Interface Overview

Interface Overview

Overview

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

The overall layout is designed to stay true to the original DataDigger interface, helping you move from selecting a connection to browsing tables, fields, and records in a simple and predictable flow.

Header Area

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

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
• open the connection settings

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

For more information about connections refer to the Connection Management guide.

Tables Panel

The tables panel is shown on the left side of the top area.

This panel lets you:

• browse the tables in the selected database
• filter the table list by name
• select a table to load its fields and records
• mark tables as favorites
• switch between All tables and Favorite tables

Fields and Indexes Panel

The fields and indexes panel is shown on the right side of the top area.

This area helps you understand the structure of the selected table.

You can:

• view the list of fields
• switch between Fields and Indexes
• sort field information by column
• filter field information
• review field details such as type, format, label, and order
• edit formats

This panel updates when you select a different table.

Records Area

The records area is shown in the lower part of the screen.

This is where DataDigger displays the records from the selected table.

In this area, you can:

• browse the rows returned for the table
• sort by column
• filter records by column
• select one or more rows
• open a full record view for a selected row

This is the main working area when you want to inspect actual data.

Connection Management

Connection Management

This section explains how to create, test, save, and manage database connections in OpenEdge DataDigger. 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 DataDigger 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.

Password and Security Notes

If your connection requires a password, DataDigger 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.

If you are not sure which option to use, choose Save as secret. This is done by leaving the Save password as plain text checkbox unchecked.

Switching Between Contexts and Databases

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

• Switching context changes where DataDigger 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 DataDigger 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 is available below.

Step 1: Open the Connection Manager

• Click on the Connection Settings gear icon in the top right corner of the DataDigger 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).
• Enter a connection string (Example -db mydb -S 10001).
• Enter a name for the connection (if left blank the name of the database will be used).
• If required enter your user credentials (user and password).
• Choose how you want to save your user password (Save as secret is recommended).

  

Step 4: Test the Connection

• Before we can add a connection we need to 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 DataDigger 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 in 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 DataDigger window.

  

• A window will open displaying a list of all the current connections.

Step 2: Click "Duplicate Connection"

• Click the Duplicate Connection duplicate icon to the right of the connection name in between the pencil icon and the trashcan icon to open the connection duplication form.
• 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 changes.
• 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 DataDigger 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 after the pencil and duplicate icons.
• Click Done to close the connection manager.
• The connection is now removed.

  

Full Demo Video

Using Project Profiles

If your project uses the openedge-project.json, you can manually 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.

At the moment, these profile definitions need to be added manually in your openedge-project.json.

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
• an optional inherits property if the profile should inherit the default connections
• a value.dbConnections section when the profile should define its own connections

NOTE: a restart may be required before the new profile is available.

Example Structure

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

How DataDigger Uses This

• When you select a profile, DataDigger applies that profile's resolved connection list.
• If a profile defines value.dbConnections, those connections are used.
• If a profile does not define its own connections but has "inherits": "default", DataDigger uses the top-level dbConnections.
• If a profile has no valid connections, selecting it may not show any 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.

Demo Video

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.

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

Notes

• A connection can only be added after it has been tested.
• If you leave the connection name empty, DataDigger 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 (User settings, Folder settings or Workspace settings) the connection was saved to.

Working With Records

Working with Records

Overview

This guide explains how to work with records in OpenEdge DataDigger after you have selected a database and table.

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

Read the full Interface Overview documentation

The available actions are the same in both the VS Code extension and the native application unless noted otherwise.

Before You Start

Before you begin, make sure:

• DataDigger is open
• the correct context is selected
• the correct database is selected
• a table is selected

The Records Area

After you select a table, the lower part of the screen becomes the main area for working with records.

Here you can:

• review the returned rows for the selected table
• sort data by column
• filter data by column
• select one or more rows
• open the full record view for a selected row
• add a new record
• copy an existing record
• edit an existing record
• delete an existing record
• export records to a file
• import records from a file
• show and hide columns

If no records are currently shown, DataDigger prompts you to load data for the selected table.

Loading and Querying Data

DataDigger includes a query strip above the records area.

From there, you can:

• enter a WHERE condition directly
• open the query editor
• execute the current query
• clear the current query
• browse query history
• copy the generated query to the clipboard

This is useful when you want to narrow the records that are shown before you start editing or exporting data.

Viewing Records

To inspect a record more closely, select a row and open the record view.

The full record view shows the selected record in a readable field-by-field format. From there, you can:

• review all returned field values together
• copy the formatted record contents to the clipboard

This is especially useful when a row contains many fields or long values that are difficult to review in the grid.

Grid Menu Actions

The records grid also provides a filter field and context menu with actions.

Depending on where you open it and whether a row is selected, you can use actions such as:

• copy to clipboard
• add a value to the filter
• set a value as the only filter
• clear filters
• set sorting
• clear sorting
• view the selected record
• add a record
• clone a record
• edit the selected record or records
• export selected data
• load data through the import flow
• hide a column
• unhide all columns
• delete the selected record or records

More on these actions can be found in the following sections in this document.

Adding a Record

You can add a new record for the selected table.

When you do this, DataDigger opens an input dialog based on the fields of the current table. After the record is added successfully, DataDigger refreshes the data and may update the query to help you find the newly added record.

Use this when you want to create a new row directly from the DataDigger interface.

Copying an Existing Record

If you want to create a new record based on an existing one, select a single row and use the copy action.

DataDigger opens the add-record dialog with values from the selected record already filled in. Fields that must remain unique are excluded so that you can enter new values where needed.

This is useful when you need a new record that is similar to an existing one.

Editing Records

You can edit one selected record or update multiple selected records at once.

Edit a Single Record

When one row is selected, DataDigger opens the edit dialog with the current values from that record.

After you save the changes, DataDigger refreshes the grid so you can review the updated values.

Edit Multiple Records

When multiple rows are selected, DataDigger supports a multi-record edit flow.

In that case:

• fields with the same value across all selected records are shown normally
• fields with different values are marked as mixed values
• the changes you apply to records with mixed values are applied to all selected records

This is useful when you need to update the same field across multiple records in one action.

Deleting Records

You can delete one or more selected records.

Before the delete runs, DataDigger asks for confirmation. If the operation succeeds, the grid refreshes automatically.

Because this action affects live data, it should be used carefully.

Importing Data

DataDigger can load data into the selected table through the import flow.

After you choose the import action, DataDigger opens an import dialog and then sends the imported content to the backend for loading. When the import succeeds, the table data is refreshed.

Use this when you want to insert data into the current table from an external source. This can be done for one or multiple records.

Exporting Data

DataDigger can export data from the selected table.

The export flow supports working with the current table data and takes the current query into account. Depending on the export options you choose, DataDigger can also:

• work with selected rows
• use the current column visibility settings
• open the export location in VS Code
• open the exported file
• copy exported data to the clipboard

Use this when you want to save table data for analysis, sharing, or comparison. This can be done for one or multiple records.

Troubleshooting Tips

• No records are shown
  • Confirm that a table is selected.
  • Load data for the table.
  • Check whether the current query is too restrictive.
• A record action is unavailable
  • Confirm that the correct database and table are selected.
  • Confirm that you have selected one or more rows when the action requires it.
• The wrong rows are shown
  • Check the current query, sorting, and filters.
• The data is difficult to read
  • Hide columns you do not need.
  • Open the full record view for a selected row.