Using iKnow
iKnow Architect
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

Caché provides the iKnow Architect as an interactive interface for creating and populating iKnow domains and performing analysis on the indexed data. iKnow Architect is accessed using the Caché Management Portal.

It consists of three tools:
All functionality provided through the iKnow Architect is also available by using Caché ObjectScript to invoke iKnow class methods and properties.
Accessing iKnow Architect
The starting point for accessing the iKnow Architect is the Management Portal System Explorer option. From there you select the iKnow option.
All iKnow domains exist within a specific namespace. Therefore, you must specify which namespace you wish to use by selecting the Switch option at the top of any Management Portal interface page. This displays the list of available namespaces, from which you can make your selection.
A namespace must be iKnow-enabled before it can be used. Selecting an iKnow-enabled namespace displays the iKnow Domain Architect option.
Note:
If selecting an iKnow-enabled namespace does not display the Domain Architect option, you do not have a valid iKnow license. Look at Licensed to in the Management Portal header. Review or activate your license key.
Enabling a Namespace
A namespace must be iKnow-enabled before it can be used with iKnow Architect.
To enable a namespace for iKnow from the Management Portal, select System Administration, Security, Applications, Web Applications ([Home] > [Security Management] > [Web Applications]). This displays a list of web applications; the third column indicates if a listed item is a namespace (“Yes”) or not. Select the desired namespace name from the list. This display the Edit Web Application page. Select the Enabled check box for iKnow. Click the Save button.
You cannot enable the %SYS namespace. This is because you cannot create iKnow domains in the %SYS namespace.
You can set your Management Portal default namespace. From the Management Portal select System Administration, Security, Users ([Home] > [Security Management] > [Users]). Select the name of the desired user. This allows you to edit the user definition. From the General tab, select a Startup Namespace from the drop-down list. Click Save.
Creating a Domain
From the iKnow Architect press the New button to define a domain. You specify the following domain values (in the specified order):
Click the Finish button to create the domain. This displays the Model Elements selection screen.
You must Save and Compile a newly created domain before exiting that domain.
Both domain names and domain definitions must be unique within the namespace. If a duplication occurs, iKnow Architect performs the following operations:
Duplicate domain: if you create two domain names in the namespace that are the same but have different domain definitions, the iKnow Architect will appear to create both domains. However, when attempting to compile the domains, compilation will fail for the second domain name.
Duplicate domain definitions: if you create two domains that have the different names but have the same domain definition, the iKnow Architect will overwrite the first domain with the second domain. This is a delete and replace operation, not a rename. iKnow Architect issues no message when performing this overwrite.
For other ways to create a domain, refer to iKnow Domains. Note that iKnow Architect is the only domain creation interface that allows you to define a domain definition package name and class name.
Opening a Domain
Creating a domain using the Management Portal interface immediately opens the domain, allowing you to begin immediately to manage this new domain.
To manage an existing domain, click the Open button to list all existing domains in the namespace. This display lists the packages that contain domains. Select a package to display its domains. Select an existing domain. This displays the Model Elements selection screen.
Changing the Domain Name and Check Boxes
Creating or opening a domain displays the Model Elements window. If you click on the domain name in this window, the Details tab displays the Domain Name field, the Domain Tables Package field, and the Allow Custom Updates and Disabled check boxes. You can modify these characteristics of the domain. Changing the Domain Name does not change the Definition class name.
Checking the Allow Custom Updates check box allows the manual loading of data sources and dictionaries into this domain using interfaces other than iKnow Architect.
Checking the Disabled check box prevents the loading of data (source data, metadata, blacklists) during the Build operation.
You must Save and Compile a renamed domain before exiting that domain.
Deleting a Domain
To delete the current domain, click the Delete button. This displays the Drop domain data window. you can either delete just the domain contents or delete the domain definition. Click Drop domain & definition class to delete the domain and its associated class definition, including the specifications of data sources, blacklists, and other model elements.
Model Elements
After creating a domain, or opening an existing domain, you can define model elements for the domain. To add or modify model elements, click on the expansion triangle next to one of the headings. Initially, no expansion occurs. Once you have defined some model elements, clicking the expansion triangle shows the model elements you have defined.
To add a model element, click the heading. Then click the Add button shown in the Details tab on the right side. Specify the name and values. The model element is automatically generated when you leave the Details area. Model elements are listed in the order of their creation, with the most-recently-created element at the top of the list; modifying a model element does not change its position in the list.
To modify a model element, expand the heading, then click a defined model element. The current values are shown in the Details tab on the right side. Modify the name and/or values as desired. The model element is automatically re-generated when you leave the Details area.
Once you have created model elements, clicking on the Expand All button (or one of the expansion triangles) displays these defined values. The Element Type column shows the type of each model element. Clicking on the red “X” deletes that model element.
The iKnow Architect page heading is followed by an asterisk (*) if there are unsaved changes to the current domain definition. Click Save to save your changes.
The following Model Elements are provided:
Domain Settings
This model element allows you to modify the characteristics of the domain. All Domain Settings are optional and take default values. Domain Settings provides the following options:
Metadata Fields
Add Metadata: this button allows you to specify a source metadata field. For each metadata field you specify the field name, the data type (String, Number, or Date), the supported operators, and the storage type. After creating a domain, you can optionally specify one or more metadata fields that you can use as criteria for filtering sources. A metadata field is data associated with an iKnow data source that is not itself iKnow indexed data. For example, the date and time that a text source was loaded is a metadata field for that source. Metadata fields must be defined before loading text data sources into a domain.
Case Sensitive check box: By default, a metadata field is not case-sensitive; you can select this check box to make it case-sensitive.
Disabled check box: You can select the Disabled check box to disable all metadata fields, or to disable a single metadata field. A disabled field is not loaded during the Build operation.
The metadata fields that you specify here appear in the Data Locations Add data from table and Add data from query details under the title “Metadata mappings”.
Data Locations
Specifies the source for adding data. Option are Add data from table, Add data from query, Add data from files, Add RSS data, and Add data from global.
Add Data from Table
This option allows you to specify data stored in an existing SQL table in the current namespace. It provides the following fields:
If you have defined one or more Metadata Fields for this domain, the Metadata mapping option allows you to specify a metadata field for this table. From the drop-down list you can select a field from the selected table, select – not mapped –, or select – custom –. If you select – custom – the Architect displays an empty field in which you can specify the custom mapping.
If you have not defined any Metadata Fields for this domain, the Metadata mapping option provides a Declare Metadata button that directs you to the Add Metadata domain option.
Add Data from Query
Add data from query is similar to Add data from table, but allows you to specify a fully-formed SQL query for an existing table (or tables), from which you provides the following fields:
If you have defined one or more Metadata Fields for this domain, the Metadata mapping option allows you to select either – not mapped – or – custom – for each defined metadata field. The default is – not mapped –. If you select – custom – the Architect displays an empty field in which you can specify the custom mapping.
If you have not defined any Metadata Fields for this domain, the Metadata mapping option provides a Declare Metadata button that directs you to the Add Metadata domain option.
The Model Elements window Element Type column displays a truncated form of the query you defined; the query is truncated after the first table name in the FROM clause. The full query is shown in the Details window.
Add Data from File
This option allows you to specify data stored in files. It provides the following fields:
Add RSS Data
This option allows you to specify data from an RSS stream feed. It provides the following fields:
Add Data from Global
This option allows you to specify data from a Caché global. It provides the following fields:
Blacklists
Define blacklists: After creating a domain, you can optionally create one or more blacklists for that domain. A blacklist is a list of terms (words or phrases) that you do not want a query to return. Thus a blacklist allows you to perform iKnow operations that ignore specific terms in data sources loaded in the domain.
If you add, modify, or delete a blacklist, you must save, compile, and build the domain for this change to take effect. If you have already loaded the data locations and wish to add or modify a blacklist without reloading the data locations, you can click the Data Locations Disabled check box, then save, compile, and build the domain.
Defining blacklists has no effect on how data is loaded into a domain. The blacklists defined here are compiled, then supplied to the Knowledge Portal, which allows you to specify none, one, or multiple blacklists when performing analysis of source text data loaded into the domain. A blacklist is applied to some (but not all) Knowledge Portal analytics.
Matching
The Matching option provides the Add Dictionary option to define a dictionary and specify its items and terms.
The Matching option provides four check box options, as follows:
Add Dictionary
The Add Dictionary button displays the dictionary definition options: dictionary name (with a supplied default), an optional description, the dictionary language selected from a drop-down list of iKnow supported languages, and the disabled check box.
The Add Item button displays the item definition options: item name (with a supplied default), a uri name (with a supplied default), the item language selected from a drop-down list of iKnow supported languages, and the disabled check box. To define more items, select the dictionary name. Items are listed in order of creation, with the most recent at the top of the list. Within each item you can define one or more terms.
The Add Term button displays the term definition options: a string specifying the term, the term language selected from a drop-down list of iKnow supported languages, and the disabled check box. To define more terms, select the item name. Terms are listed in order of creation, with the most recent at the top of the list.
Save, Compile, and Build
You must save, compile, and build a domain (in that order) using the buttons provided. You must save and compile a domain after adding, modifying, or deleting any Model Elements.
The Save button saves the current domain definition. Architect greys out (disables) the Save button if no domain definition is open. Architect does not issue an error if you save a domain definition without changing it.
The Compile button compiles the current domain definition. It compiles all of the classes and routines that comprise the domain definition. If you have not saved changes that you made to the domain definition, the compile operation prompts you to save the domain definition before compiling.
The Build button loads the specified sources into the current domain. If you have made changes to the Data Locations values or Blacklists, you must save and compile the domain definition for these changes to be recognized by the build operation. The Build Domain window displays progress messages such as the following:
13:50:48: Loading data...
13:51:49: Finished loading 3 sources
13:51:49: Creating dictionaries and profiles...
13:51:49: Finished creating 1 dictionaries, 1 items, 3 terms and 0 formats
13:51:49: Matching sources...
13:51:50: Finished matching sources
13:51:50: Successfully built domain 'mydomain'
If the Disabled check box is checked for a resource, the Build operation does not load the corresponding sources.
Knowledge Portal
The Tools tab provides the Knowledge Portal button. Once you have specified Data Locations and populated the domain with this data using the Build button, you can select Knowledge Portal to display iKnow analysis of the data. This displays the Knowledge Portal as a separate browser tab.
The Knowledge Portal is a Zen page query display interface with broad application. It shows a wealth of information about the source text data indexed in a domain. It includes analysis of top (most-frequently-occurring) concepts. By selecting one concept, it provides analysis of similar and related concepts, and analysis of the appearance of the specified concept in larger text units. This provides a contextual at-a-glance view of what's in your data. (You can also specify a relation for context analysis.) The Knowledge Portal provides generic filters that support selecting subsets of the sources in a domain based on metadata criteria. This interface provides a sample of how iKnow Smart Indexing can be used to quickly overview and navigate a large set of documents.
A drop-down list at the top right of the Knowledge Portal allows you to select a domain. By default, the current domain is selected.
Listing All Concepts
The Knowledge Portal initially provides the following analysis of the data loaded in the domain:
Analyzing a Specified Entity
In the Start button entry field you can type the first few characters (minimum of 3, not case sensitive) of a word found in an entity, and the Knowledge Portal displays a drop-down list of all of the existing entities that contain a word beginning with those characters. You can select an entity from this drop-down list, then pressing Start.
You can select a Concept from the any of the concepts listings, or by clicking a concept highlighted in red in a path, CRC, or CC listing, or by typing in the Start button entry field. Selecting a concept changes all listings (except Top Concepts) to display information about that concept. Selecting a concept displays two kinds of information: other concepts that are associated with the specified concept, and how the specified concept appears in context.
You can select a Relation from the Similar Entities listing, or by typing in the Start button entry field. Selecting a relation changes the Similar Entities, Paths, Sources, and CRCs listings.
Other associated entities listings:
Specified entity in context:
Concepts in the Paths, CRCs, and CCs listings are highlighted in red and can be selected.
Note:
If Japanese is the only language supported for the domain, the Knowledge Portal display differs as follows: the Related Concepts, Related Concepts (map), CRCs, and CCs listings are not shown. An Entity Vectors listing is substituted for the Paths listing.
Limiting the Data to Return
You can limit the scope of your data analysis by using filters and/or blacklists.
Indexing Results
You can access the Indexing Results tool in two ways:
At the top left of the Indexing Results window is a drop-down list that shows the sources loaded into the domain. (The domain is shown in the drop-down list at the top right.) Select a data source from the drop-down list, then press the manual input button.
This displays three listings: Indexed Sentences, Concepts, and CRCs
Indexed Sentences
The sentences in the source are listed in order, one sentence per line, with iKnow indexing indicated by highlighting. The sentence text is highlighted as follows:
Concepts and CRCs
The Indexing Results displays two listings, one of all concepts in the source, one of all of the CRCs in the source
The sort by buttons at the top of the window allow you to toggle the Concepts and CRCs listings to display either frequency counts or dominance values in descending order.
In the Concepts listing, the most dominant concept(s) are given a dominance of 1000. Less dominant concepts are given smaller integer values, with larger sources tending to have lower least-dominant values. For example, a source containing 25 concepts might have a dominance range between 1000 and 83; a source containing 300 concepts might have a dominance range between 1000 and 2.
Note:
If Japanese is the only language supported for the domain, the Indexing Results display substitutes a single Entities listing for the Concepts and CRCs listings.