Updating the Database Configuration

Learn how to update database configuration; for example, when the database password changes.

The database is added as part of initial installation. For information about adding the database, refer to the installation documentation for your product version: go to Installing the Akana API Platform and choose the version. Add Database is one of the pending tasks after installing features into the container.

Note: This document references the version of the Admin Console that is the default up to and including version 2022.1.0, but does not show the redesigned Admin Console available as an option in version 2022.1.0. For an overview of the new user interface, plus illustrations, see Admin Console 2022.1.0—Overview.

Table of Contents

Introduction

When you change the database password, you'll essentially need to delete the existing database connection and create a new one.

To update the database password using the new encryption method, which is more secure, follow the steps below.

To update the database connection when the database password has changed

To refresh the database connection when the database password or other database-related information has changed, you'll need to:

  1. Delete the existing database connection
  2. Create a new database connection

To delete the existing database connection

Note: Before deleting the existing database connection, it's best to take a screen capture of the configuration settings, or in some other way to record the settings so that you can easily create a new connection.

  1. Log in to the Admin Console.
  2. Click the Configuration tab.
  3. On the left, under Configuration Categories, find the com.soa.database.config category as shown below.

    Database Configuration properties

  4. Recommended: take a screen capture of the existing database configuration.
  5. On the right, click the Delete icon to delete the database configuration. At the prompt, click OK to confirm the deletion.
  6. Delete any additional configuration instances.

The next step is to create a new connection to the database, using the new password.

To create a new database connection

  1. In the Admin Console, on the Configuration tab, go to the Configuration Actions section at the bottom left.
  2. Click the Add Database configuration task.
  3. On the first page of the wizard, choose Use existing database and then click Next.
  4. Provide additional values for the database, as needed, and then click Save. For additional information on using the Configure Database Options wizard, see Configuration Actions: Add Database.