[Rt-commit] rt branch 5.0/action-clear-custom-field-values created. rt-5.0.3-220-g2f1cbbfc7d

BPS Git Server git at git.bestpractical.com
Tue Jan 3 22:02:22 UTC 2023


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rt".

The branch, 5.0/action-clear-custom-field-values has been created
        at  2f1cbbfc7d977f7ef149ba23a829f2684f206af8 (commit)

- Log -----------------------------------------------------------------
commit 2f1cbbfc7d977f7ef149ba23a829f2684f206af8
Author: Ronaldo Richieri <ronaldo at bestpractical.com>
Date:   Thu Dec 29 18:02:03 2022 -0300

    Add RT::Action::ClearCustomFieldValues ScripAction

diff --git a/etc/initialdata b/etc/initialdata
index 54b2d1a6d5..3e3a9f8561 100644
--- a/etc/initialdata
+++ b/etc/initialdata
@@ -125,6 +125,11 @@
        Description => 'Set the due date according to an agreement' , # loc
        ExecModule  => 'SLA_SetDue',
     },
+    { Name        => 'Clear the Values of a Custom Field',                               # loc
+      Description => 'Just an example. Use "Copy Action" to create one to your specific Custom Field.', # loc
+      ExecModule  => 'ClearCustomFieldValues',
+      Argument    => 'SomeCustomFieldNameOrId' 
+    },
 );
 
 @ScripConditions = (
diff --git a/etc/upgrade/5.0.4/content b/etc/upgrade/5.0.4/content
new file mode 100644
index 0000000000..a5126f6853
--- /dev/null
+++ b/etc/upgrade/5.0.4/content
@@ -0,0 +1,13 @@
+use warnings;
+use strict;
+
+our @ScripActions;
+
+ at ScripActions = (
+    { 
+        Name        => 'Clear the Values of a Custom Field',                               # loc
+        Description => 'Just an example. Use "Copy Action" to create one to your specific Custom Field.', # loc
+        ExecModule  => 'ClearCustomFieldValues',
+        Argument    => 'SomeCustomFieldNameOrId' 
+    },
+);
\ No newline at end of file
diff --git a/lib/RT/Action/ClearCustomFieldValues.pm b/lib/RT/Action/ClearCustomFieldValues.pm
new file mode 100644
index 0000000000..267e74e3e3
--- /dev/null
+++ b/lib/RT/Action/ClearCustomFieldValues.pm
@@ -0,0 +1,139 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2022 Best Practical Solutions, LLC
+#                                          <sales at bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+#
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
+
+=head1 NAME
+
+RT::Action::ClearCustomFieldValues - clears all the values of a custom field on a ticket.
+
+=head1 DESCRIPTION
+
+ClearCustomFieldValues is a ScripAction that will clear the values of a custom field on a ticket.
+
+Since it requires a Custom Field name or ID as an argument, you will need to create a specific Action
+with this ScripAction module and the desired Custom Field to be cleared.
+
+B<IMPORTANT>: For multiple values custom fields, this action will clear all the values
+
+=head1 USAGE
+
+For example, suppose you want to clear the values of a custom field called "AffectedLocations".
+
+The first step is to create a new Custom Action on Admin -> Global -> Actions -> Create.
+
+Here is an example of how to fill out the new Custom Action:
+
+    Name: over Clear AffectedLocations Custom Field 
+    Description: Clear AffectedLocations Custom Field
+    Action Module: ClearCustomFieldValues
+    Parameters to Pass: AffectedLocations
+
+B<P.S.>: On "Parameters to Pass", you can inform the name or the custom field ID.
+
+Finally, create a new Scrip using your Custom Action.
+
+=cut
+
+package RT::Action::ClearCustomFieldValues;
+use base 'RT::Action';
+
+use strict;
+use warnings;
+
+sub Describe  {
+    my $self = shift;
+    return (ref $self . " will clear the value of a custom field, provided as the Argument.");
+}
+
+
+sub Prepare  {
+    my $self = shift;
+    my $ticket = $self->TicketObj;
+
+    # Check if custom field identifier is provided
+    unless ( $self->Argument ) {
+        RT->Logger->error("No custom field identifier provided. Skipping...");
+        return 0;
+    }
+
+    # Check if custom field is available on this queue
+    my $cf = $ticket->LoadCustomFieldByIdentifier($self->Argument);
+    if ( !$cf->Id ) {
+        RT->Logger->debug("$self->Argument custom field is not available on this queue. Skipping...");
+        return 0;
+    }
+
+    return 1;
+}
+
+sub Commit {
+    my $self = shift;
+
+    # Get the current value of the custom field
+    my $cfvaluesobj = $self->TicketObj->CustomFieldValues($self->Argument);
+
+    unless ( $cfvaluesobj->Count ) {
+        RT->Logger->debug("No value for ".$self->Argument." custom field. Skipping...");
+        return 0;
+    }
+
+    # For each value, delete it
+    my @cfvalues = @{$cfvaluesobj->ItemsArrayRef};
+    foreach my $cfvalue (@cfvalues) {
+        my ($ret, $msg) = 
+            $self->TicketObj->DeleteCustomFieldValue(Field => $self->Argument, Value => $cfvalue->Content);
+        unless ($ret) {
+            RT->Logger->error($msg);
+        }
+    }
+
+    return 1;
+}
+
+RT::Base->_ImportOverlays();
+
+1;

-----------------------------------------------------------------------


hooks/post-receive
-- 
rt


More information about the rt-commit mailing list