CSV Format to Load Glossaries and Terms
Go Up to Loading Glossaries and Terms from a CSV File
Contents
Team Server can load CSV (comma-separated values) files containing information about glossaries and terms as long as they follow the expected format.
Later in this topic there are some examples of the format required to import either Glossaries or Terms.
Each set of rows contains four or more rows with the following content:
- The first row contains a fixed value, the start tag, which depends on the type of resource:
- If you want to define a glossary:
+++ Glossaries Begin +++
. - If you want to define a term:
+++ Terms Begin +++
.
- If you want to define a glossary:
- The second row contains a comma-separated list of the names of properties of the target type of resource that we want to define later. Only the resource name is mandatory.
- Between the second row and the last row 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.
- The last row contains a fixed value, the end tag, which depends on the type of resource:
- If you defined a glossary:
+++ Glossaries End +++
. - If you defined a term:
+++ Terms End +++
.
- If you defined a glossary:
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 |
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: |
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 will be 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 |
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: |
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. |
RelatedGlossaries |
Name of any related glossaries. Separate values with a semicolon. For example: |
RelatedTerms |
Name of any related terms. Separate values with a semicolon. For example: |
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 will be ignored. |
Note: Please note that linked terms cannot be updated.
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 |
Examples of Valid CSV Files
These are some example CSV files that you can load into Team Server.
Single Glossary
The following CSV code defines a single glossary named "Accounting".
+++ Glossaries Begin +++ Key,Name,Status,Definition,Abbreviations,Aliases,AdditionalNotes,Stewards,,,,,,,, ,Accounting,Approve,"Glossary of commonly used accounting terms.",,,,admin,,,,,,,, +++ Glossaries End +++
Terms
The following CSV code defines terms named "AMT" and "Abatement".
+++ Terms Begin +++ Key,Name,Status,Definition,Abbreviations,Aliases,AdditionalNotes,Stewards,RelatedGlossaries,RelatedTerms,TermEntityType ,AMT,Approved,"Tax imposed to back up the regular income tax imposed on CORPORATION and individuals to assure that taxpayers with economically measured income exceeding certain thresholds pay at least some income tax.",,,,admin,Accounting,, ,Abatement,Approved,"Complete removal of an amount due, (usually referring to a tax ABATEMENT a penalty abatement or an INTEREST abatement within a governing agency).",,,,admin,Accounting,AMT, +++ Terms End +++
Note: When relating more than one term to another, term entity types must be specified with the format "RelatedTermName1,TermEntityType1";"RelatedTermName2,TermEntityType2".