CustomConditionSnippets - Revision history

Kincl: Fixing greater than and adding pre blocks

2016-08-15T17:50:24Z

Fixing greater than and adding pre blocks

Tharn: /* On Status Change to "resolved" */

2016-08-14T19:56:13Z

On Status Change to "resolved"

← Older revision		Revision as of 15:56, 14 August 2016
Line 56:		Line 56:

	=== On Status Change to "resolved" ===		=== On Status Change to "resolved" ===
			<pre>
	my $txn = $self->TransactionObj;		my $txn = $self->TransactionObj;
	my $type = $txn->Type;		my $type = $txn->Type;
Line 64:		Line 64:
	return 0 unless $txn->NewValue eq "resolved";		return 0 unless $txn->NewValue eq "resolved";
	return 1;		return 1;
			</pre>

	=== on Status Change from "new" to "open" ===		=== on Status Change from "new" to "open" ===

Admin: 8 revisions imported

2016-04-06T20:03:36Z

8 revisions imported

← Older revision		Revision as of 16:03, 6 April 2016
(No difference)

173.189.242.194: /* On Re-Assign */

2016-02-01T16:04:05Z

On Re-Assign

← Older revision		Revision as of 12:04, 1 February 2016
Line 152:		Line 152:
	return 1;		return 1;

	== Checks with acting user (actor)		=== Checks with acting user (actor) ===

	my $actor = $self->TransactionObj->CreatorObj;		my $actor = $self->TransactionObj->CreatorObj;

193.134.254.20: /* Checks with Custom Fields */

2013-07-15T12:56:32Z

Checks with Custom Fields

← Older revision		Revision as of 08:56, 15 July 2013
Line 209:		Line 209:

	<nowiki>		<nowiki>
	my $Ticket = $self->TicketObj;		my $Ticket = $self->TicketObj;

	return 0 unless $self->TicketObj->FirstCustomFieldValue('CustomFieldName') eq 'X';		return 0 unless $self->TicketObj->FirstCustomFieldValue('CustomFieldName') eq 'X';
	return 1;		return 1;
	</nowiki>		</nowiki>

	=== On CustomField change ===		=== On CustomField change ===
Line 256:		Line 256:
	$cf->Load( $txn->Field );		$cf->Load( $txn->Field );
	return 0 unless $cf->Name eq 'X';		return 0 unless $cf->Name eq 'X';

	return 0 unless $txn->NewValue eq 'A';		return 0 unless $txn->NewValue eq 'A';
	} else {		} else {
	return 0;		return 0;
	}		}
	return 1;		return 1;

			=== On Correspond, set Custom Field "X" to "0" ===

			return 1;

			my $ticket = $self->TicketObj;
			my $cf_obj = RT::CustomField->new($RT::SystemUser);
			my $cf_name = "X";
			my $cf_value = "0";

			$cf_obj->LoadByName( Name => $cf_name );
			$RT::Logger->debug( "Loaded \$cf_obj->Name = ". $cf_obj->Name() ."\n" );
			$ticket->AddCustomFieldValue( Field=>$cf_obj, Value=>$cf_value,
			RecordTransaction=>0 );

			return 1;

	== UserDefined2 (use with rt-crontool) ==		== UserDefined2 (use with rt-crontool) ==

151.88.22.9: fixed error in code on the 2nd line: "return if" replaced with "return unless"

2012-12-12T17:12:31Z

fixed error in code on the 2nd line: "return if" replaced with "return unless"

← Older revision		Revision as of 13:12, 12 December 2012
Line 40:		Line 40:

	return 0 unless $self->TransactionObj->Type eq "Correspond";		return 0 unless $self->TransactionObj->Type eq "Correspond";
	return 0 if $self->TicketObj->Owner == $RT::Nobody->id;		return 0 unless $self->TicketObj->Owner == $RT::Nobody->id;
	return 1;		return 1;

80.152.250.252: /* add your own conditions */

2012-05-15T08:40:15Z

add your own conditions

@@ Line 263: / Line 263: @@
    return 1;
 == add your own conditions ==
 ...

94.158.99.44 at 18:23, 8 February 2012

2012-02-08T18:23:30Z

@@ Line 19: / Line 19: @@
    <nowiki>
-   return 0 unless $self->TransactionObj->Type eq "Create";
+    return 0 unless $self->TransactionObj->Type eq "Create";
-   return 0 if $self-&gt;TicketObj-&gt;QueueObj-&gt;Name eq "xxx";
+    return 0 if $self-&gt;TicketObj-&gt;QueueObj-&gt;Name eq "xxx";
-   return 1;
+    return 1;
-   </nowiki>
+    </nowiki>
 === On Create with status resolved ===
@@ Line 204: / Line 204: @@
   return 1;
-== Custom Fields checks ==
+== Checks with Custom Fields ==
-=== When custom field value is X ===
+=== When current custom field value is X ===
    <nowiki>
-   my $Ticket = $self-&gt;TicketObj;
+    my $Ticket = $self-&gt;TicketObj;
-   return 0 unless $self->TicketObj-&gt;FirstCustomFieldValue('CustomFieldName') eq 'X';
+    return 0 unless $self->TicketObj-&gt;FirstCustomFieldValue('CustomFieldName') eq 'X';
-   return 1;
+    return 1;
-   </nowiki>
+  </nowiki>
 == add your own conditions ==
 ...

94.158.99.44 at 17:29, 8 February 2012

2012-02-08T17:29:42Z

New page

= Introduction =

This page introduce you with some code that can be used in [[Condition]]s and is part of [[CodeSnippets]] series of articles.

= Custom conditions specifics =

Read [[WriteCustomCondition]] to understand basics of writing conditions.

= Code Snippets =

Here is list of various custom conditions you can use.

== On Create and variants ==

return 0 unless $self->TransactionObj->Type eq "Create";
return 1;

=== On Create, but queue is not 'xxx' ===

<nowiki>
return 0 unless $self->TransactionObj->Type eq "Create";
return 0 if $self->TicketObj->QueueObj->Name eq "xxx";
return 1;
</nowiki>

=== On Create with status resolved ===

If you create [[Ticket]] with status resolved then standard RT condition OnResolve wouldn't trigger.

return 0 unless $self->TransactionObj->Type eq "Create";
return 0 unless $self->TicketObj->Status eq 'resolved';
return 1;

== On Correspond/Comment and variants ==

return 0 unless $self->TransactionObj->Type eq "Correspond";
return 1;

=== On Correspond to Unowned Ticket ===

return 0 unless $self->TransactionObj->Type eq "Correspond";
return 0 if $self->TicketObj->Owner == $RT::Nobody->id;
return 1;

Can be used in "On Correspond to Unowned Notify Admin Ccs With Admin Correspondence".

== On Status Change and variants ==

For historical reasons it's more correct to write this condition like this:

my $txn = $self->TransactionObj;
my $type = $txn->Type;
return 0 unless $type eq "Status"
|| ( $type eq 'Set' && $txn->Field eq 'Status');
return 1;

=== On Status Change to "resolved" ===

my $txn = $self->TransactionObj;
my $type = $txn->Type;
return 0 unless $type eq "Status"
|| ( $type eq 'Set' && $txn->Field eq 'Status');

return 0 unless $txn->NewValue eq "resolved";
return 1;

=== on Status Change from "new" to "open" ===

my $txn = $self->TransactionObj;
my $type = $txn->Type;
return 0 unless $type eq "Status"
|| ( $type eq 'Set' && $txn->Field eq 'Status');

return 0 unless $txn->OldValue eq "new";
return 0 unless $txn->NewValue eq "open";
return 1;

== On Queue Change ==

return 0 unless $self->TransactionObj->Type eq "Set";
return 0 unless $self->TransactionObj->Field eq "Queue";
return 1;

== On Owner Change and variants ==

return 0 unless $self->TransactionObj->Type eq "Set";
return 0 unless $self->TransactionObj->Field eq "Owner";
return 1;

=== On Owner Change from Nobody to Any ===

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 unless $txn->OldValue == $RT::Nobody->id;
return 1;

=== On Take ===

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 unless $txn->OldValue == $RT::Nobody->id;
return 0 unless $txn->NewValue == $txn->Creator;
return 1;

=== On Steal ===

See also [[OnStealEnhanced]]

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 if $txn->OldValue == $RT::Nobody->id;
return 0 unless $txn->NewValue == $txn->Creator;
return 1;

=== On Give ===

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 unless $txn->OldValue == $RT::Nobody->id;
return 0 if $txn->NewValue == $txn->Creator;
return 1;

=== On Give Up ===

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 unless $txn->OldValue == $txn->Creator;
return 0 unless $txn->NewValue == $RT::Nobody->id;
return 1;

=== On Assign ===

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 unless $txn->OldValue == $RT::Nobody->id;
return 0 if $txn->NewValue == $txn->Creator;
return 1;

=== On Re-Assign ===

my $txn = $self->TransactionObj;
return 0 unless $txn->Type eq "Set";
return 0 unless $txn->Field eq "Owner";
return 0 if $txn->OldValue == $txn->Creator;
return 0 if $txn->NewValue == $txn->Creator;
return 1;

== Checks with acting user (actor)

my $actor = $self->TransactionObj->CreatorObj;

=== On action by privileged ===

my $actor = $self->TransactionObj->CreatorObj;
return 1 if $actor->Privileged;
return 0;

=== On owner's action ===

my $actor = $self->TransactionObj->CreatorObj;
my $owner = $self->TicketObj->OwnerObj;
return 1 unless $actor->id == $owner->id;
return 0;

== Checks with watchers and groups ==

=== When particular email address is in requestors ===

return 1 if $self->TicketObj->IsWatcher(
Type => 'Requestor', Email => 'foo@bar.com'
);
return 0;

=== When actor is member of one or more particular groups ===

my @enforced_groups = ("Group 1","Group 2","etc");

my $actor = $self->TransactionObj->CreatorObj;

foreach my $gname (@enforced_groups) {
my $group = RT::Group->new( $self->CurrentUser );
$group->LoadUserDefinedGroup( $gname );
next unless $group->id;

return 1 if $group->HasMemberRecursively( $actor->id );
}
return 0;

=== Owner is not in the group ===

my $in_group = 'SupportManagers';

my $owner = $self->TicketObj->OwnerObj;
my $group = RT::Group->new( $self->CurrentUser );
$group->LoadUserDefinedGroup( $in_group );
return 0 if $group->HasMemberRecursively( $owner->id );

return 1;

== Custom Fields checks ==

=== When custom field value is X ===

<nowiki>
my $Ticket = $self->TicketObj;

return 0 unless $self->TicketObj->FirstCustomFieldValue('CustomFieldName') eq 'X';
return 1;
</nowiki>

== add your own conditions ==

...