OvalEdge Migration Process

Release6.2 Migration Process for VM Model

Introduction

This document offers guidance on transitioning from previous versions to the latest 6.2 version, providing essential steps to ensure a smooth migration experience.

Refer to the Migration Checklist for ensuring that all the relevant steps are executed as part of the migration. 

Prerequisites for Migration

Before initiating the migration process, ensure that the following prerequisites are met:

Supporting Application Configurations 

  • Upgrade Infrastructure (Optional)

Ensure that the applications and the operating system support the upgraded amount of RAM and have sufficient space on the new SSD for optimal performance.

  • Upgrade Database Version

Upgrade database to below mentioned versions for software performance and security. The previous versions of MySQL are not supported any longer. 

  • Upgrade MySQL Version to 8.0.36 or higher. For more information refer to:

OvalEdge Application Upgrade from MySQL 5.7 to 8.0

MySQL Upgrade from 5.7 to 8.0 on Ubuntu 18.04 Server

    • Upgrade MariaDB Version to 10.6.16+ or 10.11.6+. 
    • Pre Upgradation 

Take Database Backup

Ensure a comprehensive backup of the Database (MySQL or MariaDB) is taken. Refer to the following document for backup instructions. For more information OvalEdgeDB Backup Process

Table Row Count Validation

Validate the row count of all database entities to confirm the success of the migration process. Detailed instructions are available in the provided document. DB Migration Checklist

  • Externalizing oasis.properties

Externalizing oasis.properties on Windows: It involves configuring Tomcat as a service to enable external accessibility. Refer to the document below for more information:  Externalizing Oasis Properties for Tomcat in Windows

Externalizing oasis.properties on Linux: On Linux, the externalization of oasis.properties requires a strategic approach to key settings.  Refer to the document below for more information: Externalizing Oasis Properties for Tomcat in Linux

  • Externalizing log4j.properties

Externalizing of log4j.properties is mandatory to overcome the logs writing into catalina.out for some of the customers the space is accumulating in the tomcat folder. Refer to the document for detailed steps on Externalizing log4j.properties

  • Upgrade or Install ElasticSearch 

Upgrade ElasticSearch to 8.0.x for improved search capabilities within the OvalEdge. Refer to the document for more information.

Installation of Elasticsearch 8.X on Windows

Installation of Elasticsearch 8.X on Ubuntu

  • Upgrade Java Version (optional)

It is recommended to upgrade Java to version 8U_xxx for optimal performance and compatibility. For more information refer to Upgrading JRE and JDK on Windows

  • Upgrade Tomcat Service Version

It is recommended to upgrade Tomcat to version 9.0.x. For more information  refer to Upgrading Tomcat from 9.0.x to 9.0.83 with Step-by-Step Instructions

Application Backups

Before commencing the migration, execute the following backup and validation procedures:

  • Take Application War, and Jars Backup

Take backup of War files from Apache Tomcat > Webapps, and Jars (csp libs). This step is critical to safeguard against any potential disruptions during the migration process.

  • Take Backup of the Shared NFS Folder

Take backup of the files present in the shared NFS repository.

  • Tomcat Server Backup & Preparation

Take a backup of the Tomcat server. Clearing these folders helps create a clean environment for the upcoming migration, minimizing the risk of conflicts. In the Tomcat server, empty the following folders:

  1. Webapps folder
  2. Temp folders (excluding Jar files). Please ensure that jar files are not removed by accident.
  3. Logs folders 
  • System Settings Backup

Take the backup of the system settings table from ovaledge database in XLSX format to make sure the configured default settings are available to reflect in the new version.

Migration Process

For VM, the migration process involves downloading release artifacts links provided in the email. The procedure involves sequential tasks, such as downloading the war from the given link, configuring oasis.properties, and running the Tomcat service to reflect the latest changes. Furthermore, the execution of advanced jobs is necessary to observe the latest changes specific to certain functionalities. 

War Replacement

  1. Download the war files from the provided email link. 
  2. Once downloaded, go to the Tomcat directory, find the "Webapps'' folder, and copy the downloaded latest war file. 
  3. This ensures the integration of the latest functionalities, improvements, and gap resolutions addressed in the Release6.2 for proper OvalEdge application functioning.

Connectors & Lineage / Jars Upgrade

  1. Download the Jar files using the link provided in the email.
  2. Replace the existing csplib / jars within the External Jars Directory > third_party_jars
    1. Ensure that the csp library for standard connectors is updated.
    2. Ensure that the “oe-lineage jar” is updated.
    3. Update the csp library for big data connectors (client specific)

Setting oasis.properties in Tomcat  

Within the VM’s users can customize the oasis.properties in External Property Directory file to meet their specific requirements including database connectivity, security, authentication (SSO), and Elasticsearch, management of external dependencies, and configuration storage in key vaults. 

Jar Path Configuration in oasis.properties

Configuring the Jar path is crucial to ensure that the OvalEdge application can locate and access the required Java Archive (Jar) files which contain essential classes, libraries, and resources necessary for the application's functionality. 

Users can now configure the Jar Path through oasis.properties and incorporate the latest versions of Jar files, ensuring compatibility while introducing new features, enhancements, or bug fixes. 

  • ovaledge.jarpath: Specify the  path of the Jar file.

Note: Previously, the Jar Path was set using System Settings > System Path > ovaledge.jarpath. In Release 6.2, this has been moved to oasis.properties to simplify the process. For container systems, read this configuration from environment variables.

Governance App Configurations 

These configurations are crucial to redirect users to governance-related applications using email or direct links. Refer to the document to configure Governance application Governance App Configuration

  • gov-app.protocol: Specify the protocol used for Governance Apps.
  • gov-app.host: Specify the hostname for Governance Apps.
  • gov-app.port: Specify the port for Governance Apps.

oasis.properties to Migrate from 6.0 to 6.2

If oasis.properties is set up to read from an external location or if properties are configured in environment variables for Docker environments, please make the changes below.

The “Keys” listed below are removed in Release6.1

  • saml-metadata-type=url
  • entity-base-islb=false
  • entity-base-protocol=https
  • entity-base-host=localhost
  • entity-base-port=443
  • entity-base-contextpath=/ovaledge
  • entity-base-port-in-url=false
  • spring.security.oauth2.tenantId=tenantId

There are few modifications to the existing values of keys

Key

Previous Value

New Value

Note: If moving from MySql to Mariadb, the below parameters should be updated.

driverClassName

com.mysql.cj.jdbc.Driver

org.mariadb.jdbc.Driver

url

jdbc:mysql://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false

jdbc:mariadb://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false

read.url

jdbc:mysql://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false

jdbc:mariadb://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false

Note: The below parameters need to be verified and updated in the oasis.properties file with the new values whether it is MySql or Mariadb.

db.max.connections

40

30

read.db.max.connections

60

40

spring.session.db.max.connections

40

60

There are a few modifications to the existing keys as mentioned in the following table

Existing Keys

Renamed As

azure.secretname.jdbcstring=jdbcstringurl

secret.key.jdbcstring=jdbcstringurl

azure.secretname.username=username

secret.key.username=username

azure.secretname.password=password

secret.key.password=password

azure.secretname.read.jdbcstring=readjdbcstringurl

secret.key.read.jdbcstring=readjdbcstringurl

azure.secretname.encryptdecryptkey=encryptdecryptkey

secret.key.encryptdecryptkey=encryptdecryptkey

azure.secretname.eshost=eshost

secret.key.eshost=eshost

azure.secetname.esport=esport

secret.key.esport=esport

azure.secretname.esprotocol=esprotocol

secret.key.esprotocol=esprotocol

azure.secretname.esusername=esusername

secret.key.esusername=esusername

azure.secretname.espassword=espassword

secret.key.espassword=espassword

The “Keys” listed below are newly introduced in Release 6.1.

New Key

Value

aws-secrets

<true/false>

aws-secretregion

<aws region where the secret name exists>

aws-secretname

<secret name from which the parameters are read>

hikari.connectionTimeout.in.seconds

50

hikari.idleTimeout.in.minutes

2

hikari.validationTimeout.in.seconds

50

hikari.leakDetectionThreshold.in.seconds

30

hikari.cachePrepStmts

true

hikari.prepStmtCacheSize

250

hikari.prepStmtCacheSqlLimit

2048

hikari.useServerPrepStmts

true

hikari.useLocalSessionState

true

hikari.rewriteBatchedStatements

true

hikari.cacheResultSetMetadata

true

hikari.cacheServerConfiguration

true

hikari.elideSetAutoCommits

true

Note: Refer to the AWS Secrets Manager Configurations article to know more about the newly added Keys.

Tomcat Service Restart

Restart the Tomcat services to apply and update the changes and initiate the migration successfully.

Post Migration Checks 

Tables & Row Count Validation

Conduct a thorough verification of data row counts in the post-migration environment.

Ensure that the actual counts match with the pre-upgradation counts to identify and rectify any discrepancies, serving as a key indicator of a successful migration. 

Verify Application

Verify that the latest enhancements and features are successfully deployed in the application post-migration.

Run the Migration Advance Jobs

This involves running the Migration Advance Jobs, which are essential processes ensuring the proper functioning of OvalEdge in its upgraded state. Detailed instructions can be found in Appendix A of the migration documentation.

Verify System Settings

The migration process does not mandate adjustments to any system settings. However, it's important to note that for Release 6.2, there are new system settings that have been introduced, some system settings have been deprecated, and others have undergone modifications. For more information, please refer to the appendices below.

Verify Data Row Counts

Conduct a thorough verification of data row counts in the post-migration environment.

Ensure that the actual counts match with the pre-migration counts to identify and rectify any discrepancies, serving as a key indicator of a successful migration. 

Appendix A: Migration Advanced Jobs

Advanced Jobs to be run while migrating are listed in the sections below. 

A1 : 6.1.2 to 6.2 Migration Advanced Job Checklist 

Advance Job Name

Help

Load oereportext table for reporting framework

The objective of this job is to generate predefined reports in the OvalEdge DB.

Example: Reports with the total number of tables with business descriptions, tables with no relationship, tables with zero row count, etc, are displayed.

On the report catalog, you could view the created reports for OvalEdge DB.

Advance Job for Indexing Existing Data into ElasticSearch

This advanced job allows the indexing of pre-existing data into Elasticsearch and controls the indexing process based on the specific object types you choose.

Enter the object type names that require support in the Attribute1 by providing their names, such as 'oetable' or 'oeschema'. Data corresponding to that specific object type will be indexed in Elasticsearch. If there are multiple object types that need to be indexed, please separate them with commas. In case no object types are provided, data from all object types will be indexed.

Attributes:

Comma separated Object Types - oetable,oecolumn, etc.,

Sync Project Status and stats for old and new project

Advanced job is created to sync the old and new project status and stats in the updated version. It is required to migrate the current application version to 6.0.

Migrate Data To Denormalized Tables

This job will Migrate Data To Denormalized(ext) Tables

Servicedesk V1

This advanced job helps to migrate existing service desk templates to a new version. This allows users to select existing templates and fill out the mandatory fields before raising service requests on multiple objects on behalf of multiple users.

Note: No attribute is required to execute this job.

Migrate User License and Connector License to 61

This job will update the User and Connector License Type based on current Permissions to 61

Update Schedule Next Execution Date Time

The purpose of this job is to update the next execution date & time in the database > Schedule table > Next Execution date column. This gets updated only when the Next Execution date field is empty or null. It is important to note that it is mandatory to run this advanced job for the first time when the database is new or updated.

Attributes not needed.

Term Masking Migration JOB

This job migrates masking policies assigned to terms and their associated data objects from older versions to the latest 6.1 version.

Custom Field Migration JOB

To migrate custom field to 6.2

Notification Preferences Migration

This job will migrate notification preferences

Enable system dashboards

To enable the Dashboard tab in the Administration> Security module.

Attributes:

No attributes are needed.

Migrate favourite dashboard to new dashboards flow

To migrate all existing default dashboards to Administration > Security > Dashboard Security, where admin users can create new dashboards based on requirements.

Attributes:

No attributes are needed.

Update Origin for Objects

This job will update the origins for existing objects

Migration Job for Data Quality from R61 to R62 

This migration job helps migrate existing DQ Rules to new DQ Rule definitions supporting success and input operators. It also helps migrate the updated changes for DQRC with changes done in Release 6.2

Refresh Has-Lineage

The job refreshes the Has Lineage column present in the Data Catalog list page. The column tells whether the object has lineage or not.

Migrate RDAM Module

To migrate the users, roles, associated permissions on data objects, masking policies from the previous versions to the latest 6.2 version.


A2 : 6.1.1.1 to 6.2 Migration Advanced Job Checklist

Advance Job Name

Help

Load oereportext table for reporting framework

The objective of this job is to generate predefined reports in the OvalEdge DB.

Example: Reports with the total number of tables with business descriptions, tables with no relationship, tables with zero row count, etc, are displayed.

On the report catalog, you could view the created reports for OvalEdge DB.

Advance Job for Indexing Existing Data into ElasticSearch

This advanced job allows the indexing of pre-existing data into Elasticsearch and controls the indexing process based on the specific object types you choose.

Enter the object type names that require support in the Attribute1 by providing their names, such as 'oetable' or 'oeschema'. Data corresponding to that specific object type will be indexed in Elasticsearch. If there are multiple object types that need to be indexed, please separate them with commas. In case no object types are provided, data from all object types will be indexed.

Attributes:

Comma separated Object Types - oetable,oecolumn, etc.,

Sync Project Status and stats for old and new project

Advanced job is created to sync the old and new project status and stats in the updated version. It is required to migrate the current application version to 6.0.

Migrate Data To Denormalized Tables

This job will Migrate Data To Denormalized(ext) Tables

Servicedesk V1

This advanced job helps to migrate existing service desk templates to a new version. This allows users to select existing templates and fill out the mandatory fields before raising service requests on multiple objects on behalf of multiple users.

Note: No attribute is required to execute this job.

Migrate User License and Connector License to 61

This job will update the User and Connector License Type based on current Permissions to 61

Update Schedule Next Execution Date Time

The purpose of this job is to update the next execution date & time in the database > Schedule table > Next Execution date column. This gets updated only when the Next Execution date field is empty or null. It is important to note that it is mandatory to run this advanced job for the first time when the database is new or updated.

Attributes not needed.

Term Masking Migration JOB

This job migrates masking policies assigned to terms and their associated data objects from older versions to the latest 6.1 version.

Custom Field Migration JOB

To migrate custom field to 6.2

Notification Preferences Migration

This job will migrate notification preferences

Enable system dashboards

To enable the Dashboard tab in the Administration> Security module.

Attributes:

No attributes are needed.

Migrate favourite dashboard to new dashboards flow

To migrate all existing default dashboards to Administration > Security > Dashboard Security, where admin users can create new dashboards based on requirements.

Attributes:

No attributes are needed.

Update Origin for Objects

This job will update the origins for existing objects


A3 : 6.1 to 6.2 Migration Advanced Job Checklist

Advance Job Name

Help

Load oereportext table for reporting framework

The objective of this job is to generate predefined reports in the OvalEdge DB.

Example: Reports with the total number of tables with business descriptions, tables with no relationship, tables with zero row count, etc, are displayed.

On the report catalog, you could view the created reports for OvalEdge DB.

Update User License Type

It updates the user license on the current application version based on the permissions available in the previous version. It is required to migrate the current application version to 6.0.

Advance Job for Indexing Existing Data into ElasticSearch

This advanced job allows the indexing of pre-existing data into Elasticsearch and controls the indexing process based on the specific object types you choose.

Enter the object type names that require support in the Attribute1 by providing their names, such as 'oetable' or 'oeschema'. Data corresponding to that specific object type will be indexed in Elasticsearch. If there are multiple object types that need to be indexed, please separate them with commas. In case no object types are provided, data from all object types will be indexed.

Attributes:

Comma separated Object Types - oetable,  oecolumn, etc.,

Sync Project Status and stats for old and new project

Advanced job is created to sync the old and new project status and stats in the updated version. It is required to migrate the current application version to 6.0.

Migrate Data To Denormalized Tables

This job will Migrate Data To Denormalized(ext) Tables

Servicedesk V1

This advanced job helps to migrate existing service desk templates to a new version. This allows users to select existing templates and fill out the mandatory fields before raising service requests on multiple objects on behalf of multiple users.

Note: No attribute is required to execute this job.

Migrate User License and Connector License to 61

This job will update the User and Connector License Type based on current Permissions to 61

Update Schedule Next Execution Date Time

The purpose of this job is to update the next execution date & time in the database > Schedule table > Next Execution date column. This gets updated only when the Next Execution date field is empty or null. It is important to note that it is mandatory to run this advanced job for the first time when the database is new or updated.

Attributes not needed.

Term Masking Migration JOB

This job migrates masking policies assigned to terms and their associated data objects from older versions to the latest 6.1 version.

Custom Field Migration JOB

To migrate custom field to 6.2

Notification Preferences Migration

This job will migrate notification preferences

Enable system dashboards

To enable the Dashboard tab in the Administration> Security module.

Attributes:

No attributes are needed.

Migrate favourite dashboard to new dashboards flow

To migrate all existing default dashboards to Administration > Security > Dashboard Security, where admin users can create new dashboards based on requirements.

Attributes:

No attributes are needed.

Update Origin for Objects

This job will update the origins for existing objects


A4: 6.0 to 6.2 Migration Advanced Job Checklist 

Advanced Jobs to be run while migrating from Release6.0 to Release6.2 are listed in the table below. 

Advance Job Name

Help

Load oereportext table for reporting framework

The objective of this job is to generate predefined reports in the OvalEdge DB.

Example: Reports with the total number of tables with business descriptions, tables with no relationship, tables with zero row count, etc, are displayed.

On the report catalog, you could view the created reports for OvalEdge DB.

Update User License Type

It updates the user license on the current application version based on the permissions available in the previous version. It is required to migrate the current application version to 6.0.

Advance Job for Indexing Existing Data into ElasticSearch

This advanced job allows the indexing of pre-existing data into Elasticsearch and controls the indexing process based on the specific object types you choose.

Enter the object type names that require support in the Attribute1 by providing their names, such as 'oetable' or 'oeschema'. Data corresponding to that specific object type will be indexed in Elasticsearch. If there are multiple object types that need to be indexed, please separate them with commas. In case no object types are provided, data from all object types will be indexed.

Attributes:

Comma separated Object Types - oetable, oecolumn, etc.,

Sync Project Status and stats for old and new project

Advanced job is created to sync the old and new project status and stats in the updated version. It is required to migrate the current application version to 6.0.

Migrate Data To Denormalized Tables

This job will Migrate Data To Denormalized(ext) Tables

Servicedesk V1

This advanced job helps to migrate existing service desk templates to a new version. This allows users to select existing templates and fill out the mandatory fields before raising service requests on multiple objects on behalf of multiple users.

Note: No attribute is required to execute this job.

Migrate User License and Connector License to 61

This job will update the User and Connector License Type based on current Permissions to 61

Update Schedule Next Execution Date Time

The purpose of this job is to update the next execution date & time in the database > Schedule table > Next Execution date column. This gets updated only when the Next Execution date field is empty or null. It is important to note that it is mandatory to run this advanced job for the first time when the database is new or updated.

Attributes not needed.

DQ Score calculation for 61

The primary objective of this job is to ensure that users migrating from the previous version to the 6.1.1 release can access the most up-to-date Data Quality (DQ) score. This is imperative due to recent adjustments made in the score calculation process.

Attributes not needed.

Term Masking Migration JOB

This job migrates masking policies assigned to terms and their associated data objects from older versions to the latest 6.1 version.

Custom Field Migration JOB

To migrate custom field to 6.2

Notification Preferences Migration

This job will migrate notification preferences

Enable system dashboards

To enable the Dashboard tab in the Administration> Security module.

Attributes:

No attributes are needed.

Migrate favourite dashboard to new dashboards flow

To migrate all existing default dashboards to Administration > Security > Dashboard Security, where admin users can create new dashboards based on requirements.

Attributes:

No attributes are needed.

Update Origin for Objects

This job will update the origins for existing objects

Migrate RDAM Module

To migrate RDAM module


Appendix B: Advanced Jobs Removed in Release6.2


Advanced Job Names

Class

Build BusinessGlossary for table column

com.ovaledge.oasis.advance.BuildBusinessGlossaryAuto



Build Terms

com.ovaledge.oasis.advance.TermBuilderAIService

Process CouchDb Lineage

com.ovaledge.oasis.advance.CouchDbAdvanceJob

Advance Job for updating editor from md to froala

com.ovaledge.oasis.advance.MdEditorMigration

Load DataQuality Function

com.ovaledge.oasis.advance.LoadDataQualityFunctionsSql

Build Lineage and Associate Term

com.ovaledge.oasis.advance.AssosciateTermLineage

Process File Data Quality Rules

com.ovaledge.oasis.advance.DQFleRuleProcessorJob

Update techincal table and column descriptions from user table

com.ovaledge.oasis.advance.AssignTableTechDescriptions

Servicedesk Data Migration

com.ovaledge.oasis.advance.TransferServicedeskData

Reference Data CodeList

com.ovaledge.oasis.advance.ReferenceDataCodeList

Download Term Assosciation Details

com.ovaledge.oasis.advance.DownloadTermAssosciations

Object Tagging

com.ovaledge.oasis.advance.ObjectTaggingService

Object Access History

com.ovaledge.oasis.advance.ObjectAccessService

SqlServer RDAM Sync

com.ovaledge.oasis.advance.SqlServerRDAMSyncJob

Sort DataCatalog Tableau Reports

com.ovaledge.oasis.advance.SortDataCatalogReports

VALIDATEDBUDF

com.ovaledge.oasis.advance.ValidateUDFDataBricks

ENCRYPTDBPII

com.ovaledge.oasis.advance.EncryptDataBricksPII

BUILDENCRYPTDBPIIVIEWS

com.ovaledge.oasis.advance.BuildEncryptDatabrickViews

Create Team Using Roles

com.ovaledge.oasis.advance.CreateTeamUsingRoles

CacheSummaryResults

com.ovaledge.oasis.advance.CacheOEPages

Create AccessCart For Existing Users

com.ovaledge.oasis.advance.CreateAccessCartForExistingUsers

S3 policy marker file reader

com.ovaledge.oasis.advance.S3PolicyMarkerFileReader

Tag Relation Creator

com.ovaledge.oasis.advance.TagRelationCreator

Catalog Creator

com.ovaledge.oasis.advance.CatalogCreator

CDR Integration Job

com.ovaledge.oasis.advance.CDRIntegration

Redshift Column Masking

com.ovaledge.oasis.advance.EncryptRedshiftPII

GDQR Custom Query Process

com.ovaledge.oasis.advance.GdqrCustomQueryJob

Snowflake Tag Sync Service

com.ovaledge.oasis.advance.SyncSFTaggingService

Load Snowflake SQLS

com.ovaledge.oasis.advance.LoadSnowflakeSqlsWithBridge

Migrate Terms to organization and departments

com.ovaledge.oasis.advance.HandleTermsForDQR

ALERT FILE CHECK

com.ovaledge.oasis.advance.AlertFileCheckChanges

DataLake Analysis First Level

com.ovaledge.oasis.advance.DataLakeFirstLevelAnalysisAdvanceJob

 

Appendix C: New System Settings Added in Release6.2

The latest release introduces new configurations that provide users with even greater control over the application's behavior. The newly added configurations are shown in the Table below.


Users & Roles

oe.ropa.contributors

To configure administrative privileges for the ROPA feature, assign a role to perform actions such as adding, editing, and deleting ROPA.

Parameters:

The default value is set to OE_ADMIN.

Select the role(s) by clicking on the field to designate them as ROPA Contributors.

is.apirole.mandatory

This system setting acts as a trigger to authorize access to APIs for roles designated in the system settings "oe.apirole.read" and "ovaledge.api.role".

Parameters:

  • If set to true, the roles defined in both "oe.apirole.read" and "ovaledge.api.role" will be granted the privilege to access the APIs.
  • If set to false, it will override the roles specified in "oe.apirole.read" and "ovaledge.api.role", granting all users the ability to access the APIs.

oe.apirole.read

To grant view access for multiple roles exclusively through the HTTP GET method.

Parameters:

  • The default value is OE_ADMIN.
  • Select the role(s) by clicking on the field to designate them as Project Administrators.

role.rdm.admin

This system setting allows configuring admin privileges to a role for the Reference Data Management feature. Assign a role to perform actions such as creating, deleting, updating stewards, viewing audit trails, and more.

Parameters:

  • The default value is OE_ADMIN.
  • Click on the field to select a role you assign as Reference Data Management Admin.

role.gov-app.admin

To configure administrative privileges to a role(s) for the Governance Application feature to perform actions such as adding, editing, and deleting apps.

Parameters:

  • The default value is set to OE_ADMIN.
  • Select the role(s) by clicking on the field to designate admin privileges for Governance Apps.

Notifications

Description

ms.teams.client.id

Configure the Microsoft Teams client ID for authenticating the integration with Microsoft Teams.

Parameters:

  • The default value is Empty.
  • Enter the value in the field provided.

ms.teams.client.secret

Set the Microsoft Teams client secret to authenticate and authorize access for the integration.

Parameters:

  • The default value is Empty.
  • Enter the value in the field provided.

ms.teams.tenant.id

Specify the Microsoft Teams tenant ID to identify and authenticate the tenant for the integration.

Parameters:

  • The default value is Empty.
  • Enter the value in the field provided.

ms.teams.redirect.uri

Define the Microsoft Teams redirect URI for handling the callback after authentication and authorization.

Parameters:

  • The default value is Empty.
  • Enter the value in the field provided.

google.chat.credentails.path

Provide the file path to the Google Chat credentials for authentication and authorization in the integration.

Parameters:

  • The default value is Empty.
  • Enter the value in the field provided.

Global Search

Description


globalSearch.objectMatch.weightage

This configuration allows users to adjust how search results are prioritized and displayed by identifying matching search keywords in the names and titles of data objects.

 This adjustment depends on the "globalSearch.objectDescriptionsMatch.weightage" and "globalSearch.objectOtherAttributesMatch.weightage" system settings, which adjust results related to descriptions and other attributes respectively. The displayed search results are determined by the greatest value among the three specified system settings.

Parameters:

The default weight is set at 2.

Enter the value in the field provided.


globalSearch.objectDescriptionsMatch.weightage

This configuration allows users to adjust how search results are prioritized and displayed by identifying and matching search keywords in the descriptions (Business, Technical, and Source Descriptions) of data objects. This adjustment depends on the "globalSearch.objectMatch.weightage" and "globalSearch.objectOtherAttributesMatch.weightage" system settings, influencing results related to Names/Title and other attributes respectively. The displayed search results are determined by the greatest value among the three specified system settings.

Parameters:

The default weight is set at 3.

Enter the value in the field provided.


globalSearch.objectOtherAttributesMatch.weightage

This adjustment allows users to adjust how search results are prioritized and displayed by identifying and matching other attributes of data objects (Tags, Terms, Custom Fields, etc). This adjustment depends on the "globalSearch.objectMatch.weightage" and "globalSearch.objectOtherAttributesMatch.weightage" system settings, influencing results related to Names/Title and other attributes respectively. The displayed search results are determined by the greatest value among the three specified system settings.

Parameters:

The default weight is set at 3.

Enter the value in the field provided.


Data Quality

Description

anomaly.detection.analysis.algorithm.selection

These values represent the algorithm that will be used for anomaly detection on different objects.

Parameters:

Enter the algorithm that should be considered to identify anomalies.

anomaly.detection.analysis.algorithm.list

This is used to configure anomaly detection analysis algorithms.

Parameters:

Enter the names of the algorithms that should be used, separated by commas. Currently, we support the 'iqr' and 'deviation' algorithms".

anomaly.detection.analysis.enabled

This is used to activate or deactivate the anomaly feature within the application.

Parameters:

If set to "True", the anomaly feature is activated, allowing it to function as intended.

If set to "False", the anomaly feature is deactivated and the connector and data object-level anomaly-related settings will appear grayed out and will not function until set to “True”.


Service Desk

Description

servicedesk.template.fields.limit

Specify the maximum number of fields that can be configured within a service desk template.  These could include fields such as requester name, issue description, and other relevant information that the service desk template is designed to capture and manage.

Parameters:

  • The default value is 20.
  • Maximum value is 50.
  • Enter the value in the field provided.

servicedesk.approvalworkflow.team.role.limit

Specify the maximum number of users within the team or role who can approve the request.

Parameters:

  • The default value is 5.
  • Maximum value is 20.
  • Enter the value in the field provided.

servicedesk.business.hours

To customize and define the operational business hours in a day (using a 24-hour format) for SLA (Service Level Agreement) calculation. 

Parameters:

  • Value can be entered within the range of 00:00 - 23:59.

servicedesk.business.days

Specify the relevant days considered as Business Days in a week for SLA calculation.

Parameters:

  • Values accepted: Mon (Monday), Tue (Tuesday), Wed (Wednesday), Thu (Thursday), Fri (Friday), Sat (Saturday), Sun (Sunday).

servicedesk.holiday.days

To specify dates that will be excluded from the SLA calculation. This ensures that holidays are excluded from the SLA calculations.

Parameters:

  • Enter dates in dd-mm-yyyy format. The chosen days will not be considered for SLA calculation.

Lineage

Description

lineage.spline.file.connection

To specify the file connection ID for constructing lineage on selected file connections for the Spline connector.
Parameters:
Specify the File Connection ID in the field provided.  

lineage.businessview

The Business View simplifies lineage for non-technical users by displaying only source and target information, excluding intermediary details, for easier comprehension.

Parameters:

  • The default value is set to False.
  • If set to True, the Technical View is enabled, showcasing the detailed flow of lineages.
  • If set to False, the Business View is enabled.

AI

Description

openai.activation.token

It allows establishing a secure connection and utilizing the ChatGPT service. This token serves as the authentication key, allowing OvalEdge to seamlessly integrate and communicate with ChatGPT.

Parameters:

  • Users are required to provide their ChatGPT token in the specified field.

Others 

Description

impactanalysis.source.objects.limit

This configuration allows the user to specify the maximum number of source objects that can be added to a single impact analysis.

Parameters:

Enter the value in the field provided.

status.assignee

This will enable/disable the assignee list in the status popup of Processing Activity and Report summary page.

Parameters:

The default value is set to False.

If set to False,

If set to True, 

bridge.nifiversion

To configure the NiFi Bridge version.

Parameters:

  • Enter the desired version of the NiFi Bridge.

bridge.compressed.value

To control and determine the threshold or size at which data payload compression is applied to any request originating from the bridge side. For Example, if set to 10KB, any data payload exceeding 10 kilobytes in size will be compressed before transmission, whereas payloads smaller than 10KB will not undergo compression

Parameters:

  • The default value is set to 10KB.
  • Enter the desired value in the field provided.

scroll.pagination.search.limit

This limit is to display the number of users for each scroll wherever scroll pagination is available

Parameters:

  • The minimum value is 20.
   

enable.project.statusbar

Enable/disable the Status Bar functionality in the project module.

Parameters:

  • The default value is False.
  • If set to True, the Status Bar functionality is enabled in the project module.
  • If set to False, the Status Bar functionality is disabled in the project module.

supported.folderanalysis.connectors

Specify the connector names on which folder analysis can be performed to determine the size and count of folders.

Parameters:

  • Please enter the value in the provided field.

ovaledge.gov.app.host

This allows the user to configure the host server URL for governance apps, allowing the redirection of users to governance apps via email or direct links.

Parameters:

Enter the URL in the provided field.

header.glossary.reload.limit

To set a limit on the number of domains to be preloaded within the header by configuring a specific value. As users scroll down, the system loads more domains in the background, enhancing performance.

Parameters:

The default value is 20.

The configured value will be the number of domains displayed in the header in one go, with the remaining domains refreshed on scroll.

domain.default.color

This configuration is used to define the default color of the domain icon in the Business Glossary Dashboard.

Parameters:

The default value is 067FA7.

Enter the desired Hexa color code in the field provided. 

domain.icon.max.width

This configuration is used to specify the maximum width of the domain icon in the Business Glossary Dashboard.

Parameters:

The default value is 150 pixels.

Enter the value in the field provided.

domain.icon.min.width

This configuration is used to specify the minimum width of the domain icon in the Business Glossary Dashboard.

Parameters:

The default value is 50 pixels.

Enter the value in the field provided.

questions.wall.panel

To designate stakeholders (users or teams) for the question wall who will receive email notifications when a question is posted.

Parameters:

Enter the users/teams, separated by commas.

ovaledge.extendedheader.display

This configuration is used to control the visibility of the Glossary Terms and Tags carousel header within the application. 

Parameters:

The default value is set to True.

If set to True, the glossary terms and tags section will be displayed across the top in the application.
If set to False, both the glossary section and carousel headers are disabled, ensuring they are not displayed anywhere in the application.

file.tree.pagination.limit

To define and display the maximum number of records in the Data Catalog's file tree view.

Parameters:

  • The default value is set to 100.
  • Input the value in the field provided. 

folder.analysis.api.limit

To set the threshold for the number of API calls allowed for Folder Analysis. When the number of calls reaches the configured threshold, the system automatically stops further calls.

Parameters:

  • The default threshold is set at 5000.
  • Enter the value in the field provided.

bridge.request.timeout

It is used to configure bridge request timeout interval

ovaledge.instance.name

Allows to set the environment name to display it under the OvalEdge icon in the top left corner of the main header. Additionally, notifications will have a prefix indicating the instance type (e.g., dev, prod) for users to distinguish notifications based on the instance.

Parameters:

The default value is set to empty.

Enter the  Instance Name in the field provided. Supports alphanumeric characters up to 15 characters length.



Appendix D: System Settings Modified in Release6.2


System Setting Name

Description

tag.multiple.parent.hierarchy

The default value has been altered from true to false for this system setting.

This configuration setting provides users with the flexibility to create tags with the same name under different root tags.

Parameters:

If set to true, users can create tags with the same names under different root tags.

If set to false, it mandates unique tag names, disallowing the use of identical tags or duplicates, need to run the advance job - Update Tag Hierarchy to update the hierarchies for existing tags.

application.defaulttheme

Previously, this system setting was configurable. 

Now, by default, the blue theme is set to be the default theme, which colorizes the entire user interface in blue hues. The default theme cannot be altered in the current version. 

globalsearch.es.objecttabs.display

The search results now include API, API Attributes, Ropareports, processing activity.


Appendix E: System Settings Removed in Release6.2


ovaledge.jarpath

Configure the jar files path to support crawl/profile. Example: D:\Jars

Parameters:

The default value is /home/ovaledge/third_party_jars.

Enter the path of the jar files in the field provided.

ovaledge.dqrule.bg.enforcement

Configure to execute Data Quality Rules only when the Term is applied.

Parameters:

The default value is False.

If set to True, then a term should be associated with the object to execute the Data Quality rule.

If set to False, then a term is not needed to execute the Data Quality Rule.


ovaledge.dqr.topvalue.separator

Define a separator to give a set of input fields for the Top Value function>Values field. For Example If / (slash) is used as a separator, then the input values can be separated as red/yellow/blue.

Parameters:

The default value is comma (,).

Enter the value in the field provided.

remote.user.password

Assign default password to all the Remote users fetched to the OvalEdge application.

Parameters:

  • Enter the password in the field provided.

enable.dq.policy

Show/hide the Data Quality Policies sub-module in the application menu under the Governance Catalog module in Data Quality.

Parameters:

If set to True, the Data Quality Policies sub-module is displayed in the application menu.

If set to False, the Data Quality policies module is hidden.

display.tree.tagtile

Show/hide the tree structure inside a tile on Tags>Tiles page.

Parameters:

The default value is True.

If set to True, the Tags hierarchy is shown for all the Tags on the Tiles page.

If set to False, the Tags hierarchy is disabled.

dashboard.dqsb.mode

To set the DQR mode to DQSB or ALL.

Parameters:

The default value is ALL.

Enter ALL or DQSB in the field provided.

dataquality.catalogobjects.additionalcolumns

To set a limit on the number of parameters that can be configured within Additional Column details for the Data Quality Center. For instance, when set to a value such as 10, it enforces a maximum limit of 10 parameters that can be configured for the additional columns.

Parameters:

Enter the value in the field provided. The Maximum limit is 20.

show.home.graphicalcount 

To show/hide the display of graphical presentations such as Tables, Files, and Reports on the home page.

Parameters:

If set to true, the graphs will be displayed.

If set to false, the bar graph of objects will not be displayed.

tag.multiple.parent.hierarchy

This configuration setting provides users with the flexibility to create tags with the same name under different root tags.

Parameters:

If Set to True: Users can create tags with the same names under different root tags.

If Set to False: It mandates unique tag names, disallowing the use of identical tags or duplicates.

default.term.relationname

Configure the OvalEdge application default term relation name when relating an object to a term.

Parameters:

The default value is related to.

You can pass only 1 relation type name.



questions.wall.notification.email

To control whether the users tagged in the question wall should receive email notifications.

Parameters:

If set to 'Empty, email notifications are sent to the users if the user is tagged in the Questions Wall.

If set to False, email notifications are not received.

sqlserver.profile.columnlength