Maintenance

With the add-on Maintenance, maintenance appointments can be planned, coordinated, and managed. Planned maintenance activities are linked to any objects. To avoid missing deadlines, notifications are automatically sent via email.

Download and installation#

This add-on can be installed additionally. Details on download, installation, and updates can be found in the article "i-doit Add-ons".

Configuration#

No separate configuration is required.

Assigning rights#

Under Administration → Permissions → Wartung can permissions for persons and person groups be adjusted.

Planning maintenance#

Maintenance activities can be created and edited under Add-ons → Maintenance → All maintenance.

The action bar provides the following functions:

When creating a new maintenance activity, the following options are available:

Upcoming maintenance#

Here you can send emails for maintenance activities, complete maintenance, or create and edit them.

Completed maintenance#

When a maintenance activity is marked as completed, it no longer appears under Upcoming maintenance (see above). Instead, you can find it under Add-ons → Maintenance → Completed maintenance.

Planning view#

A detailed overview of all objects for which maintenance has been planned or already performed can be found under Add-ons → Maintenance → Planning view. For filtering, you define the time period via the From and To options.

Creating a report#

From the previously planned and performed maintenance activities, you can create a report that can be downloaded as a PDF file. You can find the function under Add-ons → Wartung → Report (Export) or alternatively under Extras → Report Manager → Views → Wartung Report (Export). The following options are available:

The PDF file is generated via the PDF Export & Download button and offered for download.

Maintenance overview in the object#

If an object is under maintenance, this is indicated symbolically. On every page of the object -- on the overview page or within categories -- the note In maintenance appears.

You can add the Maintenance overview category to the object type via the object type configuration to also display maintenance activities directly in the object.

Maintenance on the dashboard#

On the Dashboard you display planned and completed maintenance activities in the calendar widget. These are highlighted.

Creating email templates#

For each planned maintenance activity, you can generate an email to notify the affected persons. You specify them either as recipients or via their assigned role. You define the email text under Add-ons → Maintenance → Email templates. You can create any number of templates and assign them to individual planned maintenance activities (see above).

Using the New button, you create a new template; using Edit, you modify an existing one. Using Delete, you irrevocably remove templates.

The form for creating and editing offers the following Options:

You can populate both the Title and the Content with placeholders that are replaced before sending. The list of available placeholders can also be found on the page.

Sending emails automatically#

The actual sending of emails takes place in the background via the Console, the CLI tool of i-doit. For this, you use the maintenance command. It is best to set up a cron job to send emails automatically. Example call:

1

sudo -u www-data php console.php --user admin --password admin maintenance

This automates the manual sending of emails (Send emails button under Add-ons → Maintenance → All maintenance).

CLI console commands and options#

maintenance#

Sends emails with planned maintenance according to defined time periods.

Optionen:

Usage example

1

sudo -u www-data php console.php maintenance --user admin --password admin --tenantId 1

Releases#