ITSMChangeManagement -> rel-3_2 API documentation

NAME

Kernel::System::ITSMChange::Event::HistoryAdd - Change and workorder history add lib

SYNOPSIS

Event handler module for history add in change management.

PUBLIC INTERFACE

• new()

  create an object

  use Kernel::Config;
  use Kernel::System::Encode;
  use Kernel::System::Log;
  use Kernel::System::DB;
  use Kernel::System::Main;
  use Kernel::System::Time;
  use Kernel::System::ITSMChange::Event::HistoryAdd;
  
  my $ConfigObject = Kernel::Config->new();
  my $EncodeObject = Kernel::System::Encode->new(
      ConfigObject => $ConfigObject,
  );
  my $LogObject = Kernel::System::Log->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
  );
  my $MainObject = Kernel::System::Main->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
  );
  my $TimeObject = Kernel::System::Time->new(
      ConfigObject => $ConfigObject,
      LogObject    => $LogObject,
  );
  my $DBObject = Kernel::System::DB->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      MainObject   => $MainObject,
  );
  my $EventObject = Kernel::System::ITSMChange::Event::HistoryAdd->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      DBObject     => $DBObject,
      TimeObject   => $TimeObject,
      MainObject   => $MainObject,
  );
  

• Run()

  The Run() method handles the events and adds/deletes the history entries for the given change or workorder.

  It returns 1 on success, undef otherwise.

  my $Success = $EventObject->Run(
      Event => 'ChangeUpdatePost',
      Data => {
          ChangeID       => 123,
          ChangeTitle    => 'test',
      },
      Config => {
          Event       => '(ChangeAddPost|ChangeUpdatePost|ChangeCABUpdatePost|ChangeCABDeletePost)',
          Module      => 'Kernel::System::ITSMChange::Event::HistoryAdd',
          Transaction => '0',
      },
      UserID => 1,
  );
  

  For workorder events the WorkOrderID is expected.

  my $Success = $EventObject->Run(
      Event => 'WorkOrderUpdatePost',
      Data => {
          WorkOrderID    => 456,
          WorkOrderTitle => 'test',
      },
      Config => {
          Event       => '(WorkOrderAddPost|WorkOrderUpdatePost|WorkOrderDeletePost)',
          Module      => 'Kernel::System::ITSMChange::ITSMWorkOrder::Event::HistoryAdd',
          Transaction => '0',
      },
      UserID => 1,
  );
  

TERMS AND CONDITIONS

This software is part of the OTRS project (http://otrs.org/).

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.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

• Around line 130:

  =cut found outside a pod block. Skipping to next block.