Installation

Integrating Elasticsearch with OvalEdge

This article provides information about Global Search, technically called Elasticsearch, its functionalities, installation, and integration of Elasticsearch into the OvalEdge application.

  1. If the user is migrating from an older version to 5.3 or 6.0 and does not have Elasticsearch installed, they need to run the advanced job to create indexes for data in elasticsearch.
  2. If the user is migrating to 5.3 or 6.0 but already has Elasticsearch installed, they need to run the advanced job to create indexes for data in elasticsearch.

Elasticsearch is an open-source analytical search engine used to fetch any data from the database, including text, numerical, structured, and unstructured data types. In Elasticsearch,  the data is stored in the form of documents and the related documents are logically indexed. The index search displays search results on associated tags, terms, custom fields, and object attributes instead of tables and schemas.

Elasticsearch allows you to search, store and analyze a large volume of data from different connected database systems apart from the OvalEdge database. Once a database is crawled within OvalEdge, an index is created for each data object added to the database storage. 


The following are the key features of Elasticsearch:

Whitespace Tokenizer: Tokenization is the process of breaking text strings into separate terms. The white Tokenizer thus helps to split the text or large data entered into the search engine into individual keywords or terms based on the whitespace character.  

For Example: If the text is entered in the search engine ‘Two little Monkeys jumping on the bed’. Then, ‘Two, little, monkeys, jumping, on, the, bed’ are divided into individual terms. 

Standard Analyzer: It provides grammar-based tokenization defined by the Unicode Text Segmentation Algorithm. It uses:

  • A standard tokenizer - splits the text into individual strings or terms based on white space or punctuation.
  • A lowercase token filter - lowercases the text. If ‘Projects’ is entered, it is changed to ‘projects’.
  • A stop token filter - removes stop words. Stop words are common words such as a/the/is/are that carry very little useful information.

The default analyzer is put into effect if none of the other analyzers are specified. It is extended to support many other languages other than English.

Indexing: An Index is like a database in a relational database which in turn contains multiple Table types which hold Documents (rows), and each document has properties (columns). The Elasticsearch contains lots of documents that are unique to each index. 

Elasticsearch > Indices > Documents with properties. 

No. of Shards:  Indexing includes a bit of both shards and replicas. The nodes are used to split the index data into two for effective data storage and to store large volumes of data. However, if the size of an index in a single node exceeds the size of the hardware limits, then shards come into play.  The shards are functional and independent subsets of index data that can be hosted in any node within the cluster.

Thus, the index volume data is divided into smaller parts to increase performance.  The number of shards for a particular index can be specified at the time of index creation.  The no of shards cannot be changed once the indexing is done.

Routing: It is the process of distributing the documents evenly across the shards without overloading a single node or shard. The routing thus helps decide which shard a given document is stored. Elasticsearch uses a simple routing formula to distribute the documents evenly across the indexed shards. 

Mapping: It defines how a document and its fields are indexed and stored. There can be different field types -  for the Name, it can be strings to enter full-text, to enter quantities it can be an integer field or a boolean. The information is stored in the mapping and Elasticsearch; thus, looking at each field type infers the data from the specific field content.

Highlighters: These emphasize the search/query matches for one or more fields in the search results. 

To integrate Elasticsearch with OvalEdge, complete the following tasks:

  1. Install Elasticsearch on Windows/Linux. 
  2. Integrate Elasticsearch with the OvalEdge Application.

Installing Elasticsearch on Windows

The following are the prerequisites required for installing Elasticsearch on Windows.

Pre-requisites:

  1. Java 1.8 for 7.x versions
  2. The OvalEdge application uses the 7.17.7 version and supports Java 1.8 in a stand-alone environment.

To install Elasticsearch on Windows, complete the following steps:

  1. Download Elasticsearch (with JDK) from the below link:
    https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.17.7-windows-x86_64.zip
  2. Organize the Elasticsearch files you downloaded into one folder and extract them. Upon extraction, new folders are created.

Configuring Elasticsearch

  1. For efficient elasticsearch heap allocation, we recommend using the following JVM settings: -Xms4g -Xmx4g. 
  2. Go to the elasticsearch installation folder, copy jvm.options file, and place it in jvm.options.d folder. 
  3. Open jvm.options file present in jvm.options.d folder and search for values like -Xms and -Xmx. 
  4. If it's commented, uncomment it and change the value to -Xms4g -Xmx4g.
  5. To configure the parameters, navigate the Elasticsearch ‘config’ folder and open the Elasticsearch.yml file. 
  6. Now, Uncomment xpack.security.enabled: true if existing or add a new line.
  7. Uncomment or add the below lines
    1. cluster.name: ovaledge
    2. network.host: 0.0.0.0
    3. transport.host: localhost
    4. transport.tcp.port: 9300
    5. http.port: 9200

  8. To start the Elasticsearch server > go to bin folder > open cmd > type the following command Elasticsearch.bat
  9. Setting Password: To set the Password for Elasticsearch, run the following command Elasticsearch-setup-passwords.bat interactive.
    Note: The username for Elasticsearch is elastic by default.
  10. Check whether Elasticsearch is installed. Go to a web browser like Chrome and type in localhost:9200 (9200 is the default port number for Elasticsearch). 
  11. A web page opens on the screen to enter the Username and Password. Enter the Username as elastic, and the user can choose to enter any password of their choice.
  12. The Elasticsearch is installed.



Installing Elasticsearch on Linux

The following are the prerequisites required for installing Elasticsearch on Linux.

Pre-requisites

  1. Java 1.8 for 7.x versions
  2. The OvalEdge application is currently using the 7.10.2 version that supports Java 1.8 in a stand-alone environment.

To install Elasticsearch on Linux, complete the following steps:

  1. Download Elasticsearch (with JDK) from the below link
    https://artifacts.elastic.co/downloads/Elasticsearch/Elasticsearch-7.16.3-linux-x86_64.tar.gz
  2. To install java 8, run the command, sudo apt-get install openjdk-8-jdk
  3. If  Java8 is already installed. Install APT transport package to allow access to repositories via https sudo apt install apt-transport-https
  4. Add the Elasticsearch Repository and update the GPG Key for the Elasticsearch Repository.
  5. Use the wget command to pull the public key:
    wget -qO - https://artifacts.elastic.co/GPG-KEY-Elasticsearch | sudo apt-key add -
  6. Use the below command to add the repository to the system
    echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-7.x.list
  7. Install Elasticsearch
  8. Update the package index > sudo apt update
  9. Run the installation for the specific version 7.16.2 sudo apt install elasticsearch=7.16.2 -y
  10. Start the Elasticsearch Service.
  11. The service will not start until we start it after the installation is complete.
  12. Run the below command to automatically reload when the system restarts.
    sudo systemctl daemon-reload
  13. Enable the Elasticsearch service with the below command:
    sudo systemctl enable Elasticsearch.service
  14. Start the Elasticsearch service using the below command:
    sudo systemctl start elasticsearch.service

Configuring Elasticsearch 

For efficient elasticsearch heap allocation, we recommend using the following JVM settings: -Xms4g -Xmx4g.

  1. Go to the Elasticsearch installation folder, copy jvm.options file, and place it in jvm.options.d folder.
  2. Open jvm.options file present in jvm.options.d folder and search for values like -Xms and -Xmx.
  3. If it's commented, uncomment it and change the value to -Xms4g -Xmx4g.
  4. To configure the Parameters, edit the Elasticsearch.yml file located under /etc/Elasticsearch directory
  5. Uncomment or add the below lines
    1. cluster.name: ovaledge
    2. network.host: 0.0.0.0
    3. transport.host: localhost
    4. Transport.tcp.port:9300
    5. http.port: 9200
  6. Restart the service
    sudo systemctl restart Elasticsearch.service
  7. Set the password
  8. Add the below line in Elasticsearch.yml and restart the service
    xpack.security.enabled: true
  9. Go to /usr/share/Elasticsearch/bin path and run the below command
    ./elasticsearch-setup-passwords interactive
  10. We can access Elasticsearch with port 9200 after authenticating with the user credentials

Integration of Elasticsearch with OvalEdge Application

The below-mentioned configuration settings are required to set up the configuration,

  1. Open the Tomcat folder and navigate to the following path apache-tomcat-8.5.40\webapps\ovaledge\WEB-INF\classes
  2. In classes, open oasis.properties file and configure variables related to Elasticsearch like es.password, es.host, etc.
  3. Navigate to OvalEdge application > Administration module >  Configuration Tab > others > Key column > Search for es.
  4. For this key: globalsearch.es.objecttabs.display set the following value: ALL,glossary,oetable,oetag,oeschema,oecolumn,oefile,oefilecolumn,oechart,chartchild,oestory,oequery,servicedesk, project
  5. Restart the Tomcat server.
  6. Navigate to Administration > Advanced Jobs module > under Names column > search for Indexing Existing Data into Elasticsearch > select the Advanced Jobs and click on  Run Advance Job in the top right corner of the page. 
  7. Go to the Jobs module to check the status of the submitted Advanced Job.

    To search data assets in OvalEdge using Global Search

    In OvalEdge, the Global Search is a powerful search function integrated with Elasticsearch that searches for the data objects and their links across the application giving relevant search results. The Global search is dynamic with fine-grained filters and advanced search options that help narrow down the search application-wide. However, search isn't the only way to find data in OvalEdge. You can navigate from one object to the next to find the data you are looking for.

    To search for any data,

    1. Enter a keyword in the search bar located in the Home page header and click on the Main search icon. The results are displayed for all the data objects with a full or partial keyword match from the database.
    2. The All tab displays the relevant search results of all the data objects. It displays the number of objects associated with a search keyword in a specific object type. You can select the object type checkboxes to view search results for preferred data object types. A Certified Objects filter is provided in the top of the left panel that helps to filter out and view the Certified data objects as search results.
    3. The object tabs in the top helps you to view results pertaining to a specific object tab i.e., Databases, Tables, Table Columns, Files, File Column, Reports, Report Columns, Queries, Business Glossary, Tags, Projects, Data Stories, Service Requests. For Example, when you filter for Tables, all the search keyword matching objects are filtered and  displayed. Selecting an Object Tab takes you to the specified data object page.
    4. Left Panel Field Search: The left panel helps refine search results on specific object-type fields by selecting the preferred fields. Users can now search for Certified data objects specific to an object type using the Certified checkbox option enabled in the left panel search field.
    5. Search using Qualifiers: The Global search filter works on the exact search term functionality. Users can fetch accurate search results for the keyword entered by including qualifiers (& for AND, II for OR, - for NOT) in the search filter.
      1. AND Operator - The AND operator is an inclusionary operator which targets all the keywords entered and thus limits the search results. The operators used to execute AND operations are + (plus symbol) or && (double symbol). For Example: If you want to see results for objects containing both Projects and RDAM, then both Projects && RDAM or Projects + RDAM must be entered in the search field. The results are shown for objects containing both the Projects and RDAM keywords.
      2. OR Operator - The OR operator Is used to combine search operations where results are shown for one or multiple keywords entered.  The  || ( Pipe operator) one or double symbols are used. For Example: If you want to see results for objects containing Snowflake or RDAM, then Snowflake || RDAM must be entered in the search field to see results for one or multiple search keywords entered.
    6. Advanced Search: Advanced search filter is enabled for every object type with multi-level granularity filtering. It facilitates the users to refine the search results by applying filters on top of the search results.

    Note: In the search filter, the AND search operator can be applied on Tags/Terms/Synonyms fields,  and OR search operator can be applied on fields like Connection Name/Schema Name/Status/Certify fields.

    Data Highlights: The Highlight icon helps you to see which attribute of the data object the search keyword is related to. The attribute of an object can be a Business Description, Title, Term, Tag, Technical Description, Project Notes, Synonyms, Connection, Schema, Column Tag, Column Term, Endorsement message, Code Custom Field, Test Custom Field, Classification Custom Field. However, the search results may not always have the search keyword in the object.

    Relevance Score: It shows how closely the data objects match the search keyword on a scale of 1-100. It uses a  1-100 scale in which 1 means the data object search keyword is much less relevant than other data objects and 100 means the data object is much more relevant.  

    It is calculated based on the formula: (Elasticsearch Score + Synonym Score) ✖ Popularity Score.

    Add to Project: You can add the data objects to Projects. If  My Access Cart project is selected as the default project then you can raise service requests on the selected data objects in bulk. An Add to Projects icon is enabled for Tables/ Table Columns / File / File Columns.

    1. The Pagination box in the bottom left of the page shows the current screen page count and the total number of pages. You can use the right and left arrows to navigate left/right pages.
    2. A Download icon is provided in the bottom right corner of the global search screen to download the data objects along with Business Description and Technical Description.

    Note: The search filter also supports search based on custom fields. 

    Global Search for Databases

    In the Global Search result page, when you click on the Databases tab, the results are displayed related to database objects. The left panel displays the filters associated with the Database fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Connection

    OR

    The field displays all the connection names from which the database is crawled. Select preferred connections to see search results pertaining to the selected connection.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. Search or select the names from the drop-down options to view search results pertaining to the selected names. 

    Status

    OR

    The field displays options that include Error, Partial Success, Running, and Success. Select the appropriate option to view search results pertaining to the selected status.

    Tags

    AND

    The field displays the Tag options in the drop-down list. Select the Tag to view search results pertaining to the selected Tags

    Terms

    AND

    The field displays the Term options in the drop-down list. Select the appropriate Term to view search results pertaining to the selected Terms.

    Endorsement Rating

    OR

    You can choose to view low-medium-high endorsement ratings for the objects by dragging the bar to the left/right.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Row Count

    OR

    The filter displays the range of row counts from 0- maximum limit in the system. You can toggle the bar to an approximate value of row count to view search results in the applied row count range.

    Additional Fields

    OR

    Additional search fields are provided to further refine the search process based on custom fields.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the  Global Search field. 

    Global Search for Tables 

    In the  Global Search result page, when you click on the Tables tab, the related Table object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Tables fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Certification

    OR

    The Certification options are displayed. You can select the certification from the options for which search results are displayed.

    Connection

    OR

    The field displays all the connection names from which the database is crawled. Select preferred connections to see search results pertaining to the selected connection.

    Schema Name

    OR

    The field displays all the schema names in the system. You can select from the options to see results pertaining to the Schema Name selected.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. You can search or select the names from the drop-down options to view search results pertaining to the selected names. 

    Status

    OR

    The field displays options that include Error, Partial Success, Running, and Success. You can select the appropriate option to view search results pertaining to the selected status.

    Type

    OR

    The Table Type options are displayed. You can select the Table Type for which search results are displayed.

    Tags

    AND

    The field displays the Tag options in the drop-down list. Select the Tag to view search results pertaining to the selected Tags

    Terms

    AND

    The field displays the Term options in the drop-down list. You can select the appropriate Term to view search results pertaining to the selected Terms.

    Endorsement Rating

    OR

    You can choose to view low-medium-high endorsement ratings for the objects by dragging the bar to the left/right.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Importance Score

    OR

    Filter based on the number of entities or lineage the object has with other objects. You can choose to view low-medium-high lineage value objects by dragging the bar to the left (Minimum) /right (maximum).

    Last Modified Date

    OR

    Select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    Certified Date

    OR

    Select the Start/End dates using the Calendar icon to view the results based on the date range the object is certified.

    Row Count

    OR

    The filter displays the range of row counts from 0- maximum limit in the system. You can toggle the bar to an approximate value of row count to view search results in the applied row count range.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global Search field.

    Global Search for Table Columns

    In the  Global Search result page, when you click on the Table Columns tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Table Column fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Connection

    OR

    The field displays the connection names which are crawled from the database and when the user selects the particular connection the search results pertaining to the selected connection are displayed.

    Schema Name

    OR

    The field displays all the schema names in the system. You can select from the options to see results pertaining to the Schema Name selected.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. You can select the names from the field options to view search results pertaining to the selected names. 

    Certification

    OR

    The Certification options are displayed. You can select the certification from the options for which search results are displayed.

    Status

    OR

    The field displays options that include Error, Partial Success, Running, and Success. You can select the appropriate option to view search results pertaining to the selected status.

    Tags

    AND

    The field displays the Tag options in the drop-down list. Select the Tag to view search results pertaining to the selected Tags

    Terms

    AND

    The field displays the Term options in the drop-down list. You can select the appropriate Term to view search results pertaining to the selected Terms.

    Endorsement Rating

    OR

    You can choose to view low-medium-high endorsement ratings for the objects by dragging the bar to the left/right.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Importance Score

    OR

    Filter based on the number of entities or lineage the object has with other objects. You can choose to view low-medium-high lineage value objects by dragging the bar to the left (Minimum) /right (maximum).

    Last Modified Date

    OR

    Select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    Crawled Date

    OR

    Select the Start/End dates using the Calendar icon to view the results based on the date the connection is crawled;

    Profiled Date

    OR

    Select the Start/End dates using the Calendar icon to view the results based on the date the connection is profiled;

    Certified Date

    OR

    Select the Start/End dates using the Calendar icon to view the results based on the date range the object is certified;

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the  Global Search. In the pop-up, there is a provision given to search fields based on AND/NOT functions to include/not include a specific field in the search. 

    Global Search for Files

    In the Global Search result page, when you click on the Files tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Files fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

      Field

    Search Operator

    Description

    Certification

    OR

    The Certification options are displayed. You can select the certification from the options for which search results are displayed.

    File Folders

    OR

    The field displays File Folders in the system. You can select the file folder option to view search results pertaining to the selected file folders.

    Connection

    OR

    The field displays the connection names which are crawled from the database and when the user selects the particular connection the search results pertaining to the selected connection are displayed.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. You can select the names from the field options to view search results pertaining to the selected names. 

    Status

    OR

    The field displays options that include Error, Partial Success, Running, and Success. You can select the appropriate option to view search results pertaining to the selected status.

    Terms

    AND

    The field displays the Terms options in the drop-down list. Select the Term to view search results pertaining to the selected Term

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the  Global Search field. In the pop-up, there is a provision given to search fields based on AND/NOT functions to include/not include a specific field in the search. 

    Global Search for File Columns

    In the Global Search result page, when you click on the File Columns tab, the related object suggestions are displayed for file objects based on the search keyword entered. The left panel displays the filters associated with the File fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    File Folders

    OR

    The field displays File Folders in the system. You can select the file folder option to view search results pertaining to the selected file folders.

    Connection

    OR

    The field displays the connection names which are crawled from the database and when the user selects the particular connection the search results pertaining to the selected connection are displayed.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. You can select the names from the field options to view search results pertaining to the selected names. 

    Status

    OR

    The field displays options that include Error, Partial Success, Running, and Success. You can select the appropriate option to view search results pertaining to the selected status.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    • Upon selecting the field options, click on the to view search results for applied filters. 
    • You can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global search. 

    Global Search for Reports 

    In the result page, when you click on the Reports tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Reports fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Certification

    OR

    The Certification options are displayed. You can select the certification from the options for which search results are displayed.

    Connection

    OR

    The field displays the connection names which are crawled from the database and when the user selects the particular connection the search results pertaining to the selected connection are displayed.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. You can select the names from the field options to view search results pertaining to the selected names. 

    Tags

    AND

    The field displays the Tag options in the drop-down list. Select the Tag to view search results pertaining to the selected Tags

    Terms

    AND

    The field displays the Term options in the drop-down list. You can select the appropriate Term to view search results pertaining to the selected Terms.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Importance Score

    OR

    Filter based on the number of entities or lineage the object has with other objects. You can choose to view low-medium-high lineage value objects by dragging the bar to the left (Minimum) /right (maximum).

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    Certified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is certified;

    Report Group

    OR

    The field displays all the existing report groups in the system. You can select from the options to view search results pertaining to the selected report group options.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global search field.

    Global Search for Reports Columns

    In the Global Search result page, when you click on the Report Columns tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Report Column fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Connection

    OR

    The field displays the connection names which are crawled from the database and when the user selects the particular connection the search results pertaining to the selected connection are displayed.

    Owner/Custodian/Steward/System Analyst

    OR

    The field displays the names of Owners, Stewards, Data Managers, HR Labels, System Analysts, and Custodian names existing in the system. You can select the names from the field options to view search results pertaining to the selected names. 

    Certification

    OR

    The Certification options are displayed. You can select the certification from the options for which search results are displayed.

    Terms

    AND

    The field displays the Term options in the drop-down list. You can select the appropriate Term to view search results pertaining to the selected Terms.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Importance Score

    OR

    Filter based on the number of entities or lineage the object has with other objects. You can choose to view low-medium-high lineage value objects by dragging the bar to the left (Minimum) /right (maximum).

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    Report Group

    OR

    The field displays all the existing report groups in the system. You can select from the options to view search results pertaining to the selected report group options.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global search field.

    Global Search for Queries 

    In the Global Search result page, when you click on the Queries tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Queries fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Source code connection

    OR

    The field displays the build lineage options. You can select the appropriate options to view search results pertaining to the selected Source Code Connections

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global search field.

    Global Search for Business Glossary

    In the Global Search result page, when you click on the Business Glossary tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Business Glossary fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Domain

    OR

    The field displays the Domain names of the Business Glossary Term in the system. You can select the options to view relevant search results pertaining to the selected domains.

    Owner

    OR

    The field displays the names of Owners in the system. You can select the names from the field options to view search results pertaining to the selected names.

    Category

    OR

    The field displays Category options in the system. Select the appropriate options from the list to view results pertaining to the selected Category options.

    Sub Category

    OR

    The field displays Sub Category options in the system. Select the appropriate options from the list to view results pertaining to the selected SubCategory options.

    Steward

    OR

    The field displays the names of Steward in the system. You can select the names from the field options to view  search results pertaining to the selected names. 

    Status

    OR

    The field displays options that include Error, Partial Success, Running, Success. You can select the appropriate option to view search results pertaining to the selected status.

    Popularity

    OR

    Filter based on the highest number of users who viewed the same object. You can choose to view low-medium-high popularity objects by dragging the bar to left/right.

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global search field.

    Global Search for Tags

    In the Global Search  result page, when you click on the Tags tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Tag related fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Note: When searching an object using a Tag, the Search results now include all the objects associated with the tags. If the search results in multiple tags, the tags bucket at the right should expand reflecting the corresponding parent tags.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global Search field. In the pop-up, there is a provision given to search fields based on AND/OR/NOT functions to include/not include specific fields in the search.

    Global Search for Projects

    In the Global Search  result page, when you click on the Projects tab, the related object suggestions are displayed based on the search keyword entered. The left panel displays the filters associated with the Project fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    • Upon selecting the field options, click on the to view search results for applied filters.
    • The user can further customize the search results as per the specific requirements using the Advanced Search icon placed next to the Global search field.

    Global Search for Data Stories

    In the Global Search  page, when the user clicks on the Data Stories tab, the list of Data Stories available in the OvalEdge is displayed based on keywords entered in the Elastic Search box. 

    The left panel displays the filters associated with the Data Story fields mentioned below. You can select the appropriate filters from the options to narrow down the search results.

    Field

    Search Operator

    Description

    Story Zone

    OR

    The field options display Different story zones in the application. You can select to view search results pertaining to the selected story zone.

    Endorsement Rating

    OR

    Filter based on star rating given to an object out of 5 stars. You can choose to view low-medium-high endorsement ratings for the objects by dragging the bar to left/right

    Created By

    OR

    The field options displays all the service desk creators names. You can select the options for which relevant search results are displayed.

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    1.  Upon selecting the field options, click on the to view search results for applied filters.
    2. You can further customize the search results using the Advanced Search icon placed next to the Global Search based on the following criteria:
      1. Story Name
      2. Story Description
      3. Tags
      4. Synonym
      5. Endorsement Description
      6. Project Notes

    Global Search for Service Desk

    It displays the search results related to Service Desk. The left panel displays the filters associated with the Service Desk fields mentioned below. You can select and apply the appropriate filters from the options to narrow down the search results. The status of the tickets are also displayed in the search results.

    Field

    Search Operator

    Description

    Create Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is created on.

    Last Modified Date

    OR

    You can select the Start/End dates using the Calendar icon to view the results based on the date range the object is last modified.

    Configure Search Keywords

    Configure Search Keywords are searchable or relevant keywords added to the objects for the end-users to search the Project in an easy way. 

    1. Select a data object > In the object detailed page.
    2. Click on the Nine Dots > select the Configure Search Keyword option from the list.
    3. A Configure Search Keywords pop-up is displayed.
    4. Click on the Add the keyword button enabled at the bottom. 
    5. Enter the keyword in the field. Click Save and the keyword gets added to the Search Keyword grid.
    6. Search keywords with a minimum score of 3 are considered for the Global search to find and locate the objects.
    7. If the admin user adds the keyword, then the score is recorded as 3.
    8. If the non-admin user adds the keyword the score is recorded as 1. 
    9. If the admin user votes the keyword, the score gets additional three points added to it.
    10. If the non-admin user votes the keyword the score gets an additional 1 point added to it. 
    11. You can enable/disable the search keyword using the toggle.
    12. You can delete the search keyword using the delete icon.

    Note: The Custom fields or Additional fields help You to customize and add additional information for a specific object which helps refine the search process. In the Administration > Custom Fields, You shall declare the definition by selecting the Object Type based on the Global or Connection type selected. Upon setting the definition to a global or specific connection, You can define the custom field value in the object level (Object > Additional Fields).

    Downloading search results

    The data object search results  can be downloaded into an .XLXS Excel format along with  Business Descriptions and Technical Description.


    Copyright © 2022, OvalEdge LLC, Peachtree Corners GA USA