OPAR - OTRS Package ARchive

Browseable collection of plugins for the popular OTRS software.


KIXCore

Version
5.0.0
Other Versions
1.0.4, 1.2.4, 2.0.6, 3.0.3, 2.0.9, 3.0.5, 4.0.0, 3.0.7, 4.0.2, 2.0.10, 3.0.9, 4.0.5, 4.0.6, 4.0.8,
Uploaded by/on
capeIT on 08 Feb 2016
Framework
5.0.6
Links
Download Website
Description
KIXCore - Core package for KIX tsunami framework.

Rate/comment this package

General

This package provides a more flexible and more general approach for extensions of extensions than the common "Custom"-folder of OTRS itself. KIXCore (as the custom folder itself) is the continued development of the previous tsunami approach to extend other OTRS-extensions. Employing "use lib" instead of "unshift @INC" provides more stability and reduced complexity. Therefore each extension requires a modification of Kernel/Config.pm and scripts/apache2-perl-startup.pl. This can be done automatically by KIXUtils::RegisterCustomPackage. Each time a new custom folder is registered, a backup of the modified file Config.pm or apache2-perl-startup.pl with a timestamp suffix is written.

You can use a command line tool (<OTRS_HOME>/bin/kix.ManageMultipleCustomPackages.pl) to list custom folders, register or unregister a custom folder but actually this should be done by the package installation process.

IMPORTANT: if you're using mod-perl a webserver restart is required after the modification of apache2-perl-startup. Otherwise, no further custom packages in your custom modification will be found. Using a function of your custom extension upon installation (type "post") will NOT work, since @INC does not contain your custom directory yet. In order to use custom functions immediately on installation you need to install the extension via command line.

The common folder "Custom" allows to overwrite an existing file of an already installed package once. If you installed another extension, you would encounter the same problem as if you had no "Custom" folder. This drawback is resolved with KIXCore. Furthermore the common Custom-folder of OTRS does not affect following files/items (yet). By extending the custom-folder approach it is possible to easily dis- and enable whole OTRS-extensions by un-/registering the corresponding custom folder.

  • Kernel::System::KIXUtils

      contains methods to un-/register custom packages and add/delete modifications to/from Kernel/Config.pm and scripts/apache2-perl-startup.pl

  • Kernel::Output::HTML::Layout

      contains modifications to place and access template files and to load sub layout files

  • Kernel::Output::HTML::LayoutLoader

      contains modifications to use KIX paths for skins

  • Kernel::System::LinkObject

      required modification since module searches LinkObject backends not based on @INC but on hard coded file paths - should be fexed in future OTRS releases

  • Kernel::System::SysConfig

      contains modifications to place xml-configuration files in custom folders

  • Kernel::System::Stats

      contains modifications to place and access static and dynamic stats in custom folders

  • Kernel::Language

      contains modifications to (re-)place translation files by custom packages

  • CustomerHeader.dtl, CustomerLogin, dtl, Login.dtl

      contain modifications to build correct paths in links to css ans js files (needed for tsunami approach).

Copyright

KIXCore written/edited by:

  • Rene(dot)Boehm(at)cape(dash)it(dot)de

  • Martin(dot)Balzarek(at)cape(dash)it(dot)de

  • Torsten(dot)Thau(at)cape(dash)it(dot)de

  • Anna(dot)Litvinova(at)cape(dash)it(dot)de

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (AGPL). If you did not receive this file, see http://www.gnu.org/licenses/agpl.txt.