Advanced DeepSee Modeling Guide
Defining Term Lists
[Back] [Next]
   
Server:docs1
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

Term lists provide a way to customize a DeepSee model without programming. This chapter describes how to define them. It discusses the following topics:

Overview of Term Lists
Term lists provide a way to customize a DeepSee model without programming. A term list is a simple (but extendable) list of key and value pairs. The key values must be unique within the list. You can extend the term list by adding custom fields. You can use term lists in the following ways:
Tip:
You can use term lists to define matching dictionaries for use with unstructured data. See Using Unstructured Data in Cubes in Defining DeepSee Models.
Accessing the Term List Manager
To define and modify term lists, you use the Term List Manager. To access this tool:
  1. Select the InterSystems Launcher and then select Management Portal.
    Depending on your security, you may be prompted to log in with a Caché username and password.
  2. Switch to the appropriate namespace as follows:
    1. Select Switch.
    2. Select the namespace.
    3. Select OK.
  3. Select DeepSee, Tools, and then select Term List Manager.
The [DeepSee] > [Term List Manager] page initially looks like this:
On this page you can do the following:
Defining a Term List
To define a term list, select New. The system displays a dialog box that asks for the name of the new term list. Enter a name and select OK. Then do the following tasks as needed:
Then save the term list. To do so, select Save or Save As. If you select Save As, specify a new name and then select OK.
Specifying the Pattern for a Term List
The %TERMLIST function returns a set that, by default, consists of members that are identified by the keys in the term list, in combination with the term list pattern.
If you intend to use a term list with the %TERMLIST function, then define the term list as follows:
In either case, dimension name, hierarchy name, and level name are the names of the dimension, hierarchy, and level to which the member belongs. The asterisk represents the value in the value field. For an example, see %TERMLIST in the DeepSee MDX Reference.
Exporting and Importing Term Lists
You can export term lists to comma-separated files and you can import term lists from such files.
Exporting a Term List
To export a term list:
  1. Display the term list in the Term List Manager.
  2. Select Export. The system generates a file.
    Depending on your browser settings, the browser then either saves the file automatically (in the default download directory for this browser) or opens the file in a default application.
Sample Term List File
The following shows the contents of an example term list file:
%%NAME,My Term List
%%CAPTION,My Caption
%%DESCRIPTION,My Description
%%SUBJECTAREA,HoleFoods
%%MODDATE,2014-06-06 11:31:10
Atlanta,Braves
Boston,Red Sox
New York,Yankees
As you can see, the first lines of the export contain items that start with %%; these lines contain descriptive information about the term list.
Importing a Term List
To import a term list:
  1. In the right area, for CSV File to import, select Browse... and navigate to the file.
  2. Select Import.
    DeepSee examines the name of the term list as contained in this file. Then:
  3. Optionally save the new or changed term list. To do so, select Save or Save As. If you select Save As, specify a new name and then select OK.
Deleting a Term List
To delete a term list:
  1. Display the term list in the Term List Manager.
  2. Select Delete.
  3. Select OK.
Accessing Term Lists Programmatically
You can use the %DeepSee.TermList class to access term lists programmatically. This class provides class methods like the following:
See the InterSystems Class Reference.