You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Now that we are familiar with the structure of the IT documentation we will take a more detailed look at the attribute fields which are available in the i-doit web GUI.

Overview

Each attribute that can be edited is represented by a form field. This applies to default categories as well as to custom categories. Almost all attribute fields can be declared as mandatory fields and/or be configured to have validation options.

 

 

Attributes that cannot be edited either do not have an attribute field in the edit view or they only have one with the read-only option.

An example for a dynamically created attribute without an attribute field is the FQDN in the Host Address category. The FQDN consists of the attributes Hostname and DNS Domain.

 

An example for a read-only attribute field is the Object ID which is generated automatically by MySQL/MariaDB.

 

Single-line Text Fields

Text fields consisting of a single line can be used for all kinds of texts. The character limit is around 255 symbols. An example is the Serial number in the Model category.

 

 

HTML-Editor/Multiline Text Fields

Text fields consisting of multiple lines can have any kind of text in multiple lines. The character limit is set to around 65000 symbols. It's possible to switch from a simple text field to a HTML-editor in order to format the text. This happens at Administration → System settings → User interface → WYSIWYG Editor in Categories. "WYSIWYG" stands for "What You See Is What You Get".

The HTML-editor possesses further formatting options which can be activated at Administration → System settings → User interface → Activate all WYSIWYG Editor Functions.

Almost all category entries possess the description attribute at the end, which is displayed as HTML-editor by default.

 

 

Dialogue Field (Drop Down)

The dialogue field is a selection field (drop down). The values that can be selected in this field are pre-defined and can generally not be altered. If no value is to be selected, the dash ( - ) can be selected instead if possible.

The Condition in the category General serves as an example.

 

 

An example for an attribute which may be edited centrally is the CMDB-Status in the General category.

Dialog-Plus-Field (expanded Drop Down)

The dialog-plus field is similar to the dialogue field. Furthermore, additional values can be defined. To do so either the icon to the right of the attribute field or the Dialog-Admin can be used. The attributes Category and Purpose in the General category are examples for this.

 

 

Clicking the icon opens the List browser via which additional values can be added and existing ones can be edited.

 

Note

Deleting is only possible via the Dialog-Admin. This function should be used exclusively by administrators, since all field values will be irreversibly removed from all entries.

Multi-Dialog-Plus-Field (Multiselection)

For the attribute fields mentioned above, only one value can be selected in each case. In order to select multiple values the Multi-Dialog-Plus-Field exists. Additional values can be added from a drop-down menu. In some cases there are additional buttons for (de-)selecting all values or for inverting the selection.

An example for this is the DNS domain attribute in the Host address category.

 

 

Date Field

Clicking the single-line text field will open a calendar. If you click the desired date it is transferred to the text field. As an alternative you can use the format yyyy.mm.dd for entering the date manually.

The Accounting category contains the example attribute Date of purchase.

 

 

Units and Intervals

A drop-down field for setting units and intervals exists next to suitable attribute fields. These can be time units, measuring units, weight units, time frames and so on.

The Warranty period in the Accounting category is an example for this.

 

 

Costs

Costs are documented as decimal numbers (or simplified as real numbers without decimal places). Dots and commas can be used as separators for the decimal places. The attribute field also shows the configured currency. This is determined at Administration → CMDB settings → General configuration → Monetary format.

An example for this is the Investment costs in the Accounting category.

 

 

Some single-line text fields are intended to have URIs in them. A link will be generated from this, which the user can then click to get forwarded.

The Access category offers this attribute field for example.

 

 

Object-Relations

In order to create a relationship between two or more objects, the object browser is used for most cases. An additional browsers is used for some special cases. The single-line text field is complemented by two icons on the right side.

The text field is writable if a 1-to-1 relationship can be established between two objects. While typing suggestions are already being shown. The text field is in the read-only mode if a 1-to-n relationship can be established.

Clicking on the magnifier-icon opens the corresponding browser. The icon next to it (a clip with a blocking signal) detaches existing or selected relations.

 

 

Object-Browser

The object-browser is built in a way which depends on which kind of relationship is going to be documented. Hence not all functions described here are available in all cases. The selection of filters if often limited as for example only objects of particular object types may be selected.

A single selection is the only possibility ff the selection of the object that is to be referenced is done via radio buttons. If the -buttons are available however, multiple selections are possible.

There are multiple tabs in the upper area:

  • Object view: The object view is sorted by filters. If the matching object is missing it can be created via the Create new object button. Filters:
    • by object type: Choose the object type first, then the object/s.
    • by object groups: All objects can be listed per object-group if the object type object-group is used.
    • by person groups: All persons per person group are listed.
    • by relations: The kind of relation has to be selected first, then all relationship objects are listed.
    • by date: Objects are sorted by date. The options are: newly created, newly updated, created this month, created last month.
  • Location view: The location tree with all paths is displayed from which the matching object can be selected.
  • Search: Here the objects can be searched via the object title.
  • Reports: Objects are listed utilizing already created reports.
  • Selected objects: The objects that are already selected are shown in this tab. Via the Create a new object-group from selection button an object of the type object-group is created and is filled with the selected objects.

All current changes are listed in the Log.

An example is the Contact browser which is available for the Purchased at attribute in the Accounting category.

 

 

Location Selection

This browser establishes a 1-to-1 relation of the type Location to an object which is defined as a location. The Location selection is displayed when clicking the magnifier icon. This looks similar to the Location view (see above). This browser appears in the Location category.

 

 

 

Browser with Sub-Selection

Sometimes it's necessary not only to select the object but also an attribute of this object. Examples for this are the attributes Connected with in the Port (Network) category. There an input or output is selected from the Connection (Cabling) category and the possibility to select software relations in the Service components category.

 

 

Note

A selection has to be made in both columns if the browser is separated in two parts (and as such has a sub-selection available) and is using radio-buttons. The entry will not be carried over when saving if for example only the connected object but not the corresponding port is selected in the object browser for the connection of two devices.