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.