Data Administration

Quick Start

VScode OpenEdge Data Administration

Getting Started

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

Connect to a Database

1. Open the Data Administration extension view from the sidebar.

2. Open the connection settings using the 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 sports2020 -H localhost -S 10001

6. Enter a name for the connection.

   If left blank the name of the database will be used.

7. If required, enter user credentials.
8. Choose how to store the 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 Data Administration

1. Open Data Dictionary to work with schema objects.
2. Browse and maintain:
   • tables
   • fields
   • indexes
   • sequences
3. Use the available editors to create, update, or delete schema objects where supported.
4. Use the Admin section for operations such as:
   • Dump Definitions (.df)
   • Dump Incremental Definitions
   • Dump Data (.d)
   • Dump Sequence Values
   • Load Definitions (.df)
   • Load Data (.d)
   • Load Sequence Values
   • Database Properties
5. Use the Reports section to open quick reports for:
   • tables
   • fields
   • indexes
   • sequences
   • views
   • triggers
   • users

Native

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

Install the Application

1. Download the native Data Administration application from your release location.
2. Find the correct version for your operating system.

   Windows

   

   Linux

   

3. Install the package for your operating system.

   Windows (.msix)

   • Double click the .msix installer file.
   • The Windows installer opens.
   • Click Install.
   • Wait until the installation is completed.

     

     Linux (.deb)

   • Double click the .deb package.
   • Your package installer opens.
   • Click Install.
   • Approve any permission prompts if required.
   • Wait until installation is completed.

     

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

6. Enter or browse to your OpenEdge installation folder.
7. Wait for validation feedback.
8. Click Save.

Connect to a Database

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

1. Open the connection settings using the 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. Enter credentials if required.
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 Data Administration

1. Launch the application.
2. Select your connection from the dropdown.
3. Select a database.
4. Use Data Dictionary to inspect and maintain schema objects.
5. Use Admin for dump/load and database-level actions.
6. Use Reports to generate quick overviews of the selected database.

Example Connection Information

A full connection string might look like this:

Name: Sports Database
Connect: -db sports2020 -H localhost -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 the 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 Data Administration in the VS Code extension and the native application. It will help you connect to a database, understand the interface, and work with schema, administration, and report screens through simple examples and common user workflows.

Interface Overview

This section explains the main areas of the Data Administration interface and how they work together during normal use.

Interface Overview describes the header controls, context and database selectors, the navigation and schema panel, the detail and editor panel, the administration screens, and the reports area. It is useful if you want a clearer understanding of what each part of the screen is used for before you start working with schema or administration tasks.

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 Screens

This section explains how to work with the available Data Administration screens.

Working with Screens covers the Data Dictionary area, the dump and load screens, the database administration screens, and the report screens. It explains what each screen or section is used for and helps you choose the correct place to work depending on whether you want to maintain schema, load or dump data, review database properties, or inspect report-style overviews.

Read the full Working with Screens documentation

Interface Overview

Interface Overview

Overview

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

The overall layout is designed to help you move from selecting a connection and database to browsing schema objects, editing properties, and opening administration or reporting screens in a simple and predictable flow.

Header Area

The header is the main control area at the top of Data Administration.

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 working with schema or administration tools.

Dictionary Databases and tables Panels

The panels are shown on the left side and in the middle section of the main interface.

This area lets you:

• browse the available databases
• switch between the main schema views
• open tables
• open sequences
• select the current database object you want to work with
• move to administration or report-related screens depending on the active view

This panel is the main starting point for moving through Data Administration.

Dictionary Detail and Editor Panels

The detail and editor panel is shown in the main content area.

This area helps you inspect and maintain the selected object.

You can:

• view the properties of the selected table, field, index, or sequence
• switch between fields, indexes, table properties, and other object-specific views
• review structure details such as type, format, label, order, uniqueness, and sequence settings
• create new schema objects where supported
• edit existing schema objects
• save changes to the selected object
• delete schema objects when needed

This panel updates when you select a different database object.

Administration Screens

The administration screens are used for database administration tasks outside normal schema browsing.

From these screens, you can work with actions such as:

• Dump Definitions (.df)
• Dump Incremental Definitions
• Dump Data (.d)
• Dump Sequence Values
• Load Definitions (.df)
• Load Data (.d)
• Load Sequence Values
• Database Properties

These screens are used when you want to export, import, review, or maintain database-level information.

Reports Area

The reports area is used to open quick reports for the selected database.

In this area, you can open reports for:

• tables
• fields
• indexes
• sequences
• views
• triggers
• users

This is the main working area when you want a structured overview of schema or administration information instead of editing a single object.

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 the current view.

Connection Management

Connection Management

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

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

• Switching context changes where Data Administration 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 Data Administration 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 the Connection Settings gear icon in the top right corner of the Data Administration window.

Step 2: Click "Add Connection"

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

Step 3: Fill in Connection Details

• Select the context you want to save your connection to: User settings, Folder settings, or Workspace settings.
• Enter a connection string, for example -db mydb -S 10001.
• Enter a name for the connection. If left blank, the database name is used.
• If required, enter your user credentials.
• Choose how you want to save your password. Save as secret is recommended.

Step 4: Test the Connection

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

Step 5: Save the Connection

• Click Add 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 the edit button next to the connection name in the connection list.

Step 1: Open the Connection Manager

• Click the Connection Settings gear icon in the top right corner of the Data Administration window.

Step 2: Click "Edit Connection"

• A window opens displaying a list of 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 Update 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 duplicated, saving time when a new connection is mostly similar to an existing one. You can duplicate a connection by clicking the duplicate icon between the pencil icon and the trashcan icon.

Step 1: Open the Connection Manager

• Click the Connection Settings gear icon in the top right corner of the Data Administration window.
• A window opens displaying a list of the current connections.

Step 2: Click "Duplicate Connection"

• Click the Duplicate Connection icon to the right of the connection name to open the duplication form.
• Here you can edit the copied connection details and test the connection.

Step 3: Save the Duplicated Connection

• Update the copied connection details as needed.
• Click Add 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 the trashcan icon to the right of the connection name.

Step 1: Open the Connection Manager

• Click the Connection Settings gear icon in the top right corner of the Data Administration window.
• A window opens displaying a list of 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

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.

At the moment, these profile definitions need to be added manually in 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

A restart may be required before a new profile becomes 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 Data Administration Uses This

• When you select a profile, Data Administration 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", Data Administration 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 selected project profile is the correct one and whether the profile contains valid dbConnections.

Additional Information

Notes

• A connection can only be added after it has been tested.
• If you leave the connection name empty, Data Administration uses 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.
  • Verify that the selected context, folder, or project profile matches where you saved it.

Working With Records

Working with Screens

Overview

This guide explains what each available screen in OpenEdge Data Administration is used for.

Where Interface Overview explains the main layout of the application, this guide focuses on the screens you can open and the kind of work each screen supports.

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

Before You Start

Before you begin, make sure:

• Data Administration is open
• the correct context is selected
• the correct database is selected when the screen requires one
• the backend is running when you are using database-dependent features

The names in this guide follow the current application structure:

• Data dictionary is the main schema area
• Admin is the sidebar section that contains administrative screens
• Reports contains the Quick Reports section

Data Dictionary Screen

The Data Dictionary area is used for browsing and maintaining schema objects.

Databases

The Databases section is the main starting point for Data Administration.

From here, you can:

• choose the database you want to work with
• move into the schema-oriented screens
• switch contexts and refresh the current database list

Use this screen when you want to begin working with a database or change to a different one.

Tables

The Tables section is used to browse and maintain tables in the selected database.

From here, you can:

• review the available tables
• select a table to inspect its structure
• create a new table
• edit an existing table
• delete a table
• move into related field, index, and table property views

Use this screen when you want to work with table-level schema definitions.

Fields

The Fields section is used to inspect and maintain fields for the selected table.

From here, you can:

• review the fields that belong to the selected table
• inspect field attributes such as type, format, label, and validation-related settings
• create a new field
• edit an existing field
• delete a field

Use this screen when you want to manage the structure of a table at field level.

Indexes

The Indexes section is used to inspect and maintain indexes for the selected table.

From here, you can:

• review the indexes that belong to the selected table
• inspect index properties such as uniqueness and primary status
• review the fields that participate in an index
• create a new index
• edit an existing index
• delete an index

Use this screen when you want to manage lookup, uniqueness, or key definitions for a table.

Sequences

The Sequences section is used to inspect and maintain database sequences.

From here, you can:

• review the available sequences
• inspect sequence settings such as current value, increment, minimum, maximum, and cycling behavior
• create a new sequence
• edit an existing sequence
• delete a sequence

Use this screen when you want to manage generated number behavior in the database.

Dump and Load Screens

The dump and load screens are used for exporting and importing database structure and related data files.

Dump Definitions

The Dump Definitions screen is used to export schema definitions to a .df file.

From here, you can:

• choose which tables should be included
• choose the output location for the generated file

Use this screen when you want to export schema structure from the current database.

Dump Incremental Definitions

The Dump Incremental Definitions screen is used to create an incremental .df file based on differences between databases or schema states.

From here, you can:

• choose the comparison database
• generate an incremental schema definition file
• capture only the changes that need to be transferred

Use this screen when you want to prepare a smaller schema change package instead of a full schema dump.

Dump Data

The Dump Data screen is used to export table data to .d files.

From here, you can:

• select one or more tables
• choose an output location for the generated data files
• optionally provide a code page

Use this screen when you want to export table contents for transfer, backup, or loading elsewhere.

Dump Sequence Values

The Dump Sequence Values screen is used to export current sequence values.

From here, you can:

• create a file containing the current values of database sequences
• preserve sequence state for later reuse or migration

Use this screen when you want to keep sequence counters aligned across environments.

Load Definitions

The Load Definitions screen is used to import a .df schema file into the selected database.

From here, you can:

• choose the definition file to load
• choose load and error-handling options
• start the schema load operation
• apply schema changes to the current database

Use this screen when you want to apply schema updates from a prepared .df file.

Load Data

The Load Data screen is used to import .d files into the selected database.

From here, you can:

• choose the table you want to load data into
• choose the source file to load
• include hidden tables when needed
• choose LOB-related options
• define the acceptable error percentage
• choose whether errors should be displayed on screen
• start the data load operation

Use this screen when you want to import data that was previously dumped from a database.

Load Sequence Values

The Load Sequence Values menu entry currently opens a screen titled Load Sequence Definitions.

From here, you can:

• choose the input file
• optionally provide a code page
• load sequence-related definitions into the current database

Use this screen when you want to load sequence-related .df content through the current implementation.

Database Administration Screens

The administration screens are grouped under the Admin section in the sidebar.

Within Admin, the current visible groups are:

• Dump Data and Definitions
• Load Data and Definitions
• Database Identification

The administration screens are used for database-level properties and identification information.

Database Properties

The Database Properties screen is used to review database-level information.

From here, you can:

• inspect general database properties
• review structural or identification-related settings
• understand the current database configuration before making changes elsewhere

Use this screen when you need a database-level view instead of an individual schema object view.

Report Screens

The report screens are grouped under Reports and then Quick Reports in the sidebar.

The report screens provide structured, report-style views of schema and administration information.

Quick Table Report

The Quick Table Report screen is used to review table information in report form.

From here, you can:

• inspect table-level summaries across the current database
• review table-oriented information in a compact list

Use this screen when you need an overview of tables instead of editing a single table.

Quick Field Report

The Quick Field Report screen is used to review field information in report form.

From here, you can:

• inspect field definitions across tables
• review field-oriented information in a report layout

Use this screen when you need a broader overview of field definitions.

Quick Index Report

The Quick Index Report screen is used to review index information in report form.

From here, you can:

• inspect index definitions across the database
• review index-oriented information in a compact overview

Use this screen when you need to review index structure without opening tables one by one.

Sequence Report

The Sequence Report screen is used to review sequence information in report form.

From here, you can:

• inspect sequence values and settings together
• compare sequences across the current database

Use this screen when you need a report-style overview of sequences.

View Report

The View Report screen is used to review database views in report form.

From here, you can:

• inspect defined views
• review view-related information in a structured list

Use this screen when you need an overview of database views.

Trigger Report

The Trigger Report screen is used to review database trigger information.

From here, you can:

• inspect trigger definitions in report form
• review trigger-related information across the database

Use this screen when you need an overview of configured triggers.

User Report

The User Report screen is used to review user-related database information.

From here, you can:

• inspect user entries in report form
• review database user information in one place

Use this screen when you need a report-style overview of configured database users.

Troubleshooting Tips

• The screen does not show expected data
  • Confirm that the correct database is selected.
  • Confirm that the screen you opened requires a selected database.
  • Refresh the view if you recently changed connections or schema information.
• A screen action is unavailable
  • Confirm that the required object is selected first.
  • Confirm that the backend is running.
• The wrong database information is shown
  • Check the current context, folder, or project profile.
  • Reopen the screen after changing the active database if needed.