Import and export file formats
The choice of file format to use for import and export is based on the reasons to import and export and based on the type of content that needs to be imported.
| File Format | When to use | What the file can define |
|---|---|---|
| CSV file (comma-separated values) | Use a CSV file to import glossary assets from a CSV file that has been generated from other software applications such as spreadsheet programs. Similarly, use a CSV file to export glossary assets as rows of comma-separated values so that you can edit the content with a spreadsheet program. The CSV file format has some limitations on the type of glossary assets that can be defined in it. |
The file can define categories, terms, references to stewards, and the values of custom attributes of categories and terms. The file cannot define information governance policies, information governance rules, their properties, or their custom attributes. Not all relationships can be defined. You can change the values of most, but not all, term and category properties. |
| XML file (Extensible Markup Language) | Use an XML file to import or export all or part of your glossary assets so that you can modify it outside of a running instance of InfoSphere® Information Governance Catalog. You can generate an XML file for import with other software tools, as long as the file conforms to the InfoSphere Information Governance Catalog XML schema. The XML file format is the most versatile of all InfoSphere Information Governance Catalog import and export file formats, and is the standard format for the interchange of glossary assets. |
The file can define any kind of glossary asset, including new or existing terms, categories, information governance policies, and information governance rules. The file can include all properties of these assets, including steward assignments, labels, collections, and relationships. |
| XMI file (XML Metadata Interchange) | Use an XMI file (glossary archive file) to transfer glossary assets from versions of IBM® InfoSphere Business Glossary that are earlier than version 8.1.1. Use this format to transfer glossary assets without modifications. |
The file can include all glossary assets, but it cannot be used to define new terms, categories, information governance policies, and information governance rules. The XMI file can be used to change properties of existing glossary assets by using a mapping file. |
| Category property | CSV file | XML file | XMI file |
|---|---|---|---|
| Name | Yes, if being added for a new category only. Names of existing categories cannot be changed. | Yes, if the repository identifier (RID) is defined in the XML file. | Yes |
| Long description | Yes | Yes | Yes |
| Short description | Yes | Yes | Yes |
| Subcategory | Yes | Yes | Yes |
| Parent category | Yes, if being added for a new category only. Parent categories of existing terms or categories cannot be changed. | Yes | Yes |
| Referenced term | No | Yes | Yes |
| Contained term | Yes | Yes | Yes |
| Custom attribute | Can be assigned to a category but cannot be defined. | Yes. can be assigned to a category and defined. | Yes, can be assigned to a category and defined. |
| Custom attribute value | Yes, if the custom attribute already exists in the target catalog. If the custom attribute does not exist, the import fails. | Yes | Yes |
| Reference to steward | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the import fails. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. |
| Label | Yes, can be assigned to a category if the label already exists in the target catalog. If the label does not exist, the import fails. | Yes. can be both defined and assigned to a category. | Yes. can be both defined and assigned to a category. |
| Note | No | Yes | Yes |
| Collections | No | Yes | Yes |
| Term property | CSV file | XML file | XMI file |
|---|---|---|---|
| Name | Yes, if being added for a new term only. Names of existing terms cannot be changed. | Yes, if the repository identifier (RID) is defined in the XML file. | Yes |
| Long descriptions | Yes | Yes | Yes |
| Short descriptions | Yes | Yes | Yes |
| Abbreviations | Yes | Yes | Yes |
| Usages | Yes | Yes | Yes |
| Examples | Yes | Yes | Yes |
| Status | Yes | Yes | Yes |
| Related terms | No | Yes | Yes |
| Attribute IsModifier | Yes | Yes | Yes |
| Attribute Type | Yes | Yes | Yes |
| Synonyms | No | Yes | Yes |
| Containing (parent) category | Yes, if being added for a new term only. Parent categories of existing terms or categories cannot be changed. | Yes | Yes |
| Custom attribute | No | Yes | Yes |
| Custom attribute value | Yes, if the custom attribute already exists in the target catalog. If the custom attribute does not exist, the import fails. | Yes | Yes |
| Reference to steward | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the import fails. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. |
| Reference to assigned assets (such as columns, jobs, tables) | No | Yes, if the asset already exists in the target catalog. If the asset does not exist, the relationship is not created but other content is imported successfully. | Yes, if the asset already exists in the target catalog. If the asset does not exist, the relationship is not created but other content is imported successfully. |
| References to assigned external assets (such as business process models or Web services) | No | Yes | Yes |
| Labels | Yes, can be assigned to a term if the label already exists in the target catalog. If the label does not exist, the import fails. | Yes. can be both defined and assigned to a term. | Yes. can be both defined and assigned to a term. |
| Has Types, Is A Type Of | No | Yes | Yes |
| Has A, Is Of | No | Yes | Yes |
| Note | No | Yes | Yes |
| Collections | No | Yes | Yes |
| Policy property | CSV file | XML file | XMI file |
|---|---|---|---|
| Name | Yes, if being added for a new policy only. Names of existing information governance policies cannot be changed. | Yes, if the repository identifier (RID) is defined in the XML file. | Yes |
| Long description | Yes | Yes | Yes |
| Short description | Yes | Yes | Yes |
| Subpolicy | Yes | Yes | Yes |
| Parent policy | Yes, if being added for a new policy only. Parent information governance policies of existing information governance policies cannot be changed. | Yes | Yes |
| Custom attribute | Can be assigned to an information governance policy but cannot be defined. | Yes, can be assigned to an information governance policy and defined. | Yes, can be assigned to an information governance policy and defined. |
| Referenced rules | No | Yes | Yes |
| Custom attribute value | Yes, if the custom attribute already exists in the target catalog. If the custom attribute does not exist, the import fails. | Yes | Yes |
| Reference to steward | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the import fails. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. |
| Label | Yes, can be assigned to an information governance policy if the label already exists in the target catalog. If the label does not exist, the import fails. | Yes. can be both defined and assigned to an information governance policy. | Yes. can be both defined and assigned to an information governance policy. |
| Note | No | Yes | Yes |
| Collection | No | Yes | Yes |
| Rule property | CSV file | XML file | XMI file |
|---|---|---|---|
| Name | Yes, if being added for a new rule only. Names of existing information governance rules cannot be changed. | Yes, if the repository identifier (RID) is defined in the XML file. | Yes |
| Long description | Yes | Yes | Yes |
| Short description | Yes | Yes | Yes |
| Referencing policy | Yes, if being added for a new rule only. Referencing information governance policies for existing information governance rules cannot be changed. | Yes | Yes |
| Governs | No | Yes, if the asset already exists in the target catalog. If the asset does not exist, the relationship is not created but other content is imported successfully. | Yes, if the asset already exists in the target catalog. If the asset does not exist, the relationship is not created but other content is imported successfully. |
| Custom attribute | No | Yes | Yes |
| Implemented By | No | Yes, if the asset already exists in the target catalog. If the asset does not exist, the relationship is not created but other content is imported successfully. | Yes, if the asset already exists in the target catalog. If the asset does not exist, the relationship is not created but other content is imported successfully. |
| Custom attribute value | Yes, if the custom attribute already exists in the target catalog. If the custom attribute does not exist, the import fails. | Yes | Yes |
| Reference to steward | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the import fails. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. | Yes, if the user or user group already exists in the target catalog. If the user or user group does not exist, the steward relationship is not created but other content is imported successfully. |
| References to assigned external assets (such as business process models or web services) | No | Yes | Yes |
| Label | Yes, can be assigned to a rule if the label already exists in the target catalog. If the label does not exist, the import fails. | Yes. can be both defined and assigned to a rule. | Yes. can be both defined and assigned to a rule. |
| Note | No | Yes | Yes |
| Collections | No | Yes | Yes |