Wewnętrzne rozszerzanie systemu OTOBO

W tym artykule dowiesz się, jak dostosować OTOBO bezpośrednio w jądrze – za pomocą konfiguracji XML, modułów Perl i szablonów. Pokażemy Ci krok po kroku, jak dodać własny moduł "HelloWorld" do systemu.

---

1. Struktura katalogów

Wszystkie dostosowania znajdują się pod katalogiem Kernel/ Twojego klonu OTOBO:

Kernel/
├─ Config/Files/           # Rejestracje XML
│  └─ XML/
├─ System/                 # Moduły logiki biznesowej (Core)
├─ Modules/                # Kontrolery frontendu (Agent/Customer)
├─ Output/HTML/Standard/   # Szablony Template Toolkit (TT)
└─ Language/               # Tłumaczenia

---

2. Konfiguracja XML

Nowe moduły i trasy są rejestrowane za pomocą XML. Utwórz plik HelloWorld.xml w katalogu Kernel/Config/Files/XML/:

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

  <!-- 1. Zarejestruj moduł frontendu -->
  <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">Moduł HelloWorld</Item>
          <Item Key="Title"       Translatable="1">HelloWorld</Item>
          <Item Key="NavBarName">HelloWorld</Item>
        </Hash>
      </Item>
    </Value>
  </Setting>

</otobo_config>

---

3. Moduł Core (logika biznesowa)

Utwórz swój kod w 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. Moduł frontendu (kontroler)

W Kernel/Modules/AgentHelloWorld.pm połącz swój kod z frontendem agenta:

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. Szablony (TT)

Utwórz szablon w Kernel/Output/HTML/Standard/AgentHelloWorld.tt:

[% Data.Text %]

<p>To jest Twoje własne moduł HelloWorld!</p>

---

6. Przykładowy workflow

1. Odśwież konfigurację:

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

2. Wyczyść pamięć podręczną:

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

3. Otwórz przeglądarkę: Interfejs agenta → Menu → „HelloWorld”

---

7. Wskazówki i najlepsze praktyki

• ObjectDependencies deklaruj czysto (np. DB, Layout).
• Dokumentację POD w modułach Perl nie zapomnij.
• Tłumaczenia przechowuj w Kernel/Language/de_*.pm.
• Testy jednostkowe z Mojolicious ustaw (opcjonalnie).
• Po każdej zmianie odbuduj konfigurację i wyczyść pamięć podręczną.

W ten sposób masz solidny szablon, aby realizować dalsze rozszerzenia jądra OTOBO. Powodzenia w rozwoju!