Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com. 

 
Hitachi Vantara Lumada and Pentaho Documentation

Manage Business Glossary

  1. Last updated
  2. Save as PDF

Pentaho Data Catalog provides a single location for creating, organizing, curating, and identifying business glossary items like domains, categories, and terms to help you navigate your vast data environment so you can get the right data efficiently. You also can use the business glossary as a tool with role-based access control to secure and separate valuable data and metadata and prevent such data from reaching unintended audiences.

In Data Catalog, business terms are organized into a category and then into a domain representing a hierarchy. Using the business glossaries, you can manage or browse the business glossaries for your data environment. Form more information, see Tour the Business Glossary page.

In Business Glossary page you can perform following tasks based on your role:

Parent Topic
Child Topics

Create a domain

Perform the following steps to create a domain:

Procedure

  1. Click Glossary in the left navigation menu.

    The Business Glossary page opens.

  2. Click Add New and select Domain.

    The Create Domain dialog box opens.

  3. In the Domain Name field, enter a name for the domain you want to create.

  4. Click Continue.

    The domain is created and displayed in the list of glossaries in the Business Glossary navigation tree.

  5. Click Edit to add a definition. Enter the definition and click Save Changes.

    You can add multiple definitions using the Add Definition option.

  6. Click Edit to add a purpose. Enter the purpose and click Save Changes.

  7. (Optional) To change the domain name, click the pencil icon next to the domain name.

  8. (Optional) In the Tags panel, you can click and add tags to the domain, which helps identify the resource with tagged keywords.

Results

You have successfully created the domain.

Next steps

Repeat steps 1 through 8 to create additional domains or see Create a category to create categories.
Parent Topic

Delete a domain

Deleting a domain irrevocably removes all its associated categories and terms in Data Catalog.

CautionBecause you cannot recover this data, use caution when deleting domains.
This task assumes you are on the Business Glossary page. Perform the following steps to delete a domain:

Procedure

  1. In the left navigation tree, select the domain you want to delete.

  2. Click Actions and select Remove from the dropdown menu.

    A dialog box displays, asking you to confirm the deletion.

  3. To confirm the deletion, click Remove.

Results

You have successfully deleted the domain along with its associated categories and terms.
Parent Topic

Create a category

Perform the following steps to create a category:

Procedure

  1. Click Glossary in the left navigation menu.

    The Business Glossary page opens.

  2. Click Add New and select Category.

    The Create Category dialog box opens.

  3. In the Category Name field, enter a name for the category you want to create.

  4. In the Domain Name field, choose a domain from the dropdown options under which this new category will be grouped.

    If you selected a domain from the list before creating a new category, then the selected domain is automatically pre-selected as the new category's domain. You can choose a different domain if necessary.

  5. Click Continue.

    The category is created and displayed in the list of glossaries in the Business Glossary navigation tree.

  6. Click Edit to add a definition. Enter the definition and click Save Changes.

    You can add multiple definitions using the Add Definition option.

  7. Click Edit to add a purpose. Enter the purpose and click Save Changes.

  8. (Optional) To change the domain name, click the pencil icon next to the domain name.

  9. (Optional) In the Tags panel, you can click and add tags to the domain, which helps identify the resource with tagged keywords.

Results

You have successfully created the category.

Next steps

Repeat steps 1 through 9 to create additional categories or see Create a business term to create a new business term.
Parent Topic

Delete a category

Deleting a category irrevocably removes all its associated terms in Data Catalog.

CautionBecause you cannot recover this data, use caution when deleting categories.
This task assumes you are on the Business Glossary page. Perform the following steps to delete a category:

Procedure

  1. In the left navigation tree, select the category you want to delete.

  2. Click Actions and select Remove from the dropdown menu.

    A dialog box displays, asking you to confirm the deletion.

  3. To confirm the deletion, click Remove.

Results

You have successfully deleted the category along with its associated terms!
Parent Topic

Create a business term

Domains and categories group terms that data analysts will use to label their glossary-specific data. Newly created terms are generally associated with a domain and category. However, you can also create terma that are not linked to any domain and category, but they will be grouped under Unassigned Terms.

Perform the following steps to create a new term:

Procedure

  1. Click Glossary in the left navigation menu.

    The Business Glossary page opens.

  2. Click Add New and select Term.

    The Create Business Term dialog box opens.

  3. In the Business Term Name field, enter a name for the term you want to create.

  4. 4. (Optional) In the Domain Name field, choose a domain from the dropdown options and in the Category Name field, choose a category from the dropdown options, under which this new term will be grouped.

    If you selected a domain from the list before creating a new term, then the selected domain is automatically pre-selected as the new term's domain. You can choose a different domain if necessary.

  5. 4. (Optional) In the Category Name field, choose a category from the dropdown options under which this new term will be grouped.

    Suppose you selecte a domain or category from the list before creating a new term. In that case, the chosen domain and category are automatically pre-selected as the new term's domain and category. You can choose a different domain and category if necessary.
    NoteIf you don't select any damon and category, the term will grouped under Unassigned Terms.

  6. Click Continue.

    It creates the new term and displays in the left navigation tree.

  7. Click Edit to add a definition. Enter the definition and click Save Changes.

    You can add multiple definitions using the Add Definition option.

  8. Click Edit to add a purpose. Enter the purpose and click Save Changes.

  9. (Optional) To change the term name, click the pencil icon next to the domain name. Edit the text, click the check mark to save or the X to cancel.

  10. (Optional) In the Tags panel, you can click and add tags to the domain, which helps identify the resource with tagged keywords.

Results

You have successfully created a new business term!
Parent Topic

Delete a business term

Deleting a business term irrevocably removes all its associated associations in Data Catalog.

CautionBecause you cannot recover this data, use caution when deleting business terms.
This task assumes you are on the Business Glossary page. Perform the following steps to delete a business term:

Procedure

  1. In the left navigation tree, select the business term you want to delete.

  2. Click Actions and select Remove from the dropdown menu.

    A dialog box displays, asking you to confirm the deletion.

  3. To confirm the deletion, click Remove.

Results

You have successfully deleted the business term!
Parent Topic

Edit a domain, category, or business term

Administrators can edit the glossary items, like domain, category, and business term and their features, such as name, description, and purpose, including tags added to the item.

For example, if both the Finance domain and the Claims domain have a term named "expense",then these terms each have an independent identity: the "Finance.expense" and the "Claims.expense".

NoteWhena glossary item name is updated, the changes are reflected for all users.

Perform the following steps to edit a glossary item:

Procedure

  1. Click Glossary in the left navigation menu.

    The Business Glossary page opens.

  2. Select the glossary item you want to edit, like domain, category, or business term.

  3. (Optional) In the Summary tab, you can click the pencil icon to change the name of the glossary item.

    Whenfinished editing, click the checkmarkicon to save the change.

  4. (Optional) In the Summary tab, click Edit to update the glossary definition and purpose.

    You can add multiple definitions using the Add Definition option.When finished editing, click the Save Changes to save the update.

Results

You have successfully modified the glossary item!
Parent Topic

Import glossary

In Data Catalog, you can import a glossary. Perform the following steps to import a glossary:

Procedure

  1. Click Glossary in the left navigation menu.

    The Business Glossary page opens.

  2. Click Add New and select Import.

    The Import Glossary Items dialog box opens.

  3. In the Glossary Items field, browse and select the file you want to import.

    You can also download a template if needed.

  4. Under Existing Items, choose any one of the following options as per your requirements.

    It defines how the system should handle terms that already exist in the same hierarchy as the terms you’re importing.

    • Update Content

      Updates the attributes of existing Business Glossary terms.

    • Create New Items

      Doesn’t update the attributes of existing Business Glossary terms. Instead, a new business term will be created in the same hierarchy with a numeric suffix appended.

    • Ignore

      Doesn’t update the attributes of existing terms.

  5. Click Continue.

Results

You have successfully imported the glossary! You can now see the imported terms in the left glossary item tree.
Parent Topic

Export glossary

In Data Catalog, you can import a glossary. Perform the following steps to import a glossary:

Procedure

  1. Click Glossary in the left navigation menu.

    The Business Glossary page opens.

  2. Click Export Glossary.

    The Export Glossary? dialogbox appears.

  3. Click Export Glossary.

    This creates an Excel file for you to download.

  4. Click the Excel file name.

    This downloads the Excel file containing glossary.

Results

You have successfully exported the glossary to an Excel file.
Parent Topic