Skip to main content

By clicking Submit, you agree to the developerWorks terms of use.

The first time you sign into developerWorks, a profile is created for you. Select information in your developerWorks profile is displayed to the public, but you may edit the information at any time. Your first name, last name (unless you choose to hide them), and display name will accompany the content that you post.

All information submitted is secure.

  • Close [x]

The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerworks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

By clicking Submit, you agree to the developerWorks terms of use.

All information submitted is secure.

  • Close [x]

Use CSV and XML import methods to populate, update, and enhance your InfoSphere Business Glossary content

Shlomit Becker (shlomitb@il.ibm.com), Quality Assurance Engineer, IBM
Photo of Shlomit Becker
Shlomit Becker is a QA Engineer who works on the IBM InfoSphere Business Glossary team at the IBM Israel Software Lab. Shlomit joined IBM as part of the Unicorn Solutions acquisition in 2006. She has developed a suite of automated tests for the Business Glossary Import and Export features.
Yair Rinot (yairr@il.ibm.com), Software Developer, IBM
Photo of Yair Rinot
Yair Rinot is a Software Developer who works on the IBM InfoSphere Business Glossary team at the IBM Israel Software Lab. Yair holds a B.Sc in Computer Science from Hebrew University of Jerusalem. He has developed the Business Glossary CSV and XML import and export features.

Summary:  IBM InfoSphere™ Business Glossary enables you to create, manage, and share an enterprise vocabulary and classification system. In Version 8.1.1, the InfoSphere Business Glossary introduced some new CSV and XML import and export methods to populate a business glossary with data. This tutorial provides technical instructions, tips, and examples to help you implement these new features to efficiently create a business glossary.

Date:  16 Sep 2010
Level:  Intermediate PDF:  A4 and Letter (407 KB | 34 pages)Get Adobe® Reader®

Activity:  17150 views
Comments:  

Introduction

The InfoSphere Business Glossary (Business Glossary) enables you to use a controlled vocabulary to create, manage, and share standard definitions of business and organization concepts. The Business Glossary product uses a category hierarchy in which categories contain terms. You can use terms to classify data assets in the metadata repository based on the needs of your organization.

Populating a business glossary with data is the first step to using it. In Version 8.1.1, the Business Glossary introduced some new import and export methods that use CSV and XML formats such that glossary administrators can import and export glossary content to and from external files of these types. These methods introduced greater flexibility in creating glossary content, enabling users to populate their business glossaries more easily and in a more comprehensive manner.

This tutorial describes and explains how to use these new import and export features. The tutorial includes best practices, tips, and examples to help you implement these features efficiently to populate a business glossary.

The examples in this tutorial use data from the IBM Industry Models Telecom Business Glossary Content Pack. IBM provides InfoSphere Business Glossary content packs for various industries, including banking, insurance, telecommunications, retail, and healthcare.

Choosing the import method

CSV and XML are common import methods. Deciding which import method to use to populate a business glossary is based on a number of factors, including the existing glossary content and the skill level of the business glossary administration staff.

CSV
The CSV format is simple. It includes the capability to contain categories and terms with their property values, such as descriptions, abbreviations, and custom attribute values. It also enables you to define steward relationships.
XML
The XML format is more comprehensive and complex. It includes the capability to define every possible relationship among terms, categories, and other object types, including terms relating to other terms, categories referring to terms, terms linking to assigned assets.

You might already have a version of a glossary in some format and want to use that content to start to populate a new business glossary. Or you might choose to build a business glossary from scratch. Because these scenarios start from different points, the recommended import method might be different.

If your data is in a spreadsheet, you should probably convert your existing spreadsheet to the Business Glossary CSV format. If you are starting from scratch, choose the import method based on the kind of data you need to import and on your technical skill level.

Table 1 and Table 2 describe the values that can be included in a CSV file and an XML file.


Table 1. Values available for categories in CSV and XML files
Category propertyCSV fileXML file
NamesYes, if being added for a new category only; names of existing terms or categories cannot be changed.Yes
Long descriptionsYesYes
Short descriptionsYesYes
SubcategoriesYesYes
Parent categoriesYes, if being added for a new category only; parent categories of existing terms or categories cannot be changed.Yes
Referenced terms NoYes
Contained termsYesYes
Custom attributesNoYes
Custom attribute valuesYes, if the custom attribute already exists in the target metadata repository. If the custom attribute does not exist, the import fails.Yes
Links to stewardYes, if the steward already exists in the target metadata repository. If the steward does not exist, the import fails.Yes, if the user or user group already exists in the target metadata repository. If the user or user group does not exist, the steward relationship is not created, but other content is imported successfully.

Table 2. Values available for terms in CSV and XML files
Term propertyCSV fileXML file
NamesYes, if being added for a new term only; names of existing terms or categories cannot be changed. Yes
Long descriptionsYesYes
Short descriptionsYesYes
AbbreviationsYesYes
Usages YesYes
ExamplesYesYes
StatusYesYes
Related termsNo Yes
Attribute IsModifierYesYes
Attribute TypeYesYes
SynonymsNo Yes
Containing (parent) categoriesYes, if being added for a new term only; parent categories of existing terms or categories cannot be changed. Yes
Custom attributesNoYes
Custom attribute valuesYes, if the custom attribute already exists in the target metadata repository. If the custom attribute does not exist, the import fails. Yes
Links to stewardYes, if the steward already exists in the target metadata repository. If the steward does not exist, the import fails. Yes, if the user or user group already exists in the target metadata repository. If the user or user group does not exist, the steward relationship is not created, but other content is imported successfully.
Links to assigned assets (such as columns, jobs, tables)NoYes, if the asset already exists in the target metadata repository. If the asset does not exist, the relationship is not created, but other content is imported successfully.
References to assigned external assets (such as business process models or web services)NoYes

Note: If you need to transfer business glossary content from versions older than Version 8.1.1 to newer business glossary instances, the only available method is the Glossary Archive import and export (format is XMI), which lets you transfer all or a subset of glossary data between glossary instances without editing their contents. In Business Glossary Version 8.1, if you wanted to transfer only categories and terms with their basic properties, you could also use the CSV import and export.

1 of 7 | Next

Comments



Help: Update or add to My dW interests

What's this?

This little timesaver lets you update your My developerWorks profile with just one click! The general subject of this content (AIX and UNIX, Information Management, Lotus, Rational, Tivoli, WebSphere, Java, Linux, Open source, SOA and Web services, Web development, or XML) will be added to the interests section of your profile, if it's not there already. You only need to be logged in to My developerWorks.

And what's the point of adding your interests to your profile? That's how you find other users with the same interests as yours, and see what they're reading and contributing to the community. Your interests also help us recommend relevant developerWorks content to you.

View your My developerWorks profile

Return from help

Help: Remove from My dW interests

What's this?

Removing this interest does not alter your profile, but rather removes this piece of content from a list of all content for which you've indicated interest. In a future enhancement to My developerWorks, you'll be able to see a record of that content.

View your My developerWorks profile

Return from help

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Information Management, XML
ArticleID=522340
TutorialTitle=Use CSV and XML import methods to populate, update, and enhance your InfoSphere Business Glossary content
publish-date=09162010
author1-email=shlomitb@il.ibm.com
author1-email-cc=
author2-email=yairr@il.ibm.com
author2-email-cc=

Tags

Help
Use the search field to find all types of content in My developerWorks with that tag.

Use the slider bar to see more or fewer tags.

Popular tags shows the top tags for this particular content zone (for example, Java technology, Linux, WebSphere).

My tags shows your tags for this particular content zone (for example, Java technology, Linux, WebSphere).

Use the search field to find all types of content in My developerWorks with that tag. Popular tags shows the top tags for this particular content zone (for example, Java technology, Linux, WebSphere). My tags shows your tags for this particular content zone (for example, Java technology, Linux, WebSphere).

Try IBM PureSystems. No charge.