Mapping to i2 Analyze types

In Analyst's Notebook, the types of the entities and links that users can add to a chart (and the types of the properties that they can contain) are governed by a schema. The schema has an associated charting scheme that controls the appearance of entities and links.

Individual deployments of i2 software have custom schemas that define entity and link types that are appropriate to the analysis they perform. Different organizations will use different types; even if two organizations used entity types named Person, those types would have different definitions.

TextChart, on the other hand, has a fixed list of types that it can extract from documents, which is defined in the LxBase. In order for Analyst's Notebook to receive entities and links from TextChart, and to display and analyze them successfully, there must be a mapping from the TextChart types to an i2 Analyze schema.

When you install i2 TextChart, it includes an i2 Analyze schema that defines all the same types that the LxBase defines, and a mapping configuration that provides a one-to-one mapping between the two sets of definitions. By default, TextChart uses that schema and mapping configuration when you send extracted entities and links to the chart.

Through Analyst's Notebook, you can make changes to the default mapping configuration so that some types are extracted differently - or so that they're not extracted at all. You can also create mapping configurations for different schemas, so that the entities and links you extract from documents are aligned with those that you're already using.

To start the process, select Text Analytics > Mapping Configuration.

The command opens the Mapping Configuration window, where you can make changes to the active configuration, switch to a different configuration, or create a mapping configuration of your own.

Mapping to a new schema

To start the process of mapping TextChart types to a new i2 Analyze schema, you must tell TextChart about the schema that you want to map to!

Click New to open the New Mapping Configuration window.
Click UPLOAD FILE, and locate the XML file that contains the schema you want to use.
When the upload succeeds, click OK to close the dialog. TextChart creates an empty mapping configuration for the new schema and makes it active.
Click Edit to open the new mapping configuration. At this stage, all of the TextChart types are "unmapped".

Note: When a configuration contains no mapping for a particular TextChart entity or link type, TextChart falls back to using the default mapping (and the default schema) for that type.

Mapping entity types

At this point, you can start to create the mappings from TextChart types to i2 schema types. It's usually easier to start with the entity types.

Click the "plus" icon next to the name of the TextChart type that you want to map. The type moves from the "unmapped" list to the "mapped" list:

When you first move a type to the "mapped" list like this, the mapping - and, effectively, extraction - is disabled. Entities with this type do not appear in TextChart results.
To enable the mapping, click the crossed-out "eyeball" icon next to the type name.
Now, you can choose the entity type in the i2 Analyze schema that you want the TextChart type to map to. Open the drop-down list in the i2 Entity Type column.
Select the i2 entity type that you want to use, and then click Save to update the mapping configuration.

Mapping entity types based on attribute values

Sometimes, you might want to map a TextChart type to different i2 Analyze types depending on the value of a particular attribute. For example, if the i2 Analyze schema has separate Male and Female entity types, you might map TextChart Person entities whose Gender attribute is "Male" to the former, and those whose Gender attribute is "Female" to the latter.

As before, click the "plus" icon next to the name of the TextChart entity type that you want to move to the "mapped" list.
Click the "plus" icon again to add a new row to the mapping configuration for the same TextChart entity type.
In the i2 Entity Type column, select one of the types that the TextChart entity type will be mapped to.
In the attribute column, select the TextChart attribute whose value will control whether this mapping is used.
In the match column, specify the attribute value that will cause this mapping to be used.

When you save this mapping configuration, the entities that you send to charts from TextChart extraction results will have different types, according to the criteria that defined.

Mapping TextChart attributes to i2 Analyze property types

After you set up mappings between TextChart and i2 Analyze entity types, the next step is to configure the mappings between their attributes and property types.

Select the Properties tab in the Mapping Configuration window to display a list of all the entity types that you've mapped.
Click the "plus" icon next to the entity type to which you want to add a property type mapping. A new row appears below the entity type.
In the TextChart attribute column, select the attribute of the TextChart type for which you want to define a mapping.
In the Map To i2 Property column, select the property type of the i2 entity type that you want to map the attribute to.
Continue this process until you have created mappings for all the property types that you want to see in Analyst's Notebook charts.

At any point in the mapping process (and always at the end), click Save to update the stored version of the mapping configuration.

Mapping link types

Like property types, you can only create mappings from TextChart link types to i2 Analyze link types after you've created the necessary entity type mappings.

Select the Links tab in the Mapping Configuration window to display a list of all the entity types that you've mapped.
Click the "plus" icon next to the name of the entity type that forms the "From" end of the link type that you want to map. A new row appears below the entity type.
In the Link 'To Type' column, select the i2 Analyze entity type that forms the "To" end of the link type that you want to map.
In the i2 Link Type column, select the i2 Analyze link type that you want to map to.
Finally, in the Rosoka Link Type column, select the TextChart link type that you want to map from, and then click Save.