init III

Perl OTRS/Kernel/System/ProcessManagement/TransitionAction/TicketTitleSet.pm

@@ -0,0 +1,147 @@
+# --
+# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
+# --
+# 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.
+# --
+
+package Kernel::System::ProcessManagement::TransitionAction::TicketTitleSet;
+
+use strict;
+use warnings;
+use utf8;
+
+use Kernel::System::VariableCheck qw(:all);
+
+use parent qw(Kernel::System::ProcessManagement::TransitionAction::Base);
+
+our @ObjectDependencies = (
+    'Kernel::System::Log',
+    'Kernel::System::Ticket',
+);
+
+=head1 NAME
+
+Kernel::System::ProcessManagement::TransitionAction::TicketTitleSet - A Module to set the title of a Ticket
+
+=head1 DESCRIPTION
+
+All TicketTitleSet functions.
+
+=head1 PUBLIC INTERFACE
+
+=head2 new()
+
+Don't use the constructor directly, use the ObjectManager instead:
+
+    my $TicketTitleSetObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::TransitionAction::TicketTitleSet');
+
+=cut
+
+sub new {
+    my ( $Type, %Param ) = @_;
+
+    # allocate new hash for object
+    my $Self = {};
+    bless( $Self, $Type );
+
+    return $Self;
+}
+
+=head2 Run()
+
+    Run Data
+
+    my $TicketTitleSetResult = $TicketTitleSetActionObject->Run(
+        UserID                   => 123,
+        Ticket                   => \%Ticket,   # required
+        ProcessEntityID          => 'P123',
+        ActivityEntityID         => 'A123',
+        TransitionEntityID       => 'T123',
+        TransitionActionEntityID => 'TA123',
+        Config                   => {
+            Title  => 'Some ticket title',
+            UserID => 123,                      # optional, to override the UserID from the logged user
+
+        }
+    );
+    Ticket contains the result of TicketGet including DynamicFields
+    Config is the Config Hash stored in a Process::TransitionAction's  Config key
+    Returns:
+
+    $TicketTitleSetResult = 1; # 0
+
+=cut
+
+sub Run {
+    my ( $Self, %Param ) = @_;
+
+    # define a common message to output in case of any error
+    my $CommonMessage = "Process: $Param{ProcessEntityID} Activity: $Param{ActivityEntityID}"
+        . " Transition: $Param{TransitionEntityID}"
+        . " TransitionAction: $Param{TransitionActionEntityID} - ";
+
+    # check for missing or wrong params
+    my $Success = $Self->_CheckParams(
+        %Param,
+        CommonMessage => $CommonMessage,
+    );
+    return if !$Success;
+
+    # override UserID if specified as a parameter in the TA config
+    $Param{UserID} = $Self->_OverrideUserID(%Param);
+
+    # use ticket attributes if needed
+    $Self->_ReplaceTicketAttributes(%Param);
+
+    # Check for required parameters in ConfigHash
+    if ( !defined $Param{Config}->{Title} ) {
+        $Kernel::OM->Get('Kernel::System::Log')->Log(
+            Priority => 'error',
+            Message  => $CommonMessage . "No Title configured!",
+        );
+        return;
+    }
+
+    $Success = 0;
+    if (
+        $Param{Config}->{Title} ne $Param{Ticket}->{Title}
+        )
+    {
+        $Success = $Kernel::OM->Get('Kernel::System::Ticket')->TicketTitleUpdate(
+            Title    => $Param{Config}->{Title},
+            TicketID => $Param{Ticket}->{TicketID},
+            UserID   => $Param{UserID},
+        );
+    }
+    else {
+
+        # data is the same as in ticket nothing to do
+        $Success = 1;
+    }
+
+    if ( !$Success ) {
+        $Kernel::OM->Get('Kernel::System::Log')->Log(
+            Priority => 'error',
+            Message  => $CommonMessage
+                . 'Ticket title could not be updated for Ticket: '
+                . $Param{Ticket}->{TicketID} . '!',
+        );
+        return;
+    }
+
+    return 1;
+}
+
+1;
+
+=head1 TERMS AND CONDITIONS
+
+This software is part of the OTRS project (L<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 L<https://www.gnu.org/licenses/gpl-3.0.txt>.
+
+=cut