Business glossary exercise

Completed

In this exercise we're going to create a term in the business glossary, update our term, add a term to an asset, and create a term template.

Create terms

You can create terms one at a time or in bulk! In this example, we do both.

Single

  1. Open the data catalog and select Manage glossary on the home page menu. Or in the left menu when you're in the data catalog, select Glossary

    Screenshot of the glossary home page with the 'Manage glossary' button highlighted in the menu and glossary highlighted in the left menu.

  2. On the glossary terms page select + New term, and a page opens showing available templates.

    Screenshot of glossary terms page with new term button highlighted.

  3. Later in this exercise, we talk about creating term templates. For now, let's choose the System default template and select Continue.

    Screenshot of new term page with system default and continue buttons highlighted.

  4. Give your new term a name, which must be unique in the catalog and is case sensitive.

    Screenshot of new term page with the name box highlighted.

  5. Add a definition. You can use rich text in the definition to include hyperlinks or even tables.

    Screenshot of new term page with the definition box highlighted.

  6. Set the status for the term. Set to Draft if you'd like to review the term before implementing it. Set the term to Approved if it's ready to implement.

    Screenshot of the new term page with the status dropdown menu open, showing all options.

  7. Add resources, an approved Acronym, and a parent term, if applicable.

    Screenshot of new term page with parent, acronym, and resources highlighted.

  8. Open the Related tab, and add any related terms and synonyms.

    Screenshot of the new term page with the related tab selected and highlighted.

  9. Open the Contacts tab to add experts and stewards to your term. These contacts are the users that manage the term, and other users can contact them if they have questions.

    Screenshot of the new term page with the contacts tab selected and highlighted.

  10. Select Create to create your term.

    Screenshot of the new term page with the create button highlighted at the bottom.

  11. Now we can see our new term listed in the product glossary.

    Screenshot of the glossary page, showing the newly created term.

Bulk

You can also import many terms into the data catalog at one time using a .csv file. Entries to your csv should look like this:

"Name","Nick Name","Status","Definition","Acronym","Resources","Related Terms;Separated by semicolons","Synonyms","Stewards","Experts","Parent Term Name","IsDefinitionRichText(True/False)","Term Template Names"

A full sample CSV is provided in the following steps.

  1. To import these terms to the glossary, open the data glossary and select Import terms in the top menu.

    Screenshot of the glossary page with the Import terms button highlighted in the action menu.

  2. Select the term template you want to use. For now, let's choose System default.

    Screenshot of the import terms page with the Continue button highlighted at the bottom.

  3. There's a sample .csv available for you to download and edit. To complete your terms, download the CSV and use it as a template.

    Tip

    When using the sample CSV, remember to remove the first example row before uploading your CSV.

    Screenshot showing import terms page with the download a sample csv button highlighted.

  4. When you add your terms as shown, upload the completed file to the import terms window. Then select Ok.

    Screenshot of the import terms page, showing a loaded sample file and the ok button highlighted.

  5. It might take a few minutes, but the system uploads the file and adds all the terms to your glossary.

    Screenshot of the terms page with an 'import in progress' pop up showing the import progress.

Manage terms

  1. Open the glossary and search for a term you want to edit. You can select the check box to the right of the term name, and select the Edit button at the top of the page.

    Screenshot of the glossary terms page with the edit button highlighted and a term selected using the check button.

  2. You can also open the term itself and select the Edit button inside the term.

    Screenshot of a term in the glossary, with the edit button highlighted in the action bar.

  3. From this Edit screen, you can update any values to the term.

  4. Select Save to make sure your edits persist.

    Screenshot of the term edit screen with the save button highlighted.

  5. In the glossary menu, you can also select multiple terms and either delete these terms or export them, using the Delete or Export buttons at the top of the page.

    Screenshot of the glossary with multiple terms selected, showing the now-available export and delete actions.

Add term to an asset

  1. To add a term to a data asset, open the data catalog and search or browse for your asset.

    Screenshot of a selected asset in the data catalog.

  2. Select your asset and select Edit

    Screenshot of an asset page with the edit button highlighted in the action menu.

    Tip

    You can also add a glossary term to multiple assets using bulk editing, like we discussed in the last section.

  3. You can add your term to an entire data asset by selecting it under Glossary terms on the Overview page.

    Screenshot of the edit asset page on the overview tab, with the glossary terms dropdown highlighted and a single term selected.

  4. You can also add your term to a specific column in the data asset under Glossary terms for that column on the Schema page.

    Screenshot of the edit asset page on the schema tab. The glossary terms dropdown is highlighted in one row and a single term is selected.

  5. Select Save to save your changes.

    Screenshot of the edit asset page with the save button highlighted at the bottom.

  6. Now you can see your term listed on the asset description.

    Screenshot of the asset page, showing the newly applied term under glossary terms.

Create a term template

  1. Open the data catalog and select Manage term templates in the top menu.

    Screenshot of the glossary page, showing the 'Manage term templates' button highlighted in the action bar.

  2. Select the Custom tab at the top of the Manage term templates window.

    Screenshot of the 'Manage term templates' window with the 'Custom' tab highlighted.

  3. Select New term template.

    Screenshot of the 'Manage term templates' page on the custom tab with the new term template button highlighted.

  4. Give your template a name and description that gives other users enough information about how to use the term template.

    Screenshot of new term template page with the template name and description boxes highlighted.

  5. Select New attribute to add your first attribute to your term.

    Screenshot of new term template page with the new attribute button highlighted.

  6. Give your new attribute a name and a description as well.

    Screenshot of new attribute page with the name and description buttons highlighted.

  7. Choose whether or not you want the attribute to be required to create a term by selecting Mark as required.

    Screenshot of new attribute page with mark as required check button highlighted.

  8. Choose your field type.

    Screenshot of new attribute page with the field type dropdown highlighted.

  9. For Text, you can provide a default value. For single or multiple choice, provide values for all the choices you want.

    Screenshot of new attribute page showing a multiple choice field type with several example choices added.

  10. Select Apply

    Screenshot of new attribute page with the apply button highlighted at the bottom.

  11. Add as many other attributes as you'd like your term to have, then select Create.

    Screenshot of new term template page with the create button highlighted.

  12. Now your new term template is available when others create terms in the business glossary. You can use these templates to define terms that provide the best information for your business.

    Screenshot of the glossary page with new term selected, and the newly created term template available to select.