Sie sind auf Seite 1von 131

IBM InfoSphere Business Glossary

Version 8 Release 5

Administrator's and Author's Guide

SC19-2455-03

IBM InfoSphere Business Glossary


Version 8 Release 5

Administrator's and Author's Guide

SC19-2455-03

Note Before using this information and the product that it supports, read the information in Notices and trademarks on page 113.

Copyright IBM Corporation 2006, 2010. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents
Chapter 1. Overview . . . . . . . . . 1
Accessing business glossary content Business scenarios . . . . . . . . . . . . . . . . . 1 . 3 Including hypertext links . . . . . . Deleting categories . . . . . . . . Managing terms . . . . . . . . . . Terms . . . . . . . . . . . . Assigned external assets . . . . . . Creating or editing terms . . . . . . Adding notes . . . . . . . . . . Including hypertext links . . . . . . Deleting terms . . . . . . . . . Managing custom attributes . . . . . . Custom attributes . . . . . . . . Creating or editing custom attributes . . Assigning values to custom attributes . Deleting custom attributes . . . . . Managing business glossary reports . . . Business glossary reports . . . . . . Generating business glossary reports . . Importing and exporting glossary content . Import and export methods . . . . . Importing and exporting CSV files . . Importing and exporting XML files . . Importing and exporting glossary archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 50 52 52 55 56 63 63 64 66 67 67 68 69 69 69 70 70 70 75 78 89

Chapter 2. Integrating with other software . . . . . . . . . . . . . . 7


Integration with IBM Cognos products . . . . Integration with IBM Industry Models . . . . . Integration with other IBM InfoSphere Information Server products . . . . . . . . . . . . Integration with Eclipse-based applications . . . Custom applications . . . . . . . . . . . . 7 . 8 . 8 . 9 . 9

Chapter 3. Administering a glossary of metadata assets. . . . . . . . . . . 11


Planning, designing, and publishing a glossary . Establish a glossary governance team. . . . Design the category structure of the glossary . Gather preliminary information. . . . . . Design and develop glossary content . . . . Set up the glossary environment . . . . . Populate the glossary with categories and terms Populate the metadata repository with other assets . . . . . . . . . . . . . . Assign stewards . . . . . . . . . . . Make the glossary available to the enterprise . Configuring the glossary . . . . . . . . . Configuring general settings . . . . . . . Assigning security roles to glossary users . . Configuring viewing permissions . . . . . Bidirectional language support . . . . . . Accessing the business glossary for administering and authoring . . . . . . . . . . . . Accessing glossary content . . . . . . . Managing stewards. . . . . . . . . . . Stewards . . . . . . . . . . . . . Designating a user to be a steward . . . . Assigning a steward to categories and terms . Assigning assets to a steward . . . . . . Removing assets from a steward . . . . . Transferring assets between stewards . . . . Deleting stewards . . . . . . . . . . Adding notes . . . . . . . . . . . . Managing categories . . . . . . . . . . Categories . . . . . . . . . . . . . Creating or editing categories . . . . . . Adding notes . . . . . . . . . . . . . . . . . . 11 12 14 14 17 19 20 23 24 25 26 26 27 29 31 33 33 37 37 37 38 39 40 41 41 41 42 42 42 48

. . . . . . . . . . . . . . . . . . . . . . .

Chapter 4. Accessing business glossary content from Eclipse applications . . . . . . . . . . . . 99 Chapter 5. Developing and extending applications . . . . . . . . . . . . 101
Integrating with Eclipse-based applications . . . 101

Chapter 6. InfoSphere Business Glossary glossary . . . . . . . . . 103 Product accessibility . . . . . . . . 107 Accessing product documentation 109

Links to non-IBM Web sites . . . . . 111 Notices and trademarks . . . . . . . 113 Contacting IBM . . . . . . . . . . 117

Index . . . . . . . . . . . . . . . 119

Copyright IBM Corp. 2006, 2010

iii

iv

Administrator's and Author's Guide

Chapter 1. Overview
IBM InfoSphere Business Glossary provides users with a Web-based tool for creating and managing standard definitions of business and organization concepts by using a controlled vocabulary. The tool divides metadata into categories, each of which contains terms. You can use terms to classify other objects in the metadata repository based on the needs of your organization. You can also designate users or groups as stewards for metadata objects.

Accessing business glossary content


You can access the data assets that are stored in the metadata repository with several different business glossary interfaces. You can access glossary content by using the following interfaces: IBM InfoSphere Business Glossary administrative interface The administrative interface is part of the IBM InfoSphere Information Server Web console, in which glossary Administrators and Authors can create and manage terms, categories, and stewards. This interface is accessible from a Web browser. InfoSphere Business Glossary browser This interface enables glossary users to browse and search the glossary. Like the administrative interface, this interface is accessible from a Web browser. IBM InfoSphere Business Glossary Anywhere This search tool, accessible from your Microsoft Windows desktop, gives you the business definition of a term or category without the need to log into IBM InfoSphere Information Server or to open a Web browser. InfoSphere Business Glossary REST API A REST (Representational State Transfer) API (Application Programming Interface) is provided with InfoSphere Business Glossary Anywhere. This API allows client applications to access and author business glossary content. InfoSphere Business Glossary Client for Eclipse An Eclipse plug-in component allows users of other Eclipse-based applications to browse glossary content directly within the Eclipse application. For example, users of IBM Rational Software Architect can view and search for terms, categories, and their properties, and use the terms in model elements. You can also extend other Eclipse-based applications to incorporate similar glossary access. The following table compares the access methods for the glossary:

Copyright IBM Corp. 2006, 2010

Table 1. Comparison of business glossary access methods


Administrative interface of InfoSphere Business Glossary How do users access the interface? Who uses this interface? In IBM InfoSphere Information Server Web console Any Information Server user with the Business Glossary Administrator or the Business Glossary Author role v Add, delete, edit, search, and view terms, categories, and custom attributes Browser interface of InfoSphere Business Glossary In a Web browser InfoSphere Business Glossary Anywhere On your computer in the system tray InfoSphere Business Glossary REST API Programmatic interface (any programming language) InfoSphere Business Glossary Client for Eclipse From other Eclipse-based applications

Any Information Server user with the Business Glossary User role or higher

Any Information Application Server user with developers the Business Glossary User role or higher

Users of other Eclipse-based applications such as developers of business process models View and search for glossary terms and categories, view their properties, and, depending upon the support provided by hosting Eclipse-based application, use glossary terms in models being developed within the application.

What can users do?

v Export and import terms attributes v Open the and categories v Send feedback glossary by using an browser to about the asset XML, XMI, or view details to its steward, CSV file of a term if one is assigned

v Search terms, v Search the categories, and glossary for custom terms that are attributes captured from any text-based v View terms, document or categories, Web page on stewards, and your desktop custom

Developers can develop client applications that allow users to perform some or all of the functions that are available from the administrative or browser interfaces of InfoSphere Business Glossary, but from within a custom client.

What kind of searches can users do in the glossary?

v All contents of v Names and the glossary properties of terms, v Search results categories, or can be filtered assets v Search results can be filtered

Any of the v All terms, searches that are categories, available from and their the descriptions administrative v Search results or browser can be filtered v Search results interfaces of can be filtered InfoSphere Business Glossary, but from within a custom client. v Names and short descriptions of terms and categories Depends on functionality of the custom client. No

Can users No export the search results?

Yes. The export No is in CSV format.

Administrator's and Author's Guide

Table 1. Comparison of business glossary access methods (continued)


Administrative interface of InfoSphere Business Glossary Can users export parts of the glossary? Yes. The export formats are: v commaseparated value (CSV) v Extended Markup Language (XML) v XML Metadata Interchange (XMI) Where can users learn more? See "Browsing See "Administering a glossary content." glossary of metadata assets." See "Looking up terms in business documents." If you have purchased InfoSphere Business Glossary Anywhere, see the "Developing with the IBM InfoSphere Business Glossary REST API" section of the installed information center. See "InfoSphere Business Glossary Eclipse plug-in" Browser interface of InfoSphere Business Glossary InfoSphere Business Glossary Anywhere InfoSphere Business Glossary REST API Depends on the functionality of the custom client. InfoSphere Business Glossary Client for Eclipse No

Yes. The export No is in CSV format.

Related concepts Chapter 3, Administering a glossary of metadata assets, on page 11 Business analysts and subject matter experts can use InfoSphere Business Glossary to create and manage a controlled vocabulary and classification system. Such a system enables them to build a common language between business and information technology. Chapter 4, Accessing business glossary content from Eclipse applications, on page 99 IBM InfoSphere Business Glossary includes an Eclipse plug-in component. This component, the IBM InfoSphere Business Glossary Client for Eclipse, provides access to glossary content from within any Eclipse-based application. Related information Browsing glossary content Looking up terms in business documents

Business scenarios
You can easily organize and access business-relevant metadata to help make business decisions.

Chapter 1. Overview

IBM InfoSphere Business Glossary and IBM InfoSphere Business Glossary Anywhere provide a business context for managing and viewing metadata. The following scenarios show how two different business environments organized their metadata to solve business problems. Insurance: Risk information Problem: Insurance companies define levels of risk by using various parameters such as age, prior accident claims, credit rating, and so on. Agents need to know how their particular company defines levels of risk to process claims correctly. Solution: By using InfoSphere Business Glossary, the glossary administrator and business analyst in an insurance company work together to design the glossary structure. The glossary is organized into categories, each of which contains terms used in business correspondence and financial reports. For example, terms such as risk, coverage, and prior claims are given definitions specific to the company. Along with a definition of each term, the business analyst associates each term with an asset such as a specific table or column in the company's database. Stewards are assigned to various terms to maintain the term definitions according to the needs of the company. A new claims agent in the company is learning what to do in the case of a Claim for an Assigned Risk 3 after Deductible. Because he does not know what Assigned Risk 3 is in his company's policy plans, he uses InfoSphere Business Glossary browser to look up the definition. In addition, the claims agent finds other business terms that are related, instructions on how to handle these claims, and the location in the database where Assigned Risk 3 Premium and Deductible data is stored. Manufacturing: Production information Problem: A Chief Financial Officer needs to determine the profitability of a production line by using specific financial parameters. He wants to analyze each stage of production. Solution: The glossary administrator and business analyst design the glossary structure by using InfoSphere Business Glossary. Separate categories are defined for each stage of production. Members of the finance team assign terms within each category to specific database tables and columns. Another business analyst receives a request to present a business intelligence report on revenues and operating expenses at each stage of production. The analyst uses the InfoSphere Business Glossary browser to view each category, check the meaning of its terms, and select which terms are needed for his report. The analyst sends a request to the database team to build a report based on the selected terms. The database team builds the report by using the glossary browser to find which database columns are associated with those terms. In addition to understanding the semantic meaning of these terms, the analyst invokes business lineage to view the data sources that populate the business intelligence report. The chief financial officer, while viewing the report, can use InfoSphere Business Glossary Anywhere to understand the definitions of the fields used in it.

Administrator's and Author's Guide

Related concepts Planning, designing, and publishing a glossary on page 11 A business glossary is an authoritative dictionary of the terms and relationships that are used throughout the enterprise. A benefit of a business glossary is increased trust and confidence in business information.

Chapter 1. Overview

Administrator's and Author's Guide

Chapter 2. Integrating with other software


You can integrate IBM InfoSphere Business Glossary with other software products as well as custom applications. InfoSphere Business Glossary is designed to work with other software products, both within the IBM InfoSphere Information Server suite and outside of the suite. In addition, you can develop custom applications or extend existing applications to incorporate InfoSphere Business Glossary features and functions. For example, you can interact with glossary content with the following InfoSphere Information Server components in addition to InfoSphere Business Glossary and IBM InfoSphere Business Glossary Anywhere: v IBM InfoSphere Information Analyzer v IBM InfoSphere Metadata Workbench v IBM InfoSphere FastTrack In addition, InfoSphere Business Glossary works together with IBM Industry Models, IBM Cognos products, and, with the InfoSphere Business Glossary Client for Eclipse, with Eclipse-based IBM products such as Rational Software Architect and InfoSphere Data Architect. You can use the InfoSphere Business Glossary Client for Eclipse Java API to extend other Eclipse-based applications. And, you can create custom applications or extend existing applications, with the InfoSphere Business Glossary REST API.

Integration with IBM Cognos products


InfoSphere Business Glossary can work together seamlessly with IBM Cognos 8 products. IBM Cognos 8 Business Intelligence provides capabilities and information that businesses need to manage their performance. If you have both IBM Cognos 8 Business Intelligence and InfoSphere Business Glossary or InfoSphere Business Glossary for Cognos installed, you can view glossary content from directly within the IBM Cognos 8 Business Intelligence interface. In addition, you can configure InfoSphere Business Glossary to directly search for references to terms within reports in IBM Cognos 8 Business Intelligence. From within the InfoSphere Business Glossary display of term or category properties, users can click a link to display the results of searches by IBM Cognos 8 Go!, which searches the set of reports in IBM Cognos 8 Business Intelligence. Network access must be available between IBM Cognos 8 Go! and InfoSphere Business Glossary.

Copyright IBM Corp. 2006, 2010

Related tasks Configuring general settings on page 26 Glossary administrators can customize glossary display and behavior. Related information Details page, browser

Integration with IBM Industry Models


The IBM InfoSphere Business Glossary Packs for IBM Industry Models provide industry-specific sets of terms that you can use to quickly populate a business glossary. IBM InfoSphere Business Glossary Packs for industries such as telecommunications, financial services, retail, insurance, and health plan provide glossary archive (XMI) files of business terms specific to those business areas. You can import the file into InfoSphere Business Glossary to create a "starter" glossary that contains terms that apply to your business. You can then customize the glossary to meet the particular needs of your organization by using the glossary management functions available with InfoSphere Business Glossary. Related concepts Gather sources for categories and terms on page 14 You can populate your glossary with categories and terms that already exist in your enterprise or that come from external sources. Related information IBM Industry Models

Integration with other IBM InfoSphere Information Server products


You can interact with glossary content by using several different products in the IBM InfoSphere Information Server suite. Because glossary content is stored in the InfoSphere Information Server metadata repository, you can interact with glossary content with the following components of the InfoSphere Information Server suite: v IBM InfoSphere Information Analyzer v IBM InfoSphere Metadata Workbench v IBM InfoSphere FastTrack You can also import and export glossary content with these other components of InfoSphere Information Server: v Categories and Terms MetaBroker v IBM InfoSphere Data Architect MetaBroker v IBM Rational Data Architect MetaBroker

Administrator's and Author's Guide

Related concepts Gather sources for categories and terms on page 14 You can populate your glossary with categories and terms that already exist in your enterprise or that come from external sources. Related information IBM InfoSphere Information Analyzer IBM InfoSphere Metadata Workbench IBM InfoSphere FastTrack Bridges and MetaBrokers IBM Categories and Terms MetaBroker IBM Rational Data Architect MetaBroker IBM InfoSphere Data Architect product overview

Integration with Eclipse-based applications


IBM InfoSphere Business Glossary includes an Eclipse plug-in component. This component, the IBM InfoSphere Business Glossary Client for Eclipse, provides access to glossary content from within any Eclipse-based application. With the InfoSphere Business Glossary Client for Eclipse, you can access business glossary content as part of using any Eclipse-based application. For example, after installing the client, you can view glossary content while you are developing software models of business processes with IBMRational Software Architect products. Having glossary terms readily available to you enables you to easily choose the correct term to apply to elements within your model. If you install the optional UML Integration and UML Profile features, you can integrate glossary terms into model elements. Installing the UML Profile feature by itself gives you the ability to see what terms have been applied to existing models but without editing capability. Through integration of the InfoSphere Business Glossary Client for Eclipse with InfoSphere Data Architect, you can associate terms with data model elements. These associations can be transferred to the business glossary, and can also be used by other products in the InfoSphere Information Server suite. You can also extend other Eclipse-based applications to make use of the same features by using the InfoSphere Business Glossary Client for Eclipse Java API. Related concepts Chapter 4, Accessing business glossary content from Eclipse applications, on page 99 IBM InfoSphere Business Glossary includes an Eclipse plug-in component. This component, the IBM InfoSphere Business Glossary Client for Eclipse, provides access to glossary content from within any Eclipse-based application.

Custom applications
You can create custom applications or extend existing applications to take advantage of IBM InfoSphere Business Glossary. You can create custom software applications that use the features of InfoSphere Business Glossary with the InfoSphere Business Glossary REST (Representational

Chapter 2. Integrating with other software

State Transfer) API (Application Programming Interface). You can also use the REST API to extend the functionality of existing applications. You can extend Eclipse-based applications to integrate with InfoSphere Business Glossary by using the InfoSphere Business Glossary Java API. Related concepts Chapter 5, Developing and extending applications, on page 101 You can create custom applications or extend existing applications to take advantage of IBM InfoSphere Business Glossary.

10

Administrator's and Author's Guide

Chapter 3. Administering a glossary of metadata assets


Business analysts and subject matter experts can use InfoSphere Business Glossary to create and manage a controlled vocabulary and classification system. Such a system enables them to build a common language between business and information technology. InfoSphere Business Glossary provides a Web interface where you can manage the important business aspects of your assets from any computer. With the business glossary, you can create categories and terms, define custom attributes and values, search the glossary, and assign a steward to assets. The IBM InfoSphere Information Server metadata repository stores metadata about tools, processes, and data sources. Individual instances of metadata are called information assets, or just assets. Examples of assets are physical data resources, ETL jobs, profiling processes, routines, and functions. External assets are assets that are not stored in the metadata repository. External assets can include such things as business process models, Web services, or reports that are in an external asset management system. The business glossary organizes your metadata into categories that contain terms. Terms can relate to the assets that are stored in the metadata repository or to external assets according to the standards and practices of your enterprise. You can also designate specific users or user groups as stewards who are responsible for particular assets. For example, you need to work with business analysts to provide information about the purchase patterns of customers in Europe. You use the business glossary to look up the category named European Sales that contains a term named Customers. That term is related to assets such as multiple database tables that are associated with the customers of the European sales operation. Then, business analysts and subject matter experts can: v browse the European Sales category v view its contained terms v browse the Customers term to see which database tables or other assets are related v see the steward who is responsible for that information

Planning, designing, and publishing a glossary


A business glossary is an authoritative dictionary of the terms and relationships that are used throughout the enterprise. A benefit of a business glossary is increased trust and confidence in business information. Development of a business glossary is both scalable and flexible. You do not have to have a well-established data dictionary to build a business glossary. If you have just categories and terms, you can build a simple glossary. You can later develop and expand the glossary contents. Content can be imported into the glossary in a variety of methods and formats by using various suite components of IBM InfoSphere Information Server, such as IBM InfoSphere Business Glossary, IBM InfoSphere FastTrack, and IBM InfoSphere
Copyright IBM Corp. 2006, 2010

11

DataStage. In addition, you can import a glossary model that is suited to your industry from IBM InfoSphere Data Architect by using IBM InfoSphere Data Architect MetaBroker. A team of subject matter experts, data architects, and business analysts form a governance team that guides the development and maintenance of a glossary. When planning the glossary structure, the team considers the following questions: v What categories and terms do you need? Which categories contain which terms? v Do you have existing categories and terms that can be imported into the glossary? v Which categories are the top-level categories, and which are subcategories? If you can answer these questions before you create the glossary structure, you can build a structure that is simple for users to understand and that supports your enterprise goals. In addition to categories and terms, the business glossary also contains information about other assets such as database tables, jobs, and reports that are in the metadata repository. You can decide in advance which assets are related to which terms, which terms are related to other terms, and which terms refer to other terms. Alternatively, you can wait until after you build the glossary structure to make these decisions. Do the following steps to plan, build, and make your glossary available to the enterprise: 1. Establish a glossary governance team 2. Design the category structure of the glossary on page 14 3. Gather preliminary information on page 14 4. 5. 6. 7. Design and develop glossary content on page 17 Set up the glossary environment on page 19 Populate the glossary with categories and terms on page 20 Populate the metadata repository with other assets on page 23

8. Assign stewards on page 24 9. Make the glossary available to the enterprise on page 25 Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Stewards on page 37 Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository.

Establish a glossary governance team


Governance refers to the procedures that your organization uses to maintain oversight and accountability of the glossary contents. To get the correct information into the business glossary, identify the people who know the most about the subject areas in your enterprise.

12

Administrator's and Author's Guide

Typically, a variety of people are involved in glossary design and maintenance: v Subject matter experts who understand the business use of the terms, their dependencies, and their relationships to other terms. They create and define new terms v Business analysts who know the business definitions of terms for each business entity. They work with subject matter experts to establish a list of terms that represent the most common words used in reports, applications, and general communication. They ensure that the term definition is consistent with the goals of the enterprise. v Data architects who understand the physical and structural aspects of the data sources that terms might be assigned to. They find the terms or the assets such as database tables, jobs, and other assets that should be assigned to the term. They establish the relationships between terms and their physical storage location. v Compliance officers who are in charge of overseeing and managing compliance issues within an organization. They ensure that term definitions and relationships to other terms and assets conform to business policies and legal regulations.

Define approval processes


A multidisciplinary team should be responsible for overseeing the glossary content, to keep the content current, and to govern the life cycle for terms. The life cycle of a term is determined by its status. The status of a term can have one of the following values within the business glossary: Candidate A term that is under consideration by the team. Accepted A term that is accepted by the team as a new, valid term. The term is not widely used in the enterprise. Standard A term that is fully approved by the team, has all relationships defined to other terms or to assets, and can be used throughout the enterprise. Before a term is given the Standard status, it should be evaluated by subject matter experts, business analysts, and data architects that are outside of the governance team. Deprecated A term that is no longer approved for use. Typically, it is replaced with a new term or a synonym. It is preferable to assign the Deprecated status to a term rather than to delete the term from the glossary. The Deprecated status lets the user know that this term is no longer in use. In IBM InfoSphere Business Glossary, the property, Replaced by, guides the user to the new term. In the life cycle of a term, it moves from Candidate to Accepted and then to Standard. Typically, you use InfoSphere Business Glossary to assign status to a term. In this tool, the Business Glossary Administrator selects to display only terms with Standard status or to display terms with Accepted or Standard status.

Chapter 3. Administering a glossary of metadata assets

13

Design the category structure of the glossary


Data architects and subject matter experts establish a hierarchy of categories that reflects how a user might intuitively look for information about the business. A common strategy is to divide the business by subject areas, such as customers and products. This approach is effective for organizations that implement enterprise-wide data governance, customer data integration (CDI), or master data management (MDM) projects. A second strategy might be to divide the top-level categories by departments such as Marketing, Finance, and Human Resources. For large companies that have independent business units, the strategy might be to organize the business units into top-level categories. If categories and terms are in multiple languages, each country or language should be a top-level category. This design enables users to search within the top-level category that is appropriate for their language. The subcategory structures of each language should be parallel. Subcategories should be organized according to business areas and how users might think about where to find the term. When terms are displayed in the browser interface of IBM InfoSphere Business Glossary, the context, or path, of the term can add important information about the meaning of the term. For example, the context for the term Finance Service Repayment Type is Marketing >> Geographies >> NE Region. The context indicates that the term is contained in the category Geographies, which is a subcategory of the category Marketing. Related information Accessing the glossary browser

Gather preliminary information


You can import categories and terms into a glossary from several types of sources and file formats.

Gather sources for categories and terms


You can populate your glossary with categories and terms that already exist in your enterprise or that come from external sources. Categories and terms have properties such as name and parent categories. Categories and term can also have additional properties, called custom attributes, assigned to them. You can import categories, terms, their properties, and their custom attributes from the following sources: v Existing lists of categories, terms, and custom attributes, or an existing data dictionary Categories and terms from existing lists or from a data dictionary must be in a format that can be imported into the business glossary. The format can be either extensible markup language (XML) or comma-separated value (CSV). You can download import templates that are in XML or CSV format from IBM InfoSphere Business Glossary. The differences between the two formats are:

14

Administrator's and Author's Guide

XML

The XML format is more comprehensive and robust than the CSV format. This format lets you create custom attributes, links to stewards, and links to assets. The CSV format is suitable for someone who does not have experience with the XML language.

CSV

Start with a category structure that has only top-level categories and one level of subcategories to make it easy to populate the CSV file. You can design a job in IBM InfoSphere DataStage to extract terms and categories from a data source and to produce a file in a CSV or an XML format that is compatible with InfoSphere Business Glossary. v IBM InfoSphere Data Architect or IBM Rational Data Architect, Version 7.5 and earlier If your enterprise has not previously created any terms and categories, you can use IBM Industry Models, a collection of prepared glossary models for various industries such as finance, banking, health care, and insurance. The models typically include the following features: A comprehensive list of terms and their definitions for your business A data warehouse model with assets that have dependencies on a glossary with categories and terms You can export a glossary model from InfoSphere Data Architect or from Rational Data Architect, Version 7.5 and earlier, into the metadata repository. IBM Industry Models can be supplied as logical data models and glossary models in InfoSphere Data Architect format. To export a data warehouse model to the metadata repository, you must first transform the logical model to a physical model. v Logical data models Although you cannot import logical models into the business glossary, you can use the following tools to convert a logical data model into a physical model that you can import into the glossary: InfoSphere Data Architect and Rational Data Architect, Version 7.5 and earlier, support the conversion of a logical data model into a physical model. IBM Services can provide tools or guidance to convert CA ERwin logical models to a file in XML format that you can import into the glossary. These tools also link terms to the associated column of the database table in the physical model. Tip: IBM Industry Models are big and often require that you pick and choose which assets are needed for your enterprise. Before import, enterprises typically work with model consultants to edit the model so that it has only those assets that are needed by the enterprise. Pre-import editing makes it easier to manage the assets that you import into the glossary.

Chapter 3. Administering a glossary of metadata assets

15

Related concepts Integration with other IBM InfoSphere Information Server products on page 8 You can interact with glossary content by using several different products in the IBM InfoSphere Information Server suite. Integration with IBM Industry Models on page 8 The IBM InfoSphere Business Glossary Packs for IBM Industry Models provide industry-specific sets of terms that you can use to quickly populate a business glossary. Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Import and export methods on page 70 Glossary administrators can use several methods to import and export glossary content to enable rapid development of a glossary. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Related information User Information MetaBroker

Gather sources for other assets


You can populate the metadata repository with assets such as business intelligence (BI) reports, physical schemas, models, and jobs that already exist in your enterprise or that come from external sources. Assets that are assigned to terms in the metadata repository can come from the following sources: v IBM Industry Models in IBM InfoSphere Data Architect The models typically include a data warehouse model with physical assets such as tables and columns, and a glossary with categories and with terms that are assigned to those assets. v Metadata from independent software vendors You can import physical metadata such as database tables and columns, business intelligence metadata, and glossary metadata into the metadata repository by using a MetaBroker or a bridge. v Metadata that is generated by or imported by IBM InfoSphere DataStage and QualityStage, IBM InfoSphere FastTrack, or IBM InfoSphere Information Analyzer This metadata is already in the metadata repository.

16

Administrator's and Author's Guide

Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Import and export methods on page 70 Glossary administrators can use several methods to import and export glossary content to enable rapid development of a glossary. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Related information User Information MetaBroker

Design and develop glossary content


Whether you design a new business glossary or design a glossary from one or more glossaries that exist throughout the enterprise, the process is similar. When you develop the categories, terms, and their relationships, also plan what custom attributes the terms need, and which stewards are appropriate for the terms and categories.

Define terms
You define terms for the entire enterprise to ensure clarity and compatibility among departments, projects, or products. If the term name is long, use spaces instead of underscores or hyphens to break up the name. Otherwise, when long term names are displayed in results tables, the name does not wrap and the adjacent columns are narrow. For example, instead of Northeast_Office_Billing_Address, use Northeast Office Billing Address. Tips: v Define terms according to the standards accepted by the International Organization for Standardization and the International Electrotechnical Commission (InterISO/IEC 111794): Write term names in the singular form State descriptions as a phrase or with a few sentences Express descriptions without embedded concepts and without definitions of other terms State what the concept of a term is rather than just what it is not Use only commonly understood abbreviations in descriptions v In addition, according to ISO/IEC 111794, term descriptions should: State the essential meaning of the concept Be precise, unambiguous, and concise Be able to stand alone

Chapter 3. Administering a glossary of metadata assets

17

Be expressed without embedded rationale, functional usage, or procedural information Avoid definitions that use other term definitions Use the same terminology and consistent logical structure for related definitions Be appropriate for the type of metadata item that is being defined If departments, projects, or product lines have different meanings for the same term, review all definitions together and have subject matter experts arrive at a common definition. If a common definition is not possible, create several terms from the single term and identify the context for the term in the term name. Terms can have the same name only if they are in different categories. In this scenario, the category that contains the term gives you added information about the term. For example, the term Address might mean Shipping Address to Distribution, Bill To Address to Accounting, and Contact Address to Sales. You might define the terms as follows: v Create a single category with different terms In the same category, create terms Shipping Address, Bill To Address, and Contact Address. In the Short Description and Long Description fields of each term, give a definition that is specific to the department. This method lets you create terms that have a unique definition. v Create separate categories where each category contains a term with the same name In the Distribution, Accounting, and Sales categories, create the term Address. Each term is contained by a different category, which indicates that the term definition is specific to each department. This method combines several term definitions into a single definition. To understand the meaning of a term, you must look at the category that contains it. Related tasks Specifying terms for a category to contain on page 46 Administrator and Author users can specify terms for a category to contain. Related information Examples of good and poor term definitions according to ISO standards

Relate terms to terms


You can relate a term to another term to provide users with other terms that might give additional information. You can define relationships of terms to other terms: v Different terms with the same meaning can be defined as synonyms v Terms that are not synonyms, but that are related in some other way, can be defined as related terms v Terms can be assigned to terms Typically, the subject matter expert with overall knowledge of the glossary decides which terms to relate to other terms.

18

Administrator's and Author's Guide

If you plan to use IBM Rational Data Architect as your import tool, use this tool to relate the terms before you import into the business glossary. The relationship between the terms persists in the business glossary. Typically, you use IBM InfoSphere Business Glossary to define term relationships.
Table 2. How define various term relationships
Term relationship Relate terms to terms Define terms as synonyms Reference information Relating a term to another term Making a term synonymous with another term

Create custom attributes for terms and categories


You create custom attributes when you want to define additional properties to describe a term or category. Custom attributes are attributes of categories and terms that you create if the standard attributes such as name, parent category, and description are insufficient for the needs of your company. For example, you might create a custom attribute called Data Sensitivity with values 1 through 5, with 5 as the highest data sensitivity and the greatest security impact. With XML, you can import custom attributes and their values into the glossary. Use IBM InfoSphere Business Glossary (Glossary Import XML) to create or edit custom attributes in the glossary, or to import custom attribute values into the glossary. Related concepts Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Related tasks Creating or editing custom attributes on page 67 Administrator users can create and edit custom attributes to store additional information about terms and categories. Assigning assets to a steward on page 39 Administrator users can assign assets to users or groups of users that are stewards.

Select users to be stewards


Select a user to be a steward of a term, category, or other asset in the metadata repository. The steward is responsible for the definition, purpose, and use of the asset. Before a user can be assigned as a steward, the user must exist in IBM InfoSphere Information Server. If the user does not already exist, that steward will not be assigned to an asset. Either create the user in InfoSphere Information Server or use User Information MetaBroker to import a list of users with their contact information. If you use this MetaBroker, you do not need any special administrator or security role in InfoSphere Information Server.

Set up the glossary environment


The glossary that is under development can be either in the production or in a development environment.

Chapter 3. Administering a glossary of metadata assets

19

Ideally, the glossary is designed in a development environment. This environment allows the team to import, review, delete, and change the glossary contents as needed without endangering the production glossary. The development environment must have the same version of IBM InfoSphere Information Server and its suite components that are installed in the production environment. If the glossary is designed in the production environment, you can hide the terms that are under development from users. 1. Set the status of the categories and terms that you want to publish by doing the following steps: a. In IBM InfoSphere Business Glossary, click Glossary Edit Settings Edit Options. b. Select the Candidate check box to display the deployed glossary terms. 2. Verify that the terms under development are displayed in the glossary by using the browser application in InfoSphere Business Glossary or by using IBM InfoSphere Business Glossary Anywhere. 3. In the Edit Options pane, clear the Candidate check box to hide the terms that are under development.

Populate the glossary with categories and terms


After you have decided on a category structure and which terms each category contains, either create the categories and terms, or import them into the glossary.

Tips about the environment for categories and terms


You can choose one of the following methods to create or import your terms and categories into a glossary: v Create or import categories and terms in a test environment of IBM InfoSphere Information Server until the glossary is ready for deployment in your production environment. v If you do not have a separate test environment, you can hide these new terms from users in the production glossary. Go to the Edit Options pane of IBM InfoSphere Business Glossary (Glossary Edit Settings Edit Options) and clear the Candidate and Accepted check boxes. After the terms are approved by the team, select those check boxes to make the new terms accessible to users. The tree structure of categories is created when you assign a category to be a subcategory of another category. The subcategory can be the parent of another category. This assignment is made in the import file or is done by the tool that you use to create the categories.

Tools to import categories and terms


The following tables list tools that you can use to import or to create categories and terms in your glossary. Which tool you use depends on the source of your categories and terms.
Table 3. Tools to import categories and terms into the glossary
Sources of categories and terms A file in a comma-separated value (CSV) format from InfoSphere Business Glossary, Version 8.1 or later Tool InfoSphere Business Glossary Reference information Importing from a CSV file

20

Administrator's and Author's Guide

Table 3. Tools to import categories and terms into the glossary (continued)
Sources of categories and terms A file in an extensible markup language (XML) format from InfoSphere Business Glossary, Version 8.1.1 or later IBM Rational Data Architect Tool InfoSphere Business Glossary This import method also imports the links to assets and to stewards. IBM Rational Data Architect MetaBroker IBM Rational Data Architect MetaBroker Importing metadata with Import Export Manager A CSV file from any spreadsheet application IBM InfoSphere FastTrack Importing existing mapping specifications that are in CSV files Reference information Importing from an XML file

Tools to create categories and terms


Table 4. Tools to create categories and terms
Tool InfoSphere Business Glossary Reference information Creating or editing categories Creating or editing terms IBM Rational Data Architect Glossary models

Create or import categories and terms


After the team has approved the categories and terms, use the appropriate tool either to create them or to import them into the glossary.

Tips about the environment for categories and terms


You can choose one of the following methods to create or import your terms and categories into a glossary: v Create or import categories and terms in a test environment of IBM InfoSphere Information Server until the glossary is ready for deployment in your production environment. v If you do not have a separate test environment, you can hide these new terms from users in the production glossary. Go to the Edit Options pane of InfoSphere Business Glossary (Glossary Edit Settings Edit Options) and clear the Candidate and Accepted check boxes. After the terms are approved by the team, select those check boxes to make the new terms accessible to users. The hierarchy of categories is created when you assign a category to be the parent of other categories. This assignment is made in the import file or is done by the tool that you use to create the categories.

Tools to import categories and terms


The following tables list tools that you can use to import or to create categories and terms in your glossary. Which tool you use depends on the source of your categories and terms.
Table 5. Tools to import categories and terms into the glossary
Sources of categories and terms A file in a comma-separated value (CSV) format from InfoSphere Business Glossary, Version 8.1 or later A file in an extensible markup language (XML) format from InfoSphere Business Glossary, Version 8.1.1 or later Tool InfoSphere Business Glossary Reference information Importing with a CSV file

InfoSphere Business Glossary This import method also imports the links to assets and to stewards.

Importing with an XML file

Chapter 3. Administering a glossary of metadata assets

21

Table 5. Tools to import categories and terms into the glossary (continued)
Sources of categories and terms IBM InfoSphere Data Architect IBM Rational Data Architect, Version 7.5 or earlier A glossary archive file in a metadata interchange format from InfoSphere Business Glossary, Version 8.1 or later Tool IBM InfoSphere Data Architect MetaBroker IBM Rational Data Architect MetaBroker InfoSphere Business Glossary Reference information IBM Rational Data Architect MetaBroker Importing metadata with Import Export Manager Importing business glossaries from archive files

A CSV file from any spreadsheet IBM InfoSphere FastTrack application

Importing existing mapping specifications that are in .csv files

Tools to create categories and terms


Table 6. Tools to create categories and terms
Tool IBM InfoSphere Business Glossary Reference information Creating or editing categories Creating or editing terms InfoSphere Data Architect Rational Data Architect, Version 7.5 or earlier Glossary models in InfoSphere(tm) Data Architect

Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Import and export methods on page 70 Glossary administrators can use several methods to import and export glossary content to enable rapid development of a glossary. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Related information User Information MetaBroker

Review and revise the glossary structure


As the team develops the glossary, it can view the category structure, the terms that each category contains, and the term relationships to other assets. Use IBM InfoSphere Business Glossary to browse and to edit categories, terms, and other assets in the glossary. You can make changes in the structure of the category tree, change term relationships, and check steward assignments.

22

Administrator's and Author's Guide

Related tasks Creating or editing categories on page 42 Administrator and Author users can create a category or edit the properties of existing categories. Creating or editing terms on page 56 Administrator and Author users can create a term or edit the properties of an existing term.

Populate the metadata repository with other assets


A non-external asset must be in the metadata repository before you can assign the asset to a term.

Import assets into the metadata repository


You can use various tools to import assets such as business intelligence (BI) reports, jobs, and database tables into the metadata repository. Typically, data architects import the assets into the metadata repository. Choose the tool to import the assets based on the source of the assets. For example, if you want to import a Cognos BI report, use the appropriate MetaBroker bridge in Import Export Manager. If your assets are sourced in IBM InfoSphere Data Architect, import its physical data models. Related information Bridges and MetaBrokers IBM InfoSphere Data Architect product overview

Assign assets to terms


Assigning an asset to a term provides business analysts with the correct data sources that are associated with the term. Typically, the data architect or data analyst works with the business analyst to decide which asset is assigned to a term. If you plan to use IBM InfoSphere Data Architect as your source of assets, you can assign the asset to the term before you import into the metadata repository. The relationship between the terms and their assets persists in the metadata repository. During the export process, in Select the Model to Export window, select Create classified object relationships to Terms based on dependencies to words. This parameter preserves the relationship between the term and its asset in the metadata repository. If you use other tools to import assets into the business glossary, you can use IBM InfoSphere Business Glossary or IBM InfoSphere Metadata Workbench to assign an asset to a term. Typically, InfoSphere Business Glossary is used to assign large numbers of assets to terms. The following table lists tools that can assign assets to terms. The tools are listed in order of ease of use and versatility, with the highest preference listed first.
Table 7. Tools to assign assets to terms
Tool InfoSphere Business Glossary InfoSphere Data Architect with IBM InfoSphere Data Architect MetaBroker Reference information Assigning assets to a term Setting up your work environment in InfoSphere Data Architect IBM Rational Data Architect MetaBroker

Chapter 3. Administering a glossary of metadata assets

23

Table 7. Tools to assign assets to terms (continued)


Tool IBM InfoSphere FastTrack IBM InfoSphere Information Analyzer Reference information Importing metadata into the metadata repository Associating imported metadata with your project

Assign external assets to terms


You can assign entities that are outside of the metadata repository to terms. These entities are referred to as external assets. An external asset might be a business process model or a UML model that is stored in an asset management system, a Web service, or a quarterly report on a shared network drive. External assets differ from assets that are in the metadata repository in the following ways: v You cannot search or browse external assets by using IBM InfoSphere Business Glossary because external assets are outside of the metadata repository. v You cannot assign stewards to external assets. v External assets exist only in relationship to a term. If you delete the term, all information about the external asset is also deleted from the metadata repository. With external assets, you can do the following actions: v You can assign an external asset to a term. The assignment is done from the Glossary tab in IBM InfoSphere Information Server Web console. v You can display all assets, including external assets, that a term is assigned to. You can also see basic information about an external asset. The display is from the InfoSphere Business Glossary browser. Related tasks Assigning external assets to a term

Assign stewards
Assign a user in IBM InfoSphere Information Server to be a steward who is responsible for the definition, purpose, and use of a term, category, or other asset in the metadata repository. Typically, the data architect assigns stewards to terms, categories, and other assets in the metadata repository. The following table lists the tools that can assign stewards. Which tool you use depends on the number of stewards you need to assign to assets.
Table 8. Tools to assign a steward to categories, terms, and other assets
Tool IBM InfoSphere Business Glossary Use this tool if you have many stewards to assign. Reference information Assigning a steward to categories and terms Assigning assets to a steward Importing from a CSV file Importing from an XML file IBM InfoSphere Metadata Workbench Use this tool to assign individual stewards to assets. Right-click the name of the asset and then select Assign Steward.

24

Administrator's and Author's Guide

Related concepts Stewards on page 37 Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository. Related tasks Designating a user to be a steward on page 37 Administrator users can assign any user or group of users to be a steward who is responsible for a category or a term. Related information Creating users in the Web console Bridges and MetaBrokers Requirement for importing database-related metadata Categories and Terms MetaBroker User Information MetaBroker

Make the glossary available to the enterprise


Make the glossary available to the enterprise after the team decides that the glossary is ready for use. The last step in developing the glossary is to make it available for use in the enterprise. To make the glossary available to the enterprise: 1. Depending on the environment that you chose for developing your glossary, you make your glossary available to users by doing the following steps:
Option Description

If the glossary is not part of the production 1. Export the glossary from the test glossary environment by using the Export Glossary Archive tool in IBM InfoSphere Business Glossary. 2. Export the glossary from the test environment by using the Export Glossary Archive tool in InfoSphere Business Glossary. 3. Import the glossary into the production environment by using the Import Glossary Archive tool. Use the mapping file to manage conflicts between the imported and the existing business glossary assets. If the glossary is part of the production glossary 1. In InfoSphere Business Glossary, click Glossary Edit Settings Edit Options. 2. Select the Standard and Accepted check boxes to display the deployed glossary terms.

2. Verify that the new categories and terms are displayed in the glossary by using the browser application in InfoSphere Business Glossary or by using IBM InfoSphere Business Glossary Anywhere.

Chapter 3. Administering a glossary of metadata assets

25

Related concepts Importing and exporting glossary archives on page 89 You can export all or part of the business glossary from one instance of IBM InfoSphere Information Server and import it to the metadata repository on another instance, or reimport it to the original repository. Related tasks Exporting to a glossary archive file on page 95 Glossary administrators can export the business glossary or a subset of it in order to merge it into another business glossary or to move it to another instance of IBM InfoSphere Information Server. Importing from a glossary archive file on page 91 Administrator users can import all or part of a business glossary and change the values of its assets during the import.

Configuring the glossary


You can configure IBM InfoSphere Business Glossary to fit the needs of your organization. You can configure: v General settings, such as: the display that users see when they log in an e-mail address for feedback about the glossary display order of parts of user names the set of terms to display based on their status (standard, accepted, a candidate or deprecated) whether to display undefined properties whether to display a history of changes to each term integration with IBM Cognos 8 Go! v security roles (access rights to the glossary) v viewing permissions v support for right-to-left reading languages

Configuring general settings


Glossary administrators can customize glossary display and behavior. You must have the Business Glossary Administrator role. You configure most IBM InfoSphere Business Glossary settings from the Edit Settings pane. Note: You configure viewing permissions from the InfoSphere Business Glossary browser. Procedure To edit the Edit Settings page: 1. In the Navigation pane on the Glossary tab, click Contents Glossary Settings Edit Settings. 2. Edit the General Settings:

26

Administrator's and Author's Guide

3.

4.

5.

6.

7.

v The header and welcome text that you enter are displayed with line returns, special characters, and white space intact. You do not need to include HTML code. For example, to display the text Sales & Marketing, you do not need to write Sales &amp; Marketing. v Enter an e-mail address. This address is used when users click a Feedback link in their glossary display. v The logo size is 100 by 40 pixels. Larger images are scaled to this size. v By editing the user name display pattern, you can change the sequence in which elements of user names are displayed. For example, to cause the title to appear as the rightmost entry, move <TITLE> to the right, after the other elements. Under Term Display in Browser, select the status of terms to display. The browser displays only terms whose status is selected. By default, all statuses are selected so that the browser displays all terms, with any status. Under Property Display in Browser, select whether you want to have properties that have no values defined displayed in the browser. The default is to display all properties, including those for which values are not defined. These are indicated in the browser by the label "Undefined." Under Term History, select whether you want to have term history displayed. Term history shows the changes that have been made to a term over time. Term history is enabled by default. If you disable term history after it has been enabled and history data has been recorded, the existing data will be deleted. Under Integration with Cognos 8 Go! Search, select the check box to enable a connection with an instance of IBM Cognos 8 Go! Search and enter the URL through which it can be reached. Click Test Connection to determine whether the connection works. Click Save and Close.

Assigning security roles to glossary users


Access to the glossary is controlled by user roles. IBM InfoSphere Business Glossary supports role-based access of the glossary. The IBM InfoSphere Information Server suite administrator assigns roles to users. Related information Assigning security roles in the Web console

Roles
Roles give business glossary users varying levels of authority to perform tasks.

Business Glossary Administrator role


Users with the Business Glossary Administrator role can set up and administer the glossary so that other users can find and analyze the information they need. Business Glossary Administrators have access to all menus in the Navigation pane of the glossary administrative interface. Administrators can do the following tasks in addition to the tasks that Business Glossary Authors, Business Glossary Users, and Business Glossary Basic Users can do: v Customize the business glossary display and settings, including items such as: The e-mail address for glossary feedback Which terms are displayed based on their status
Chapter 3. Administering a glossary of metadata assets

27

Whether a record of changes to terms is stored and displayed Whether the glossary is connected to IBM Cognos 8 Go! Search, if available v Create, edit, and delete the following items in the glossary: All terms and all categories, regardless of author Custom attribute definitions External assets that are assigned to terms v Assign information assets to terms; for example, data sources that are stored in the metadata repository, and external assets v Create stewards from users and groups v Restrict certain users from viewing specific categories and their contents v Import and export glossary content from or to external files The Business Glossary Administrator role is the most privileged InfoSphere Business Glossary role.

Business Glossary Author role


Users with the Business Glossary Author role can create and edit terms and categories, and can assign assets to terms. Business Glossary Authors have access to terms and categories from the Browse and Edit menu in the Navigation pane of the glossary administrative interface. Authors can perform the following tasks in addition to the tasks that can be performed by Business Glossary Users and Business Glossary Basic Users: v Create and edit all categories and all terms v Delete categories and terms that they created v Assign stewards to terms, categories, and other assets The Business Glossary Author role is often assigned to stewards.

Business Glossary User role


Users with the Business Glossary User role can view the terms, categories, and stewards in the glossary, including the assets that are assigned to terms and categories. Users with this role can view glossary content from any interface that provides access to InfoSphere Business Glossary except from the glossary administrative interface. Users can do the following tasks in the glossary browser in addition to the tasks that Business Glossary Basic Users can do: v Browse the structure of data sources that are related to terms v View the details of categories and terms, including assigned assets v View assets in the metadata repository (whether they are assigned to terms or not) v View the business lineage of a term (if supported by the configuration) v View a list of assets that are managed by a particular steward, including assets other than terms and categories v Search the glossary for other assets in addition to terms and categories

28

Administrator's and Author's Guide

Business Glossary Basic User role


Users with the Business Glossary Basic User role can view the terms, categories, and stewards in the glossary, but information about other types of metadata repository assets is not available to them. In this way, users who do not need to know about the relationship of terms and categories to other assets are not presented with unnecessary information. For example, the assets that are assigned to terms are not shown in the display of term details to users with the Business Glossary Basic User role. In addition, when users with this role search for assets, they can search only for terms and categories, and not other kinds of assets. Finally, some views that are available to other user roles are not available: for example, Business Glossary Basic Users cannot view the data source tree or business lineage. Users with this role can view glossary content from any interface that provides access to InfoSphere Business Glossary except from the glossary administrative interface. Business Glossary Basic Users can do the following tasks in the glossary browser: Browse the structure of categories and terms Search the glossary for categories and terms View the details of categories and terms, excluding assigned assets Send feedback to the administrator about categories and terms Find terms in IBM Cognos 8 Business Intelligence (if supported by the configuration) v View a list of assets that are managed by a particular steward, excluding assets other than terms and categories v v v v v The Business Glossary Basic User role is the least privileged InfoSphere Business Glossary role. Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Stewards on page 37 Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository. Related tasks Accessing the business glossary for administering and authoring on page 33 Administrator and Author users can access the business glossary from the IBM InfoSphere Information Server Web console by using a Web browser.

Configuring viewing permissions


IBM InfoSphere Information Server suite administrators can restrict specific users from viewing certain glossary categories.

Chapter 3. Administering a glossary of metadata assets

29

You must be a InfoSphere Business Glossary Administrator and be either an IBM InfoSphere Information Server Suite User or Suite Administrator to configure viewing permissions. By default, all IBM InfoSphere Business Glossary users can view all the categories and terms in the glossary. However, the Business Glossary Administrator can specify a subset of categories that only specific users are permitted to view. In this way, you can restrict access to certain categories and their associated content (such as terms) to certain glossary users. You can set viewing permissions for Business Glossary Basic Users and Business Glossary Users who are not assigned a more privileged role (Business Glossary Author or Business Glossary Administrator) in InfoSphere Business Glossary. Business Glossary Authors and Business Glossary Administrators have unlimited access to all categories and you cannot restrict their access. You can set viewing permissions for individual users or user groups. You can also deny access to a category to all users whose most privileged role is Business Glossary User, or, if you have previously changed the default to restrict access, restore access to a category. If a user is not authorized to view a category, then the following results occur for that user: v The category and its associated content are not included in search results. v The category and its associated content do not appear in other glossary displays, such as the category tree or context, except in the following case: If the user is authorized to view a subcategory, but is not authorized to view the parent category of that subcategory, then the name of the category for which the user is not authorized is replaced with ***restricted*** in some InfoSphere Business Glossary displays. Viewing permissions are enforced in the InfoSphere Business Glossary browser, in IBM InfoSphere Business Glossary Anywhere, and by the InfoSphere Business Glossary REST API. User groups whose most privileged role is that of Business Glossary User are included in the set of users for which you can define access. Any individual user who is a member of a user group and who has not been assigned a specific InfoSphere Business Glossary role has permission to view only the categories and terms that are permitted to be seen by the group. If a member of a user group also has another role assigned, the most privileged role determines viewing permissions. If a user is part of a user group that has the Business Glossary Basic User or Business Glossary User role, and is also assigned the same role as an individual user, then that user can be assigned viewing permissions that are different from those of the group. Procedure To configure viewing permissions: 1. Log in to the InfoSphere Business Glossary browser with a Business Glossary Administrator user name and password. 2. Select Viewing Permissions.

30

Administrator's and Author's Guide

3. From the navigation tree of categories in the left pane, select a category for which you want to specify viewing permissions. The category name becomes highlighted. The Permissions pane displays the existing permissions for the selected category. 4. Change permissions as follows: a. Select an authorization level. b. If you selected Only selected users and groups have access, click the check box beside the name of each user that you want to allow to view the selected category and its content. If you selected All users and groups have access or No users or groups have access, continue to the next step. 5. Optional: Select the Copy permissions to subcategories check box if you want all the subcategories to have the same permissions as those of the selected parent category. 6. Click Apply. The viewing permissions are saved. Starting with their next glossary session, the selected users can view only those categories and contained terms for which they have permission. In the categories pane of the Viewing Permissions page, the visual icon displayed next to the category name changes if the category is available to no users or some users. Related concepts Assigning security roles to glossary users on page 27 Access to the glossary is controlled by user roles. Roles on page 27 Roles give business glossary users varying levels of authority to perform tasks.

Bidirectional language support


IBM InfoSphere Business Glossary provides bidirectional language support. You can configure InfoSphere Business Glossary to operate correctly for right-to-left reading languages or to determine, based on the text that a user enters in a text entry field, whether to operate correctly for a right-to-left or left-to-right language. The default is to operate correctly for left-to-right reading languages. If you configure InfoSphere Business Glossary for right-to-left languages, text entry will start in the right side of text entry fields and proceed to the left, and glossary content will be displayed from right-to-left. If you configureInfoSphere Business Glossary for left-to-right languages, text entry will start in the left side of text entry fields and proceed to the right, and glossary content will be displayed from left-to-right. Or, you can choose a setting that causes the user interface to adapt to the direction of the text that the user enters and the text direction of glossary content. The settings will affect text entry and display in InfoSphere Business Glossary and IBM InfoSphere Business Glossary Anywhere. You configure this setting from the IBM WebSphere Application Server administrative console.

Configuring base text direction


Change the setting for base text direction by configuring it in the IBM WebSphere Application Server administrative console.
Chapter 3. Administering a glossary of metadata assets

31

You must be a WebSphere Application Server administrator. By default, IBM InfoSphere Business Glossary and IBM InfoSphere Business Glossary Anywhere support text entry and display for languages that read from left-to-right. You can change this so that for languages that read from right-to-left, text fields correctly accept and display text that reads from right-to-left and glossary content is displayed correctly. When the setting is correct for the language in use, phrases in that language will be displayed in the correct order. You can also change this so that InfoSphere Business Glossary dynamically adapts to the direction of the language that the user types, and correctly displays glossary content based on the text direction of the particular glossary item. By default, text that is entered into InfoSphere Business Glossary and InfoSphere Business Glossary Anywhere is displayed with left-to-right direction. This includes text entry fields in which users can type text and static contexts in which text is displayed; for example, when the glossary displays a list of terms. You can configure the base text direction setting to be left-to-right (the default), right-to-left, or to dynamically adapt to the text that is typed or displayed. Procedure 1. Log in to the IBM WebSphere Application Server administrative console. 2. Expand Servers. 3. Click Application servers. 4. Click the name of the server that hosts InfoSphere Business Glossary. 5. Under the Server Infrastructure heading, expand Java and Process Management. 6. Click Process Definition Java Virtual Machine Custom Properties. 7. Click New, and enter the following information: a. In the Name field, type user.iis.bg.bidi.direction. b. In the Value field, type one of the following: v Left-To-Right Bidirectional text entered in or displayed by the glossary will appear with left-to-right base direction. v Right-To-Left Bidirectional text entered in or displayed by the glossary will appear with right-to-left base direction. v Contextual The base direction of text entered in or displayed by the glossary will dynamically adjust to left-to-right or right-to-left based on the initial characters that appear in the text. Note: Text that consists entirely of Latin characters will be displayed correctly, even if the setting is Right-to-Left. Optional: Type a description. Click Apply or OK to save the changes to the local configuration. Click Save to apply these changes to the master configuration. Restart WebSphere Application Server. Note: You must restart WebSphere Application Server for the setting to take effect.

8. 9. 10. 11.

32

Administrator's and Author's Guide

Results When users type text into text entry fields or when previously introduced text is displayed in InfoSphere Business Glossary or InfoSphere Business Glossary Anywhere, the interface displays this text according to the setting that you specified.

Accessing the business glossary for administering and authoring


Administrator and Author users can access the business glossary from the IBM InfoSphere Information Server Web console by using a Web browser. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v You must have the URL to a server where IBM InfoSphere Business Glossary is installed. v You must enable pop-up windows in your Web browser for this URL. An administrator of IBM InfoSphere Information Server Web console controls access to the glossary by specifying which suite users are assigned which product role: Business Glossary Administrator, Business Glossary Author, and Business Glossary User. Procedure To access the business glossary: 1. In the Web browser, enter the URL for the glossary. The URL is http://host_server:port, where host_server is the name or IP address of the IBM InfoSphere Information Server Web console for the business glossary that you want to connect to, and port is the port number that is assigned to the IBM InfoSphere Information Server Web console. 2. Type the user name and password for the IBM InfoSphere Information Server Web console and click Login. 3. Click the Glossary tab to begin working with the business glossary. Related concepts Roles on page 27 Roles give business glossary users varying levels of authority to perform tasks.

Accessing glossary content


Administrator and Author users can access glossary content from the administrative interface. From the IBM InfoSphere Business Glossary administrative interface, you can search for glossary content, browse glossary content, and retrace your browsing history. From the Navigation panel, you can search for glossary content, manage glossary content and the glossary configuration, and retrace your browsing history. From the Overview page, you can drill down through the displayed categories to obtain information about them and the terms that they contain.

Finding categories and terms with a simple search


Administrator and Author users can search for categories and terms in the business glossary by name or by description.
Chapter 3. Administering a glossary of metadata assets

33

v You must have the Business Glossary Administrator role or the Business Glossary Author role. To find categories or terms by using a simple search: Procedure 1. In the Navigation pane on the Glossary tab, click Search Simple Search. 2. In the Simple Search field, type the search criteria. You can use all or part of a name or short description. You can use multiple keywords for names or descriptions, separated by spaces or by commas. Search results are ranked by relevance to your search criteria. 3. Click Search. If you typed multiple keywords, the list includes the categories and terms whose names or short descriptions include all of the keywords. 4. In the list, click the name of a category or term to display its relationship and its properties. Related concepts Viewing the properties of an asset on page 35 On the Details pane for an asset, you can examine its properties and relationships.

Finding assets with an advanced search


Administrator and Author users can use multiple criteria to search for assets in the business glossary. v You must have the Business Glossary Administrator role or the Business Glossary Author role. Procedure To find assets with an advanced search: 1. In the Navigation pane on the Glossary tab, click Search Advanced Search. 2. Specify the criteria for the search:
Option To search by keyword: Description In the Keyword field, type one or more keywords that represent words in the name or short description of the asset. Use commas or spaces to separate multiple keywords. You can leave this field blank when you are searching by class or by date. Select one of the following options: All Any Exact Finds assets where all keywords are present. Finds assets where any of the keywords are present. Finds assets where the exact search string entered in the Keyword field is present.

To define the scope of the keyword search:

To search in the description field of assets: To display synonym terms of any terms returned by the search:

Select Search Descriptions. Otherwise, only the name field is searched. Select Also Return Synonyms.

34

Administrator's and Author's Guide

Option To limit the search to a particular class of information asset:

Description Select the class from the Type list. For example, to limit the search to categories, select Category. You can run this search without specifying a keyword. In the Created by field, type the user name. The user name is listed in the Details page for the steward. Select an option from the Created on list. If you choose Range, you must select beginning and end dates. In the Modified by field, type the user name. The user name is listed in the Details page for the steward. Select an option from the Modified on list. If you choose Range, you must select beginning and end dates.

To limit the search to assets that were created by a particular steward whose identity is defined in the repository: To limit the search based on the date the assets were created: To limit the search based on the user who last modified the assets: To limit the search based on the date that the assets were last modified:

3. Click Search. Search results are ranked by relevance to your search criteria. 4. In the list, click the name of the asset to display its relationships and its attributes. Related concepts Viewing the properties of an asset On the Details pane for an asset, you can examine its properties and relationships.

Viewing the properties of an asset


On the Details pane for an asset, you can examine its properties and relationships. The Details pane for each asset in the business glossary displays multiple properties and relationships of the asset. Assets include terms, categories, and more technical assets that glossary authors or administrators can assign to terms. Database tables, database table columns, terms, and categories are among the types of assets in the business glossary. The type of an asset defines which attributes it can have and which other types of assets it can be related to. However, some potential attributes and relationships of a particular asset might not be populated with values.

Properties
The glossary displays the following properties for an asset: attributes, notes, modification details, and terms to which the asset is assigned. Attributes vary according to asset type, but common attributes include name, short description, and long description. For database tables and database columns, attributes can include analysis information (displayed in the Analysis section). Analysis information is available for a particular asset if an analysis has been run and published in IBM InfoSphere Information Analyzer. Notes are user-supplied comments about assets. Business Glossary Administrators and Authors can create and edit notes. Software programs can also create notes about assets that can be viewed in the glossary after those assets are imported.

Chapter 3. Administering a glossary of metadata assets

35

Most properties of an asset are on the Attributes and Notes tabs of the Details pane for the asset.

Relationships
The relationships of an asset, like its attributes, depend on its type. The following relationships are commonly displayed: Stewardship The user or user group who is assigned to manage the asset. Containment The relationship between the asset and its parent or child. For example, a database table might be contained by a data schema that is contained by a database that is contained by a host computer system. The database table contains several database table columns. Related information Column analysis in InfoSphere Information Analyzer

Retracing your browsing history


Administrator and Author users can navigate back to the page of any asset already viewed during the current session. v You must have the Business Glossary Administrator role or the Business Glossary Author role. Procedure To retrace your browsing history: 1. In the Navigation pane on the Glossary tab, click History. 2. Click the name of an asset to display its Details page. 3. Optional: Click Clear History to remove all entries from the pane.

Using Advanced Search


You can use Advanced Search to search for a term, category, or other asset by the text in one or more of its attributes. The Advanced Search display is displayed near the top of several pages of the IBM InfoSphere Business Glossary administrative interface. Procedure To perform an advanced search: 1. Expand the Advanced Search twistie. 2. Select an attribute from the Attribute: list. 3. In the Value: field, enter text to search for in that attribute. The search is case-sensitive. 4. Click Add. The attribute type and text to search for appear in a table. 5. Select the check boxes that correspond to the items in the table that you want to include in the search. To select all the items, select the check box next to the word Attribute in the top row of the table. 6. Click Search. The assets that match the search criteria are displayed in a table.

36

Administrator's and Author's Guide

To search for an asset with the text "account" in its short description and for which "John Smith" is the steward: 1. Add the short description text to the list of items that can be searched. a. Select Short Description from the Attributes: list. b. Enter account in the Value: field. c. Click Add. 2. Add the steward John Smith to the list of items that can be searched. "John Smith" must be the configured user name of the steward. a. Select Steward from the Attributes: list. b. Enter John Smith in the Value: field. c. Click Add. 3. Click Search. The terms with the word "account" in their short descriptions for which John Smith is the steward are displayed.

Managing stewards
Administrator users can assign users or groups of users as stewards to be responsible for terms and categories in the glossary.

Stewards
Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository. A steward who works with the glossary typically has the Business Glossary Author role and is assigned to the assets for which the user or group is the appropriate contact. You can assign stewardship to a user or user group, but the assigned steward does not have to be a user of the glossary. For example, a steward could be a steward for a physical model from ERwin or for an asset from IBM InfoSphere Information Analyzer or IBM InfoSphere DataStage. An asset can have only one steward. When you view the Details page of an asset that has a steward, a link to its steward is displayed. That link opens the Details page of the steward and contains an e-mail address and phone number. Related concepts Roles on page 27 Roles give business glossary users varying levels of authority to perform tasks. Related tasks Designating a user to be a steward Administrator users can assign any user or group of users to be a steward who is responsible for a category or a term.

Designating a user to be a steward


Administrator users can assign any user or group of users to be a steward who is responsible for a category or a term. v You must have the Business Glossary Administrator role. v The user or user group must exist in the IBM InfoSphere Information Server metadata repository and must have the Suite User role.
Chapter 3. Administering a glossary of metadata assets

37

Procedure To designate a user or a user group to be a steward: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Stewards. 2. On the Select a Steward to Manage pane, click New. . 3. On the Create Steward Properties pane, click the user icon 4. In the Select User or Group pane, select Users or User Groups from the Search for list. Click Search to display a new list of users. 5. For the user or user group that you want to designate as a steward, type in the name of the user or user group. 6. Optional: Click Additional Search Criteria to search by the user name, e-mail address, title, or location of the user or the user group. Type the complete text string in the search fields. 7. Click Search. In the list of search results, select the name of the user or user group and click OK. 8. Click Save and Close. Related concepts Stewards on page 37 Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository. Related tasks Assigning assets to a steward on page 39 Administrator users can assign assets to users or groups of users that are stewards. Assigning a steward to categories and terms Administrator and Author users can assign a user or a group of users to be the steward who is responsible for a category or term. Transferring assets between stewards on page 41 Administrator and Author users can transfer assets from one steward to another. Removing assets from a steward on page 40 Administrator and Author users can remove assets from a steward so that the steward no longer manages them. Related information User Information Metabroker

Assigning a steward to categories and terms


Administrator and Author users can assign a user or a group of users to be the steward who is responsible for a category or term. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v The user or user group to be the steward must exist in the IBM InfoSphere Information Server metadata repository. You can also assign stewards to categories and terms when you create or edit the steward. Procedure To assign a steward to categories and terms:

38

Administrator's and Author's Guide

1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms or Contents Browse and Edit Categories. 2. In the Select a Term to Manage or in the Select a Category to Manage page, select the term or category:
Option To select a single term or category: To select multiple terms or categories Description Select the term or category and click Edit Term or Edit Category. 1. Click the Edit Multiple Terms or Edit Multiple Categories link. A list of terms or categories is displayed. 2. Click Advanced Search to select items according to specific criteria. 3. Select the terms or categories that you want to edit. 4. Click Edit One at a Time to specify a different steward for each term or for each category. Alternatively, click Edit All at Once and select the check box next to the Steward field to assign the same steward to all selections.

3. On the Edit Properties page, click the user icon next to the Steward field. 4. In the Select Steward page, select Steward Users or Steward Groups from the Search for list. a. Optional: Click Additional Search Criteria to search by the user name, e-mail, title, or location of the steward. Type the complete text string to search for. b. Click Search. 5. Select the user name in the search results list to move it to the Selected Steward list. 6. Click OK and then click Save and Close. Related concepts Stewards on page 37 Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository. Related tasks Assigning assets to a steward Administrator users can assign assets to users or groups of users that are stewards.

Assigning assets to a steward


Administrator users can assign assets to users or groups of users that are stewards. You must have the Business Glossary Administrator role. You can also assign an asset to a steward from the Tasks list on the Details page of the asset, or on the Details page of the user or the user group that is a steward. To assign assets to a steward: Procedure
Chapter 3. Administering a glossary of metadata assets

39

1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Stewards. 2. Select the steward and click Edit Steward. 3. On the Edit Properties page, click Managed Assets. 4. On the Managed Assets page, click Add. 5. In the Add Managed Assets window, select the assets that you want the steward to be responsible for: a. From the list, select a type of asset or select All Types. Type in the search string in the Search field or leave the field blank to get a list of all assets of the selected type. b. Optional: Click Advanced Search and select Name or Description from the list. Type in the search string in the Value field and click Add. 6. Click Search. Select the assets from the list of search results to move them to the Selected Items list. 7. Click OK. The assets are listed in the Managed Assets list for the steward. 8. Click Save and Close. Related concepts Stewards on page 37 Stewards are users or groups of users who are responsible for the definition, purpose, and use of assets in the metadata repository. Related tasks Assigning a steward to categories and terms on page 38 Administrator and Author users can assign a user or a group of users to be the steward who is responsible for a category or term. Transferring assets between stewards on page 41 Administrator and Author users can transfer assets from one steward to another. Removing assets from a steward Administrator and Author users can remove assets from a steward so that the steward no longer manages them.

Removing assets from a steward


Administrator and Author users can remove assets from a steward so that the steward no longer manages them. You must have the Business Glossary Administrator role or the Business Glossary Author role. You can also remove assets from a steward by using the Edit Term Properties or the Edit Category Properties page of the asset. Procedure To remove assets from a steward: 1. In the Navigation pane on the Glossary tab, click Browse and Edit Stewards. 2. On the Select a Steward to Manage page, select a steward, and click Edit Steward. 3. On the Edit Steward Properties page, click Managed Assets. 4. In the Managed Assets list, select the assets and click Remove. 5. Click Save and Close.

40

Administrator's and Author's Guide

The steward no longer manages the assets. The assets themselves are not deleted from the glossary.

Transferring assets between stewards


Administrator and Author users can transfer assets from one steward to another. You must have the Business Glossary Administrator role or the Business Glossary Author role. Procedure To transfer assets to another steward: 1. In the Navigation pane on the Glossary tab, click Browse and Edit Stewards. 2. On the Select a Steward to Manage page, select a steward, and click Edit Steward. 3. On the Edit Steward Properties page, click Managed Assets. 4. In the Managed Assets list, select one or more assets that you want to transfer to a particular steward and click Transfer Selected Assets. A new pane opens, displaying a list of stewards. 5. Select the steward to whom you want to transfer the asset or assets. 6. Click OK, then click Save or Save and Close. The original steward no longer manages the assets. The new steward manages the assets.

Deleting stewards
Administrator users can delete stewards. You must have the Business Glossary Administrator role. When you delete a steward, the steward role is removed from the user or user group, but the user or user group is not deleted from the user directory. Procedure To delete a steward: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Stewards. 2. On the Select a Steward to Manage page, select a steward and click Delete. 3. Click Yes to confirm.

Adding notes
Administrator and Author users can add notes about an asset. You must have the Business Glossary Administrator role or the Business Glossary Author role to add notes. Administrators can edit and delete all notes. Authors can edit and delete only the notes that they added. Procedure

Chapter 3. Administering a glossary of metadata assets

41

To add a note: 1. From the Details page of an asset, click Add note. 2. In the New Note pane, type a label and comment for the note and click OK. You can include a hypertext link in the label or the comment. Note: To edit or delete a note after it has been created, from the glossary Overview page, select the Notes tab and click the appropriate icon. Related tasks Including hypertext links on page 49 You can include hypertext links in the details about a term or category.

Managing categories
Administrator and Author users can create and edit categories to build and refine the glossary structure.

Categories
A category is like a folder or directory that organizes your glossary content. Categories provide the logical structure for the glossary so that you can browse and understand the relationships among terms and categories in the glossary. A category can contain other categories and terms. In addition, a category can reference terms that it does not contain. For example, the category named Customer Summary has a subcategory named Customer Expense Summary. The category has a term named Credit Card Risk Score and references the term Credit Card Risk. Related concepts Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Related tasks Creating or editing categories Administrator and Author users can create a category or edit the properties of existing categories.

Creating or editing categories


Administrator and Author users can create a category or edit the properties of existing categories. You must have the Business Glossary Administrator role or the Business Glossary Author role. To create or edit categories: Procedure 1. In the Navigation pane on the Glossary tab, click Browse and Edit Categories:

42

Administrator's and Author's Guide

Option To create or edit a single category

Description 1. Click New to create a category, or select a category from the list of all categories and click Edit Category. 2. Specify or change information about the category. Use short names for the category. Alternatively, divide long names into parts that are separated by spaces. If you change the name of an existing category, the newly named category retains all of the properties and relationships that it had with the former name. Note: In any text entry field, you can include hypertext links to additional information. The links display as working hypertext in the IBM InfoSphere Business Glossary browser and in IBM InfoSphere Business Glossary Anywhere.

To edit multiple categories

1. Click the Edit Multiple Categories link to get a list of all categories. 2. Click Search or Advanced Search to select categories according to specific criteria. 3. Select the checkbox of the categories that you want to edit. 4. Click Edit One at a Time to make edit changes in the selected categories one after the other, or click Edit All at Once to make identical edit changes in all categories simultaneously. 5. Specify or change information about the categories. Note: In any text entry field, you can include hypertext links to additional information. The links display as working hypertext in the IBM InfoSphere Business Glossary browser and in IBM InfoSphere Business Glossary Anywhere.

2. Click Save and Close.

Chapter 3. Administering a glossary of metadata assets

43

Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Related tasks Importing from a CSV file on page 76 Administrator users can import categories, terms, and custom attributes into the glossary with a comma-separated value (CSV) file. Importing from an XML file on page 86 Administrator users can import categories, terms, and custom attributes into the glossary with an XML (Extensible Markup Language) file. Including hypertext links on page 49 You can include hypertext links in the details about a term or category.

Specifying a parent category for categories and terms


Administrator and Author users can specify a category to be the parent of a term or of another category to build the glossary structure. You must have the Business Glossary Administrator role or the Business Glossary Author role. Parent categories are required for terms but they are optional for categories. Procedure To specify a parent category for categories or terms: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms or Categories. 2. Select the terms or categories:
Option To specify the parent category for a single term or category: To specify the same parent category for multiple terms or categories: Description Select the term or category and click Edit Term or Edit Category. 1. Select the term or category or click Advanced Search to select terms or categories according to specific criteria. 2. Click Edit One at a Time to specify a parent category for terms or categories one at a time. Alternatively, click Edit All at Once and select the check box next to the Steward field to assign the same parent category to all selections.

3. On the Edit Properties page for the term or category, click Select next to the Parent Category field. 4. In the search area, select a category:
Option To search for a category by name or short description: Description 1. Type all or part of a name or short description into the search field in the Select Category window and click Search. The search is not case sensitive. 2. Select a category from the list.

44

Administrator's and Author's Guide

Option To search for a category by multiple attributes:

Description 1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the Attribute list. 3. Type a value for the attribute and click Add. For example, the value might be any text string that is part of a short description. 4. Optional. Repeat the steps to select another attribute and to add a value for it. 5. Click Search. The search uses an AND operator and returns only the categories whose results match all of the attributes. 6. Select a category from the list.

5. Click OK. The selected category is displayed in the Parent Category field on the Properties page. 6. Click Save and Close. Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Specifying subcategories of a category


Administrator and Author users can specify categories to be subcategories of other categories to build a glossary structure. You must have the Business Glossary Administrator role or the Business Glossary Author role. Procedure To specify subcategories of a category: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Categories. 2. On the Select a Category to Manage page, select the category that is the parent category and click Edit Category. 3. In the Edit Category page, click Subcategories. 4. On the Subcategories page, click Add. 5. In the Add Categories window, select categories:
Option To search for a category by name or by short description: Description 1. Type all or part of a name or short description into the first field in the Add Categories window and click Search. 2. Select categories from the list. The categories are added to the Selected Categories list.
Chapter 3. Administering a glossary of metadata assets

45

Option To use multiple attributes to search for categories:

Description 1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of a long description. 4. Click Add to add the attributes to the list of search criteria. 5. Optional: Repeat the steps to select another attribute and to add a value for it. 6. Click Search. The search uses an AND operator and returns only the categories whose results match all of the attributes. 7. Select categories from the list. The categories are added to the Selected Categories list.

6. Click OK and then click Save and Close. Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Specifying terms for a category to contain


Administrator and Author users can specify terms for a category to contain. You must have the Business Glossary Administrator role or the Business Glossary Author role. v You can also specify a term for a category to contain from the Tasks list in the Details page of the category. v Because a term can be contained by only one category, the category becomes the parent category for that term. If you later specify that the term should be contained by a different category, the new category becomes the parent category for the term. Procedure To specify terms for a category to contain: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Categories. 2. On the Select a Category to Manage page, select the category to contain the terms and click Edit Category. In the Edit Category page, click Contained Terms. 3. On the Contained Terms page, click Add. 4. In the Add Terms window, select the terms:

46

Administrator's and Author's Guide

Option To search for a term by name or by short description:

Description 1. Type all or part of a name or short description into the first field in the Add Terms window and click Search. 2. Select terms from the list. The terms are added to the Selected Terms list.

To use multiple attributes to search for terms:

1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of a long description. 4. Click Add to add the attribute to the list of search criteria. 5. Optional: Repeat the steps to select another attribute and to add a value for it. 6. Click Search. 7. Select terms from the list. The terms are added to the Selected Terms list.

5. Click OK and then click Save and Close. Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Specifying terms for a category to reference


Administrator and Author users can specify terms for a category to reference. You must have the Business Glossary Administrator role or the Business Glossary Author role. Several categories can refer to the same term. Procedure To specify terms for a category to reference: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Categories. 2. On the Select a Category to Manage page, select the category and click Edit Category. In the Edit Category page, click Referenced Terms. 3. On the Referenced Terms page, click Add. 4. In the Add Terms window, select the terms:

Chapter 3. Administering a glossary of metadata assets

47

Option To search for a term by name or by short description:

Description 1. Type all or part of a name or short description into the first field in the Add Terms window and click Search. 2. Select terms from the list. The terms are added to the Selected Terms list.

To use multiple attributes to search for terms:

1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of a long description. 4. Click Add to add the attribute to the list of search criteria. 5. Optional: Repeat the steps to select another attribute and to add a value for it. 6. Click Search. 7. Select terms from the list. The terms are added to the Selected Terms list.

Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Adding notes
Administrator and Author users can add notes about an asset. You must have the Business Glossary Administrator role or the Business Glossary Author role to add notes. Administrators can edit and delete all notes. Authors can edit and delete only the notes that they added. Procedure To add a note: 1. From the Details page of an asset, click Add note. 2. In the New Note pane, type a label and comment for the note and click OK. You can include a hypertext link in the label or the comment. Note: To edit or delete a note after it has been created, from the glossary Overview page, select the Notes tab and click the appropriate icon.

48

Administrator's and Author's Guide

Related tasks Including hypertext links You can include hypertext links in the details about a term or category.

Including hypertext links


You can include hypertext links in the details about a term or category. You must be a Business Glossary Administrator or Author user. You can add hypertext links to any text entry field that defines a term or category. For example, you can add links to a description, custom attribute value, or notes about a term or category. The link text can be the same as the link destination or you can choose different text. You can also create a link to a file or directory location or an e-mail address. Note: As a security precaution, some Web browsers restrict direct access to files from the internet. Because the IBM InfoSphere Business Glossary is accessed through your Web browser, this restriction might apply and prevent access to files. To create a hypertext link: Procedure 1. To add a link that is the same as its destination text, enter the URL. For example, you could enter http://www.example.com. The link is displayed as http://www.example.com in the InfoSphere Business Glossary browser or IBM InfoSphere Business Glossary Anywhere. 2. To add a hypertext link for which the displayed link text is different than the destination text, and that can be a link to a file name, an e-mail address or a URL, use the following syntax: [destination | linktext] where destination is the destination that you are linking to: either a Web address, a file or directory location, or an e-mail address. linktext is the text you that you want to display to glossary users that will link to the destination specified by destination. Only the linktext will be displayed in the InfoSphere Business Glossary browser or InfoSphere Business Glossary Anywhere. Note: The hypertext link will not function as a live link in the truncated version of a long or short description. Users must expand the description to see a working link. To have the browser display the phrase "company home page" as a link to http://www.example.com, enter the following text:
[http://www.example.com | company home page]

To have the browser display "Joe Smith" as a hyperlink that, when selected, opens an e-mail program with the e-mail address "joe@example.com" entered as the recipient, enter the following text:
Chapter 3. Administering a glossary of metadata assets

49

[joe@example.com | Joe Smith]

To have the browser display the word "File1" as a link to a file with that name that resides on a server called "server1" enter the following text:
[file://server1/file1.txt | File 1]

Deleting categories
Administrator and Author users can delete categories and move their subcategories, the terms that they contain, and the terms that they reference to other categories. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v Business Glossary Authors can delete only the categories that they created. If you delete a category but do not move its subcategories and the terms that it contains, they are also deleted from the glossary. Terms that the category references are not deleted from the glossary. Procedure To delete categories: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Categories. 2. On the Select a Category to Manage page, select the category, and click Delete. 3. In the Delete window, select the action:
Option To delete an empty category: To delete a category that contains subcategories, terms, or referenced terms: Description Click OK. 1. Delete or move the subcategories, terms, or referenced terms: v To move the terms that it contains to another category, click Select to specify the category you want to contain the terms. v To move the subcategory to another category, click Select to specify the category you want to move the subcategory to. You can also choose to make the subcategory a top level category. v To move the referenced terms to another category, click Select to specify the category you want to reference these terms. 2. Click OK to delete the category and to implement the choices about its subcategories, the terms it contains, and its referenced terms.

Removing terms that a category references


Administrator and Author users can remove the relationship between a category and the terms that it references.

50

Administrator's and Author's Guide

You must have the Business Glossary Administrator role or the Business Glossary Author role. When you remove the relationship between a category and the terms that it references, you do not delete those terms from the glossary. Procedure To remove terms that a category references: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Categories. 2. On the Select a Category to Manage page, select a category and click Edit Category. 3. On the Edit Category page, click Referenced Terms. 4. Select the terms from the list and click Remove. 5. Click Save and Close. Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Deleting or moving terms from a category that contains them


Administrator and Author users can delete the terms from the category that contains them or move those terms to a different category. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v Business Glossary Authors can only delete terms from categories that they created. v For a term to exist in the glossary, the term must be in a category. v When terms are deleted from a category, they are deleted from the glossary. Procedure To delete or move terms from a category that contains them: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Categories. On the Select a Category to Manage page, select a category and click Edit Category. 2. From the Edit Category page, click Contained Terms. 3. Delete the terms from the category or move them to a different category: v To delete the terms from the category, click Delete. v To move the terms to a different category, click Move to Category and select the category to contain the terms. The term is moved from the original category to the selected category. 4. Click OK and then Save and Close.

Chapter 3. Administering a glossary of metadata assets

51

Related concepts Categories on page 42 A category is like a folder or directory that organizes your glossary content. Terms A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Managing terms
Administrator and Author users can create and edit terms in the glossary, or import files of categories and terms to the glossary.

Terms
A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. The glossary organizes terms in a hierarchy of categories for ease of browsing. You can define properties and relationships of terms: v Different terms with the same meaning can be defined as synonyms. v A term in a group of terms that are synonyms can be defined as the preferred synonym. v Terms that are not synonyms but that are related in some other way can be defined as related terms. v Assets such as database tables, jobs, and reports can be assigned to terms. v A term can be replaced by another term. v Categories can contain terms. A term can be contained by only one category. v Categories can reference terms. A term can be referenced by multiple categories. v Multiple terms can have the same name but they must each be in different categories. v A term cannot be both contained and referenced by the same category. v Terms can have abbreviations. Term properties Terms can have the following properties: Abbreviations Abbreviations of the term. Example An example of how the term is used, or a typical sample value. Is Modifier Describes whether the primary purpose of the term is to provide descriptive information about an asset. No Yes The primary purpose of the term is to identify distinguishing characteristics of an asset. No is the default value. The primary purpose of the term is to provide descriptive information about an asset.

52

Administrator's and Author's Guide

Long Description A long description of the term (up to 8000 characters). Name The name can contain any character, and can be several words separated by spaces. Names can be up to 255 characters. Parent Category The category that contains the term. Preferred Synonym The term that is the preferred term in a group of synonym terms. Terms with the Deprecated status cannot be preferred terms. Replaced by term The term that replaces the term. Short Description A brief description of the term (up to 255 characters). Short descriptions are used in searches. Status The approval status of the term within the organization: Candidate The default value for new terms. Accepted This term has been accepted by an administrator for general use. Standard Considered the standard for definitions of its type. Deprecated The term must no longer be used. Steward The user or user group that is the steward for the term. Type The classification of a term based on its use in your organization. None The type has not been declared. None is the default value.

Primary The term describes a major enterprise concept such as a client or an employee. Secondary The term identifies a secondary distinguishing characteristic of a business concept, such as an identification number. Usage Information about how to use the term, and any business rules that govern its use. Term relationships You can specify that terms have the following types of relationships: Assigned Assets Assets such as jobs, reports, and database tables that are assigned to the term. Multiple assets can be assigned to a single term. An asset can be assigned to multiple terms. Assigned External Assets Assets that are outside of the IBM InfoSphere Information Server metadata repository, such as business process models or Web services.

Chapter 3. Administering a glossary of metadata assets

53

Contained term A term must be contained by a category. The term must be contained by only one category. Referenced term A category can reference a term. A term can be referenced by multiple categories. Related Terms Terms that are related in some way to the term in question. This relationship can be used for see also relationships to terms that are similar but not identical. The relationship is symmetrical. If you specify that term A has term B as a related term, then term B has term A as a related term. A term can have multiple related terms. Steward The person or group that is responsible for the term. A term can have only one steward. Synonyms Terms that have the same meaning. A term can have multiple synonym terms. The relationship is symmetrical and transitive. If term A is a synonym of term B, and term B is a synonym of term C, each term is a synonym of the others. Examples The following examples illustrate some of the term properties that you can specify: assigned asset A BI report has a section called Account IDs. You assign the BI report, which is an asset, to the term Account ID, because the full definition of the term in the glossary explains the meaning of "Account ID" to the organization. The full definition of Account ID in the business glossary consists of the term, its properties, and any other information associated with the Account ID term. This information helps people who read the report understand what is being referred to in the "Account IDs" section. In this case you would set IsModifier to Yes. synonym terms The term Billing Information has the synonyms Billing Address and Bill To. If you get a report on Billing Address but you use the term Billing Information, the synonym attribute confirms that these two terms are synonyms. related terms Billing Information has the related terms Address Details and Shipping Information. These related terms indicate that Billing Information is related to addresses. In contrast, if Billing Information had the related terms Invoice and Receipt, then the concept of Billing Information is related to financial charges. referenced terms The term Billing Information is contained by the category Payment Details. When you view the category Contact Details, you see Billing Information as a referenced term.

54

Administrator's and Author's Guide

Related concepts Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Related tasks Creating or editing terms on page 56 Administrator and Author users can create a term or edit the properties of an existing term. Deleting terms on page 64 Administrator and Author users can delete terms from the glossary.

Assigned external assets


IBM InfoSphere Business Glossary enables you to create references from business terms to entities that are outside of the IBM InfoSphere Information Server metadata repository. These entities are referred to as assigned external assets. An assigned external asset might be a business process model or UML model that is stored in an asset management system, a Web service, or a quarterly report on a shared network drive. The ability to assign business terms to these types of assets extends the value of InfoSphere Business Glossary in the following ways: v Enables the glossary to give meaning to any technical assets of interest to the business, regardless of where they exist. v Helps business users understand the meaning of all technical assets that are used in organizational processes. With external assets, you have the following abilities: From the InfoSphere Business Glossary administrative interface (in the InfoSphere Information Server Web console) You can assign a term to a technical asset by describing the technical asset in enough detail for business users to identify it, locate it, and decide whether the asset is relevant and merits further investigation. From the InfoSphere Business Glossary browser v From a term, you can see all the assets it is assigned to, regardless of whether they reside inside the metadata repository. v From a term, you can see basic information about an external asset that is assigned to it. You can also assign external assets to terms by using the InfoSphere Business Glossary REST API. External assets differ from assets that are cataloged in the metadata repository in a number of ways. Because they are outside of the repository, they are not searchable and you cannot browse for them by using the navigation tree or Browse menu in the InfoSphere Business Glossary browser. You cannot assign stewards to external assets. External assets exist only in relationship to a business term if you delete the term, all information about the external asset is removed from the repository, unlike other assets that survive independently of the terms that are assigned to them.

Chapter 3. Administering a glossary of metadata assets

55

Example
Consider the following example of how an organization might use external assets: A company wants to add business meaning to software assets such as logical models and Web services by assigning business terms to them. The business glossary author for the Customer Activity term is asked to document some of the key software assets and related information in this subject area. The software assets are stored in IBM Rational Asset Manager and include: v the IBM WebSphere Business Modeler model for Modifying Account Information" v the Web services Change Address and Add Additional Address v the logical model Customer Account Information In addition, a text document that describes corporate rules for modifying account information is stored in a content management system. The glossary author, when creating the term, assigns these assets to the term with links to the Rational Asset Manager page and to the location of the text document in the content management system. Later, a business analyst, when examining a term, is able to find the relevant Web services, the process model, the logical model, and the corporate rules. Related tasks Assigning external assets to a term on page 62 Administrator and Author users can assign assets that exist outside of the metadata repository to terms.

Creating or editing terms


Administrator and Author users can create a term or edit the properties of an existing term. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v A category must exist to contain the term. Procedure To create or edit terms: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms.

56

Administrator's and Author's Guide

Option To create or edit a single term

Description 1. On the Select a Term to Manage page, click New to create a term, or select a term from the list of all terms and click Edit Term. 2. Specify or change information about the term. If you are creating a new term, use a short name or divide a long name into parts that are separated by spaces. Names can be up to 255 characters. Note: In any text entry field, you can include hypertext links to additional information. The links display as working hypertext in the IBM InfoSphere Business Glossary browser and in IBM InfoSphere Business Glossary Anywhere. 3. If you are changing information about an existing term, enter a comment that explains the reason for the change in the Comment for Term History field. This comment will be displayed in the History section for the term.

To edit multiple terms

1. Click the Edit Multiple Terms link to get a list of all terms. Click Search or Advanced Search to select terms according to specific criteria. 2. Select the check box of the terms you want to edit. 3. Click Edit One at a Time to edit the selected terms one after the other, or click Edit All at Once to make edit changes in all terms simultaneously. 4. Specify or change information about the terms. Note: In any text entry field, you can include hypertext links to additional information. The links display as working hypertext in the IBM InfoSphere Business Glossary browser and in IBM InfoSphere Business Glossary Anywhere. 5. Enter a comment that explains the reason for the change in the Comment for Term History field. This comment will be displayed in the History section for each of the affected terms. Note: The comment you enter will be associated with all of the terms selected for edit, whether you select Edit One at a Time or Edit All at Once. Changes to the comment at any time during an Edit One at a Time session will be applied to all the terms selected for that session.
Chapter 3. Administering a glossary of metadata assets

57

2. Click Save or Save and Close. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Assigned external assets on page 55 IBM InfoSphere Business Glossary enables you to create references from business terms to entities that are outside of the IBM InfoSphere Information Server metadata repository. These entities are referred to as assigned external assets. Related tasks Including hypertext links on page 49 You can include hypertext links in the details about a term or category.

Setting the status of terms


Administrator and Author users can choose a status for a term to indicate if the term is available for use in the glossary. You must have the Business Glossary Administrator role or the Business Glossary Author role. Procedure To set the status of terms: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. From the Select a Term to Manage page, select a term or click Edit Multiple Terms to select several terms. 3. In the Edit Term Properties page, choose the status from the list. 4. Click Save and Close.

Replacing a term with a different term


Administrator and Author users can replace a term with another term in the glossary to update the glossary. You must have the Business Glossary Administrator role or the Business Glossary Author role. Procedure To replace a term with a different term: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. In the Select a Term to Manage window, select a term:
Option To search for a term by name or by short description: Description 1. Type all or part of a name or short description into the search field and click Search. 2. Select a term from the list.

58

Administrator's and Author's Guide

Option To use multiple attributes to search for a term:

Description 1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of a long description. 4. Click Add to add the attribute to the list of search criteria. 5. Optional: Repeat the steps to select another attribute and to add a value for it. 6. Click Search. The search uses an AND operator and returns only the terms whose results match all of the attributes. 7. Select a term from the list.

3. Click Edit Term. In the Edit Term Properties window, click Select next to the Replaced By Term field. Select the term to replace the current term and click OK. 4. Click Save and Close. What to do next After you replace a term with another term, you might want to edit both terms. For example, you might need to reassign assets to the new term, and redefine relationships to other terms and categories. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Related tasks Assigning assets to a term on page 61 Administrator and Author users can assign assets in the metadata repository to terms.

Relating a term to another term


Administrator and Author users can relate a term to another term to give added information about that term in the organization. You must have the Business Glossary Administrator role or the Business Glossary Author role. You can also add a related term from the Tasks list on the Details page of the term. Procedure To relate a term to another term: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. On the Select a Term to Manage page, select the term and click Edit Term. 3. On the Edit Term page, click Related Terms.
Chapter 3. Administering a glossary of metadata assets

59

4. On the Related Terms page, click Add. 5. In the Add Terms window, select the terms:
Option To search for a term by name or by short description: Description 1. Type all or part of a name or short description into the first field in the Add Terms window and click Search. 2. Select terms from the list. The terms are added to the Selected Terms list. To use multiple attributes to search for terms: 1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of a long description. 4. Click Add to add the attribute to the list of search criteria. 5. Optional: Repeat the steps to select another attribute and to add a value for it. 6. Click Search. 7. Select terms from the list. The terms are added to the Selected Terms list.

6. Click OK and then click Save and Close. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Making a term synonymous with another term


Administrator and Author users can make a term synonymous with another term to indicate that those two terms have the same meaning in the corporation. You must have the Business Glossary Administrator role or the Business Glossary Author role. You can also assign a synonym term from the Tasks list on the Details page of a term. Procedure To make a term synonymous with another term: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. 3. 4. 5. On the Select a Term to Manage page, select the term and click Edit Term. On the Edit Term page, click Synonyms. On the Synonyms page, click Add. In the Add Terms as Synonyms window, select the terms that you want to specify as synonyms:

60

Administrator's and Author's Guide

Option To search for a term by name or short description:

Description 1. Type all or part of a name or short description into the first field in the Add Terms as Synonyms window and click Search. 2. Select one or more terms from the list. The terms are added to the Selected Synonyms list.

To use multiple attributes to search for terms:

1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of a long description. 4. Click Add to add the attribute-value pair to the list of search criteria. 5. Optional: Repeat steps 2 through 4 to add other attribute-value pairs. The search uses an "and" operator, and returns only those terms whose results match all of the attribute-value pairs. 6. Click Search. 7. Select one or more terms from the list. The terms are added to the Selected Synonyms list.

6. Click OK and then click Save and Close. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Related tasks Removing a term that is synonymous with another term on page 65 Administrator and Author users can remove the relationship between terms that are synonyms when the relationship is no longer appropriate.

Assigning assets to a term


Administrator and Author users can assign assets in the metadata repository to terms. You must have the Business Glossary Administrator role or the Business Glossary Author role. You can also assign assets from the Tasks list on the Details page of the asset or of the term. Procedure To assign an asset to a term: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. Select a term from the list of all terms and click Edit Term.
Chapter 3. Administering a glossary of metadata assets

61

3. On the Edit Term page, click Assigned Assets. 4. On the Assigned Assets page, click Add. 5. In the Assign Assets window, select the assets that you want the term to relate to:
Option To search for assigned assets by name or by short description: To use multiple attributes to search for assigned assets : Description Type all or part of a name or short description in the search field and then click Search. 1. Click the Advanced Search twistie to expand the search criteria. 2. Select an attribute from the list. 3. Type a value for the attribute. For example, the value might be any text string that is part of the name or long description. 4. Click Add to add the attribute to the list of search criteria. 5. Optional: Repeat the steps to select another attribute and to add a value for it. 6. Click Search. The search uses an AND operator, and returns only those assets whose results match all of the attributes.

6. Select assets from the list. The assets are added to the Selected Assets list. 7. Click OK. 8. Click Save and Close. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Related tasks Unassigning assets from a term on page 66 Administrator and Author users can remove the relationship between a term and its assigned assets. Assigning external assets to a term Administrator and Author users can assign assets that exist outside of the metadata repository to terms.

Assigning external assets to a term


Administrator and Author users can assign assets that exist outside of the metadata repository to terms. Procedure To 1. 2. 3. assign an external asset to a term: In the Navigation pane on the Glossary tab, click Terms. Select a term from the list of all terms and click Edit Term. On the Edit Term page, click Assigned External Assets.

62

Administrator's and Author's Guide

4. On the Assigned External Assets - External Assets That Are Assigned to This Term page, click Add. 5. Complete the fields in the Assigned External Assets page, and click OK. 6. Click Save and Close. Related concepts Assigned external assets on page 55 IBM InfoSphere Business Glossary enables you to create references from business terms to entities that are outside of the IBM InfoSphere Information Server metadata repository. These entities are referred to as assigned external assets. Related tasks Unassigning assets from a term on page 66 Administrator and Author users can remove the relationship between a term and its assigned assets. Assigning assets to a term on page 61 Administrator and Author users can assign assets in the metadata repository to terms.

Adding notes
Administrator and Author users can add notes about an asset. You must have the Business Glossary Administrator role or the Business Glossary Author role to add notes. Administrators can edit and delete all notes. Authors can edit and delete only the notes that they added. Procedure To add a note: 1. From the Details page of an asset, click Add note. 2. In the New Note pane, type a label and comment for the note and click OK. You can include a hypertext link in the label or the comment. Note: To edit or delete a note after it has been created, from the glossary Overview page, select the Notes tab and click the appropriate icon. Related tasks Including hypertext links on page 49 You can include hypertext links in the details about a term or category.

Including hypertext links


You can include hypertext links in the details about a term or category. You must be a Business Glossary Administrator or Author user. You can add hypertext links to any text entry field that defines a term or category. For example, you can add links to a description, custom attribute value, or notes about a term or category. The link text can be the same as the link destination or you can choose different text. You can also create a link to a file or directory location or an e-mail address.

Chapter 3. Administering a glossary of metadata assets

63

Note: As a security precaution, some Web browsers restrict direct access to files from the internet. Because the IBM InfoSphere Business Glossary is accessed through your Web browser, this restriction might apply and prevent access to files. To create a hypertext link: Procedure 1. To add a link that is the same as its destination text, enter the URL. For example, you could enter http://www.example.com. The link is displayed as http://www.example.com in the InfoSphere Business Glossary browser or IBM InfoSphere Business Glossary Anywhere. 2. To add a hypertext link for which the displayed link text is different than the destination text, and that can be a link to a file name, an e-mail address or a URL, use the following syntax: [destination | linktext] where destination is the destination that you are linking to: either a Web address, a file or directory location, or an e-mail address. linktext is the text you that you want to display to glossary users that will link to the destination specified by destination. Only the linktext will be displayed in the InfoSphere Business Glossary browser or InfoSphere Business Glossary Anywhere. Note: The hypertext link will not function as a live link in the truncated version of a long or short description. Users must expand the description to see a working link. To have the browser display the phrase "company home page" as a link to http://www.example.com, enter the following text:
[http://www.example.com | company home page]

To have the browser display "Joe Smith" as a hyperlink that, when selected, opens an e-mail program with the e-mail address "joe@example.com" entered as the recipient, enter the following text:
[joe@example.com | Joe Smith]

To have the browser display the word "File1" as a link to a file with that name that resides on a server called "server1" enter the following text:
[file://server1/file1.txt | File 1]

Deleting terms
Administrator and Author users can delete terms from the glossary. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v Business Glossary Authors can delete only the terms that they create. You can also delete a term from the Tasks list on the Details page of the term that you want to delete.

64

Administrator's and Author's Guide

When you delete a term, the following assets are not deleted: v its synonyms v its related terms v the terms that it references v the assets in the metadata repository that the term relates to Procedure To delete terms: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. On the Select a Term to Manage page, select a term and click Delete. 3. In the Delete Term window, click OK to confirm the deletion. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Removing a term that is related to another term


Administrator and Author users can remove the relationship between terms when the relationship is no longer appropriate. You must have the Business Glossary Administrator role or the Business Glossary Author role. When you remove the relationship between terms, the terms themselves are not deleted from the glossary. Procedure To remove a term that is related to another term: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. On the Select a Term to Manage page, select a term and click Edit Term. 3. On the Edit Term page, click Related Terms. 4. Select terms from the list and click Remove. The terms are no longer related to each other. 5. Click Save and Close.

Removing a term that is synonymous with another term


Administrator and Author users can remove the relationship between terms that are synonyms when the relationship is no longer appropriate. You must have the Business Glossary Administrator role or the Business Glossary Author role. When you remove the relationship between synonym terms, the terms themselves are not deleted from the glossary. Procedure To remove a term that is synonymous with another term:
Chapter 3. Administering a glossary of metadata assets

65

1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms. 2. On the Select a Term to Manage page, select a term and click Edit Term. 3. On the Edit Term page, click Synonyms. 4. Select terms from the list and click Remove. The terms are no longer synonyms. 5. Click Save and Close. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning.

Unassigning assets from a term


Administrator and Author users can remove the relationship between a term and its assigned assets. You must have the Business Glossary Administrator role or the Business Glossary Author role. When you remove the relationship between a term and an assigned asset, the asset itself is not deleted from the metadata repository. Procedure To 1. 2. 3. unassign assets from a term: In the Navigation pane on the Glossary tab, click Browse and Edit Terms. On the Select a Term to Manage page, select a term and click Edit Term. In the Edit Term page, click Assigned Assets or Assigned External Assets. Select one or more assets and click Remove (for Assigned Assets) or Delete (for Assigned External Assets). 4. Click Save or Save and Close.

Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Related tasks Assigning assets to a term on page 61 Administrator and Author users can assign assets in the metadata repository to terms. Assigning external assets to a term on page 62 Administrator and Author users can assign assets that exist outside of the metadata repository to terms.

Managing custom attributes


Administrator and Author users can use custom attributes to apply governance standards, to enable architecture frameworks, or to provide other metadata for the organization.

66

Administrator's and Author's Guide

Custom attributes
Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Custom attributes apply to terms, categories, or to both terms and categories. If you apply the custom attribute to both terms and categories, two separate custom attributes are created with the same name: one that applies to terms and one that applies to categories. Each custom attribute has a name, a description, and an attribute type. The type can be a string or an enumerated list of strings. You can edit the custom attribute and change its type at any time: v From the Enumerated to the String type, the value is saved as type String. v From the String to the Enumerated type, you lose the value of the string unless you include that exact string in the enumerated list of strings. The initial value of each custom attribute for a term or a category is NULL. You can edit the term or category and assign a value for its custom attributes.

Example
You create a custom attribute that is named Data Sensitivity with this short description: A number from 1 to 5 that indicates the sensitivity of the data. Sensitivity is a subjective measure of the impact of the term being released to unauthorized consumers. You can specify that the Data Sensitivity attribute applies only to terms. You choose the enumerated type and enter the numbers 1 through 5 as values. After you create the custom attribute, you assign one of these values to each term that you release to consumers. Related concepts Terms on page 52 A term is a word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. Related tasks Creating or editing custom attributes Administrator users can create and edit custom attributes to store additional information about terms and categories. Assigning values to custom attributes on page 68 Administrator and Author users can assign values to custom attributes of terms and categories. Deleting custom attributes on page 69 Administrator users can delete custom attributes for categories or terms.

Creating or editing custom attributes


Administrator users can create and edit custom attributes to store additional information about terms and categories. You must have the Business Glossary Administrator role.

Chapter 3. Administering a glossary of metadata assets

67

If your organization would find it useful to define additional properties for terms or categories in addition to those that are provided with IBM InfoSphere Business Glossary, you can create custom attributes. A custom attribute is a property that you define. Procedure To create or edit a custom attribute: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Custom Attributes. 2. In the Select a Custom Attribute to Manage page, select the custom attribute and click Edit Custom Attribute or click New. Type in or edit the name and description for the custom attribute. Note: You can include a hypertext link to other information in the form of an HTTP link in the name or description of the custom attribute. 3. Select the class of asset that the attribute applies to: categories, terms, or both. 4. From the Attribute Type list, select the type of value:
Option String: List of string values: Description Select String. 1. Select Enumerated. 2. Type a single value and click Add. Repeat this step for as many values as you need to enter.

5. Click Save and Close. Related tasks Including hypertext links on page 49 You can include hypertext links in the details about a term or category.

Assigning values to custom attributes


Administrator and Author users can assign values to custom attributes of terms and categories. v You must have the Business Glossary Administrator role or the Business Glossary Author role. v You must create custom attributes before you can assign their values. Procedure To assign values to custom attributes: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Terms or Contents Browse and Edit Categories. 2. In the Select a Term to Manage or the Select a Category to Manage page, select the term or category and click Edit Term or Edit Category. 3. In the Edit page, click Custom Attributes. 4. In the Custom Attributes window, assign a value to the attribute: v String attributes have a text box. If the text box is empty, type in free text. If the text box is not empty, you can change the value.

68

Administrator's and Author's Guide

v Enumerated attributes have a list. Select a value from the list. 5. Click Save and Close. Related concepts Custom attributes on page 67 Custom attributes are attributes of categories and terms that you create if the standard attributes are insufficient. Related tasks Creating or editing custom attributes on page 67 Administrator users can create and edit custom attributes to store additional information about terms and categories.

Deleting custom attributes


Administrator users can delete custom attributes for categories or terms. You must have the Business Glossary Administrator role. When you delete a custom attribute, you also delete all values that are defined for this attribute for any asset. Procedure To delete custom attributes: 1. In the Navigation pane on the Glossary tab, click Contents Browse and Edit Custom Attributes. 2. Select a custom attribute from the list, and click Delete. 3. Click OK to confirm.

Managing business glossary reports


Administrator users can create and run reports about categories and their terms and about stewards and their managed assets. You can manage glossary reports from the Reporting tab of the IBM InfoSphere Information Server Web console.

Business glossary reports


You can create reports on categories and their terms and on stewards and their managed assets. In the Reporting tab of the IBM InfoSphere Information Server Web console, you can use the Categories report template to create reports that show the following information for selected categories: v The name of each selected category, all subcategories, and all subcategories of subcategories v For each category or subcategory displayed, an alphabetical list of all the terms that are contained by that category, with descriptions of each term You can use the Stewardship report template to create reports that show the following information for all stewards: v Details about stewards v The short description, long description, and the creation date of every asset that each steward manages
Chapter 3. Administering a glossary of metadata assets

69

You can select the begin and end times for the report. The report can be viewed in either a PDF or an HTML format. For more information about business glossary reporting, see IBM Information Server Reporting Guide in the IBM InfoSphere Information Server PDF documentation set.

Generating business glossary reports


Administrator users can create, update, view, and delete reports on categories and their terms and on stewards and their managed assets in the glossary. v You must have administration permission in the access control list for the report to update, view, and delete the report. v You must have owner permission in the access control list to view and administer report templates, and to create reports from the templates. Report templates for the business glossary are supplied with IBM InfoSphere Information Server. Procedure To generate business glossary reports: 1. In the IBM InfoSphere Information Server Web console, click the Reporting tab. In the Navigation pane, click Contents. 2. Select a report or report template:
Option To create a report To view or edit an existing report Description Click Report Templates Business Glossary View Report Templates. Click Reports View Reports.

3. Edit the report parameters such as report format and report settings, and then run the report. 4. View the report results.

Importing and exporting glossary content


Glossary administrators can import and export glossary content to and from external files. Using external files, you can edit glossary content, bring content into the glossary from other sources, create an archive of the glossary to be deployed on another instance of IBM InfoSphere Information Server, and transfer content from one glossary to another. Each import and export method has different capabilities that you should consider before deciding which import or export method to use. You can also import and export glossary content and transfer it between InfoSphere Information Server installations by using the InfoSphere Information Server Command Line Interface (istool framework). Related information Importing and exporting from a command line

Import and export methods


Glossary administrators can use several methods to import and export glossary content to enable rapid development of a glossary.

70

Administrator's and Author's Guide

You can use the import and export capabilities to do the following: v Import a new glossary. v Import a partial glossary. For example, you might add a new subcategory with some contained terms. v Update the glossary with ongoing updates from a third party system. If the glossary is updated periodically in this way while regularly being manually updated by an administrator, you must put procedures in place to ensure that changes from one source do not incorrectly overwrite changes from the other source. v Perform large-scale glossary update or maintenance. You could export part of the glossary, edit the resulting file, and then import this modified file to update the glossary. You can import and export glossary content in different file formats, as shown in the following table. You can perform the import or export task by using the IBM InfoSphere Business Glossary administrative interface or from a command line. You can also import content by using other IBM InfoSphere Information Server components.
Table 9. Importing and exporting glossary content with Business Glossary File Format Comma-separated value (CSV) file Task Import glossary content from a CSV file that has been generated from other software applications such as spreadsheet programs. Export glossary content to a CSV file and edit the content with a spreadsheet program. This method does not allow you to import and export some relationships among categories and terms. Import or export all or part of a glossary. Content can include new or existing terms, categories, their properties, custom attributes, and relationships. An XML file for import could be generated by other software tools, as long as it conforms to the InfoSphere Business Glossary XML schema.. Note: Exporting an XML file from IBM InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.2 is supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.1 or earlier is not supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.1.2 and earlier, then importing the file into InfoSphere Business Glossary, Version 8.5 is supported.

Extensible Markup Language (XML) file

Chapter 3. Administering a glossary of metadata assets

71

Table 9. Importing and exporting glossary content with Business Glossary (continued) File Format XML Metadata Interchange (XMI) file (Glossary archive) Task Import all or part of a glossary to transfer it from an InfoSphere Business Glossary, version 8.0.1 Fix Pack 2 or later environment to a later InfoSphere Business Glossary environment. You can also use the XMI format to export all or part of a version 8.1.1 glossary to a version 8.1.0 or version 8.0.1 Fix Pack 2 environment, or to export all or part of a version 8.1.0 glossary to a version 8.0.1 Fix Pack 2 environment.

You can also import and export glossary content with these other IBM InfoSphere products: v IBM InfoSphere Data Architect v Categories and Terms MetaBroker Because glossary content is stored in the InfoSphere Information Server metadata repository, you can also interact with glossary content with the following InfoSphere Information Server components: v IBM InfoSphere Information Analyzer v IBM InfoSphere Metadata Workbench v IBM InfoSphere FastTrack Related concepts Importing and exporting CSV files on page 75 To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to a CSV (comma-separated values) file. Most, but not all glossary content can be modified with this method. Importing and exporting XML files on page 78 To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to an XML (Extensible Markup Language) file. Importing and exporting glossary archives on page 89 You can export all or part of the business glossary from one instance of IBM InfoSphere Information Server and import it to the metadata repository on another instance, or reimport it to the original repository. Related information IBM InfoSphere Information Analyzer IBM InfoSphere FastTrack IBM InfoSphere Metadata Workbench Categories and Terms MetaBroker IBM Rational Data Architect MetaBroker

Capabilities of different import methods


Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. You can import categories and terms with any of these import methods: CSV, XML, or glossary archive (XMI). The following tables show which category and term

72

Administrator's and Author's Guide

properties can be imported by each method. Both XML and XMI files have the fullest, and the same, import capabilities. CSV files are more limited in what you can import with them.
Table 10. Category properties that can be added or changed, by import method Category property Name CSV file Yes, if being added for a new category only; names of existing terms or categories cannot be changed. Yes Yes Yes Yes, if being added for a new category only; parent categories of existing terms or categories cannot be changed. No Yes No XML file Yes XMI file Yes

Long descriptions Short descriptions Subcategories Parent category

Yes Yes Yes Yes

Yes Yes Yes Yes

Referenced terms Contained terms Custom attribute Custom attribute value

Yes Yes Yes

Yes Yes Yes Yes

Yes Yes, if the custom attribute already exists in the target metadata repository. If the custom attribute does not exist, the import fails. Yes, 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.

Link to steward

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 11. Term properties that can be added or changed, by import method Term property Name CSV file Yes, if being added for a new term only; names of existing terms or categories cannot be changed. Yes Yes XML file Yes XMI file Yes

Long descriptions Short descriptions

Yes Yes

Yes Yes

Chapter 3. Administering a glossary of metadata assets

73

Table 11. Term properties that can be added or changed, by import method (continued) Term property Abbreviations Usages Examples Status Related terms Attribute IsModifier Attribute Type Synonyms Containing (parent) category CSV file Yes Yes Yes Yes No Yes Yes No Yes, if being added for a new term only; parent categories of existing terms or categories cannot be changed. No XML file Yes Yes Yes Yes Yes Yes Yes Yes Yes XMI file Yes Yes Yes Yes Yes Yes Yes Yes Yes

Custom attribute Custom attribute value

Yes

Yes Yes

Yes Yes, if the custom attribute already exists in the target metadata repository. If the custom attribute does not exist, the import fails. Yes, 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. Yes, 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. Yes

Link to steward

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. Yes, 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. Yes

Link to assigned assets (such as columns, jobs, tables)

No

References to assigned No external assets (such as business process models or Web services)

74

Administrator's and Author's Guide

Related concepts Importing and exporting glossary archives on page 89 You can export all or part of the business glossary from one instance of IBM InfoSphere Information Server and import it to the metadata repository on another instance, or reimport it to the original repository. Importing and exporting CSV files To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to a CSV (comma-separated values) file. Most, but not all glossary content can be modified with this method. Importing and exporting XML files on page 78 To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to an XML (Extensible Markup Language) file. Schema concepts on page 80 You should understand the way that glossary content is defined in the XML schema. Related tasks Importing from a CSV file on page 76 Administrator users can import categories, terms, and custom attributes into the glossary with a comma-separated value (CSV) file. Exporting to a CSV file on page 77 Administrator users can export top-level categories, their terms, and their custom attributes into a comma-separated value (CSV) file. Importing from an XML file on page 86 Administrator users can import categories, terms, and custom attributes into the glossary with an XML (Extensible Markup Language) file. Importing from a glossary archive file on page 91 Administrator users can import all or part of a business glossary and change the values of its assets during the import. Exporting to a glossary archive file on page 95 Glossary administrators can export the business glossary or a subset of it in order to merge it into another business glossary or to move it to another instance of IBM InfoSphere Information Server. Exporting to an XML file on page 87 Administrator users can export glossary content into an XML (Extensible Markup Language) file.

Importing and exporting CSV files


To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to a CSV (comma-separated values) file. Most, but not all glossary content can be modified with this method. With the CSV import method, you can import categories, terms, links to stewards, and the values of custom attributes. You cannot import custom attribute definitions or relationships. Values of most, but not all, term and category properties can be changed during the import process. You can import glossary content from a CSV file that has been generated from other software applications such as spreadsheet programs or that has been manually edited to contain the glossary content that you want to import.

Chapter 3. Administering a glossary of metadata assets

75

Related concepts Import and export considerations on page 80 You should be aware of several aspects of the way in which glossary content is imported to and exported from an XML file. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported.

Importing from a CSV file


Administrator users can import categories, terms, and custom attributes into the glossary with a comma-separated value (CSV) file. v You must have the Business Glossary Administrator role. v The CSV file with category and term information must be in the format that the CSV template uses. v The IBM InfoSphere Information Server that hosts the business glossary into which the CSV file is imported must be set to the same locale that was in effect for the InfoSphere Information Server that hosted the glossary when the CSV file was originally created, by exporting. v If you import the values of custom attributes, the definitions of those custom attributes must already exist in the target metadata repository. v Names of categories and terms can contain any character, and can be several words separated by spaces. Names can be up to 255 characters. v You can assign relationships among categories, subcategories, and terms in the CSV file. v You can assign values for custom attributes of categories and terms. v If you import terms and categories that already exist in the glossary, the existing terms and categories are replaced by the imported ones. Note: If the CSV file is not in UTF-8 format, it is converted into UTF-8 during the import process.. Procedure To import from a CSV file: 1. In the Navigation pane on the Glossary tab, click Contents Import and Export Import CSV. 2. Enter the name of the CSV file you want to import or click Browse to locate the file. 3. Optional: Click Download a sample CSV file to save a copy of the CSV import template. Edit this template by adding your terms and categories and save it, then use the file you have created this way in step 2. 4. Click Import. 5. Optional: Search for the imported categories and terms to check that they are in the business glossary as you defined them in the CSV file.

76

Administrator's and Author's Guide

Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported.

Exporting to a CSV file


Administrator users can export top-level categories, their terms, and their custom attributes into a comma-separated value (CSV) file. You must have the Business Glossary Administrator role. You use Search or Advanced Search to display a list of top-level categories that match the criteria that you specify. Then you select all or some of the categories. The selected categories, their subcategories, and the terms included in any of the categories or subcategories are exported to a file. Note: The CSV file is saved in unicode UTF-8 format. Procedure To export to a CSV file: 1. In the Navigation pane on the Glossary tab, click Contents Import and Export Export. 2. Select CSV for the type of file to export to. 3. Search for the top-level categories that you want to export by using Search or Advanced Search. Top-level categories that match the search criteria are displayed in a table. 4. Optional: To choose the number of categories to be displayed on each scrollable page of the table, click the appropriate number next to Items per Page. 5. Select the top-level categories that you want to export. a. To export all of the categories that are displayed on the current page, select the check box next to the word "Name" in the leftmost column of the table. All the categories on the scrollable page are selected, and their names are displayed in the Selected Categories list. b. To export a subset of the categories that are displayed on the current page, select only the check boxes that are next to the categories that you want to export. c. Optional: To remove a category that has already been selected, select it in the Selected Categories list and click Remove, or unselect the check box beside the name of the category. 6. Click Export. 7. Use the default file name, or edit the file name, and click Save. You have created a CSV file that contains glossary terms and categories. You can edit the exported file to change the relationships among categories, subcategories, and terms. You can assign values for custom attributes of categories and terms.

Chapter 3. Administering a glossary of metadata assets

77

Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported.

Importing and exporting XML files


To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to an XML (Extensible Markup Language) file. All aspects of glossary content terms, categories and their properties, custom attributes and their values, relationships, notes, stewardship, synonyms, and so on can be defined in the XML file. The required structure and syntax of this file is defined by the InfoSphere Business Glossary XML schema. You can download the XML schema and a sample XML file from the Import XML page. With XML import and export, the relationships between terms and categories, their links to assets assigned to them, and their links to stewards are preserved. If an assigned asset exists in the metadata repository, the assignment relationship between the asset and the term or category is established during the import. Also, if a user or user group that is assigned as a steward exists in the metadata repository, the steward relationship is established during the import. However, if a user, user group, or an assigned asset does not exist in the metadata repository, then the relationship between a term or category and the asset or the steward is not created during the import. Assigned external assets by definition do not exist in the repository, so no relationship is created during the import. Synonym relationships are created only after conflicts between the existing and the imported categories and terms are resolved by the merge method that you selected. Note: Exporting an XML file from IBM InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.2 is supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.1 or earlier is not supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.1.2 and earlier, then importing the file into InfoSphere Business Glossary, Version 8.5 is supported.

78

Administrator's and Author's Guide

Related concepts Schema concepts on page 80 You should understand the way that glossary content is defined in the XML schema. Merge options on page 82 Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. Synonym relationships after import on page 83 Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Import and export limitations on page 84 Certain actions are not supported by the IBM InfoSphere Business Glossary XML import and export method. Import and export considerations on page 80 You should be aware of several aspects of the way in which glossary content is imported to and exported from an XML file. Related reference XML schema and sample file on page 85 You can download and study the XML schema and sample XML file to understand how business glossary content is represented in an XML file. Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported.

Import and export scenarios


The XML import and export capabilities of IBM InfoSphere Business Glossary can be useful in a variety of situations. The following scenarios illustrate some of these situations: Share your business glossary with a different department A new department has just been formed and it needs to use the same business glossary terms and categories that your department uses. Export the entire glossary to an XML file. The new department then imports the XML file into an empty business glossary. Make changes to your business glossary in a test environment before releasing to production You have one instance of IBM InfoSphere Information Server for production and a second instance for testing. You want to change critical data in the business glossary and test those changes before you deploy them in the production environment. You can export your business glossary metadata from the production server and import it to a test server. Once you have made all changes to the metadata on the test server, export the changes to an XML file and then import that file to the production glossary. Move or upgrade systems If you move your InfoSphere Information Server to a different physical server, or upgrade the operating system on the existing server, you can use XML export and import to move your business glossary metadata to the new instance of the
Chapter 3. Administering a glossary of metadata assets

79

glossary. The import and export process is supported across different operating systems and different database types and versions. Note: Exporting an XML file from IBM InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.2 is supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.1 or earlier is not supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.1.2 and earlier, then importing the file into InfoSphere Business Glossary, Version 8.5 is supported.

Import and export considerations


You should be aware of several aspects of the way in which glossary content is imported to and exported from an XML file. Related concepts Importing and exporting CSV files on page 75 To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to a CSV (comma-separated values) file. Most, but not all glossary content can be modified with this method. Importing and exporting XML files on page 78 To modify glossary content outside of the business glossary itself, glossary administrators can import from and export to an XML (Extensible Markup Language) file. Importing and exporting glossary archives on page 89 You can export all or part of the business glossary from one instance of IBM InfoSphere Information Server and import it to the metadata repository on another instance, or reimport it to the original repository. Schema concepts: You should understand the way that glossary content is defined in the XML schema. The XML schema for the business glossary defines categories and terms in one of two ways: with a repository identifier or RID, or with a glossary identity. A repository identifier (RID) is a string that is generated by the metadata repository that uniquely identifies a category or term. When you export glossary content to an XML file, the file includes a RID for each category and term in the glossary. A glossary identity consists of the name and full context, or path, from the top-level category, of a term or category. The context of each category and term is defined in the XML file. When you import an XML file into an existing business glossary, a process of reconciliation occurs between what is defined in the file being imported and in the existing business glossary. Reconciliation Reconciliation refers to the process of determining the content differences between a file being imported and an existing business glossary. In trying to merge the new content with the existing content, the import utility first searches for a RID in the

80

Administrator's and Author's Guide

existing glossary that matches the RID in the imported file. If it does not find a matching RID, it then searches for a matching identity. Reconciliation is used for terms, categories, and relationships. For example, consider this snippet from an XML file:
<category name="Category1" rid="reww"> <referencedTerms> <termRef identity="Category2::Term2" rid="asdf"/> </referencedTerms> </category>

In this case, the reconcile process is used for two things: to look for the category Category1 in the existing glossary and to look for the referenced term Term2, with a parent category Category2, in the existing glossary. Merging The reconciliation process determines if there are content differences between the file being imported and the existing glossary. After reconciliation, the glossary content in the file and the glossary content in the existing glossary are combined, or merged. Merging refers to the process of selecting which assets and which asset attributes (or properties) should be used in the updated glossary if there are differences between what is defined in the file and what is defined in the existing glossary, and then actually combining them. In the example introduced earlier, if the reconcile process does not find the category Category1 in the existing glossary, then Category1 is added to the existing glossary during the import process. Merge options You can choose from among several merge options when you import a file. The merge options determine how conflicts between information in the import file and the existing glossary are resolved, for any terms and categories that exist in both places at the time of the import. Relationships Within the business glossary, you can define certain relationships among terms and categories. One term can be a "related term" to another term, or a term can be a "referenced term" or a "contained term" with respect to a category. In addition, the assignment of a steward to a term or category constitutes a relationship, and terms that are synonyms of one another also have a relationship. If the file that is being imported contains an RID or identifier that is not found in the existing glossary, then the relationship is dropped. That is, even if such a relationship existed in the current glossary, after the import occurs, the relationship will no longer exist. Using the example introduced earlier, if the reconcile process does not find the referenced term Term2, with a parent category Category2, in the existing glossary, then the referenced term relationship between Category1 and Term2 is dropped.

Chapter 3. Administering a glossary of metadata assets

81

Related concepts Merge options Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Merge options: Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. You must choose one of the following options to resolve conflicts between the imported and the existing values. The merge option that you select is applied to the entire import process. In general, if a term or category that is defined in the file being imported does not exist in the repository, it is added to the existing glossary during the import process, regardless of which merge option you choose. Attributes include term and category properties and custom attributes. Ignore the imported asset and keep the existing asset The import does not change the values of the existing assets. Overwrite the existing asset with the imported asset The import uses the values of the imported assets. Merge the asset and ignore imported attributes that cannot be merged For attributes that can have only one value, if the existing value is: v null, the imported value overwrites the existing value v not null, the import leaves the existing value unchanged For all other attributes, the import combines the existing and imported values. Merge the asset and overwrite existing attributes that cannot be merged For attributes that can have only one value, if the imported value is: v null, the import leaves the existing value unchanged v not null, the imported value overwrites the existing value For all other attributes, the import combines the existing and imported values. Example This example shows how terms with two types of attributes are imported by using each of the merge options. The short description attribute has only one value whereas there are several values for contained terms of the category. The following table displays the attributes in an existing business glossary and in the import file.

82

Administrator's and Author's Guide

Table 12. Existing and imported values of an attribute Attribute Short description Can have only one value. Contained terms of a category Can have more than one value. Existing value The unique identifier of the Customer Life Cycle Status Scheme involved in the relationship Term 1, Term 2, Term 3 Imported value The unique identifier of the Customer Life Cycle Status Type Term 2, Term 3, Term 4.

The following table displays the results from each merge method.
Table 13. Results from each merge method If you chose this merge method Ignore the imported asset and keep the existing asset The short description is The unique identifier of the Customer Life Cycle Status Scheme involved in the relationship The unique identifier of the Customer Life Cycle Status Type The unique identifier of the Customer Life Cycle Status Scheme involved in the relationship The unique identifier of the Customer Life Cycle Status Type The contained terms are Term 1, Term 2, Term 3

Overwrite the existing asset with the imported asset Merge the asset and ignore imported attributes that cannot be merged Merge the asset and overwrite existing attributes that cannot be merged

Term 2, Term 3, Term 4

Term 1, Term 2, Term 3, Term 4

Term 1, Term 2, Term 3, Term 4

Related concepts Schema concepts on page 80 You should understand the way that glossary content is defined in the XML schema. Synonym relationships after import: Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Synonym relationships are created only after conflicts between the existing and the imported categories and terms are resolved by the merge method that you selected. The rules for creating synonym relationships are the same for all of the merge methods. In the following table, each letter represents a term. Terms that are synonyms to each other are in parentheses.
Table 14. Merge results of synonyms Synonyms in file to be imported (A B) C Existing synonyms ABC Synonyms after import (A B) C
Chapter 3. Administering a glossary of metadata assets

83

Table 14. Merge results of synonyms (continued) Synonyms in file to be imported no terms with synonyms (A B) (A B) C D (A B) (B C) D E A (B C) E (A B C D) Existing synonyms (A B) C (A B C) (A B C) (D E) (B C) D (A B) (C D) (A B) (C D) (E F) (A B) (C D) Synonyms after import (A B) C (A B C) (A B C) (D E) (A B C) D (A B C D) E (A B C D) (E F) (A B C D)

Import and export limitations: Certain actions are not supported by the IBM InfoSphere Business Glossary XML import and export method. The import and export utility for the business glossary does not support the following actions for XML files: v Customizing merge rules to handle conflicts between specific imported and existing assets v Importing or exporting the following assets: Assigned assets such as jobs, reports, or database tables. Stewards for which a user or group is not already defined in the existing metadata repository. If the steward does not exist as a user or user group in the repository, then the steward is not created upon import. (If the steward already exists as a user or user group in the repository, then the steward is created upon import.) Creating relationships to stewards for which a user or user group is not already defined in the existing metadata repository. If the user or user group does not exist in the repository, then these relationships are ignored. Creating relationships to assigned assets that are not already defined in the existing metadata repository. If the asset does not exist in the repository, then these relationships are ignored. Links (that is, relationships) to assigned assets and to stewards can be exported and imported. During import, if the assigned asset that the term or category links to does not exist, the term or category is imported, but the link to the asset is not reestablished. If the export or import fails, no business glossary assets are moved. Users must not work in the business glossary while the import or export process is occurring. If a change is made to the glossary manually while the import or export is taking place, the changes will not be reflected in the results of the import or export. Note: Exporting an XML file from IBM InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.2 is supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.1 or earlier is

84

Administrator's and Author's Guide

not supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.1.2 and earlier, then importing the file into InfoSphere Business Glossary, Version 8.5 is supported.

XML schema and sample file


You can download and study the XML schema and sample XML file to understand how business glossary content is represented in an XML file.

Introduction
The IBM InfoSphere Business Glossary XML schema defines the relationship of different kinds of glossary content to one another. Any XML file that is imported into the glossary must conform to the schema, and when you export to an XML file, the resulting file conforms to the schema. From the Import XML pane, you can download the XML schema file and a sample XML file. The sample file conforms to the schema. The file format supports all aspects of the glossary; for example, categories, terms, synonyms, notes, custom attributes, stewards and assigned assets.

Understanding the sample file


Download the sample XML file from the Download a sample XML file link in the Import XML pane. You can use the sample XML file to import the following categories, terms, and custom attributes into the glossary: v Attributes Owner Legacy Name v Categories Category1 Category2 v Terms Term1 Term2 Attributes Attribute Owner applies to categories. Attribute Legacy Name applies to terms. Attribute Legacy Name can have any value that is a string. Attribute Owner can have these string values: HR, FINANCE, or BUS DEVELOPMENT. Categories In the sample, Category1 contains Term1 and refers to Term2. Category1 has value FINANCE that is assigned as the value for attribute 'Owner'. Category2 contains Term2 and refers to Term1. Category2 has value HR that is assigned as the value for attribute Owner. Terms Term1 has Category1 as its parent category. Term2 has Category2 as its parent category. Term1 and Term2 are synonyms.

Chapter 3. Administering a glossary of metadata assets

85

Related tasks Importing from an XML file Administrator users can import categories, terms, and custom attributes into the glossary with an XML (Extensible Markup Language) file.

Importing from an XML file


Administrator users can import categories, terms, and custom attributes into the glossary with an XML (Extensible Markup Language) file. v You must have the Business Glossary Administrator role. v You must prepare an XML file that complies with the InfoSphere Business Glossary XML schema. v Names of categories and terms can contain any character, and can be several words separated by spaces. Names can be up to 255 characters. v You must use the appropriate entity references for the reserved characters in XML:
For this reserved character < (left angle bracket) > (right angle bracket) " (quotation mark) ' (apostrophe) & (ampersand) Use this entity reference &lt; &gt; &quot; &#39; &amp;

In the XML file, you can designate relationships among categories, subcategories, and terms. You can assign values for custom attributes of categories and terms. Procedure To import categories, terms, and custom attributes with an XML file: 1. In the Navigation pane on the Glossary tab, click Contents Import and Export Import XML. 2. Enter the name of the XML file you want to import or click Browse to locate the file. 3. If the file to be imported uses an XML template that was provided with InfoSphere Business Glossary version 8.1.0 or earlier, then select the File is Business Glossary 8.1 or earlier XML format check box. Note: If your XML file was created by using the template from a version of InfoSphere Business Glossary earlier than version 8.1.1, you must select this check box. Otherwise, the import process will fail. 4. Optional: Click the Download a sample XML file link to save a copy of the XML template. Edit that file with your new or changed glossary content. Then, use that file in step 2. 5. Optional: To review the XML schema that your data must be in to import it into the business glossary, click the Download the XML schema link. 6. Select the method you want to use to reconcile any conflicts between the values of the existing glossary content and the imported glossary content. 7. Click Import. The content in the XML file is imported into the glossary with the merge option that you selected.

86

Administrator's and Author's Guide

Verify that the import made the expected changes in your glossary. Related concepts Schema concepts on page 80 You should understand the way that glossary content is defined in the XML schema. Merge options on page 82 Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. Synonym relationships after import on page 83 Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Import and export limitations on page 84 Certain actions are not supported by the IBM InfoSphere Business Glossary XML import and export method. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. XML schema and sample file on page 85 You can download and study the XML schema and sample XML file to understand how business glossary content is represented in an XML file.

Exporting to an XML file


Administrator users can export glossary content into an XML (Extensible Markup Language) file. You must have the Business Glossary Administrator role. If an assigned asset or steward does not exist in the target repository, the imported links are discarded. Therefore, before you use an XML file to import links: v Import or create other assets that the categories and terms link to. v Create users and user groups that do not exist in the target repository and define them as stewards. Note: Exporting an XML file from IBM InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.2 is supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.5, then importing the file into InfoSphere Business Glossary, Version 8.1.1 or earlier is not supported. Exporting an XML file from InfoSphere Business Glossary, Version 8.1.2 and earlier, then importing the file into InfoSphere Business Glossary, Version 8.5 is supported. You use Search or Advanced Search to display a list of top-level categories that match the criteria that you specify. Then you select all or some of the categories. The selected categories, their subcategories, and the terms included in any of the categories or subcategories are exported to a file. Procedure To export categories and terms to an XML file: 1. In the Navigation pane on the Glossary tab, click Contents Import and Export Export.
Chapter 3. Administering a glossary of metadata assets

87

2. Select XML for the type of file to export to. 3. Optional: To include links to assets that are assigned to the exported categories, select the Assigned Assets check box. The assets themselves are not included in the exported file. 4. Optional: To include links to the stewards for the exported categories, select the Stewards check box. If the user or user group for the steward exists in the metadata repository, then during import the steward relationship is created. If the user or user group does not exist in the metadata repository, then the steward relationship is not created. 5. Search for the top-level categories that you want to export by using Search or Advanced Search. Top-level categories that match the search criteria are displayed in a table. 6. Optional: To choose the number of categories to be displayed on each scrollable page of the table, click the appropriate number next to Items per Page. 7. Select the top-level categories that you want to export. a. To export all of the categories that are displayed on the current page, select the check box next to the word "Name" in the leftmost column of the table. All the categories on the scrollable page are selected, and their names are displayed in the Selected Categories list. b. To export a subset of the categories that are displayed on the current page, select only the check boxes that are next to the categories that you want to export. c. Optional: To remove a category that has already been selected, select it in the Selected Categories list and click Remove, or unselect the check box beside the name of the category. 8. Click Export. 9. Use the default file name, or edit the file name, and click Save. You have created an XML file containing glossary terms and categories. You can edit the exported file to change the relationships among categories, subcategories, and terms. You can assign values for custom attributes of categories and terms.

88

Administrator's and Author's Guide

Related concepts Schema concepts on page 80 You should understand the way that glossary content is defined in the XML schema. Merge options on page 82 Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. Synonym relationships after import on page 83 Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Import and export limitations on page 84 Certain actions are not supported by the IBM InfoSphere Business Glossary XML import and export method. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. XML schema and sample file on page 85 You can download and study the XML schema and sample XML file to understand how business glossary content is represented in an XML file.

Importing and exporting glossary archives


You can export all or part of the business glossary from one instance of IBM InfoSphere Information Server and import it to the metadata repository on another instance, or reimport it to the original repository. Use the glossary archive import and export method in the following circumstances: v If you need to import a glossary from an IBM InfoSphere Business Glossary, Version 8.0.1 Fix Pack 2 or later environment to a later InfoSphere Business Glossary release. v If you need to export a glossary from an InfoSphere Business Glossary, Version 8.1.1 environment and import it to an InfoSphere Business Glossary , Version 8.1.0 or version 8.0.1 Fix Pack 2 environment. v If you need to export a glossary from an InfoSphere Business Glossary, version 8.1.0 and import it to an InfoSphere Business Glossary, Version 8.0.1 Fix Pack 2 environment. Note: Exporting a glossary archive file from InfoSphere Business Glossary, Version 8.5, then importing the file to a previous release of InfoSphere Business Glossary is not supported. You can export all or part of the contents of a glossary to an archive file that is in XML Metadata Interchange (XMI) format. You can then import the archive file into a metadata repository on a different instance of InfoSphere Information Server. You cannot edit or modify the archive file. With a glossary archive, the relationships between terms and categories, their links to assets assigned to them, and their links to stewards are preserved. Assigned assets are not exported or imported, but relationships to them are imported and exported. Steward information is exported and imported. If an assigned asset exists in the metadata repository, the assignment relationship between the asset and the term or category is established during the import. Also, if a user or user group that
Chapter 3. Administering a glossary of metadata assets

89

is assigned as a steward exists in the metadata repository, the steward relationship is established during the import. However, if a user, user group, or an assigned asset does not exist in the metadata repository, then the relationship between a term or category and the asset or the steward is not created during the import. You can use a mapping file to transform the links between terms and their assigned assets, as well as between assets and stewards, in order to reestablish these relationships in the target metadata repository. You can also select a merge method to resolve conflicts between the existing and the imported glossary assets. Synonym relationships are created only after conflicts between the existing and the imported categories and terms are resolved by the merge method that you selected. Related concepts Merge options on page 82 Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. Synonym relationships after import on page 83 Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Import and export considerations on page 80 You should be aware of several aspects of the way in which glossary content is imported to and exported from an XML file. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Files that map exported assets to your target glossary on page 92 A mapping file enables you to change attributes of exported glossary content before you import it so that it is suitable for your glossary.

Import and export limitations


Certain actions are not supported by the IBM InfoSphere Business Glossary glossary archive import and export method. The import and export utility for the business glossary does not support the following actions for glossary archive files: v Customizing merge rules to handle conflicts between specific imported and existing assets v Customizing mapping rules for attributes of specific terms v Importing or exporting the following items: Category trees that start at a level other than a top-level category. Assigned assets such as jobs, reports, or database tables. Stewards for which a user or group is not already defined in the existing metadata repository. If the steward does not exist as a user or user group in the repository, then the steward is not created upon import. (If the steward already exists as a user or user group in the repository, then the steward is created upon import.) Creating relationships to stewards for which a user or user group is not already defined in the existing metadata repository. If the user or user group does not exist in the repository, then these relationships are ignored.

90

Administrator's and Author's Guide

Creating relationships to assigned assets that are not already defined in the existing metadata repository. If the asset does not exist in the repository, then these relationships are ignored. Links (that is, relationships) to assigned assets and to stewards can be exported and imported. During import, if the assigned asset that the term or category links to does not exist, the term or category is imported, but the link to the asset is not reestablished. If the export or import fails, no business glossary assets are moved. Users must not work in the business glossary while the import or export process is occurring. If a change is made to the glossary manually while the import or export is taking place, the changes will not be reflected in the results of the import or export.

Importing from a glossary archive file


Administrator users can import all or part of a business glossary and change the values of its assets during the import. v You must have the Business Glossary Administrator role. v If you need to change the values of assets in the archive file, you must use a mapping file to make those changes. Changes in the mapping file are case-sensitive. Enter the changes into the mapping file in the same case (uppercase or lowercase) in which they are entered in the target glossary. v If an assigned asset or steward does not exist in the target metadata repository, the imported links to the asset or steward are discarded. Therefore, before you use an XMI file to import links: Import or create other assets that the categories and terms link to. Create users and user groups that do not exist in the target repository and define them as stewards. You can import a glossary archive file to move all or part of the glossary to a new instance of IBM InfoSphere Information Server or to merge the contents in the archive file into another business glossary. If you import terms and categories that already exist in the glossary, you select the method to reconcile differences between them. Procedure To import a business glossary from an archive file: 1. In the Navigation pane on the Glossary tab, click Contents Import and Export Import Glossary Archive. 2. Optional: If you need to change the values of glossary content in the archive file, select the mapping file that has those changes. 3. Select the method you want to use to reconcile any conflicts between the values of the existing glossary content and the imported glossary content. 4. Click Import. The content in the glossary archive file is imported into the glossary with the merge option that you selected. Verify that the import made the expected changes in your glossary.

Chapter 3. Administering a glossary of metadata assets

91

Related concepts Import and export limitations on page 90 Certain actions are not supported by the IBM InfoSphere Business Glossary glossary archive import and export method. Related tasks Exporting to a glossary archive file on page 95 Glossary administrators can export the business glossary or a subset of it in order to merge it into another business glossary or to move it to another instance of IBM InfoSphere Information Server. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Files that map exported assets to your target glossary: A mapping file enables you to change attributes of exported glossary content before you import it so that it is suitable for your glossary. Purpose When you move assets from one business glossary to another, the exported attributes might not be suitable in the target glossary. For example, in the exported archive file, an asset that is assigned to a term is a database name. Before the archive file is imported, that asset must be reassigned to a database that exists in the target environment. Any attribute that refers to the exported database name can be mapped to the target database name. Sample mapping file The mapping file is in an Extensible Markup Language (XML) format. The following XML code makes the following changes in an exported archive file:
Table 15. Changes in an exported archive file Type of Asset server Original value in exported archive file server_a Changed value in imported business glossary server_b Northwest_Year_End

Related asset that is a project Year_End name (for example, name of an IBM InfoSphere DataStage project) Status of a term Short description of a term or category CANDIDATE Indicates whether the customer participates in a frequent flyer program.

ACCEPTED Indicates whether the customer is a member of an airline hospitality club.

<?xml version="1.0" encoding="UTF-8" ?> <!-- =================================================================== --> <!-- Business Glossary Mapping File --> <!-- =================================================================== --> <Mapping xsi:schemaLocation="MappingFile.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

92

Administrator's and Author's Guide

<!-- =================================================================== --> <!-- CHANGE THE STATUS OF A TERM FROM CANDIDATE TO ACCEPTED --> <!-- =================================================================== --> <!-- <TermStatusMappings> <TermStatusMapping> <CurrentStatus literal="CANDIDATE" /> <!-- can use a '*' as a wildcard --> <NewStatus literal="ACCEPTED" /> </TermStatusMapping> </TermStatusMappings> <!-- =================================================================== --> <!-- CHANGE AN ASSET (DATABASE SERVER) FROM server_a TO server_b --> <!-- =================================================================== --> <ObjectMappings> <ObjectMapping> <Attribute packageNsUri="http:///3.0/ASCLModel.ecore" classname="HostSystem" attrname="name"/> <!-- only string attributes --> <CurrentValue val="server_a" /> <NewValue val="server_b" /> </ObjectMapping > <!-- =================================================================== --> <!-- CHANGE AN ASSET (PROJECT) FROM Year_End TO Northwest_Year_End --> <!-- =================================================================== --> <ObjectMapping> <Attribute packageNsUri="http:///1.1/DataStageX.ecore" classname="DSProject" attrname="Name"/> <!-- only string attributes --> <CurrentValue val="Year_End" /> <NewValue val="Northwest_Year_End" /> </ObjectMapping <!-- =================================================================== --> <!-- CHANGES A SHORT DESCRIPTION --> <!-- =================================================================== --> <ObjectMapping> <Attribute packageNsUri="http:///3.0/ASCLModel.ecore" classname="BusinessTerm" attrname="shortDescription"/> <!-- only string attributes --> <CurrentValue val="Indicates whether the customer participates in a frequent flyer program." /> <NewValue val="Indicates whether the customer is a member of an airline hospitality club."/> </ObjectMapping> </ObjectMappings> </Mapping>

Merge options: Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. You must choose one of the following options to resolve conflicts between the imported and the existing values. The merge option that you select is applied to the entire import process. In general, if a term or category that is defined in the file being imported does not exist in the
Chapter 3. Administering a glossary of metadata assets

93

repository, it is added to the existing glossary during the import process, regardless of which merge option you choose. Attributes include term and category properties and custom attributes. Ignore the imported asset and keep the existing asset The import does not change the values of the existing assets. Overwrite the existing asset with the imported asset The import uses the values of the imported assets. Merge the asset and ignore imported attributes that cannot be merged For attributes that can have only one value, if the existing value is: v null, the imported value overwrites the existing value v not null, the import leaves the existing value unchanged For all other attributes, the import combines the existing and imported values. Merge the asset and overwrite existing attributes that cannot be merged For attributes that can have only one value, if the imported value is: v null, the import leaves the existing value unchanged v not null, the imported value overwrites the existing value For all other attributes, the import combines the existing and imported values. Example This example shows how terms with two types of attributes are imported by using each of the merge options. The short description attribute has only one value whereas there are several values for contained terms of the category. The following table displays the attributes in an existing business glossary and in the import file.
Table 16. Existing and imported values of an attribute Attribute Short description Can have only one value. Contained terms of a category Can have more than one value. Existing value The unique identifier of the Customer Life Cycle Status Scheme involved in the relationship Term 1, Term 2, Term 3 Imported value The unique identifier of the Customer Life Cycle Status Type Term 2, Term 3, Term 4.

The following table displays the results from each merge method.
Table 17. Results from each merge method If you chose this merge method Ignore the imported asset and keep the existing asset The short description is The unique identifier of the Customer Life Cycle Status Scheme involved in the relationship The contained terms are Term 1, Term 2, Term 3

94

Administrator's and Author's Guide

Table 17. Results from each merge method (continued) If you chose this merge method Overwrite the existing asset with the imported asset Merge the asset and ignore imported attributes that cannot be merged Merge the asset and overwrite existing attributes that cannot be merged The short description is The unique identifier of the Customer Life Cycle Status Type The unique identifier of the Customer Life Cycle Status Scheme involved in the relationship The unique identifier of the Customer Life Cycle Status Type The contained terms are Term 2, Term 3, Term 4

Term 1, Term 2, Term 3, Term 4

Term 1, Term 2, Term 3, Term 4

Related concepts Schema concepts on page 80 You should understand the way that glossary content is defined in the XML schema. Synonym relationships after import: Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Synonym relationships are created only after conflicts between the existing and the imported categories and terms are resolved by the merge method that you selected. The rules for creating synonym relationships are the same for all of the merge methods. In the following table, each letter represents a term. Terms that are synonyms to each other are in parentheses.
Table 18. Merge results of synonyms Synonyms in file to be imported (A B) C no terms with synonyms (A B) (A B) C D (A B) (B C) D E A (B C) E (A B C D) Existing synonyms ABC (A B) C (A B C) (A B C) (D E) (B C) D (A B) (C D) (A B) (C D) (E F) (A B) (C D) Synonyms after import (A B) C (A B) C (A B C) (A B C) (D E) (A B C) D (A B C D) E (A B C D) (E F) (A B C D)

Exporting to a glossary archive file


Glossary administrators can export the business glossary or a subset of it in order to merge it into another business glossary or to move it to another instance of IBM InfoSphere Information Server. You must have the Business Glossary Administrator role. About this task
Chapter 3. Administering a glossary of metadata assets

95

You can move a business glossary or a subset of it to another metadata repository. Export to a glossary archive file in the following circumstances: v If you need to export a glossary from an InfoSphere Business Glossary, Version 8.1.1 environment and import it to an InfoSphere Business Glossary , Version 8.1.0 or version 8.0.1 Fix Pack 2 environment. v If you need to export a glossary from an InfoSphere Business Glossary, version 8.1.0 and import it to an InfoSphere Business Glossary, Version 8.0.1 Fix Pack 2 environment. v If you need to export a glossary from a version of InfoSphere Business Glossary prior to Version 8.5 and import it into an InfoSphere Business Glossary, Version 8.5 environment. Note: Exporting a glossary archive file from InfoSphere Business Glossary, Version 8.5, then importing the file to a previous release of InfoSphere Business Glossary is not supported. You use Search or Advanced Search to display a list of top-level categories that match the criteria that you specify. Then you select all or some of the categories. The selected categories, their subcategories, and the terms included in any of the categories or subcategories are exported to a file. Procedure To export a business glossary to an archive file: 1. In the Navigation pane on the Glossary tab, click Contents Import and Export Export. 2. Select Glossary Archive for the type of file to export to. 3. Optional: To include links to assets that are assigned to the exported categories, select the Assigned Assets check box. The assets themselves are not included in the exported file. 4. Optional: To include links to the stewards for the exported categories, select the Stewards check box. If the user or user group for the steward exists in the metadata repository, then during import the steward relationship is created. If the user or user group does not exist in the metadata repository, then the steward relationship is not created. 5. Search for the top-level categories that you want to export by using Search or Advanced Search. Top-level categories that match the search criteria are displayed in a table. 6. Optional: To choose the number of categories to be displayed on each scrollable page of the table, click the appropriate number next to Items per Page. 7. Select the top-level categories that you want to export. a. To export all of the categories that are displayed on the current page, select the check box next to the word "Name" in the leftmost column of the table. All the categories on the scrollable page are selected, and their names are displayed in the Selected Categories list. b. To export a subset of the categories that are displayed on the current page, select only the check boxes that are next to the categories that you want to export. c. Optional: To remove a category that has already been selected, select it in the Selected Categories list and click Remove, or unselect the check box beside the name of the category. 8. Click Export.

96

Administrator's and Author's Guide

9. Use the default file name, or edit the file name, and click Save. You have created a glossary archive file containing glossary terms and categories. You can move the glossary or the subset of it that you have exported to another glossary on a different instance of InfoSphere Information Server, by importing this archive file to the other glossary. Related concepts Import and export limitations on page 90 Certain actions are not supported by the IBM InfoSphere Business Glossary glossary archive import and export method. Merge options on page 82 Merge options give you control over how to manage conflicts between the imported and the existing business glossary assets when you import glossary content. Synonym relationships after import on page 83 Synonym relationships are reconciled in a specific way, depending upon what is in the exported file and what already exists in the business glossary. Related tasks Importing from a glossary archive file on page 91 Administrator users can import all or part of a business glossary and change the values of its assets during the import. Related reference Capabilities of different import methods on page 72 Glossary administrators can decide which IBM InfoSphere Business Glossary import method to use based on the type of content that needs to be imported. Files that map exported assets to your target glossary on page 92 A mapping file enables you to change attributes of exported glossary content before you import it so that it is suitable for your glossary.

Chapter 3. Administering a glossary of metadata assets

97

98

Administrator's and Author's Guide

Chapter 4. Accessing business glossary content from Eclipse applications


IBM InfoSphere Business Glossary includes an Eclipse plug-in component. This component, the IBM InfoSphere Business Glossary Client for Eclipse, provides access to glossary content from within any Eclipse-based application. By using the InfoSphere Business Glossary Client for Eclipse you can view glossary content from within any Eclipse application. The Glossary Explorer view provides a navigation tree of the terms and categories in the glossary. You can perform text searches for terms and categories and view more in-depth information about them in the Properties view. By using a supported Rational Software Architect product and the InfoSphere Business Glossary Client for Eclipse, you can view glossary content while you are developing software models of business processes. Having glossary terms readily available to you enables you to easily choose the correct term to associate with elements in your model. If you install the optional UML Integration and UML Profile features, you can integrate glossary terms into model elements. You can assign the terms to existing model elements, create new model elements with terms assigned to them, or use a term name as the name of a model element. Installing the UML Profile feature by itself gives you the ability to see what terms have been applied to existing models but without editing capability. Through integration of the InfoSphere Business Glossary Client for Eclipse with InfoSphere Data Architect, you can associate terms with data model elements. These associations can be transferred to the business glossary, and can also be used by other products in the InfoSphere Information Server suite. You can also extend other Eclipse-based applications to make use of the same features by using the InfoSphere Business Glossary Client for Eclipse Java API. Related concepts Accessing business glossary content on page 1 You can access the data assets that are stored in the metadata repository with several different business glossary interfaces. Integrating with Eclipse-based applications on page 101 You can add IBM InfoSphere Business Glossary functionality to existing Eclipse-based applications by using the InfoSphere Business Glossary Client for Eclipse Java API. Related information Installing the IBM InfoSphere Business Glossary Client for Eclipse

Copyright IBM Corp. 2006, 2010

99

100

Administrator's and Author's Guide

Chapter 5. Developing and extending applications


You can create custom applications or extend existing applications to take advantage of IBM InfoSphere Business Glossary. You can create custom software applications that use the features of InfoSphere Business Glossary with the InfoSphere Business Glossary REST (Representational State Transfer) API (Application Programming Interface). You can also use the REST API to extend the functionality of existing applications. You can extend Eclipse-based applications to integrate with InfoSphere Business Glossary by using the InfoSphere Business Glossary Java API. Related concepts Integrating with Eclipse-based applications You can add IBM InfoSphere Business Glossary functionality to existing Eclipse-based applications by using the InfoSphere Business Glossary Client for Eclipse Java API.

Integrating with Eclipse-based applications


You can add IBM InfoSphere Business Glossary functionality to existing Eclipse-based applications by using the InfoSphere Business Glossary Client for Eclipse Java API. With this Java API, you can extend Eclipse-based applications to include many of the functions provided by the InfoSphere Business Glossary Client for Eclipse. The API includes support for two of the Eclipse features of the client: the InfoSphere Business Glossary Core feature and the InfoSphere Business Glossary UML Profile feature. You can add the functions of the InfoSphere Business Glossary Core feature to any Eclipse application. You can add the functions of the UML Profile feature to any Eclipse application that includes UML (Unified Modeling Language) support. (The Eclipse application must be based on a supported version of Eclipse.) The API and its supporting documentation are provided with the InfoSphere Business Glossary Client for Eclipse.

Copyright IBM Corp. 2006, 2010

101

102

Administrator's and Author's Guide

Chapter 6. InfoSphere Business Glossary glossary


This glossary contains terms and definitions for IBM InfoSphere Business Glossary. abbreviation A shortened text string that represents a term. accepted term A term that has been accepted for general use within an organization by the administrator of the glossary. asset Any defined entity that is stored in the IBM InfoSphere Information Server metadata repository, including categories and terms. Assets can include such items as business intelligence (BI) reports, physical schemas, models, and jobs.

assigned asset Assets such as jobs, reports, and database tables that are assigned to the term. Multiple assets can be assigned to a single term. An asset can be assigned to multiple terms. assigned external asset Assets that are outside of the IBM InfoSphere Information Server metadata repository, such as business process models or Web services that are assigned to the term. Multiple assets can be assigned to a single term. attribute Terms and categories can have attributes. Both terms and categories can have custom attributes, which are defined by the administrator of the glossary. Terms can also have the following other attributes defined: Type, Is Modifier, Example, and Usage. Both custom attributes and other attributes are displayed when you select the Attributes tab of the Properties view for a term. Custom attributes are displayed when you select the Attributes tab of the Properties view for a category. See also Is Modifier. candidate term A term that has not yet become standard or accepted. category A category is like a folder or directory that organizes your glossary content. Categories provide the logical structure for the glossary so that you can browse and understand the relationships among terms and categories in the glossary. A category can contain other categories and terms. In addition, a category can reference terms that it does not contain. contained term Terms are contained in categories. A term can be contained by only one category. See also referenced term. context The hierarchy of categories within which a category or term resides. custom attribute See attribute. deprecated term A term that is no longer used.

Copyright IBM Corp. 2006, 2010

103

external asset See assigned external asset. Is Modifier Describes whether the primary purpose of the term is to provide descriptive information about an asset. long description An extended description of a term. parent category A category that contains subcategories or terms. preferred synonym The term that is the preferred term in a group of synonym terms. Terms with the Deprecated status cannot be preferred terms. referenced term A category can reference terms. Each term can be referenced by multiple categories. See also contained term. related term A term that is related in some way to the term in question. This relationship can be used for see also relationships to terms that are similar but not identical. The relationship is symmetrical. If you specify that term A has term B as a related term, then term B has term A as a related term. A term can have multiple related terms. replaced by term The term that replaces a term. short description A brief description of the term. standard term A term that definitively describes a characteristic of the enterprise or organization. status A designation for a term based on where it is in its life cycle in the business glossary. A term can have one of the following status designations: accepted, candidate, deprecated, or standard. steward The person or group that is responsible for the definition, purpose, and use of the asset in the business glossary. synonym A term that has the same meaning as another term. A term can have multiple synonyms. The relationship is symmetrical and transitive. If term A is a synonym of term B, and term B is a synonym of term C, each term is a synonym of the others. term A word or phrase that describes a characteristic of the enterprise. By assigning assets to glossary terms, you can organize your metadata based on business meaning. An individual who is assigned a security role within IBM InfoSphere Business Glossary and therefore can access the business glossary. Business Glossary user types are Basic Users, Users, Administrators, and Authors.

user

user group A set of users who are collectively assigned a security role within IBM

104

Administrator's and Author's Guide

InfoSphere Business Glossary. Members of the user group can therefore access the business glossary. User groups can be stewards.

Chapter 6. InfoSphere Business Glossary glossary

105

106

Administrator's and Author's Guide

Product accessibility
You can get information about the accessibility status of IBM products. The IBM InfoSphere Information Server product modules and user interfaces are not fully accessible. The installation program installs the following product modules and components: v IBM InfoSphere Business Glossary v IBM InfoSphere Business Glossary Anywhere v IBM InfoSphere DataStage v IBM InfoSphere FastTrack v v v v IBM IBM IBM IBM InfoSphere InfoSphere InfoSphere InfoSphere Information Analyzer Information Services Director Metadata Workbench QualityStage

For information about the accessibility status of IBM products, see the IBM product accessibility information at http://www.ibm.com/able/product_accessibility/ index.html.

Accessible documentation
Accessible documentation for InfoSphere Information Server products is provided in an information center. The information center presents the documentation in XHTML 1.0 format, which is viewable in most Web browsers. XHTML allows you to set display preferences in your browser. It also allows you to use screen readers and other assistive technologies to access the documentation.

IBM and accessibility


See the IBM Human Ability and Accessibility Center for more information about the commitment that IBM has to accessibility:

Copyright IBM Corp. 2006, 2010

107

108

Administrator's and Author's Guide

Accessing product documentation


Documentation is provided in a variety of locations and formats, including in help that is opened directly from the product client interfaces, in a suite-wide information center, and in PDF file books. The information center is installed as a common service with IBM InfoSphere Information Server. The information center contains help for most of the product interfaces, as well as complete documentation for all the product modules in the suite. You can open the information center from the installed product or from a Web browser.

Accessing the information center


You can use the following methods to open the installed information center. v Click the Help link in the upper right of the client interface. Note: From IBM InfoSphere FastTrack and IBM InfoSphere Information Server Manager, the main Help item opens a local help system. Choose Help > Open Info Center to open the full suite information center. v Press the F1 key. The F1 key typically opens the topic that describes the current context of the client interface. Note: The F1 key does not work in Web clients. v Use a Web browser to access the installed information center even when you are not logged in to the product. Enter the following address in a Web browser: http://host_name:port_number/infocenter/topic/ com.ibm.swg.im.iis.productization.iisinfsv.home.doc/ic-homepage.html. The host_name is the name of the services tier computer where the information center is installed, and port_number is the port number for InfoSphere Information Server. The default port number is 9080. For example, on a Microsoft Windows Server computer named iisdocs2, the Web address is in the following format: http://iisdocs2:9080/infocenter/topic/ com.ibm.swg.im.iis.productization.iisinfsv.nav.doc/dochome/ iisinfsrv_home.html. A subset of the information center is also available on the IBM Web site and periodically refreshed at http://publib.boulder.ibm.com/infocenter/iisinfsv/v8r5/ index.jsp.

Obtaining PDF and hardcopy documentation


v PDF file books are available through the InfoSphere Information Server software installer and the distribution media. A subset of the PDF file books is also available online and periodically refreshed at http://www.ibm.com/support/ docview.wss?rs=14&uid=swg27016910. v You can also order IBM publications in hardcopy format online or through your local IBM representative. To order publications online, go to the IBM Publications Center at www.ibm.com/shop/publications/order.

Copyright IBM Corp. 2006, 2010

109

Providing feedback about the documentation


You can send your comments about documentation in the following ways: v Online reader comment form: www.ibm.com/software/data/rcf/ v E-mail: comments@us.ibm.com

110

Administrator's and Author's Guide

Links to non-IBM Web sites


This information center may provide links or references to non-IBM Web sites and resources. IBM makes no representations, warranties, or other commitments whatsoever about any non-IBM Web sites or third-party resources (including any Lenovo Web site) that may be referenced, accessible from, or linked to any IBM site. A link to a non-IBM Web site does not mean that IBM endorses the content or use of such Web site or its owner. In addition, IBM is not a party to or responsible for any transactions you may enter into with third parties, even if you learn of such parties (or use a link to such parties) from an IBM site. Accordingly, you acknowledge and agree that IBM is not responsible for the availability of such external sites or resources, and is not responsible or liable for any content, services, products or other materials on or available from those sites or resources. When you access a non-IBM Web site, even one that may contain the IBM-logo, please understand that it is independent from IBM, and that IBM does not control the content on that Web site. It is up to you to take precautions to protect yourself from viruses, worms, trojan horses, and other potentially destructive programs, and to protect your information as you deem appropriate.

Copyright IBM Corp. 2006, 2010

111

112

Administrator's and Author's Guide

Notices and trademarks


This information was developed for products and services offered in the U.S.A.

Notices
IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web

Copyright IBM Corp. 2006, 2010

113

sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose, CA 95141-1003 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to

114

Administrator's and Author's Guide

IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks
IBM, the IBM logo, and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml. The following terms are trademarks or registered trademarks of other companies: Adobe is a registered trademark of Adobe Systems Incorporated in the United States, and/or other countries. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. The United States Postal Service owns the following trademarks: CASS, CASS Certified, DPV, LACSLink, ZIP, ZIP + 4, ZIP Code, Post Office, Postal Service, USPS and United States Postal Service. IBM Corporation is a non-exclusive DPV and LACSLink licensee of the United States Postal Service. Other company, product or service names may be trademarks or service marks of others.

Notices and trademarks

115

116

Administrator's and Author's Guide

Contacting IBM
You can contact IBM for customer support, software services, product information, and general information. You also can provide feedback to IBM about products and documentation. The following table lists resources for customer support, software services, training, and product and solutions information.
Table 19. IBM resources Resource IBM Support Portal Description and location You can customize support information by choosing the products and the topics that interest you at www.ibm.com/support/ entry/portal/Software/ Information_Management/ InfoSphere_Information_Server You can find information about software, IT, and business consulting services, on the solutions site at www.ibm.com/ businesssolutions/ You can manage links to IBM Web sites and information that meet your specific technical support needs by creating an account on the My IBM site at www.ibm.com/account/ You can learn about technical training and education services designed for individuals, companies, and public organizations to acquire, maintain, and optimize their IT skills at http://www.ibm.com/software/swtraining/ You can contact an IBM representative to learn about solutions at www.ibm.com/connect/ibm/us/en/

Software services

My IBM

Training and certification

IBM representatives

Providing feedback
The following table describes how to provide feedback to IBM about products and product documentation.
Table 20. Providing feedback to IBM Type of feedback Product feedback Action You can provide general product feedback through the Consumability Survey at www.ibm.com/software/data/info/ consumability-survey

Copyright IBM Corp. 2006, 2010

117

Table 20. Providing feedback to IBM (continued) Type of feedback Documentation feedback Action To comment on the information center, click the Feedback link on the top right side of any topic in the information center. You can also send comments about PDF file books, the information center, or any other documentation in the following ways: v Online reader comment form: www.ibm.com/software/data/rcf/ v E-mail: comments@us.ibm.com

118

Administrator's and Author's Guide

Index A
adding notes 41, 48, 63 administrative interface 33 Administrators role 27 tasks 27 API, Java, for IBM InfoSphere Business Glossary 101 applications, custom 9 applications, developing and extending 101 approval process definition of 13 assets about 35 assign to terms 23 assigned to terms 61 assigning to stewards 39 definition of 11 import 23 notes about 41, 48, 63 properties 35 relationships 35 removing from stewards 40, 41 removing relationship to terms 66 unassigning from terms 66 attributes, custom assigning values to 68 creating 67 definition of 67 deleting 69 exporting with CSV 77 importing with CSV 76 with XML 86 values 67 authorization, categories 30 Authors role 27 tasks 27

C
categories assigning parent category 44 stewards 38 subcategories 45 terms 46 values to custom attributes 68 contained terms deleting 51 moving 50, 51 creating 20, 21, 42 custom attributes for 67 definition of 42 deleting 50 custom attributes from 69 editing 42 exporting with CSV 77 importing 20, 21 with CSV 76 with XML 86 referenced terms assigning 47 moving 50 removing relationship 51 reports on 69, 70 sources of 14 subcategories moving 50 Categories and Terms MetaBroker list of assets it imports 72 client, for Eclipse 9 Cognos 8 7 Cognos 8 Go! 7 compliance officers 12 configuring text direction 32 configuring the glossary 26 considerations, XML 80 contained terms deleting 50, 51 moving 50, 51 creating categories 42 custom attributes 67 notes 41, 48, 63 stewards 37 term history 56 terms 56 CSV exporting 77 importing 76 list of assets it imports 72 CSV, importing and exporting 75 custom applications 9 custom attributes assigning values to 68 creating 67 creation 19 definition of 67 deleting 69 exporting with CSV 77

custom attributes (continued) importing with CSV 76 with XML 86 values 67 customer support 117

D
data architect 12 data warehouse models 14 deleting categories 50 custom attributes 69 stewards 41 terms 64 developing applications 101

E
e-mail address of administrator Eclipse products 9 Eclipse-based client 9 Edit Settings page editing 26 editing categories 42 custom attributes 67 Edit Settings page 26 terms 56 export glossary archive 95 XMI limitations 90 XML 87 limitations 84 export and import, XML 80 exporting with CSV 77 exporting to CSV 75 exporting to XML 78 extending applications 101 external assets assign to terms 24 assigned to terms 62 definition 24 26

B
BI reports sources of 16 bidirectional language support 31 bidirectional text support, configuring 32 browsing assets retracing history 36 business analyst 12 business glossary reports on 70 business glossary integration 7 Business Glossary Java API 101 business glossary, configuring 26

G
glossary accessing 33 approval process 13 design 14 environment 20 function 11 import and export methods import methods comparison 71 introduction 11 make available 25

72

Copyright IBM Corp. 2006, 2010

119

glossary (continued) mapping rules 92 moving between repositories links to assets 89 links to stewards 89 mapping rules 89 merge methods 89 synonyms 89 term and category relationship XMI format 89 organization 14 planning structure 11 reports 69 steps in planning 11 structure 14 glossary archive export 95 import 91 glossary assets, see assets 35 glossary content, definition in schema 80 glossary integration 7 glossary models data warehouse 14 Glossary Pack 8 glossary team members 12 roles 12 glossary, accessing content 33 glossary, configuring 26 governance definition of 12

89

importing (continued) with XML (continued) terms 86 importing from CSV 75 importing from XML 78 industry 8 Industry Models 8 integration, business glossary 7 integration, with Eclipse-based software 9 introduction glossary 11 metadata repository 11

pop-ups for Web browser 33 preferred terms definition of 52 product accessibility accessibility 107 programming 101 properties of assets 35

R
Rational Software Architect 9 referenced terms assigning to categories 47 definition of 52 deleting 50 moving 50 removing relationship 51 related assets definition of 52 related terms assigning to terms 59 definition of 52 removing relationship 65 removing assets from stewards 40, 41 relationship between referenced terms and categories 51 between synonym terms 65 between term and assets 66 replace merge methods 82, 93 terms 58 reports categories, terms, stewards 69 repository assets, browsing 35 RID, repository id 80 roles Administrators 27 Authors 27 definition of 27 Users 27

J
jobs sources of 16

L
language support, bidirectional legal notices 113 life cycle status of terms 13 logical models 14 31

M
managing notes 41, 48, 63 mapping rules examples 92 import 92 limitations 84, 90 merge methods ignore 82, 93 limitations 84, 90 merge and use source 82, 93 merge and use target 82, 93 replace 82, 93 merge options 80 metadata repository function 11 models data warehouse models 14 glossary models 14 logical models 14 physical models 14 sources of 16

I
IBM Cognos 8 7 IBM Cognos Go! 7 IBM Industry Models 8 IBM Rational Software Architect 9 identifier 80 ignore merge methods 82, 93 import assets 23 categories 21 CSV format 14 glossary archive 91 mapping rules 92 merge methods 82, 93 terms 21 XMI limitations 90 XML limitations 84 XML format 14 import and export scenarios scenarios 79 import and export, synonyms 83, 95 import and export, XML 80 import methods assets imported by each 72 comparison 71 importing with CSV 76 with XML categories 86 custom attributes 86

S
searching advanced search 34 simple search 34 software services 117 status Accepted 13 Candidate 13 Deprecated 13 Standard 13 status of terms definition of 58 setting 58 steward assigning 24 selecting users 19 stewards assigning assets 39 categories and terms 38 suite users and groups 37

N
Navigation pane 36 Navigation panel 33 non-IBM Web sites links to 111 notes about assets 41, 48, 63

P
physical models 14 physical schemas sources of 16 plug-in, Eclipse 9

120

Administrator's and Author's Guide

stewards (continued) definition of 37 deleting 41 removing assets 40, 41 reports on 69, 70 structure planning glossary 11 steps in planning 11 subcategories assigning to categories 45 subject matter expert 12 suite users and groups assigning as stewards 37 support customer 117 synonym terms assigning 60 definition of 52 removing relationship 65 synonyms, import and export 83, 95

terms (continued) status, setting 58 synonym terms assigning 60 removing relationship synonyms 18

65

U
URL accessing business glossary Users role 27 tasks 27 33

V
vertical industry 8 viewing permissions 30

W
Web sites non-IBM 111 welcome text 26

T
tasks Administrators 27 Authors 27 Basic Users 27 Users 27 terms assigned to other terms 18 assigning stewards 38 to categories 46 to parent category 44 values to custom attributes 68 assigning assets 61 assigning external assets 62 contained terms deleting 50 moving 50 creating 20, 21, 56 custom attributes for 67 defining 17 definition of 52 deleting 64 custom attributes from 69 editing 56 exporting with CSV 77 importing 20, 21 with CSV 76 with XML 86 naming standards 17 properties 52 referenced terms deleting 50 moving 50 removing relationship 51 related terms 18 assigning 59 removing relationship 65 relationships 52 removing relationship to assets 66 replacing terms 58 reports on 69, 70 sources of 14

X
XMI list of assets it imports 72 XML export 87 list of assets it imports 72 XML sample file 85 XML schema 85 XML schema, concepts 80 XML, importing and exporting

78

Index

121

122

Administrator's and Author's Guide

Printed in USA

SC19-2455-03

Spine information:

IBM InfoSphere Business Glossary

Version 8 Release 5

Administrator's and Author's Guide