The application configuration guide is a document that explains the configuration that has been set up for the OvalEdge application. Through configuration, the admin user can control and modify the behavior of the OvalEdge application to meet the organization's needs.
To set up a new configuration
The configuration module is designed with various elements of a configuration. The configuration has been divided into sections: System Path, User & Roles, Lineage, Notifications, SSO, Proxy, Audit Data Archival, Splunk, File Scanner, and Others.
Following are the steps to add a configuration,
- Click on the + Add a custom configuration located in the top right corner of the screen.
- Enter the details (Type, Key, Value, Description, Configuration Group)
Fields
Description
Type
Configure Type for a given application. For example, OVALEDGE API
Key
The Key is required to configure the system path
Value
The value set for the system path, based on the value entered in the OvalEdge application, will get configured and performed accordingly.
Description
Short description of configuration
Configuration Group
Category group is set
- Click on the Save button, and configuration gets added.
Example 1: To Set the Maximum Limit of Jobs Running
- Log in with an admin account.
- Navigate to Administration > Configuration.
- Find the Key name “ovaledge.running.jobs.count”.
- Set the value with your desired limit.
- Click ✔ to save.
- Based on the Limit count set user can Run max of that number of jobs in sequence
Example 1: To Adjust the Size of Tags on the Home Screen
- Log in with an admin account
- Navigate to Administration >Configuration
- Find the Key name “tag.tile.size”
- Set the value by selecting the desired size from the dropdown list of values
- Click ✔ to save.
Configuration Types
OvalEdge configuration has the following configuration components types based on the OvalEdge major modules settings.
System Path
It provides various configurations that are available after the installation process is completed. For example, system location path for executable files, XML path, certificate path, jar file location path, registry path, and temporary operation path.
Key |
Value |
Description |
---|---|---|
Ovaledge.jarpath (System Path) |
/home/ovaledge/oejars(Path) |
Various drivers jar file’s location, to ingest data into OvalEdge. The directory/path where all the drivers are stored |
Ovaledge.base.url (System Path) |
https://app.ovaledge .net/login |
URL of the prod environment/test environment where users can register themselves and log in |
Ovaledge.temppath (System Path) |
/home/ovaledge/temp(Path) |
A temp path in the Server where the downloaded files from OvalEdge will be stored |
Rpttoxml.executable.path (System Path) |
Crystal Reports |
For BO reports (Crystal type) this is the Path where it converts rpt file to xml format and brings to catalog |
Qlik.sense.path (System Path) |
Qlik Sense |
Specific certification path to access qlik sense server (Input from client) |
Qlik.sense.xml (System Path) |
Qlik Sense |
User must provide a specific path for XMl file to store while crawling Qliksense Reports. |
Ssis.filepath (system Path) |
SSIS |
All Files, which are used in SSIS packages should be saved in this location and this location should be given to access the SSIS packages which will be used to build a lineage |
ovaledge.license.agreement.link |
https://ovaledge.com/eula/ |
The url provided in the value column navigates to the End user license agreement page, where the user can read the terms and conditions for the license agreement. |
Note: JDBC makes it possible to establish a connection with a data source, send queries and update statements, and process the results.
There are various driver jar path locations to ingest data into OvalEdge. A Driver is used to connect database servers that help to (parse the java) string objects to their native SQL and vice versa. In the OvalEdge application, all the JDBC driver’s jars are needed in a file and added to the file location in ovaledge.jarpath.
User & Roles
Users, and Roles configuration contains keys & related to the application and its user and roles.The Configuration section allows to edit these roles. For example, OE_ADMIN is role which is provide in VALUE colum to configure admin role of OvalEdge application.
Key |
Value |
Description |
---|---|---|
ovaledge.admin.principle |
admin |
OvalEdge application admin userid. (RESTART REQUIRED) |
ovaledge.admin.credential |
XXXXXXXXXX |
OvalEdge applications admin password. |
ovaledge.role.admin |
OE_ADMIN |
This role is configured as a default admin role with entire application access. The default is OE_ADMIN |
ovaledge.tag.role |
Example: TAG_CREATORS |
These are custom roles created in These are custom roles created in OvalEdge and configured to be used for creating parent and child tags in the application. |
ovaledge.role.public |
OE_PUBLIC |
System user role configured as default public role |
ovaledge.crawler. role |
OE_ADMIN |
These are custom roles created in OvalEdge and configured to be used for crawling the new data sources. |
Ovaledge.api.role |
Empty |
API Role (Leave empty to permit all user roles) Empty-accessed by anyone OE_ADMIN- APIs only accessed by OE_ADMIN |
ovaledge.role. governance |
OE_ADMIN |
These are custom roles created in OvalEdge and configured to validate the custom fields in the incoming objects. |
Oe.userdelete.role |
Empty |
Alternative user management to delete the users |
ovaledge.jobs.view.role |
OE_ADMIN, Empty |
Jobs view/edit role |
ovaledge.default.role |
OE_PUBLIC |
This is the default role applied to a user if the user does not have permissions on the object when it change the owner or steward |
remote.user.password |
XXXXXXXXXX |
RemoteUser Default Password |
ovaledge.username.pattern |
lastname,firstname |
This configuration helps to set the user name pattern. (firstname, lastname /lastname, firstname) |
Lineage
Under the Lineage tab, each configuration has its use case and functionality to build lineage. These are the configuration for managing lineage building and relationships
Key |
Value |
Description |
---|---|---|
shallow.lineage.connection.ids |
Connection id’s |
Add all connection ids to search tables/columns for shallow lineage |
Lineage.selfbuild |
True/False |
Setting for building self-lineage from any Queries. |
lineage.width.nodes |
3 |
To show lineage graph width at max |
Lineage.height.nodes |
Numbers |
To show lineage graph width at max level |
Lineage.debugmode |
True/False |
For getting the temp tables -debug the temp table lineage |
Lineage.pick.anytable |
True/False |
While building the lineage, pick any table from queries which are available in oetable data. |
Lineage.shallow |
True/False |
When query is sent for for lineage building, it will verify whether that query is a procedure/function/normal query If it is not a normal query, it will prefer shallow lineage there to pick references from it. It can be set to TRUE, when lineage is not yet all build. |
connections.order.lineage |
Empty |
Add needed connection id to pick the tables if multiple connections are there |
need.hard.coded.values.in.lineage |
True/False |
To the hard-coded/fixed-values in lineage make this flag as true |
add.dataset.lineage.version |
True/False |
Apply dataset lineage versioning ? (true/false) |
process.function.related.lineage |
True/False |
A User defined function is used in a query pick the function and process the function, use function related table column in the query instead of Function |
lineage.report.column.reference |
True/False |
Show lineage for tablecolumn to reportcolumn in reports? (true/false) |
versioning.for.lineage.connection |
Empty |
Lineage versioning for datasets that are part of OE database connections. Add such connection ids separated by comma(,) |
informatica.query.dialect |
Empty |
Configuration to store database used in Informatica Workflows. |
lineage.node.height |
3 |
To show lineage graph width at max for a particular node |
ovaledge.lineage.maxquerylines |
Empty |
Maximum lines of query to be allowed to process at the time of lineage |
informatica.param.file.type |
.txt,.ini,.param,.prm |
Type of files to read configurations from |
is.correctquery.required |
True/False |
make true if required correct query functionality |
Ovaledge.namebasedrelationsjob.ispkbased (No information) |
True/False |
This parameter confirms whether to consider PK or not while building column name-based relationships [client Specific UWM]. |
Lineage.level.size (No information) |
Numbers |
Setting will show the specific levels in UI on both source and destination w.r.t.to selected object. |
Notification
Notifications is where you provide system settings to allow the email notifications from OvalEdge to be executed through your mail services. You need to configure the SMPT server details for your other technical requirements for your email servers.
Key |
Value |
Description |
---|---|---|
ovaledge.smtp.server |
Mail.smtp2go.com |
SMTP Server of Email Provider. Test SMTP: The user can click on the Test SMTP button to check the configuration of SMTP is successfully completed. |
ovaledge.smtp.port |
2525/587/465 |
Port number at SMTP Server |
ovaledge.smtp.mode |
Default/TLS/SSL |
Transport Mode: SSL/TSL/Default |
ovaledge.email.username |
notify@ovaledge.com |
UserId at SMTP Server. Leave Empty for passwordless SMTP server |
ovaledge.email.password |
XXXXXXXXXX |
The password of this account |
ovaledge.email.fromEmail |
notify@ovaledge.com |
Default from Email Address |
license.expiry.emails |
notify@ovaledge.com |
Helps to send an email when the license of the OvalEdge application gets expired. (multiple users can be configured separated by comma) |
slack.app.oauth.token |
XXXXXXXXXX |
Slack App OAuth token. Slack: Once the oauth token is configured user can click on the Test slack button. Upon confirmation, it gives alerts that slack is successfully configured. |
Note:
- Slack: Once the oauth token is configured user can click on the Test slack button. Upon confirmation, it gives alerts that slack is successfully configured.
- Test SMTP: The user can click on the Test SMTP button to check the configuration of SMTP is successfully completed.
SSO
Many organizations are employing Single Sign On (SSO) technology. In order to avoid setting up individual accounts inside each of the applications. Depending on which SSO technology you are using, you can fulfill its requirements here. External SSO : SAML LDAP
Key |
Value |
Description |
---|---|---|
Saml.role.prefix |
|
User roles configured in OvalEdge-OE_ADMIN/OE_PUBLIC On the client-side, they will give different prefixes like PH_ADMIN Whatever prefix is there it can get configure.SO leave it empty |
ovaledge.extauth.authtype |
Ovaledge saml type (REMOTE or HYBRID) |
REMOTE-Default value. Example: Client roles and users will be coming to our application from the external authentication methods. For example: if the OKTA has a username, email, first name, and role configured. In the REMOTE both user and user role will be imported from OKTA and taken into consideration HYBRID- whatever roles will be in their SSO will not come. Only users will be copied, and user roles need to be configured in OE and OE user roles must be assigned manually. Initially, when users sign in for the first time, they will have the OE_PUBLIC role. Then the admin must change the user roles. |
Ldap.allow.emptyemail |
True/False |
Empty Email support for LDAP user |
Saml.role.suffix |
True/False |
User roles configured in OvalEdge-OE_ADMIN/OE_PUBLIC On the client-side, they will give different suffixes like ADMIN Whatever suffix is there it can get configure.SO leave it empty |
User.allow.hashpassword |
True/False |
User should be able to login with DB password|hashpassword |
ovaledge.login.application |
TRUE |
Is OvalEdge allowed to be logged via a self-service user account. |
Proxy
In this section, you can configure your proxy server settings. This section enables you to configure an optional proxy server in OvalEdge. There are many benefits to using a proxy server.
Key |
Value |
Description |
---|---|---|
proxy.host |
Proxy Host |
Proxy Host |
proxy.port |
Proxy Port |
Proxy Port |
proxy.protocol |
Proxy Protocol(https/http) |
Proxy Protocol(https/http) |
Audit Data Archival
This tab allows you to reduce the audit logging load on the OvalEdge database. OvalEdge, by default, archives all tables on a daily basis at 2.00 AM server time.
You can add the table by using “Add Archival Policy.” You must add the table name and retention period and click the save button. This feature includes the data retention period to archive the logs for over a period. It could be a month or a year. Once the retention period for a particular data set expires, it can be deleted or moved, and the users have the option to archive the logs in the CSV or SQL format. Here the Audit Archive page in configuration displays the current row count, days to retention, archive before delete, CSV, SQL, and last archive date.
Fields |
Description |
---|---|
Table Name |
Name of the table added to data archival. |
Row Count |
Display the total row count of a table. |
Retention Period |
It displays the number of days the table is archived. |
CSV Format |
Audit data can be archived in the CSV format. |
SQL Format |
Audit data can be archived in the SQL format. |
Last Archived Date |
It displays the last date of data object archival. |
Last Processed Date |
It displays the last date of the data object processed for the archival. |
Splunk
You can configure Splunk to capture job logs from the client machine to resolve in the OvalEdge application. OvalEdge posts three kinds of Logs to Splunk.
- Application/Server Logs
- Job/Process Logs
- Audit Logs
Key |
Value |
Description |
---|---|---|
splunk.tcp_udp.host |
http://splunk.dns.com:9999 |
Hostname of splunk tcp events consuming url. |
splunk.hec.host |
http://splunk.dns.com:8088 |
Hostname of splunk http event collector url. |
splunk.hec.token |
Empty |
Splunk token to authenticate HEC index. This is mandatory for HEC index logs storing. |
splunk.index |
Empty |
Splunk index that stores log messages coming from http event collector. (Optional) |
- Test Connection: The user can click on theto check that all key and value configuration is successfully completed.
File Scanner
File scanner is implemented using the ClamAV. The ClamAV is a protection engine uses a variety of techniques to detect malware. This section enables you to configure an ClamAV - File Scanner in OvalEdge. The benefit of having File scanner to validate malicious content in the file when it the file is upload using OvalEdge Upload Files or Folder.
Key |
Value |
Description |
---|---|---|
fs.system.hostname |
Empty |
This parameter is used to collect data filescan system address |
fs.system.username |
Empty |
This parameter is used to collect data filescan system username |
fs.system.password |
Empty |
This parameter is used to collect data filescan system password |
fs.filemanager.enable |
True/False |
This parameter is used to enable/disable filescan service on File Manager. |
fs.loadmetadata.enable |
True/False |
This parameter is used to enable/disable filescan service on Load Metadata for Files. |
Axiomatics
Axiomatics is policy based authorization applied on the content of databases. Axiomatics integrates data access control with OvalEdge application Identity & Access Management (IAM). This section enables you to configure the Axiomatics policy to integrate with OvalEdge Application.
Key |
Value |
Description |
---|---|---|
axiomatics.validate.url |
Empty |
Axiomatics validate URL to process approved axiomatics request through workflow |
axiomatics.createpolicy.url |
Empty |
Axiomatics policy creation url |
axiomatics.policytest.url |
Empty |
It is used to test the submitted policy access |
axiomatics.bearertoken |
xxxxxxxxxx |
Bearer token to submit the axiomatics requests |
axiomatics.clientid |
xxxxxxxxxx |
Client Id used to submit the axiomatics requests |
axiomatics.clientsecret |
xxxxxxxxxx |
Client secret used to submit the axiomatic requests |
axiomatics.api.gatewayid |
Empty |
API Gateway ID used to submit the axiomatic requests |
axiomatics.token.url |
Empty |
Axiomatics Bearer token endpoint |
axiomatics.grant.type |
API Grant type used to submit axiomatic requests |
|
axiomatics.scope |
API Scope used to submit axiomatic requests |
|
axiomatics.processing.type |
Axiomatics accessing type |
|
axiomatics.payload |
Empty |
Axiomatics payload sample |
axiomatics.bearer.token |
xxxxxxxxxx |
Axiomatics beaerer token |
Others
There are several pages of configuration options in the Others tab. Various configurations are available in this section, each with its own use case and functionality. OvalEdge governance engineers can guide a client through this section based on their unique requirements. For example, you can change the logo used in the application here to include your brand's logo instead.
Key |
Value |
Description |
---|---|---|
handle.missing.view.name |
Use Additional logic to handle missing view names in code |
|
use.conn.to.resolve.tables |
Use Connection info logic to resolve ambiguous tables in code |
|
ordertyperetrieve.default.classification |
Default retrieve classification |
Others: Business Glossary Module & Data Classification
Key |
Value |
Description |
---|---|---|
Ai.match.score |
10 |
When AI is performed on term recommendation, the objects that have a Smart Score value above the given threshold is only listed |
Aiterm.maxcolumns |
Example: 50000 |
When a run AI Job in Business Glossary, if the total columns in consideration are more than the configured number, it will exit the job. Number of columns considered for this recommendation job. |
Ordertypedelete.default.classification |
NA |
Client Specific |
Ovaledge.default.domain |
NA |
Client Specific |
enforce.validateobjects |
To validate New Objects by Data Governance Team |
Others: Tags
Key |
Value |
Description |
---|---|---|
Tag.tile.size |
Small/ Medium/ Large |
Size of each tag in OvalEdge. This decides the number of tags that can fit on the home page. |
Tag.additionaldelete.fieldname |
NA |
Client Specific |
Tag.additionalretrieve.fieldname |
NA |
Client Specific |
Parent.exceptiontag.name |
NA |
Client Specific |
Default.customdefinition.name |
NA |
Client Specific |
default.customobject.fieldposition |
NA |
Client Specific |
Others: File System
Key |
Value |
Description |
---|---|---|
ovaledge.filesize.limit |
2097152 |
Size limit of each file upload |
profile.json.file.read.single.line |
NA |
Client Specific |
file.skipfullprofile |
True/False |
Skip File Profiling |
Ovaledge.fileupload.maxfiles |
10 |
Maximum file count to be considered in uploading Files. If there are more files in a root folder it will connect and if try to upload files more than this count mentioned, it cannot upload those. |
Alternate.file.ext.types |
*TXT, *CSV |
Alternate file types for client aka TXT=CSV. Sometimes clients store one file type as another type as shown in the example |
Others: Configurations for various systems
Key |
Value |
Description |
---|---|---|
Ovaledge.qlik.iframe (Other) |
True/False |
Qlik iframe value display in summary page of qlik dashboards(true or false) |
Qubolehive.skipviewprofile |
Skip profiling of Qubole Hive Views |
|
snowflake.skipviewprofile |
Skip profiling of Snowflake Views |
Others: Default Configurations
Key |
Value |
Description |
---|---|---|
Ovaledge.locale |
en |
Default App Locale |
Ovaledge.license.agreement.link |
https://ovaledge.com/eula/ |
License agreement Link |
Ovaledge.term.policy |
A|3 |
OvalEdge Term Recommendation Policy |
Others: High-Performance parameters
The following parameters are required specifically when profiling file systems to increase performance and efficiency.
Key |
Value |
Description |
---|---|---|
high.perf.server.host |
Empty |
OvalEdge high-performance server. |
high.perf.server.port |
Empty |
OvalEdge high-performance port. |
high.perf.rt.server.port |
Empty |
OvalEdge high-performance real-time port. |
high.perf.rt.server.host |
Empty |
OvalEdge high performance real time server. |
high.perf.use.blue.print |
Empty |
Use a blueprint concept for this client. |
high.perf.limit.catalog.file |
0 |
OvalEdge high-performance catalog job will execute on a folder only when the number of files in that folder is less than this limit. |
high.perf.limit.profile.file |
0 |
OvalEdge high-performance catalog job will execute on a folder only when the number of files in that folder is less than this limit. |
Others: Jobs & Logs Setup
Key |
Value |
Description |
---|---|---|
Ovaledge.log.level |
Info/Debug |
DEBUG- it will provide detailed logs INFO- major information. The log files are not in the DEBUG mode as they will occupy more memory to store the detailed information and their log files will become huge. |
Ovaledge.running.jobs.count |
5 |
Maximum jobs that can get initiated at a time For example: if the limit is configured as 5, and there are 15 serial jobs, only the first 5 jobs will be initiated. AS soon as one job is executed completely, the 6th job will start |
Load Metadata for Lineage
This feature enables users to build lineage manually between data elements. The table below displays the fields required to build a Lineage using the Template.
Lineage |
Mandatory |
Details |
Source Connection* |
Yes |
Enter the Source Connection name from the crawler page. |
Source Schema* |
Yes |
Enter the Source Schema name |
Source Name* |
Yes |
Enter the Source Name (Table name /File name /Report name) |
SourceType* |
Yes |
Enter the Source Type (Table /File /Report) |
Target Connection* |
Yes |
Enter the Target Connection name |
Target Schema* |
Yes |
Enter the Target Schema name |
Target Name* |
Yes |
Enter the Target Name (Table name /File name /Report name) |
Target Type* |
Yes |
Enter the Target Type (Table /File /Report) |
Reference Name |
No |
Enter the data set name (query). |
Reference Connection |
No |
Enter the data set connection name from the crawler page. |
Reference Schema |
No |
Enter the data set Schema name from the crawler page. |
Reference Value |
No |
Enter the Query. |
Transformation Notes |
No |
Enter the Description about the lineage. |
Column Info |
No |
Enter the description about the column. |
Source Column |
No |
Enter the source column name from which the data is moving. |
Target Column |
No |
Enter the target column name to which the data is moving. |
Source Object Id |
No |
Enter the Source Object Id. |
Target Object Id |
No |
Enter the Target Object Id. |
Source Column Id |
No |
Enter the Source Column Id. |
Target Column Id |
No |
Enter the Target Column Id. |
Copyright © 2019, OvalEdge LLC, Peachtree Corners GA USA