ITSMConfigurationManagement -> rel-3_3 API documentation

NAME

Kernel::Output::HTML::LinkObjectITSMConfigItem - layout backend module

SYNOPSIS

All layout functions of link object (config item)

• new()

  create an object

  $BackendObject = Kernel::Output::HTML::LinkObjectITSMConfigItem->new(
      %Param,
  );
  

• TableCreateComplex()

  return an array with the block data

  Return

  @BlockData = (
      {
          Object    => 'ITSMConfigItem',
          Blockname => 'ConfigItem Computer',
          Headline  => [
              {
                  Content => '',
                  Width   => 20,
              },
              {
                  Content => 'ConfigItem#',
                  Width   => 100,
              },
              {
                  Content => 'Name',
              },
              {
                  Content => 'Deployment State',
                  Width   => 130,
              },
              {
                  Content => 'Created',
                  Width   => 130,
              },
          ],
          ItemList => [
              [
                  {
                      Type             => 'CurInciSignal',
                      Key              => '123',
                      Content          => 'Incident',
                      CurInciStateType => 'incident',
                  },
                  {
                      Type    => 'Link',
                      Content => '123',
                      Link    => 'Action=AgentITSMConfigItemZoom;ConfigItemID=123',
                  },
                  {
                      Type      => 'Text',
                      Content   => 'The Name of the Config Item',
                      MaxLength => 50,
                  },
                  {
                      Type      => 'Text',
                      Content   => 'In Repair',
                      Translate => 1,
                  },
                  {
                      Type    => 'TimeLong',
                      Content => '2008-01-01 12:12:00',
                  },
              ],
              [
                  {
                      Type             => 'CurInciSignal',
                      Key              => '234',
                      Content          => 'Incident',
                      CurInciStateType => 'incident',
                  },
                  {
                      Type    => 'Link',
                      Content => '234',
                      Link    => 'Action=AgentITSMConfigItemZoom;ConfigItemID=234',
                  },
                  {
                      Type      => 'Text',
                      Content   => 'The Name of the Config Item 234',
                      MaxLength => 50,
                  },
                  {
                      Type      => 'Text',
                      Content   => 'Productive',
                      Translate => 1,
                  },
                  {
                      Type    => 'TimeLong',
                      Content => '2007-11-11 12:12:00',
                  },
              ],
          ],
      },
  );
  
  @BlockData = $LinkObject->TableCreateComplex(
      ObjectLinkListWithData => $ObjectLinkListRef,
  );
  

• TableCreateSimple()

  return a hash with the link output data

  Return

  %LinkOutputData = (
      Normal::Source => {
          ITSMConfigItem => [
              {
                  Type    => 'Link',
                  Content => 'CI:55555',
                  Title   => 'ConfigItem# 555555: The config item name',
                  Css     => 'style="text-decoration: line-through"',
              },
              {
                  Type    => 'Link',
                  Content => 'CI:22222',
                  Title   => 'ConfigItem# 22222: Title of config name 22222',
              },
          ],
      },
      ParentChild::Target => {
          ITSMConfigItem => [
              {
                  Type    => 'Link',
                  Content => 'CI:77777',
                  Title   => 'ConfigItem# 77777: ConfigItem name',
              },
          ],
      },
  );
  
  %LinkOutputData = $LinkObject->TableCreateSimple(
      ObjectLinkListWithData => $ObjectLinkListRef,
  );
  

• ContentStringCreate()

  return a output string

  my $String = $LayoutObject->ContentStringCreate(
      ContentData => $HashRef,
  );
  

• SelectableObjectList()

  return an array hash with selectable objects

  Return

  @SelectableObjectList = (
      {
          Key      => '-',
          Value    => 'ConfigItem',
          Disabled => 1,
      },
      {
          Key   => 'ITSMConfigItem::25',
          Value => 'ConfigItem::Computer',
      },
      {
          Key   => 'ITSMConfigItem::26',
          Value => 'ConfigItem::Software',
      },
      {
          Key   => 'ITSMConfigItem::27',
          Value => 'ConfigItem::Network',
      },
  );
  
  @SelectableObjectList = $LinkObject->SelectableObjectList(
      Selected => $Identifier,  # (optional)
  );
  

• SearchOptionList()

  return an array hash with search options

  Return

  @SearchOptionList = (
      {
          Key       => 'Number',
          Name      => 'ConfigItem#',
          InputStrg => $FormString,
          FormData  => '1234',
      },
      {
          Key       => 'Name',
          Name      => 'Name',
          InputStrg => $FormString,
          FormData  => 'BlaBla',
      },
  );
  
  @SearchOptionList = $LinkObject->SearchOptionList(
      SubObject => '25',  # (optional)
  );
  

• _XMLData2Hash()

  returns a hash reference with all xml data of a config item

  Return

  $Data = {
      'HardDisk::2' => {
          Value => 'HD2',
          Name  => 'Hard Disk',
       },
      'CPU::1' => {
          Value => '',
          Name  => 'CPU',
      },
      'HardDisk::2::Capacity::1' => {
          Value => '780 GB',
          Name  => 'Capacity',
      },
  };
  
  my $Data = $LinkObject->_XMLData2Hash(
      XMLDefinition => $Version->{XMLDefinition},
      XMLData       => $Version->{XMLData}->[1]->{Version}->[1],
      Data          => \%DataHashRef,                                 # optional
      Prefix        => 'HardDisk::1',                                 # optional
  );
  

TERMS AND CONDITIONS

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

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