CSV Format to Load Glossaries and Terms

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to Loading Glossaries and Terms from a CSV File

Team Server can load CSV (comma-separated values) files containing information about glossaries and terms as long as they follow the expected format.

You can import the following objects and terms:

  • Glossary objects
  • Business Term objects
  • Relationships between Business Terms
  • Relationships between Business Terms and ER Objects

Later in this topic there are some examples of the format required to import Glossaries and Terms. A great way to start is by exporting some manually-created glossaries and terms from the Glossaries tab of ER/Studio Team Server.

Each of the sections above contain:

  • a section start marker row, such as:
    • +++ Glossaries Begin +++
    • +++ Terms Begin +++
    • +++ Term Relations Begin +++
    • +++ Object Relations Begin +++
  • a comma-separated list containing the names of properties of the target type of resource that we want to define later. Only the resource name is mandatory.
  • your data. You can insert as many rows as you want. Each one of the rows represents a single glossary or term, and contains a comma-separated list of property values for that resource. The order that you have to use to specify the resource property values is that of the property names in the second row.
  • a section end marker row, such as:
    • +++ Glossaries End +++
    • +++ Terms End +++
    • +++ Term Relations End +++
    • +++ Object Relations End +++

See also the examples of CSV files below.

Properties that You Can Use in Your CSV File

The property names that you can use on the second row of a set depends on whether your set defines a glossary or a term.

Glossary Properties

Item Description

Key

This value is filled when exporting existing glossaries and terms. Updating with the key allows you to modify the glossary without creating new ones. The Key field is left empty when creating new glossaries.

Name
(mandatory)

Name of the glossary.

Status

Chosen status (this is a status of the glossary that is predefined by you).

Stewards

List of usernames of Team Server users that must become stewards of the new glossary.

Separate values with a semicolon. For example: username1;username2.

Definition

Definition of the new glossary.

Abbreviations

An abbreviation of the glossary.

Aliases

An alias for the glossary.

AdditionalNotes

Anything you would like to define in the Additional Notes section of your glossary.

ParentGlossary

Name of the parent glossary, in case you wish to structure your Glossary as a child of another glossary.

[CustomAttributes]

Indicate the name of a custom attribute in the column header and value in a row. A custom attribute should be assigned to glossaries in advance or it is ignored.

Term Properties

Item Description

Key

This value is filled when exporting existing glossaries and terms. Updating with the key allows you to modify the term without creating new ones. The Key field is left empty when creating new terms.

Name
(mandatory)

Name of the term.

Status

Chosen status (this is a status of the term that is predefined by you).

Stewards

List of usernames of Team Server users that must become stewards of the new term.

Separate values with a semicolon. For example: username1;username2.

Definition

Definition of the new term.

Abbreviations

An abbreviation of the term.

Aliases

An alias for the term.

AdditionalNotes

Anything you would like to define in the Additional Notes section of your term.

ParentGlossary

Name of the (optional) Glossary which owns this term. The term is unique within this Glossary.

RelatedGlossaries

Name of any related glossaries.

Separate values with a semicolon. For example: Glossary1;Glossary2.

TermEntityType

Name of the Term Entity Type. This can be predefined by you when creating terms, or from the Term Entity Types subpage of the admin pages.

[CustomAttributes]

Indicate the name of a custom attribute in the column header and value in a row. A custom attribute should be assigned to glossaries in advance or it is ignored.

Notepad blue icon 2.pngNote: Please note that you cannot update linked terms.

Custom Attributes

The custom attributes format depends on the type.

Type Format Example

Date

MM/DD/YYYY 01/23/2013
Boolean True or False True
Time HH:MM:A 01:25 PM
Numeric Integer Number 364
External File Path String \\servername\file.txt
Text String Some Text
Text List String and matching valid values Value1


Term Relation Properties

Item Description

RelationKey

This value is filled when exporting existing term relationships. Updating with the key allows you to modify the relationship without creating new ones. The RelationKey field is left empty when creating new relationships.

TermKey1

This value is filled when exporting existing terms. Updating with the key allows you to relate to existing terms. The TermsKey1 field is left empty when relating to terms newly created in this csv import.

Name1

Name of the Term from which this relationship points.

TermEntityType1

Term Entity Type of the Term from which this relationship points.

ParentGlossary1

Parent Glossary of the Term from which this relationship points.

ForwardRelationType

The forward type name of the relationship. The following values for the standard relationships are allowed:

  • Attribute - Parent
  • Attribute - Child
  • Related
  • Type - Parent
  • Type - Child
  • Synonym

ForwardRelationName

The forward name of the relationship. Note this is only used for the 'Related' relationship.

FromMultiplicity

The multiplicity of the from term of the relationship. Note this is only used for the 'Related' relationship. The following values are allowed:

  • ZERO_OR_ONE
  • ONLY_ONE
  • ONE_OR_MANY
  • ZERO_ONE_OR_MANY

TermKey2

This value is filled when exporting existing terms. Updating with the key allows you to relate to existing terms. The TermsKey2 field is left empty when relating to terms newly created in this csv import.

Name2

Name of the Term to which this relationship points.

TermEntityType2

Term Entity Type of the Term to which this relationship points.

ParentGlossary2

Parent Glossary of the Term to which this relationship points.

ReverseRelationType

The reverse type name of the relationship. Note that this order should be the opposite of the previously set forward relationship. The following values for the standard relationships are allowed:

  • Attribute - Parent
  • Attribute - Child
  • Related
  • Type - Parent
  • Type - Child
  • Synonym

ReverseRelationName

The reverse name of the relationship. Note this is only used for the 'Related' relationship.

ToMultiplicity

The multiplicity of the to term of the relationship. The following values are allowed:

  • ZERO_OR_ONE
  • ONLY_ONE
  • ONE_OR_MANY
  • ZERO_ONE_OR_MANY

Object Relation Properties

Item Description

RelationKey

This value is filled when exporting existing term relationships. Updating with the key allows you to modify the relationship without creating new ones. The RelationKey field is left empty when creating new relationships.

TermKey

This value is filled when exporting existing terms. Updating with the key allows you to relate to existing terms. The TermsKey1 field is left empty when relating to terms newly created in this csv import.

Name

Name of the Term from which this relationship points.

TermEntityType

Term Entity Type of the Term from which this relationship points.

ParentGlossary

Parent Glossary of the Term from which this relationship points.

ObjectKey

This value is filled when exporting existing term-object relationships. You can populate these values, but you need to find the ID of the ER Object to which you wish to map the term. You can do this easily by opening the object page in Team Server of the ER Object and look at the URL http://192.168.180.3:88/object/view.spg?key=12950</object>. You can see the key is included.

Examples of Valid CSV Files

These are some example CSV files that you can load.

Single Glossary

The following CSV code defines a single glossary named "Example Glossary."

+++ Glossaries Begin +++,,,,,,,,,,,,,,
Key,Name,Status,Definition,Abbreviations,Aliases,AdditionalNotes,Stewards,ParentGlossary,,,,,,
,Example Glossary,Approved,Glossary of commonly used accounting terms.,EG,Sample Glossary,Here are some more notes,admin,,,,,,,
+++ Glossaries End +++,,,,,,,,,,,,,,

Terms

The following CSV code defines four terms named "Employee," "Employee Number," "Person," and "Contract."

+++ Terms Begin +++,,,,,,,,,,,,,,
Key,Name,Status,Definition,Abbreviations,Aliases,AdditionalNotes,Stewards,RelatedGlossaries,TermEntityType,ParentGlossary,,,,
,Employee,Approved,An employee is someone who works under an employment contract. A person may be an employee in employment law but have a different status for tax purposes. Employers must work out each worker's status in both employment law and tax law.,,Staff,,admin,,Business Terms,Example Glossary,,,,
,Employee Number,Approved,The unique identifier for an Employee.<div>Any employee with an employment contract with the business must have an employee number. Only those with an employee number can have security access to any building.</div>,,EmpNum,"Staff Number, Employee ID, Staff ID",admin,,Business Terms,Example Glossary,,,,
,Person,Approved,"a human or non-human entity that is treated as a person for limited legal purposes. Typically, a legal persons can sue and be sued, own property, and enter into contracts.",,,,admin,,Business Terms,Example Glossary,,,,
,Contract,Approved,,,,,admin,,Business Terms,Example Glossary,,,,
+++ Terms End +++,,,,,,,,,,,,,,


Term Relationships

The creates three relationships from "Employee" to the other terms.

+++ Term Relations Begin +++,,,,,,,,,,,,,,
RelationKey,TermKey1,Name1,TermEntityType1,ParentGlossary1,ForwardRelationType,ForwardRelationName,FromMultiplicity,TermKey2,Name2,TermEntityType2,ParentGlossary2,ReverseRelationType,ReverseRelationName,ToMultiplicity
,,Employee,Business Terms,Example Glossary,Attribute - Parent,,,,Employee Number,Business Terms,Example Glossary,Attribute - Child,,
,,Employee,Business Terms,Example Glossary,Related,employed under,ONE_OR_MANY,,Contract,Business Terms,Example Glossary,Related,governs the employment of,ONE_OR_MANY
,,Employee,Business Terms,Example Glossary,Type - Parent,,,,Person,Business Terms,Example Glossary,Type - Child,,
+++ Term Relations End +++,,,,,,,,,,,,,,

Object Relationships

This creates a relationship from the term "Employee" to an object of key 37. Not this may fail for your model if it does not have a valid ER Object of id key 37.

+++ Object Relations Begin +++,,,,,,,,,,,,,,
RelationKey,TermKey,TermName,TermEntityType,ParentGlossary,ObjectKey,,,,,,,,,
,,Employee,,Human Resources,37,,,,,,,,,
+++ Object Relations End +++,,,,,,,,,,,,,,

See Also