i-diary#

About i-diary#

i-diary is an application for Microsoft Windows, which works as an add-on for i-doit. With the help of the add-on, system administrators are able to get an overview of the changes that have occurred on the server.

This will be possible by using the application “diary” directly on a Windows server, without having to log in to i-doit and search for the information.

Documentation#

• Requirements
• Install
• Update
• Configuration
• Basic Usage
• Determine the host
• Determine the author

Copyright & License#

Copyright (C) 2020 synetics GmbH

Requirements#

The following requirements are necessary before installing or using the i-diary.

For i-Diary Version 1.1#

• Show all details about the host
• Update entries in i-diary
• Automatic recognition of object types
• Provide all Changelogs in CHANGELOG file

For i-Diary Version <= 1.0.1#

• Required i-doit >= 1.14
• Required i-doit-API add-on >= 1.10.4
• Executable:
• Windows 7 or 10
• .Net framework version >= 4.6.2

For i-Diary Version 1.0.2#

• Required i-doit >= 1.17
• Required i-doit API add-on >= 1.12.1
• Executable:
• Windows 7 or 10
• .Net framework version >= 4.8

Install#

The add-on is downloaded via the customer portal
The add-on must first be installed via the Admin Center.

Update#

i-diary is updated like other add-ons via the Admin Center.
The new i-diary.exe must then be replaced by the updated i-diary.exe.
This can be found in the downloaded ZIP idoit-i_diary-x.x.x.zip in path
\idoit-i_diary-1.0.1\src\classes\modules\idoit-i_diary\i-diary\

Change and save settings via GUI#

The user has the possibility to create and modify the configuration file via the application.

These are the following cases:

• If the configuration file is empty or does not exist yet or if it the configuration file empty, the GUI setting is opened automatically when the application is started.

• If the user changes something in the GUI setting, the change is immediately checked and saved if it is valid.
• When the user does not specify ‘http://’, ‘http://’ is used for the check and saved.
• When the user does specify ‘rc/jsonrpc.php’ as a suffix in the URL field, it will be ignored for the check and saved without it.
• The user can test the connection manually by clicking the button ‘Test the connection’.

Basic Usage#

Creating a new entry#

The user can create a new entry, for this purpose the following steps are taken:

• The author, date, and entry must be filled in and valid.
• For further entries, the selection of author and date persists until the application is closed.
• When the user saves an entry, the list of entries is updated.

Determine the host#

There are three ways to select a host:

Automatically select a host#

If no object is stored in the settings, an object should be determined automatically and proposed to the user. The name of the application host is determined for this purpose.

The hostname is searched for as the object title in i-doit#

• If exactly one object is found, its ID is saved.
• If several objects with the same name are found, the user can choose from these objects.
• The user can cancel the selection to manually select the host.

Set host manually#

• The user sets the Object ID in the configuration file. After restarting the application the setting takes effect.

• The user selects an object title from a searchable list. Only objects whose object types are assigned to the category “Diary” are displayed. The list is divided into the respective object types. The translated title of the respective object type is displayed as the list heading. If the user selects an object from the list, its ID is saved.
• The user types the Object ID into a search mask. The application gives feedback whether the object was found and saves its ID.
• The user enters the Object Title in a search mask. The application gives feedback if the object was found and saves its ID.
• If several objects with the same name are found, the user can choose from this list.

Reuse host#

When the application is started, the configuration file is read if the configuration file exists.

If an object ID is saved, the application gets the respective title to display it.

There are three ways to select an author:

Automatically discover an author#

If no author has been saved and the user starts the application, the application tries to recognize the author automatically.

This will be done through the following process:

When a “user name” is specified in the settings, the application will check whether the person matches a person object in i-doit. If this is the case the ID will be saved.

Set author manually#

The user can manually select an author for a new entry with the following options:

• The user can write the object ID of the author in the configuration file. This setting takes effect when the application is restarted.

• The user can select a person from a searchable list. This list is divided into “Contacts” (object relations from the category “Contact assignment”) and “Persons” (objects of the type “Persons”).

The titles of the objects are displayed in the list. When the user selects an object, its ID is saved.

Reuse author#

When the user starts the application, the already saved author is preselected for a new entry.

The application checks whether the object ID in the configuration file is valid, based on the ID, the application retrieves the object title to display it.

FAQ#

Known error messages and their meaning:

Changelog#