Can we modify tbl_pj_ControlSetting through the UI instead of in SQL?

Guide for Venio Admins

We have recently added a new field in the SQL schema for tbl_pj_ControlSetting.

This guide will walk you through the steps required to set up and manage your ControlSetting variables from the VOD UI.

First, let's show in the UI where these settings will be made available.

Login to VOD under an account which is a member of internal client and has been assigned a Venio Admin role

Click the user drop down and select 'admin settings'

Navigate to the `Environment Settings` Menu:

Under System, you'll find the `Environment Settings` option. By default, only the `AZURE_REGION`, `AZURE_ACCESS_KEY_ID`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_REGION` settings will be displayed.

View and Modify Visible Keys

You will initially see only the default visible keys. You can update the values of these keys and others as necessary.

We have made several changes to the `tbl_pj_controlsetting` table, notably:

- The addition of the `IsVisible` flag. This controls which keys will be displayed in the User Interface (UI).
- The addition of the `IsEncrypted` flag. This controls which settings' values will be encrypted.

IsVisible Flag:

This controls which keys will be displayed in the User Interface (UI).

Notable Exceptions:

The settings `IS_DEVELOPMENT_ENVIRONMENT`, `IS_CLOUD_ENVIRONMENT`, `RELATIVITY_ERROR_MESSAGE_KEYWORDS`, `ENABLE_NEW_CASE_SETTINGS_FEATUREFLAG`, `ENABLE_VOD`, and `ENABLE_VODR` will not be visible in the UI, regardless of the `IsVisible` setting.

IsEncrypted Flag:

If you upgrade using upgrade scripts, the `IsEncrypted` flag will remain 0 for all settings. However, if you upgrade using the `ConfigureDatabase.exe` utility or during the venio upgrade process, the `AWS_SECRET_ACCESS_KEY` and `AZURE_ACCESS_KEY_ID` will, by default, have the `IsEncrypted` flag set to 1 and the values changed to encrypted strings.

If a key is encrypted, its value will be blank in the UI. If you update the value as blank, the previous data will not be updated - that is, it will retain its original populated value.

How to Modify AWS and Azure Key encryption in SQL:

Keys with the `IsEncrypted` flag set to 1 will be encrypted. If you wish to encrypt or decrypt other keys, change the `IsEncrypted` flag for that key to 1 or 0, respectively.

Example:

To enable configuration of URL settings from within VOD, you can set the 'IsVisible' field to '1' where [key] like '%url%' (see screenshot)

Or, To enable configuration of Ingestion engine, and transcribe engine settings from within VOD, you can set the 'IsVisible' field to '1' where [key] like '%engine%' (see screenshot)

Now, when you navigate out from "Environment Settings" and back in, you will see those values in the VOD UI:

Troubleshooting

Remember, wherever this data is accessed, it should work fine, meaning the value should be decrypted correctly. However, there could be errors in cases where there is direct access to the value from the database. As such, these fields should be used carefully as they are intended for hiding confidential control setting data.