ITSMChangeManagement -> rel-3_2 API documentation

NAME

Kernel::System::ITSMChange::Template::ITSMChange - all template functions for changes

SYNOPSIS

All functions for change templates in ITSMChangeManagement.

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::Template::ITSMChange;
  
  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 $TemplateObject = Kernel::System::ITSMChange::Template::ITSMChange->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      DBObject     => $DBObject,
      TimeObject   => $TimeObject,
      MainObject   => $MainObject,
  );
  

• Serialize()

  Serialize a change. This is done with Data::Dumper. It returns a serialized string of the datastructure. The change actions are wrapped within an arrayreference...

  my $TemplateString = $TemplateObject->Serialize(
      ChangeID   => 1,
      StateReset => 1, # (optional) reset to default state
      UserID     => 1,
      Return     => 'HASH', # (optional) HASH|STRING default 'STRING'
  );
  

  returns

  '{ChangeAdd => {Title => 'title', ...}}, {WorkOrderAdd => { ChangeID => 123, ... }}'
  

  If parameter Return is set to HASH, the Perl datastructure is returned

  {
      ChangeAdd => { ... },
      Children  => [
          {
              WorkOrderAdd => { ... },
              Children     => [ ... ],
          },
          {
              WorkOrderAdd => { ... },
              Children     => [ ... ],
          },
      ],
  }
  

• DeSerialize()

  DeSerialize() is a wrapper for all the _XXXAdd methods.

  my %Info = $TemplateObject->DeSerialize(
      Data => {
          # ... Params for ChangeAdd
      },
      ChangeID => 1,
      UserID   => 1,
      Method   => 'ChangeAdd',
  );
  

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.