Using business glossary
After you have established the business glossary for your organization, you can open it up to users to view it, search it, link the business glossary to different resources such as datasets, projects, tables, columns, etc. to add business context.
Users can also start discussions on business glossary and suggest edits to the terms created in the organization. This helps you crowd source inputs from your users and further improve the quality of the business glossary for the organization.
Associating business glossary with resources
Once you have created your business glossary terms you need to associate the terms with the resources in the application so that users of the catalog can find the terms in the right context, attached to the right resource, to be able to use the term definitions appropriately while using the catalog resources.
To add business terms as related resources:
On the Business term page, browse to the Related tab. Here you can view all the related resources.
From the Actions dropdown, select Edit relationships. In the Edit relationships window, set the following:
From the Resource type dropdown, choose the type of resource you want to relate.
From the Relationship type dropdown, choose the type of relationship between the resources. If only one relationship type is available for the resource, this option is disabled.
The available types of relationships are pre-configured by the administrator. If you cannot find the relationship type you need, please contact your catalog administrator.
In the Related resource field, type the resource name and select it from the dropdown. To view all available resources of the selected type, type either the * or ? symbol.
Preview the changes and continue to add other relationships, if desired.
To remove a relationship, click the Remove button next to the relationship you want to remove.
Once you have made all changes, click the Save change button. You can now see your changes in the Related tab.
Use the available filters and sorting options to narrow down and organize the list.
All the fields show hover text that include complete details about the field when the text cannot be displayed in the column view. For fields like Created and Updated hover over the field values to see the actual date and time information.
To remove a relationship, click the checkbox next to the resource name to select a resource. Then, click the Actions dropdown > Remove selected relationships button.
In the Remove linked resources window, click Save change.
Accessing business glossary terms as top concepts on search results page
To access the business glossary as top concept:
Business glossary terms get surfaced as top concepts on search pages. This concept card highlights the best matching glossary term. It presents at-a-glance the custom metadata configured by the catalog stewards including descriptions, technical metadata, related people, and resources. For details, see Understanding search results.
Collaborating on business glossary
As a user of the business glossary, you will not always have edit access to the glossary terms. However, you can use the discussion feature to interact with the stewards of the glossary to ask them questions, point errors, or make suggestions. If you have specific content change suggestions, you can always use the suggest changes feature to do that.
The Discussion tab captures all the communication between team members about the term. Either join an ongoing discussion or start a new one to collaborate with your team members on the project. You can also use this space to provide feedback.
To collaborate on a business glossary term:
Browse to a business glossary resource you want to collaborate on.
On the Discussions tab, you can choose to either start a new discussion, or participate in an ongoing one. You get an option to Flag or Like comments in a discussion. Flagging notifies data.world support team of potentially inappropriate content in the post.
To start a new discussion, do the following:
Click the Create topic button next to the Topics list.
In the Create a new topic window, provide the discussion topic and the first comment.
Click the Create topic button.
To participate in an ongoing discussion, do the following:
From the Topics list, select the topic you want to participate in.
Provide your comment and click the Post button.
While adding comments, you can use Markdown and add images and links. You can mention users (using @user_name) to notify them about an ongoing discussion to get their attention and participation. Some important things to note:
When you do this for private resources only available in an organization, typing @ suggests only the members of that organization. It also shows a prompt to contact an administrator of the organization to ask them to allow others to have access to the organization. If you are an administrator, you get the option to invite other people to the organization.
For community resources, you get a list of suggested users from the community.
In both cases, only the users who have at least read access to the resource are notified. So make sure that when you are setting access for the users, you also give them access to the resource where they need to participate in the discussion.
If you are a user with Admin access to the business glossary resource, you can delete a discussion topic and change the title of a discussion.
The system notifies users about on going discussions on resources. Receiving notifications from discussions depends on the actions taken in the discussions, your access level to the resource, and your involvement in the discussion. To learn more about managing and receiving notifications on your resources, go to the Staying updated about your data catalog page.
Suggesting changes to business glossary
As a user of the business glossary, you will not always have edit access to the glossary terms. But, if you find errors in terms or want to enhance the content, you can either start a discussion on the term, or better, suggest specific changes to the terms using the suggestions feature.
To suggest changes to business glossary:
Browse to the term you want to suggest edits for.
In the appropriate section, click the Suggest changes link.
In the Suggest changes window, make the suggestions by editing the fields. Click the Review changes button.
On the next screen, see the summary of your suggestions and click the Save changes button.
The users who can review the changes are notified through emails and in-app notifications about your suggestions.
A new Suggestions tab is added to the glossary term page where you can view all your suggestions. If you want, you can also remove your suggestion from here.