Custom Categories#

Besides having standard categories i-doit makes it possible to create (custom) categories in order to document additional attributes, which are not included in standard categories.

Configuration of the Category#

You can find the configuration of the custom categories in i-doit at Administration → Data structure → Custom categories. The New button is used to create a custom category. If you already created some custom categories, you can also edit them here.

As a first step, it is necessary to give a unique name to the category so that it can be identified in the category list.

Furthermore, the category has to be linked to one or more object types in order to use it.

Now you can define if you require a single- or a multi-value-category. If you wish to use attributes which are unique in their combination, the configuration as single-value category will be sufficient. However, if you want to use the values repeatedly, you will need a multi-value category. This way it is possible to save multiple entries in one category.

In order to have access to a category in a database when querying (for example, in custom-made reports of the report manager) you can set a database constant. This constant is suggested automatically when creating the category and can be changed.

Characteristics of the Category#

In order to customize your category you can add any number of attributes with the Add new field button.

You can choose from the following field types:

• Checkbox
  A checkbox that can be selected
• Date and Time
  A field for date or for date + time
• Dialog+
  Dialog-Plus-Fields are fields which can be filled with their own values to make them re-usable. The dialog-plus field can also be used in other categories via the identifier in the Additionfield, so that the already entered values are available there. For this purpose, it is necessary to enter the same identifier in both categories.
• Dialog+ (multiple selection)
  Like Dialog+, only with any number of values.
• File Browser
  Allows you to reference a file.
• HTML editor
  A text field which allows simple text formatting, such as italic letters.
• Link
  A field to show a hyperlink which can be clicked within the category and forwards from there.
• Number only
  A field where only numbers can be entered.
• Object browser
  A field for creating a link to another object. This link is a reference only and not a complete relationship. Therefore this kind of reference will not appear in the CMDB explorer.
• Object browser (multiple objects)
  Like object browser, only with any number of objects.
• Object relation
  A complete relationship is generated when using an object relation. The Addition field allows the selection of the kind of relation and the associated relation text. These relations can also be found in the CMDB explorer. Whenever possible, this field type is to be preferred over the object browser mentioned above.
• Object relation (multiple objects)
  Like object relation, only with any number of objects.
• Report
  Displays a report, the ID of the report must be entered in the additional field.
• Text field
  A single-line text field for entering plain text.
• Text field (masked)
  A single-line text field for entering masked text. Content is only in the Database visible.
• Text field (multiple rows)
  You can enter longer texts in this multi-line text field.
• Time
  A time between 00:00 and 23:59 can be entered here
• Yes-no-field
  A simple yes-or-no selection.

Additionally, the following design elements are available:

• Horizontal line
  Separate fields and contents graphically with a line.
• HTML
  You can enter HTML code in the categories configuration which will be interpreted in the category. The source code will be entered in the configuration of the category and cannot be entered by the user when viewing the category in the documentation.
• Javascript
  You can enter Javascript code in the categories configuration which will be interpreted in the category. The source code will be entered in the configuration of the category and cannot be entered by the user when viewing the category in the documentation.

As with most of the other categories, custom categories also have a Description field attached at the end.
If you wish to change the order of the fields, you can do so easily with the dotted area at the start of each line and move the position of the attributes via drag and drop.

You can delete attributes with the Remove button.

An interpretation is carried out below the configuration:

• Total entry count::
  How often was this category saved? The entries are added up per object (once with single value, per entry with multi-value).
• Value count:
  Each attribute which was filled and saved is added together.

As soon as your category is configured and set up, you can use the Save button in order to make the category available in the chosen object types.

Technical Configuration#

The technical configuration helps you to use the custom category via API. You can display it with the Show technical configuration button.

It is possible to change the technical keys for each field by click on Change technical key

Now you are able to alter the key. The key will be checked automtically before you can save the new value.

After saving the custom category you can view and use the new technical configuration.