1.3.3.6.6.5.  Manage index

1.3.3.6.6.5.1. V12 functionality - Preconditions

The IndexManager from V12 uses a new JavaLucene Index, which is among $CADENAS_SETUP/partsol.cfg in following key is activated.

[INDEX:LUCENE]
JavaLucene=1

Even if a complete index from V11 is available, the full text index [Full-text index] for V12 must be completely regenerated. The LinkDB index must also be recreated as it also uses the new index type. The geoindex [Geo index] is immediately displayed correctly; however, it should also be regenerated as there are new algorithms that extend the search options.

The illustration shows the situation with the new index after a recent update from V11 to V12. The index has only been recreated for the "ANSI" catalog.

The illustration shows the situation with the new index after a recent update from V11 to V12. The index has only been recreated for the "ANSI" catalog.

[Note]Note

If the new Geo(DB) index exists, it is the icon (tooltip "Index for geometric search available [Geometric search index available]" + "GeoDb including Geometric Search") and no longer displays the Icon (Tooltip "Index for Geometric Search available [Geometric search index available]").

1.3.3.6.6.5.2.  Manage index" dialog --- General call and procedure
  1. Select the category Index management [Index administration] in PARTadmin.

  2. Select the catalog you want to index or the catalog you want to examine.

  3. In the context menu of the catalog, click the Manage index command.... [Manage index...]

    -> The IndexManager settings [IndexManager preferences] dialog box opens.

    IndexManager settings [IndexManager preferences]

    IndexManager settings [IndexManager preferences]

  4. Determine which statistics are to be loaded. Activate the desired checkboxes accordingly. (Loading takes some time.)

    • Full-text (activated by default)

    • Geo (old index). The option is deactivated by default, as it is not relevant in the default configuration.

    • GeoDB (activated by default - from V12.7 this index is used unless it is explicitly deactivated. If an old index exists, it is automatically converted to the new one in the background as soon as the app server is running).

    Always show this dialog: If you had deactivated the option but would like to display the dialog again later, activate the option Show the settings dialog on next startup on the Settings tab page (see Section 1.3.3.6.6.5.6.7, “ Settings).

    -> The Manage index dialog box opens, with the Statistics [Statistic] tab page open by default.

1.3.3.6.6.5.3.  Manage index" dialog --- Columns

Columns

The Path / Project column shows the structure of the selected catalog. The other columns show the percentage of generation for the corresponding elements.

  • Path / Project

  • Geo: Special algorithms for the geometric search (3D) [Geometric search (3D)]

  • Topo: Special algorithms for the topology search [Topology search]

  • GeoDB(Partial): The GeoDB( Partial) [GeoDB(Partial)] column is only displayed if a catalog has been marked for partial search via configuration file. See Section 1.6.5.8.4, “ Block [settings] Key PartialSearchCatalogs - Partial Search ”.

  • Full text [Full-text] / LinkDB: Depending on whether table [Table] or LinkDB mode [LinkDB] is selected at the top left, the corresponding column title is displayed.

Colors

  • Red: No index information available (0%)

  • Yellow: Index information available (but not complete)

  • Green: Complete index information available (100%, i.e. all fingerprints or text index for all lines ... Complete GeoIndex usually only recommended / necessary for own part catalogs)

  • White (-): There are no entries in the LinkDB for these projects/folders, i.e. nothing that could be indexed.

1.3.3.6.6.5.4.  Manage index" dialog --- Generation example

Manage [Manage index...] index generation using Index [Manage index...]... or Generate index for full-text search [Create full-text search index] | Create LinkDB search indexes [Create LinkDB search index] | Geosearch indexes [Geometrical search index] basically do exactly the same thing.

Context menu commands at catalog level -

Context menu commands at catalog level -

Using Generate index for full-text search [Create full-text search index] | Create LinkDB search indexes [Create LinkDB search index] | Geosearch indexes [Geometrical search index], only entire catalogs can be selected and indexed.

Individual folders, projects and even lines can also be indexed via the Manage index dialog.

The generation of the geo index is shown below as an example. In addition, the GeoDB(Partial) index is generated, for which a special config setting must be set (see Section 1.3.3.6.6.15, “ Update full text search index (and geo search index ) for finding topological values via full text search).

The initial situation shows the directory and projects in red. The percentage value shows 0% in all columns (GeoDB(Geo) [GeoDB(Geo)], GeoDB(Topo) and GeoDB(Partial) ). This means that there is no GeoDB index.

Manage index" dialog

Manage index" dialog

  1. For example, click the context menu command Add project to geoindex generation [Add project to geo index generation] at project level.

    -> Tabbed page Index generation is opened.

    -> The Generate geoindex [Generate geo index] checkbox is already ticked and the corresponding dialog area is opened.

    -> The desired path is already entered under Project selection [Select project]. You can use Add and Remove to make changes, i.e. add or remove additional projects and directories.

    Adding is also possible by drag&drop.

    Add projects/directories to the generation via drag & drop

    Add projects/directories to the generation via drag & drop

  2. If necessary, adjust the value under Percentage share [Percental fraction], usually to 100% for own parts catalogs (which is the case here in the example).

  3. Click on the Start generation button.

    -> The progress is displayed under Index generation status [Status of index generation].

    -> Once generation is complete, the page is automatically refreshed and the GeoDB indexes are displayed at 100%.

    -> On the Geoindex [Geo index] Tabbed page, you will see that 3 of 3 indexes (i.e. GeoDB(Geo), GeoDB(Topo) and GeoDB(Partial) =100%) are available.

    3 GeoDB indexes with 100%

    3 GeoDB indexes with 100%

  4. The procedure for Add project for full text index generation [Add project to full-text index generation] and Add project for LinkDB index generation [Add project to LinkDB index generation.] is identical.

1.3.3.6.6.5.5.  Manage index" dialog --- Table / LinkDB mode

Click on one of the two buttons to switch between table mode and LinkDB mode:

  • Table mode: Only the rows from the table are viewed

  • LinkDB mode: Only the rows from the LinkDB are considered

    Ideally, the value should always be 100%. If new ERP numbers have been assigned over time, the value falls below 100% and the LinkDB index must be updated.

Colors:

  • Green: All lines with LinkDB entry are indexed.

  • Yellow: Some lines with LinkDB entry are indexed.

  • Red: No line with LinkDB entry is indexed.

  • White (-): For these projects/folders there are no entries in the LinkDB, meaning nothing that could be indexed.

The LinkDB index Tabbed page shows the project table. Here you can see which rows are indexed and which are not by the corresponding icon at the start of the row.

  • indexed

  • not indexed

Tabbed page "LinkDB index [LinkDB index]": In this example, the project "iso_21269.prj" has 3 ERP numbers. The display of 33% means that only one of the three is indexed.

Tabbed page "LinkDB index [LinkDB index]": In this example, the project "iso_21269.prj" has 3 ERP numbers. The display of 33% means that only one of the three is indexed.

1.3.3.6.6.5.6.  Manage index" dialog --- Tabbed pages

1.3.3.6.6.5.6.1.  Statistic

[Note]Note

Depending on whether the Table or LinkDB mode is selected, the results refer to all table rows or only to those occurring in the LinkDB.

The information on the Statistics [Statistic] tab page always refers to the selected element in the index tree.

So select the desired level (catalog, directory or project).

-> You receive a complete overview of the geoindex [Geo index] as well as the full text index [Full-text index] and LinkDB index, with detailed information on indexed projects, lines and fingerprints.

- Projects

  • Number of projects: Total number of projects

  • Number of fully indexed projects: A project is fully indexed if all rows of the project are fully indexed.

  • Share of indexed projects [Percentage of indexed projects]: In percent

- Lines

  • Number of lines: Total number of lines

  • Number of fully indexed lines:

    Geo/Topo/Partial: A line is considered fully indexed if all fingerprints belonging to the index type are present.

    Text index: A line is considered completed if index information for it exists.

  • Percentage of indexed lines: Percentage

- Fingerprints

  • Number of fingerprints (geo/topo/partial only): Sum of possible fingerprints

  • Number of existing fingerprints [Number of available fingerprints]: Sum of the fingerprints in the index

  • Percentage of existing fingerprints [Percentage of available fingerprints]: Percentage

Statistics [Statistic] " tab page

Statistics [Statistic] " tab page

After finished index generation the statistic is reloaded in the IndexManager.

1.3.3.6.6.5.6.2.  Geo index

Select one single project.

-> You receive an overview of which indexes are stored for each project line.

Depending on whether Table or LinkDB mode is selected, the corresponding rows are displayed on the Geoindex [Geo index] Tabbed page.

The following two illustrations show a typical example of a manufacturer catalog. By default, 1% of the project lines or 3 project lines are indexed.

If "Table [Table]" is selected, all project lines are displayed.

If "Table [Table]" is selected, all project lines are displayed.

If "LinkDB [LinkDB]" is selected, 3 project lines are displayed, as only these three have an entry in the LInkDB.

If "LinkDB [LinkDB]" is selected, 3 project lines are displayed, as only these three have an entry in the LInkDB.

Element complete

All indexes (algorithms) are available for the relevant row (characteristic). It is therefore considered complete.

When a project is considered complete depends on the values you selected in the IndexManager preferences dialog.

Element incomplete: Not all indexes (algorithms) are used for the relevant line (characteristic).

Element missing: No indexes (algorithms) are available for the relevant line (characteristic).

Element obsolete [Element deprecated]: Outdated algorithms are used for the relevant line (characteristic).

1.3.3.6.6.5.6.3.  Full text index / LinkDB index

[Note]Note

Depending on whether Table or LinkDB mode is selected, the Full text index [Full-text index] or LinkDB index [LinkDB Index] tab page is displayed.

  • Register page full text index [Full-text index]

    A table similar to PARTdataManager is displayed (without LinkDB columns and information).

    Full text index [Full-text index] " tab page

    Full text index [Full-text index] " tab page

    For lines marked with an icon there is a full text index [Full-text index].

    1. Select a single project and a table line.

      -> In the below dialog areas the available text index is displayed.

    2. At the bottom left, select the name of a single index element.

      -> At the bottom right, then you will see the saved terms belonging to the selected index element.

  • LinkDB index [LinkDB Index] tab page

    Colors in LinkDB column

    • Green: All lines with existing LinkDB entry are indexed.

    • Yellow: Some lines with existing LinkDB entry are indexed.

    • Red: No line with existing LinkDB entry is indexed.

    • White (-): For these projects/folders there are no LinkDB entries, meaning nothing which could be indexed.

    Icons in table

    In the table on the LinkDB index tab page, you can see which rows are indexed and which are not by the corresponding icon at the start of the row.

    • indexed

    • not indexed

    Tabbed page "LinkDB index [LinkDB index]": In this example, the project "iso_21269.prj" has 3 ERP numbers. The display of 33% means that only one of the three is indexed.

    Tabbed page "LinkDB index [LinkDB index]": In this example, the project "iso_21269.prj" has 3 ERP numbers. The display of 33% means that only one of the three is indexed.

1.3.3.6.6.5.6.4.  Explanation of result

Explanation of result

Explanation of result

Results declaration [Explanation of result] tab page: For internal analyses only

For a certain search term, search results (and their sequence) can be displayed. The "Score" for a search result can be seen and how it is composed.

When double-clicking on a search result, the element is selected in the index tree.

1.3.3.6.6.5.6.5.  Search Variables

Here, search variables related to a project are displayed, including unit and type of the variable and all existing description texts.

1.3.3.6.6.5.6.6.  Index generation

Tabbed page Index generation: Here you can start index generation in parallel for different index types. You can select the entire catalog, directories, projects or just individual lines.

Elements can be added to the index generation via context menu command or drag&drop.

See example above.

Add projects/directories to the generation via drag&drop

Add projects/directories to the generation via drag&drop

Once index generation is complete, the statistics are reloaded in the Index Manager.

1.3.3.6.6.5.6.7.  Settings

Default setting for the IndexManager settings [IndexManager preferences] dialog:

Settings" Tabbed page

Settings" Tabbed page