ITSMChangeManagement -> rel-3_2 API documentation

NAME

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

SYNOPSIS

All functions for CAB 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::CAB;
  
  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::CAB->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      DBObject     => $DBObject,
      TimeObject   => $TimeObject,
      MainObject   => $MainObject,
  );
  

• Serialize()

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

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

  returns

  '{CABAdd => { CABCustomers => [ 'mm@localhost' ], ... }}'
  

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

  {
      CABAdd   => { ... },
      Children => [ ... ],
  }
  

• DeSerialize()

  Updates the CAB of a change based on the given CAB template. It returns the change id the cab is for.

  my $ChangeID = $TemplateObject->DeSerialize(
      Data => {
          CABCustomers => [ 'mm@localhost' ],
          CABAgents    => [ 1, 2 ],
      },
      ChangeID => 1,
      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.