Virtual Machine (VM)

This article provides comprehensive guidance on migrating OvalEdge from Release6.3.4.x to Release7.2.x in a Virtual Machine (VM)-based deployment. It outlines prerequisites, backup steps, migration procedures, and post-migration validation tasks to ensure a smooth and secure upgrade.

Prerequisites

Before initiating the migration, ensure the following:

Infrastructure and System Requirements

Ensure the operating system and environment support upgraded RAM and SSD space requirements for optimal performance.

Database Upgrade

OvalEdge Release7.2.x requires MySQL 8.4.x or higher.
✅ Upgrade MySQL using appropriate guides:

⚠️ Ensure the database backup is completed before the upgrade.

Java Upgrade

OvalEdge Release7.2.x requires Java 17.x.
- Refer to: Java Upgrade 17.x on Windows

Tomcat Upgrade

Recommended upgrade to Apache Tomcat 9.0.x or higher.
Refer to:
- Tomcat Upgrade from 9.0.x to 10.1.x on Windows
- Tomcat Upgrade from 9.0.x to 10.1.x on Linux

⚠️ After Tomcat upgrade:

Update server.xml to enable compression and verify ports/SSL settings.
Add <Resources cacheMaxSize="102400"/> in context.xml.
Restart Tomcat and review logs for errors.

ElasticSearch Upgrade

Upgrade to ElasticSearch 7.17.x.
Refer to:
- Elasticsearch Upgrade on Windows
- Elasticsearch Upgrade on Ubuntu

Configuration Externalization

✅ Externalize oasis.properties
- Refer to:
  - Externalize Oasis Properties (Windows)
  - Externalize Oasis Properties (Linux)
✅ Externalize log4j.properties
- Refer to:
  - Externalize log4j.properties

Backup Procedures

Before initiating the migration, perform the following backup steps to safeguard the environment and ensure a smooth recovery in the event of failure.

Take a Full Database Backup

Use MySQL tools or database management utilities to create a full backup of the OvalEdge database (MySQL or MariaDB).
Ensure the backup includes all schema, data, triggers, and procedures.
Store the backup securely in a location with restricted access.
For detailed instructions, refer to: [OvalEdgeDB Backup Process]

Table and Row Count Validation

Validate and record the row counts of all critical database entities before migration.
Refer to: DB Migration Checklist.

Backup Application WAR Files

Navigate to the Tomcat installation directory on your VM.
Go to the webapps folder.
Copy and save the WAR files (OvalEdge-related deployments) to a secure backup location.
Verify the integrity of copied files using file hashes or checksums if required.

Backup JAR Files (Connectors, Lineage, Advanced Jobs)

Navigate to the External Jars Directory > third_party_jars location.
Copy all existing JAR files, including:
- csplib libraries
- Oe-lineage.jar
- Oe-advancejob.jar
- Any custom connector JARs (for big data or client-specific connectors)
Save these files in a backup folder on a secure storage drive.

Backup the Shared NFS Repository

Identify the location of your shared NFS folder (typically mounted for storing large or shared files).
Copy the complete contents of this NFS directory to a backup location.
Validate that all files have been copied successfully.

Backup the Tomcat Server Structure

Take a copy of the Tomcat installation directory or its key folders.
Specifically, back up the following subdirectories:
- webapps (ensure WAR files are included)
- logs (retain for troubleshooting if migration fails)
- conf (for Tomcat configuration files)
Clear the following Tomcat directories (except critical files as noted):
- webapps (clear old deployed apps after backup)
- temp (do not delete JAR files accidentally)
- logs (clean old logs to reduce clutter)

Backup System Settings

Connect to the OvalEdge database using your preferred DB client.
Export the system settings table in XLSX format.
Ensure that this export captures all configuration data for the system’s default and custom settings.
For detailed instructions on exporting database tables, refer to: [MySQL Table Backup to CSV/XLSX Guide]

Take a VM Snapshot (Optional)

If your virtualization environment allows (e.g., VMware, Hyper-V), create a snapshot of the VM.
This provides an additional rollback point if system-level recovery is required.
- All backups should be labeled with the date and time, as well as the migration version (e.g., pre-7.2-migration-2025-06-13).
- Store backups in secure, access-controlled locations, and verify their integrity before proceeding.

Migration Process

WAR Replacement

Download WAR files from the link provided via email.
Replace existing WAR files in Tomcat/webapps with the new WAR.

JAR Upgrade

Connectors and Lineage JARs
- Replace existing JARs in External Jars Directory/third_party_jars with:
  - Updated csplib (e.g., csp-lib-7.2-RELEASE-with-dependencies.jar)
  - Updated oe-lineage.jar
  - Updated big data connector libraries (if client-specific)
Advanced Job JAR
- Update oe-advancejob.jar.

Configuration Update

Update oasis.properties
- Set DB connection, SSO, Elasticsearch, and external dependencies.
- Ensure proper configuration storage in Key Vaults if applicable.

Restart Tomcat Service

Restart the Tomcat service to apply changes.

Post-Migration Validation

Table and Row Count Validation

Validate row counts using provided SQL scripts (refer to: Tables and Row Count Validation Scripts).
Ensure pre- and post-migration counts match.

Application Verification

Confirm the deployment of the latest features and enhancements.

Run Migration Jobs

After upgrading to Release7.2.x, it is mandatory to:
- Execute all migration jobs introduced in Release7.2x to ensure that data structures, configurations, and system components are aligned with the new version.
- Re-run any migration jobs executed until Release6.3.4.x that are still applicable to ensure data consistency and integrity across the environment.
- For detailed information about the migration jobs introduced in Release7.2.x, refer to the Release7.2.x Migration Jobs Sheet.

19KB

OvalEdge_Release7.2.x_Migration _Jobs_Sheet.xlsx

Open

Run Advanced Jobs

After migrating to Release7.2.x, it is essential to:
- Execute all new advanced jobs introduced in Release7.2.x to ensure the proper functioning of new features and enhancements.
- Re-run all advanced jobs that were executed until Release6.3.4.x to maintain data integrity and consistency in the upgraded environment.
- For details on the advanced jobs introduced in Release7.2.x, refer to New Advanced Jobs (Release6.3.4.x to Release7.2.x) in the Appendix.

Verify System Settings

After completing the migration, ensure that all new system settings introduced in Release7.2.x are configured as required to support the latest functionalities and enhancements.
No changes are needed for existing system settings unless specifically required for your environment.
For a complete list of new, modified, and deprecated system settings in Release7.2.x, along with guidance on their configuration, refer to New System Settings (Release6.3.4.x to Release7.2.x) in the Appendix.

Rollback Plan

If migration fails:

✅ Restore the database from backup.
✅ Restore WAR/JAR files.
✅ Revert configurations (oasis.properties, log4j.properties).
✅ Roll back Tomcat, Java, and ElasticSearch versions if necessary.
✅ Restore VM snapshot (if available).

Important Notes

After the Tomcat upgrade, verify the compression settings, ports, and SSL configuration.
Confirm context.xml cache configuration is applied.
Always validate Tomcat logs after a restart.

Appendix

New Advanced Jobs (Release6.3.4.x to Release7.2.x)

Version

Advanced Job Name

Description

Release7.2.4

QlikSense Metadata Export Service

This job exports the metadata of Qlik Sense apps to files.

Release7.2.4

ConnectorLevelSemanticMapping

This job helps migrate temporary lineage schemas by updating their connection reference and replacing "templineage" with the original connection name.

Release7.2.4

Business Glossary Associated Count Stats

This job consolidates and migrates the counts of objects associated with terms into a single unified table for better consistency and reporting.

Release7.2.4

Update Project Task Weight Factors in Bulk

This job calculates and updates task and baseline weight factors for all projects in batches, helping the Advanced project management fields work as intended.

Release7.2.4

Migration Data Metrics

This job captures all the important data metrics from all configured modules.

Release7.2.3

Merging Temp Lineage Tables in Bulk

This job merges temporary lineage tables into their original tables within a specified schema in bulk.

Release7.2.3

Fetching Labels for Synapse Columns

This job helps fetch Synapse labels at both the table and column levels.

Release7.2.3

Table Archival

This job archives data present in the table according to the specified retention period. For example, if the retention period is set to 5 days, the recent 5 days of data will persist, and all other data will be deleted and archived in CSV format into the specified temppath/table_archival/.

Release7.2.2

Migrate Descriptions From Alation

This job loads object metadata from the Excel sheets in the given folder path into the stage table. Then it reads descriptions from the OvalEdge database, updating the references from the Alation format to the OvalEdge format.

Attributes:

Folder Path: Path of the folder that contains the Excel sheets of object metadata required to identify the related object IDs in the database
Load Excel Data to stage table(true/false)?
1. The default value is true.
2. If set to True, the job first loads the data into the stage table from the sheets in the given folder path and then updates the references.
3. If set to False, the job does not load any data; instead, it updates the references directly. It must be False when the user re-initiates the job on the same folder path, which prevents data duplication.

Release7.2.2

User Favorite Code Migration Job

This job migrates user favorite codes by matching navigation links to appropriate favobj values. It processes all user favorites in the userfavorite table and updates their favobj column based on the link patterns.

Release7.2.1

Update Servicedesk Date columns from UTC to Database time zone

This job converts ticket creation and SLA (Service Level Agreement) dates from UTC to the database Time Zone. It also processes all tickets created after the first build date for the Release6.3 version.

Release6.3.4.2

GDQ Compliance Data Migration

This job transfers entries from the deprecated GDQ table to the active GDQ table.

Release7.1

Advanced Job for Inserting data into the Lineage table

This job allows the insertion of data into the Lineage Table to build the Connection Dashboard view.

Release7.1

Load Axiomatics Policies

This job will take a folder or file (in JSON format) as input that contains Axiomatics Policies and load them into OvalEdge. This job is also used to reconcile policies if any discrepancies are identified between OvalEdge and Axiomatics.

Release7.1

Caching of Business Applications from UPC

This job will sync business applications from UPC to OE cdr_products. These products will be consumed for raising the Service Requests

Release7.1

MetaData Change Report Sync Service

This job imports all data from an XLSX sheet and inserts it into the database, removing any existing records.

Release7.1

DataLake Analysis Second Level

This is no longer required and can be deleted.

Release7.1

Retry Fulfillment for Service Requests

This job collects Service Requests that are in Fulfillment Error and attempts to re-initiate their fulfillment. It groups the Service Requests by Template ID. If the retry fails for the first request in a group, the entire group is skipped, and the process moves to the next group, assuming the integrated system has not yet recovered.

Release7.1

Delete Inactive Users for SSO

The purpose of this job is to delete inactive users in OvalEdge by verifying their status in Azure Active Directory (Azure AD).

Release7.1

Assign Role to Users

This job takes a role as input and assigns that role to all the users in OvalEdge.

Release7.1

Cascade Customfields for Buckets

This job cascades custom fields from buckets to their downstream folders and files. Two attributes need to be specified for this job:

attribute1: The S3 Connection ID

attribute2: The bucket name, if only a single bucket is to be processed.

Release7.1

Cascade tags to the folder and files

This job aims to cascade tags from a bucket to its downstream folders and files. Two attributes need to be specified for this job:

attribute1: The S3 Connection ID

attribute2: The bucket name, if only a single bucket is to be processed.

Release7.1

Update TicketParams For Snowflake

This job updates the ticket parameters for a Snowflake connection, including field code, field type, and option value.

Release7.1

Sync DQ Policy Execution Summary to OE

This job synchronizes the policy execution summary results to OvalEdge (OE).

Release7.1

Cache scopes associated with a Business Application

This advanced job retrieves the scopes associated with the Business Application and caches them in OvalEdge.

Release7.1

Crawl Snowflake Users and Roles

This job crawls users, roles, and warehouses for a Snowflake connection.

Release7.1

Process KAFKA ACLs Dump File For Audit

This job loads the specified file and processes the ACL's information into the audit table. It is exclusively designed for the Kafka connector. Ensure that both the Crawler ID/Name and File Name (only .xlsx files are supported) are provided.

Release7.1

Update SR data for Backward Compatibility

This job updates the default data for existing tickets by adding new fields.

Release7.1

Update Group Info for Service Requests

This job updates the Group Info for existing Service Requests, excluding API Access Requests.

Release7.1

S3 to Snowflake Lineage using DDL Commands

This job creates a lineage from S3 to Snowflake.

Release7.1

Build Lineage from Excel File

This job will build the lineage from an Excel file.

Release7.1

Add connection details to ticketparam2

This job adds connection details to the ticketparam2 table.

Release7.1

Update Fulfillment Detail for Service Requests

This job updates the Fulfillmentdetailid for pending Service Requests.

Release7.1

Remove Access For Inactive Tables

This job removes access for inactive objects.

Release7.1

An advanced Job for Indexing Existing

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

Enter the names of the object types that need to be supported in Attribute1, such as 'oetable' or 'oeschema'. The data corresponding to the specified object types will be indexed in Elasticsearch. If multiple object types need to be indexed, separate them with commas. If no object types are provided, data from all object types will be indexed.

Attributes:

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

Release7.1

Upgrade Image Avatars

This job upgrades the image avatars from a circular shape to a square.

Release7.1

Generate GUID

This job will generate GUIDs for existing unassigned catalog objects, tags, and terms. A GUID is a unique identifier for objects within the application. This job will generate and assign the unassigned objects with GUIDs.

Release7.1

Tableau columns curated info moving from the report to the Datasource

This job transfers curated information from the report column to the data source column.

Release7.1.1

Migration of Mention and Myaction Comments

This job updates the tab column in the comment table with either "Mention" or "My Action" for existing messages. All pre-existing messages will be marked as Read, except for My Action messages, which will remain pending without requiring any further action.

This Advanced Job should be executed only once after the migration."

Release7.1.1

Inconsistent Objects Diagnostic & Cleanup

This job identifies and removes inactive objects from OvalEdge to maintain metadata accuracy. When executed, it provides a diagnostic report on the number of inactive parent objects in the job logs. If the cleanup attribute is set to true in Attribute1, the job will proceed to delete these inactive objects while ensuring hierarchical integrity, removing dependent child objects. By default, the cleanup attribute is set to false, allowing admins to review the impact before performing deletions.

Release7.1.1

RDAM Deleted Instance Migration

This job will migrate deleted RDAM instances and their associated records to ensure consistency following the version upgrade.

Release7.1.1

Image Upload Security Enhancement

This job updates the identifiers of previously uploaded images in the Business Description, Technical Description, and other fields in the Froala Editor. Previously, images were stored with sequential IDs, which posed a security risk as users could access other uploaded images by modifying the URL. Running this job after migration replaces all existing image IDs with unique, non-sequential keys, ensuring enhanced security and preventing unauthorized access.

Release7.1.1

Advanced job for adding a subject to the comment table

This job adds subject information for team-related notifications, ensuring that the details appear in the My Recent Notifications widget on the homepage.

Release7.1.1

IPC Parameter file processing

This job copies the parameter file from a remote machine to a local machine and processes the file for configuration details.

Release7.1.1

OvalEdge User Licenses AD Verification

This job generates a comparison report that includes users in Active Directory (AD) groups and users with OvalEdge licenses.

Attributes:

Attribute1: Compare Azure AD Groups with Author License (comma-separated).

Attribute2: Compare Azure AD Groups with Viewer License (comma-separated).

Attribute 3: Notify Users (comma-separated) - Enter the users to notify.

Attribute4: Notify Team (comma-separated) [The users in the Team will be notified] - Enter the team names.

Attribute5: Notify Roles (comma-separated) [The users of the given Roles will be notified] - Enter the roles.

Release7.1.1

Collaboration Message Migration

This job migrates all collaboration messages older than Release 6.2 and should be executed only once after the migration is complete.

Release7.1.1

Compare Axiomatics Policies

This job compares Axiomatics policies created or updated via API Access Requests from OvalEdge with the existing policies in the Axiomatics application. It identifies and logs any discrepancies in the job logs. An email is sent with an attachment listing the mismatched policies. This process helps in understanding and reconciling any discrepancies.

Release7.1.1

Ovalsight Bridge Migration

This job creates multiple DuckDB files, specific to each connector, from an existing DuckDB file.

Release7.1.1

License Issue

This advanced job, related to migration, aims to add additional attributes to certain existing connectors, fetch unique values for the connectors, and update the license accordingly.

Release7.1.1

Advanced job for updating Deltalake custom fields

This advanced job will update technical and business descriptions for tables in Delta Lake.

Release7.2

Curated report column info that maps to the appropriate reporting object based on the connector

This job enables the movement of curated column-level metadata from higher-level reporting objects to their associated downstream entities, supporting consistent metadata alignment across all connectors.

Release7.2

Migrate Tag Role to Master Tag Admin

This job migrates all users and roles from ovaledge.tag.role to ovaledge.mastertag.admin to align with the new Master Tag-based tag management model. Use this job to ensure continuity in tag administration.

Release7.2

Restore archived data

This Job allows users to retrieve historical data related to tags and terms that were previously archived and are no longer visible in the application. It ensures continuous access to past operations for auditing and compliance purposes. Users can restore the archived data into the original or a temporary table, making it easier to track changes, maintain data governance, and meet regulatory requirements even after data has been archived.

Note: This Job is run based on the client's request

Release7.2

Reset Time Zones For Schedule

This job updates the time zones for schedules that do not have a valid time zone associated with them. It will update the time zone to match the server's time zone.

Release7.2

Profile By Importance Score

This job allows admins to perform targeted profiling of tables based on their Importance Score. Users can specify a threshold range (e.g., 80-100) to profile only the most critical tables within that range. The job supports filtering by a specific connection and its associated schemas. Attributes:

Attribute 1: Connection ID (Required) Enter the ID of the connection. Only one connection can be selected per job.

Attribute 2: Schema IDs (Optional) Provide one or more schema IDs. All schemas must belong to the selected connection.

Attribute 3: Low Range (Required) Enter the lower limit of the Importance Score range (e.g., 80). The value should be between 0 and 100.

Attribute 4: High Range (Required) Enter the upper limit of the Importance Score range (e.g., 100). The value must be greater than the Low Range and less than or equal to 100.

Release7.2

Azure SQL Database Masking Sync

This job is run to fetch details of all the corresponding masked Azure SQL Database columns from the source into OvalEdge.

Attributes: 1. Connection Id

Note: Only Security and Governance admins of the corresponding connection (Defined while creating a connection) and OvalEdge’s super admin (ovaledge.role.admin) can run this job.

Release7.2

StoryZoneAllowContentEditMigration

This job is run when migrating from R6.x or R7.2 to allow adding or editing content to Data Story Zones.

Release7.2

Migrate Ropa Dropdown Data

This job migrates data from multiple ROPA tables to a single unified ROPA table.

Release7.2

Migrate TCF Text TO Rich Text

This job converts existing text to rich text format for custom text fields.

Release7.2

Migrate Homepage Widgets

This job migrates the Homepage Widgets layout from 6.3.x and 7.x versions to the 7.2 version.

Code Custom Fields Options CleanUp

Running this advanced job, the code custom field values will appear beside the custom field level in the same table in the backend.

Note: No attribute is required to execute this job.

New System Settings (Release6.3.4.x to Release7.2.x)

Job Parm Key

Revised Content

Impacted Modules

application.font.family

It allows users to select the font displayed in the application interface. The selected font will be applied across the application. Available options: Open Sans, Lufga Regular, Lato, Arial, Roboto

Parameters:

The default font is Roboto

All Modules

openai.base.url

It allows users to specify the base URL for OpenAI if an API gateway is used between the application and OpenAI.

Parameters:

The default value is Empty

Leave this field blank if there is no gateway configured.

openai.timeout

It allows users to set the timeout duration for OpenAI API calls in seconds.

Parameters:

The default value is 30 seconds

show.ai.additional.prompt

It allows users to enable or disable the additional prompt text field in the AI generation component while generating descriptions through AI.

Parameters:

The default value is True

If True: Displays the additional prompt text field.

If False: Hides the additional prompt text field.

Data Catalog, Business Glossary

ovaledge.upload.tempfile.temppath

Specifies the temporary server folder path used to validate files before uploading.

Parameters:

The default value is /home/ovaledge/TempPath

Enter a valid temporary path in the field provided.

File Manager and My Profile

dashboard.dataquality.dqscoretrend.maximumvalues

This setting allows users to configure the maximum number of data points displayed for a specific time interval.

Parameters:

The default value is 30

Maximum value: 200

ovaledge.policy.creator

It allows the OE_Admin to assign Policy Creator privileges to specific roles.

Parameters:

Default value: OE_ADMIN

OE_Admin can select one or more roles from the dropdown list.

Policy Manager, Data Catalog

enable.policy.manager

It allows users to enable or disable the visibility of the Policy Manager module under the Governance App.

Note: A system restart is required for the changes to take effect.

Parameters:

The default value is false

True: The Policy Manager module is visible to users.

False: The Policy Manager module is hidden from users.

Policy Manager, Data Catalog

show.timeout.popup

It allows users to control the visibility of the session timeout pop-up.

Parameters:

The default value: true

If set to true, the timeout popup will be displayed before the session expires.

If set to false, the timeout popup will not be shown.

restrict.concurrent.logins

It allows administrators to restrict users from logging in concurrently from multiple sessions.

Parameters:

Default value: false

If set to true, Users are restricted from logging in simultaneously from different sessions.

If set to false, Concurrent logins are allowed.

dashboard.report.type.restricted

It allows users to restrict certain report types from being added to custom dashboards.

Parameters:

The default value is Empty

Users can enter or select report types from the dropdown to restrict their use in dashboards.

Custom Dashboards

bulkai.batchapi.outputfile.download.start.delay.minutes

It allows users to set the wait time before the system tries to download the output file metadata from OpenAI during bulk AI Description curation batch processing.

Parameters:

The default time is set to 30 minutes

Users can change the wait time between 0 to 60 minutes.

etl.new.connectorid

It allows users to specify the new connector ID for running ETL jobs.

Parameters:

The default value is Empty

Enter the connector ID on which ETL jobs should be executed.

Connectors, Jobs

ovaledge.concat.delimeter

It allows users to specify the delimiter used to join multiple values into a single field.

Parameters:

The default value is Comma

Enter a character (e.g., semicolon, #, $ ) to be used as the delimiter.

Data Catalog, Business Glossary, DQR, Load Metadata From Files, APIs

Code Custom Fields

ai.generatedesc.prompt.metadata

It lets users automatically generate descriptions for either Object Metadata or Underlying Attribute Metadata.

Object Metadata: Uses the object’s hierarchy and existing descriptions.

Underlying Attribute Metadata: Uses the object’s metadata along with its attributes and relationships.

Default value: Object Metadata

Data Catalog, Business Glossary

ai.bulk.description.enable

It allows users to enable or disable the Bulk AI Description generation feature.

Parameters:

The default value is True

If true, enables bulk AI description generation.

If false, disables the feature.

Data Catalog, Business Glossary

allowed.file.types.for.file.upload

It allows users to define which file types can be uploaded and cataloged from external sources.

Parameters:

The default value is pdf, txt, rtf, docx, odt, xlsx, ods, csv, pptx, odp, jpg, jpeg, png, gif, bmp, tiff, tif, svg, json, xml, log

Users can choose the allowed file types for uploading in service requests.

Files not included in the list will be rejected.

Service Desk

service.desk.file.upload.storage.service

It allows users to configure where files uploaded from Governance Apps are stored.

Parameters:

The default value is Empty

Users can select a storage service (NFS, S3, or Azure) to store files uploaded through the Service Desk.

If no option is selected, the file storage location remains unconfigured.

Service Desk

service.desk.file.upload.connector.id

It allows users to specify the connection ID for the selected storage service.

Parameters:

The default value is EmptyUsers must enter the connection ID associated with the chosen storage service.

Service Desk

service.desk.file.upload.bucketname

It allows users to specify the bucket name for the selected storage service.

Parameters:

The default value is Empty

Enter the bucket name for the storage service. This is mandatory for S3 and Azure.

Service Desk

candelete.application.diagnostic.data

This setting controls whether users can delete application diagnostic data.

Parameters:

The default value is True

If true, Users can delete diagnostic data.

If false, Deletion of diagnostic data is restricted.

ovaledge.email.server.type

It allows users to select the type of email server used for sending notifications.

Parameters:

The default value is SMTP.

Users can choose the server type from the dropdown list (SMTP, AWS SES, and Azure Graph API).

Based on the selection, the relevant configuration fields will be enabled.

Notifications

ovaledge.azure.graphapi.emailaddress

It allows users to specify the sender email address used for sending notifications through the Azure-authorized application.

Parameters:

The default value is EmptyNote: Users must enter a valid and active email address associated with a Microsoft Outlook account within the organization’s environment. The Azure application will use this email to send notifications on the user’s behalf.

Notifications

ovaledge.azure.graphapi.tenantid

It allows users to specify the Tenant ID from the Azure application registration.

Parameters:

The default value is Empty

Users must enter the Tenant ID associated with your organization's Azure Active Directory.

Notifications

ovaledge.azure.graphapi.clientid

It allows users to specify the Client ID of the OvalEdge application from Azure application registration.

Parameters:

The default value is Empty

Enter the Client ID assigned during Azure application registration.

Notifications

ovaledge.azure.graphapi.clientsecret

It allows users to store the Client Secret generated during Azure application registration securely.

Parameters:

The default value is EmptyEnter the Client Secret obtained from the Azure portal for the registered application.

Notifications

ovaledge.awsses.smtp.server

It allows users to specify the AWS SES SMTP Server URL for sending email notifications.

Parameters:

The default value is Empty

Enter the SMTP Server URL provided by AWS SES.

Notifications

ovaledge.awsses.smtp.port

It allows users to specify the AWS SES SMTP Server Port used for sending email notifications.

Parameters:

The default value is Empty

Enter the port number provided by AWS SES (e.g., 25, 465, or 587).

Notifications

ovaledge.awsses.smtp.mode

It allows users to specify the mode used by the AWS SES SMTP server for secure communication.

Parameters:

The default value is Empty

Enter the server mode (e.g., TLS, SSL) based on your AWS SES configuration.

Notifications

ovaledge.awsses.smtp.username

It allows users to specify the username for the AWS SES SMTP server.

Parameters:

The default value is Empty

Enter the SMTP username provided by AWS SES to authenticate and send email notifications.

Notifications

ovaledge.awsses.smtp.password

It allows users to specify the password for the AWS SES SMTP server.

Parameters:

The default value is Empty

Enter the SMTP password associated with the AWS SES username. This is required for authenticating and sending email notifications.

Notifications

ovaledge.awsses.smtp.from.address

It allows users to specify the email address used to send notifications through the AWS SES SMTP server.

Parameters:

The default value is Empty

Note: This must be a verified email address in your AWS SES configuration.

Notifications

project.baseline.limit

It enables users to set the number of baselines for a project, thereby enhancing performance.

Parameters:

Default value: 5

Users can set as many baselines as needed.

Projects

projects.advanced.mode.enable

It allows users to show or hide specific fields (Plan View, Task Categories, % Complete, Estimated Effort, Time Log, Remaining Effort, and Extended Bulk Update) in the Projects module.

Parameters:

The default value is false

If set to true, Fields will be visible for users to input data.

If set to false, these fields will be hidden.

Projects

projects.beta.mode.enable

It allows users to show or hide specific fields (Project Groups, Parent Tasks, Project Audit, Baseline Feature, Dependencies, and Custom Fields) in the Projects module, including Task Shutter and List View.

Parameters:

The default value is false

If true, fields will be visible to users for data input.

If false, these fields will be hidden.

Projects

dataquality.rulescore.calculation.method

It allows users to choose how the Data Quality Score is calculated, either Object-Based or Row-Based.

Parameters:

The default value is Object-Based

If Object-Based, the Score is calculated based on how many rules each object passes.

If Row-Based, the Score is calculated based on how many rows meet the rule conditions.

Data Quality

escape.sequence.regex

This setting uses a regular expression to replace predefined special characters with escape sequences when cloning a Business Glossary Term.

Parameters:

The default value is([\^$\.*+?()[\]{}|/&#])

Note: Users can add any special characters in the value to replace them with escape sequences.

Business Glossary

ovaledge.GDQ.admin

It allows OE_Admin to assign GDQ Admin privileges to specific roles.

Parameters:

The default value is OE_Admin.

OE_Admin can select one or more roles from the dropdown list to assign GDQ Admin privileges.

GDQ

home.lastlogin.enable

It allows users to enable the display of the last successful login date, time, along with the timezone, and displays the number of failed login attempts between the Last successful login and the current login below the header section.

Parameters:

The default value is False. If True, enables the last login date along with timestamp and unsuccessful login attempts. If false, it disables the display of the previous login information.

Home Page

search.es.searchcontext

Configure to view the object types in the Search box drop-down list.

Parameters:

Available object types: All, Table, Topic, File, Report, API, Schema, Query, Data Attributes, Business Glossary, Service Request, Help & Resources, Project, Question Wall.

The default value is All.

To add more objects to the Value, select them from the drop-down list. The assigned values appear in the Search drop-down.

If left blank, "All" is displayed.

Global Search

search.es.pagination.count

Configure to specify the maximum number of records to be added to an Index while running the advanced job to fetch from the local DB to Elasticsearch.

Supports: Min - 5000, Max - 10000.

Parameters:

The default value is 5000.

Enter the required value in the field provided. Based on the specified value, the records will be added to an Index.

Global Search

search.es.activedetails

Configure to show the active objects in the search results.

Parameters:

The default value is Active.

If set to Active, active objects are displayed in the search results.

If set to Inactive, inactive objects are displayed in the search results.

If set to Empty, then both the active and inactive data object results are displayed in the search results.

Global Search

search.score.use.synonym

Configure to include the Synonym score in the Relevance score formula to determine the most relevant search results.

The relevance score is calculated based on three components: the Elasticsearch score, the popularity score, and the synonym score (if configured).

Parameters:

The default value is False.

If set to True, the search results calculation includes the Synonym score.

If set to False, the search results calculation excludes the Synonym score.

search.score.use.popularity

Configure the Popularity Score in the Relevance score formula to determine the most relevant search results. The relevance score is calculated based on three components: the Elasticsearch score, the popularity score, and the synonym score (if configured).

Parameters:

The default value is False.

If set to True, the search results calculation includes the popularity score.

If set to False, the search results calculation excludes the popularity score.

The relevance score calculation depends solely on the Elasticsearch score and the settings configured for the synonym score.

enable.slack.communication

Configure to enable or disable Slack on the My Profile page.

Parameters:

The default value is False.

If set to True, the Slack option is enabled.

If set to False, the Slack option is disabled.

My Profile

alert.popup.duration

Specify the time in seconds to show the alert.

Parameters:

The default value is 3

Min value - 3

Max value - 15

Note: Recommended duration is 5.

All Modules

ovaledge.font.family

Configure to set the font across the application from the predefined fonts: Lufga, Open Sans, Roboto, Arial, and Lato.

Parameters:

The default value is Empty.

Based on the specified value, the application font will be applied.

All modules

home.videos.viewall.link

Configure to redirect the specific helpful resources link.

Enter the particular URL in the Value column.

Home

ovaledge.main.logo

Configure to upload the primary logo to the top-left black bar.

Enter the specific image in the Value column.

Application

ovaledge.login.logo

Configure to upload the logo for display at the login page.

Enter the specific image in the Value column.

Allowed image types: png, jpeg, and jpg

deployment.service.msg

Configure to enable or disable the service message that notifies users about latency information during the deployment process.

Parameters:

The default value is False.

If set to True, the service message to notify users about latency information in the deployment process is enabled.

If set to False, the service message that notifies users about latency information during the deployment process is disabled.

Home

deployment.msg

Configure to customize the deployment message.

Parameters:

The default value is blank.

The message entered in the Value column is displayed as a service message.

Home

deployment.date

Configure to set the time duration to show the service message.

Parameters:

The default value is blank.

Enter the time in mm/dd/yyyy hh:mm format.

Home

dataquality.score.external.max.score

Configure the base score for the Data Quality score calculation.

enable.user.delete.toggle

Configure to view/hide the Delete and Deactivate options in the Delete/Deactivate drop-down list in the Users&Roles.

Parameters:

The default value is False.

If set to True, the Deactivate option will be displayed.

If set to False, the "Delete" and "Deactivate" options will be displayed.

Users & Roles

search.es.active.filters

Configure the specific active filters used on the Global Search page to refine search results. Each filter corresponds to a specific attribute of the search items, allowing users to refine their results based on various criteria. Users can remove filters according to their specific requirements.

Parameters:

The default values are Connection, Schema, Business Glossary, Table Type, Folder, Report Group, Term Status, Quality Index, Service Request Status, Question Wall, Additional Information, and Created Date.

Enter the required value in the field provided. Based on the specified values, filters will be displayed on the Global Search page.

Global Search

globalsearch.match.type

Configure the Global Search function that analyzes search queries against document fields:

- best_fields: This type optimizes precision by searching multiple fields and returning the highest score for the best match.

- most_fields: This type is used to optimize recall, which means it adds the scores of each match across multiple fields to increase overall relevance scores.

- cross_fields: This type analyzes multiple fields as a single combined field, increasing relevance for queries that span multiple fields. It's beneficial for searches that are expected to have various terms across different fields.

Global Search

ovaledge.mastertag.creator

Configure to create a Master Tag privilege for the specified role.

Parameters:

The default value is OE_ADMIN.

Choose the specified roles from the drop-down list in the Value column to add more roles.