Interne uitbreiding van het OTOBO-kernsysteem

In dit artikel leer je hoe je OTOBO direct in de kern kunt aanpassen – via XML-configuratie, Perl-modules en templates. We laten je stap voor stap zien hoe je een eigen „HelloWorld“-module in het systeem integreert.

---

1. Directorystructuur

Alle aanpassingen bevinden zich onder je OTOBO-kloon in de Kernel/-directory:

Kernel/
├─ Config/Files/           # XML-registraties
│  └─ XML/
├─ System/                 # Business logic modules (Core)
├─ Modules/                # Frontend controllers (Agent/Customer)
├─ Output/HTML/Standard/   # Template Toolkit (TT) templates
└─ Language/               # Vertalingen

---

2. XML-configuratie

Nieuwe modules en routes worden geregistreerd via XML. Maak een bestand HelloWorld.xml aan in Kernel/Config/Files/XML/:

<?xml version="1.0" encoding="UTF-8"?>
<otobo_config version="2.0" init="Application">

  <!-- 1. Frontend module registreren -->
  <Setting Name="Frontend::Module###AgentHelloWorld" Required="1" Valid="1">
    <Navigation>Frontend::Agent::ModuleRegistration</Navigation>
    <Value>
      <Item ValueType="FrontendRegistration">
        <Hash>
          <Item Key="Group"><Array><Item>users</Item></Array></Item>
          <Item Key="Description" Translatable="1">HelloWorld Module</Item>
          <Item Key="Title"       Translatable="1">HelloWorld</Item>
          <Item Key="NavBarName">HelloWorld</Item>
        </Hash>
      </Item>
    </Value>
  </Setting>

</otobo_config>

---

3. Core-module (Business Logic)

Maak je logica aan in Kernel/System/HelloWorld.pm:

package Kernel::System::HelloWorld;
use strict;
use warnings;
our @ObjectDependencies = ();  

sub new {
    my ($Type, %Param) = @_;
    return bless {}, $Type;
}

sub GetHelloWorldText {
    my ($Self, %Param) = @_;
    return $Self->_FormatText(String => 'Hello World');
}

sub _FormatText {
    my ($Self, %Param) = @_;
    return uc $Param{String};
}

1;

---

4. Frontend-module (Controller)

Integreer je logica in de Agent-frontend in Kernel/Modules/AgentHelloWorld.pm:

package Kernel::Modules::AgentHelloWorld;
use strict;
use warnings;

sub new { bless {}, shift }

sub Run {
    my ($Self, %Param) = @_;

    my $HelloObj    = $Kernel::OM->Get('Kernel::System::HelloWorld');
    my $LayoutObj   = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
    my %Data;
    
    $Data{Text} = $HelloObj->GetHelloWorldText();

    return 
        $LayoutObj->Header(Title => 'HelloWorld')
      . $LayoutObj->NavigationBar()
      . $LayoutObj->Output(
          TemplateFile => 'AgentHelloWorld',
          Data         => \%Data,
        )
      . $LayoutObj->Footer();
}

1;

---

5. Templates (TT)

Maak de volgende template aan in Kernel/Output/HTML/Standard/AgentHelloWorld.tt:

[% Data.Text %]

<p>Dit is je zelfgemaakte HelloWorld-module!</p>

---

6. Voorbeeldworkflow

1. Opnieuw laden:

   bin/otobo.Console.pl Maint::Config::Rebuild

2. Cache legen:

   bin/otobo.Console.pl Maint::Cache::Delete

3. Browser openen: Agent-interface → Menu → „HelloWorld“

---

7. Tips & Best Practices

• ObjectDependencies correct declareren (bijv. DB, Layout).
• POD-documentatie niet vergeten in Perl-modules.
• Vertalingen onderhouden in Kernel/Language/de_*.pm.
• Unit tests opzetten met Mojolicious (optioneel).
• Na elke wijziging Config rebuild & Cache wissen.

Hiermee heb je een solide basis om verdere kernuitbreidingen in OTOBO te realiseren. Veel plezier met ontwikkelen!