Skip to content

Class Viewer Tool

Jump to bottom
Curtis Conard edited this page Nov 23, 2020 · 1 revision

The Class Viewer tool allows you to browse GLPI and Plugin classes and see information related to them such as the localized name(s), icon, search options and more. Currently, the Class Viewer info pane is broken into two sections. The top section displays general information while the bottom section is a table of effective search options.

General

Currently, this section shows:

  • The class name (not localized).
  • A button to quickly switch to the Database Schema Viewer for this class' table (See the Database Schema Viewer tool page).
  • The localized singular and plural forms of the class name.
  • The icon if any. This is what shows up in the menus for example.
  • Some search option audit warnings. For this, it only shows existing search options that may be missing matching database table fields.

Search Options

Effective search options means those recognized by the search engine after all other classes/plugins are done adding their own search options on it. Since search options are hard-coded with an integer as their key and can be defined in multiple places, it is quite easy to accidentally override another option. By checking the Class Viewer it is easy to see if all your options are visible and which search option IDs are available (This is more useful if you have many of the common plugins installed already to make sure you don't override their options).

The table shows each search option and the following information about each:

  • Search ID (The unique ID assigned to each search option in the class).
  • Table (The table the data comes from). In all cases, a button is shown next to this value which would take you to that table's schema in the Database Schema Viewer. If the table has a matching class (Which is almost always the case), it will also have a button to take you to that class in the Class Viewer tool.
  • Field (The column in the table the data comes from).
  • Name (The localized name of the field).
  • Link field (The foreign key that links the class' table with the one specified in the Table column if applicable. Otherwise, the Field is shown again). The Database Schema and Class Viewer buttons are shown here under the same circumstances as described for the Table value.
  • Datatype (The type of the search value such as string, integer, etc). See Search Engine Data Types for more information.

For more information about search options and the search engine, please refer to the GLPI Developer Documentation.

Clone this wiki locally