Deriving custom semantic types

You can derive a custom semantic type when the semantic types that are stored in the standard library do not sufficiently classify the data that they are being assigned to. You can derive a custom semantic type from an appropriate generalized parent semantic type.

About this task

Ensuring that you choose the correct parent semantic type is important because the custom semantic type inherits characteristics and behavior from the parent. If you choose a parent semantic type that is not fitting, Analyst's Notebook Premium might interpret the data incorrectly.

For example, it would be inappropriate for you to derive a custom semantic type for a sporting event from the Document entity semantic type. A sporting event is not a specialization of a document. The result of this inappropriate specification would be that Analyst's Notebook Premium would expect to interpret documentation as opposed to sporting event data.

You can edit the details for a custom semantic type at any time, but it is best to avoid changing them in a way that changes the original meaning. Different versions of the same custom semantic type align regardless of the custom semantic type's name, description, or synonyms.

CAUTION: Defining a custom semantic type when the library already contains an appropriate semantic type can cause problems with information retrieval. Information that is retrieved from your data source would be unaligned with information retrieved from other data sources that have the correct semantic type assigned. Search carefully for an available semantic type before you create your own custom semantic types.

Procedure

To derive a custom semantic type:

After you select the item type you want to assign a semantic type to in Schema Designer, click Select to open the Select Semantic Type window.
Locate the available semantic type that is the most similar to the specialization that you require, by searching for semantic types that have a generalized name.
Select the generalized type in the tree of semantic types, and then click Derive Custom Type. A new semantic type is added as a child of the generalized semantic type.

Note: Custom semantic types are given a special red icon to differentiate them from the standard i2® semantic types.
Change the name of the custom semantic type to a name that reflects your usage.
To improve search results when you try to locate this semantic type in the future, add synonyms for this custom semantic type in the Synonyms text box. Separate each synonym with a comma. Phrases are allowed.
Describe the intended usage for this custom semantic type in the Description box. You can type a web address to provide a hyperlink to a web page for more information.
After your new custom semantic types are configured to your specification, click Assign to assign this new custom semantic type to your item type.
Optional: You can save the custom semantic type by clicking File > Custom Semantic Types > Save Library.
Optional: You can load a library of custom semantic types by clicking File > Custom Semantic Types > Load Library

Note: If you choose to save to a file name that exists, the content of the library is overwritten. This library can be merged into other schemas to use the custom semantic types it contains.

Results

Your custom semantic type is added to your library.