WriteCustomCondition - Revision history

Anwe: /* Basic */

2016-07-25T12:54:48Z

Basic

← Older revision		Revision as of 08:54, 25 July 2016
Line 12:		Line 12:

	Major objects accessors are:		Major objects accessors are:
			<pre>
	$self->TransactionObj # returns the current transaction object		$self->TransactionObj # returns the current transaction object
	$self->TicketObj # returns the current ticket object		$self->TicketObj # returns the current ticket object
	$self->TemplateObj # returns the current template object		$self->TemplateObj # returns the current template object
			</pre>

	== Return value ==		== Return value ==

Anwe: /* Return value */

2016-07-25T12:54:31Z

Return value

← Older revision		Revision as of 08:54, 25 July 2016
Line 21:		Line 21:
	Whatever the test you do in your condition, you just have to return true value (like 1) on success or false (like 0 or undef) to abort the scrip action. Below a very simple condition that you can copy to the RT web interface if you choose <code>User Defined</code> condition when you create a new scrip condition:		Whatever the test you do in your condition, you just have to return true value (like 1) on success or false (like 0 or undef) to abort the scrip action. Below a very simple condition that you can copy to the RT web interface if you choose <code>User Defined</code> condition when you create a new scrip condition:

	<~~nowiki~~># get ticket object		<pre>
			# get ticket object
	my $ticket = $self->TicketObj;		my $ticket = $self->TicketObj;
	# don't do anything if ticket is resolved		# don't do anything if ticket is resolved
Line 27:		Line 28:
	# otherwise run scrip action		# otherwise run scrip action
	return 1;		return 1;
	</~~nowiki~~>		</pre>

	== Transaction ==		== Transaction ==

Admin: 5 revisions imported

2016-04-06T20:39:47Z

5 revisions imported

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

89.190.50.68: /* Transaction */

2013-03-01T10:03:53Z

Transaction

← Older revision		Revision as of 06:03, 1 March 2013
Line 33:		Line 33:
	Transaction object is most used object in conditions as it describes what's happened with the ticket just a few ticks ago.		Transaction object is most used object in conditions as it describes what's happened with the ticket just a few ticks ago.

	Most important properties of the transaction object are <code>Type</code> and <code>Field</code>.		Most important properties of the transaction object are <code>Type</code> and <code>Field</code>. More on [[Transaction]].

	More on [[Transaction]].

	== Another way to add conditions to RT ==		== Another way to add conditions to RT ==

89.190.50.68: /* Transaction */

2013-03-01T10:03:35Z

Transaction

← Older revision		Revision as of 06:03, 1 March 2013
Line 34:		Line 34:

	Most important properties of the transaction object are <code>Type</code> and <code>Field</code>.		Most important properties of the transaction object are <code>Type</code> and <code>Field</code>.

			More on [[Transaction]].

	== Another way to add conditions to RT ==		== Another way to add conditions to RT ==

216.16.247.154: /* Transaction */

2012-11-14T21:25:43Z

Transaction

New page

[[Documentation]] > [[WriteCustomCondition]]

= How to write custom condition code =

== Introduction ==

[[Scrip]]s' condition is a code that checks if that current transaction/ticket match some condition(s) and says to RT to run or skip scrip action.

== Basic ==

When you write a custom condition you have access to the same objects as scrip action has, so its worth it to read basics section of [[WriteCustomAction]] article.

Major objects accessors are:

$self->TransactionObj # returns the current transaction object
$self->TicketObj # returns the current ticket object
$self->TemplateObj # returns the current template object

== Return value ==

Whatever the test you do in your condition, you just have to return true value (like 1) on success or false (like 0 or undef) to abort the scrip action. Below a very simple condition that you can copy to the RT web interface if you choose <code>User Defined</code> condition when you create a new scrip condition:

<nowiki># get ticket object
my $ticket = $self->TicketObj;
# don't do anything if ticket is resolved
return 0 if $ticket->Status eq 'resolved';
# otherwise run scrip action
return 1;
</nowiki>

== Transaction ==

Transaction object is most used object in conditions as it describes what's happened with the ticket just a few ticks ago.

Most important properties of the transaction object are <code>Type</code> and <code>Field</code>.

== Another way to add conditions to RT ==

See [[NotResolved]] for another way of adding Conditions to RT

== Further readings ==

[[CustomConditionSnippets]], [[WriteCustomAction]], [[ScripAction]]