OnCreateCheckCF - Revision history

Cris70: /* 4. Creating the Scrip */

2016-07-07T07:02:15Z

4. Creating the Scrip

← Older revision		Revision as of 03:02, 7 July 2016
Line 80:		Line 80:
	In the "Custom condition" box enter this code:		In the "Custom condition" box enter this code:

	<~~pre~~>		<syntaxhighlight lang="perl" line="1" >
	my $trans = $self-~~>~~TransactionObj;		my $trans = $self->TransactionObj;
	return 0 unless $trans-~~>~~Type eq "Create";		return 0 unless $trans->Type eq "Create";

			my $ticket = $self->TicketObj;

			my $Email_Rq = $ticket->RequestorAddresses;

	~~my $ticket = $self->TicketObj;~~		my $CustomFields = $ticket->QueueObj->TicketCustomFields();
			while (my $CustomField = $CustomFields->Next()) {
	~~my $Email_Rq = $ticket->RequestorAddresses;~~		my $nam = $CustomField->Name;
			my $typ = $CustomField->Type;
	my $CustomFields = $ticket-~~>~~QueueObj-~~>~~TicketCustomFields();		my $vad = $CustomField->Pattern;
	while (my $CustomField = $CustomFields-~~>~~Next()) {
	my $nam = $CustomField-~~>~~Name;		if ($vad == '(?#Mandatory)') {
	my $typ = $CustomField-~~>~~Type;		my $val = $ticket->FirstCustomFieldValue($nam);
	my $vad = $CustomField-~~>~~Pattern;		if ($val ne '') {
			next;
	if ($vad == '(?#Mandatory)') {		} else {
	my $val = $ticket-~~>~~FirstCustomFieldValue($nam);		$ticket->SetStatus("rejected");
	if ($val ne '') {
	next;
	} else {
	$ticket-~~>~~SetStatus("rejected");
	}
	}
	}		}
			}
			}

	return 1;		return 1;
	</~~pre~~>		</syntaxhighlight>

	----		----

Cris70: Corrected formatting for the new wiki

2016-06-20T07:08:42Z

Corrected formatting for the new wiki

← Older revision		Revision as of 03:08, 20 June 2016
Line 54:		Line 54:

	'''Content:'''		'''Content:'''
			Subject: Your ticket has been rejected due to a missing mandatory field.
	Subject: Your ticket has been rejected due to a missing mandatory field		You sent a ticket with a missing piece of information. Since the missing information
			is mandatory, the ticket has been rejected.
	You sent a ticket with a missing piece of information. Since the missing information		Please verify the informations you sent and then retry submitting the ticket.
	is mandatory, the ticket has been rejected.		If you feel your ticket has been rejected due to an error, please contact the administrator.

	Please verify the informations you sent and then retry submitting the ticket.
	If you feel your ticket has been rejected due to an error, please contact the administrator.

	Obviously this is only an example, you can write what you want. Just be sure to have the "Subject:" line as the very first line, and to leave a blank line after that.		Obviously this is only an example, you can write what you want. Just be sure to have the "Subject:" line as the very first line, and to leave a blank line after that.

Cris70 at 06:53, 20 June 2016

2016-06-20T06:53:28Z

← Older revision		Revision as of 02:53, 20 June 2016
Line 1:		Line 1:
	Contributed by [[User:Cris70]]		Contributed by [[User:Cris70\|Cris]]

	=== Overview ===		=== Overview ===

Cris70 at 06:52, 20 June 2016

2016-06-20T06:52:38Z

← Older revision		Revision as of 02:52, 20 June 2016
Line 1:		Line 1:
	Contributed by [~~http~~:~~//wiki.bestpractical.com/view/Cris Cris~~]		Contributed by [[User:Cris70]]

	=== Overview ===		=== Overview ===

Rabin: /* 4. Creating the Scrip */

2016-06-18T19:45:29Z

4. Creating the Scrip

← Older revision		Revision as of 15:45, 18 June 2016
Line 83:		Line 83:
	In the "Custom condition" box enter this code:		In the "Custom condition" box enter this code:

	<~~nowiki~~>my $trans = $self->TransactionObj;		<pre>
			my $trans = $self->TransactionObj;
	return 0 unless $trans->Type eq "Create";		return 0 unless $trans->Type eq "Create";

Line 107:		Line 108:

	return 1;		return 1;
	</~~nowiki~~>		</pre>

	----		----

Admin: 6 revisions imported

2016-04-06T20:15:49Z

6 revisions imported

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

66.31.34.88: Fixed bug noted in aug 2012 comment (untested)

2013-02-01T05:00:04Z

Fixed bug noted in aug 2012 comment (untested)

← Older revision		Revision as of 01:00, 1 February 2013
Line 84:		Line 84:

	<nowiki>my $trans = $self->TransactionObj;		<nowiki>my $trans = $self->TransactionObj;
	return 0 unless $trans->Type eq "Create";		return 0 unless $trans->Type eq "Create";

	my $ticket = $self->TicketObj;		my $ticket = $self->TicketObj;

	my $Email_Rq = $ticket->RequestorAddresses;		my $Email_Rq = $ticket->RequestorAddresses;

	my $CustomFields = $ticket->QueueObj->TicketCustomFields();		my $CustomFields = $ticket->QueueObj->TicketCustomFields();
	while (my $CustomField = $CustomFields->Next()) {		while (my $CustomField = $CustomFields->Next()) {
	my $nam = $CustomField->Name;		my $nam = $CustomField->Name;
	my $typ = $CustomField->Type;		my $typ = $CustomField->Type;
	my $vad = $CustomField->Pattern;		my $vad = $CustomField->Pattern;

	if ($vad == '(?#Mandatory)') {		if ($vad == '(?#Mandatory)') {
	my $val = $ticket->FirstCustomFieldValue($nam);		my $val = $ticket->FirstCustomFieldValue($nam);
	if ($val ne '') {		if ($val ne '') {
	~~return 0~~;		next;
	} else {		} else {
	$ticket->SetStatus("rejected");		$ticket->SetStatus("rejected");
	}		}
	}		}
	}		}

	return 1;		return 1;
	</nowiki>		</nowiki>

	----		----

Cris70: added thanks

2011-01-12T16:44:51Z

added thanks

← Older revision		Revision as of 12:44, 12 January 2011
Line 113:		Line 113:
	That's all folks!		That's all folks!

	~~===Possible typo===~~

	~~'''Note'''. Are you sure Cris it's:~~

	~~if ($vad =~~ '~~(?#Mandatory)~~'~~) {~~		'''P.S.''': Thanks to the user who spotted a typo in my scrip!

	~~and not rather:~~

	~~if ($vad ==~~ '~~(?#Mandatory)~~'~~) {~~
	~~Did you forget~~ a ~~char or you want to assign it?~~

Cris70: corrected typo

2011-01-12T16:41:55Z

corrected typo

← Older revision		Revision as of 12:41, 12 January 2011
Line 84:		Line 84:

	<nowiki>my $trans = $self->TransactionObj;		<nowiki>my $trans = $self->TransactionObj;
	return 0 unless $trans->Type eq "Create";		return 0 unless $trans->Type eq "Create";

	my $ticket = $self->TicketObj;		my $ticket = $self->TicketObj;

	my $Email_Rq = $ticket->RequestorAddresses;		my $Email_Rq = $ticket->RequestorAddresses;

	my $CustomFields = $ticket->QueueObj->TicketCustomFields();		my $CustomFields = $ticket->QueueObj->TicketCustomFields();
	while (my $CustomField = $CustomFields->Next()) {		while (my $CustomField = $CustomFields->Next()) {
	my $nam = $CustomField->Name;		my $nam = $CustomField->Name;
	my $typ = $CustomField->Type;		my $typ = $CustomField->Type;
	my $vad = $CustomField->Pattern;		my $vad = $CustomField->Pattern;

	if ($vad = '(?#Mandatory)') {		if ($vad == '(?#Mandatory)') {
	my $val = $ticket->FirstCustomFieldValue($nam);		my $val = $ticket->FirstCustomFieldValue($nam);
	if ($val ne '') {		if ($val ne '') {
	return 0;		return 0;
	} else {		} else {
	$ticket->SetStatus("rejected");		$ticket->SetStatus("rejected");
	}		}
	}		}
	}		}

	return 1;		return 1;
	</nowiki>		</nowiki>

	----		----

193.1.228.252: /* How to setup OnCreateCheckCF in RT3 */

2011-01-12T15:18:34Z

How to setup OnCreateCheckCF in RT3

New page

Contributed by [http://wiki.bestpractical.com/view/Cris Cris]

=== Overview ===

----

You may want to create a mandatory custom field, so that people will have to fill the value before being able to submit a new ticket. However, if you define a cf as mandatory, only people creating tickets from the web interface will be forced to fill the value. Those creating a new ticket using the mail gateway won't notice the presence of the mandatory cf, and the ticket will be created anyway.

My solution consists of three pieces:

* the [[ExtractCustomFieldValues]] extension, needed to be able assign a value to the cf through an email message
* an OnCreate scrip which checks if the cf is present, and eventually marks the ticket as rejected and notifies the requestor
* a custom template to use when notifying the requestor about a rejected ticket

This is implemented on RT 3.8.4.

=== How to setup OnCreateCheckCF in RT3 ===

----

===== 1. Custom field creation =====

First create a new custom field: Configuration -> Custom Fields -> Create

'''Name:''' <code>cfTest</code> ''(you can use the name you want)''

'''Description:''' <code>test mandatory custom field</code>

'''Type:''' <code>Fill in one text area</code> ''(you can use the type you want)''

'''Validation:''' (?#Mandatory).

Now "Save Changes".

On the "Applies To" page select the queues where you want to enable the custom field, then on the "Group Rights" give the "ModifyCustomField" right to the "Everyone" system group (if you want everyone to be able to create tickets on those queues).

'''Note''' that this is just a sample mandatory custom field. The scrip below is generic and will check for the presence of any and all <u>mandatory</u> ticket custom fields.

----

===== 2. Configure the ExtractCustomFieldValues =====

Follow the instructions in the [[ExtractCustomFieldValues]] section

----

===== 3. Creating the template =====

Go to Configuration -> Global -> Templates -> New

'''Name:''' <code>Error: no mandatory CF</code>

'''Description:''' <code>Inform the user that the ticket has been rejected due to a missing mandatory custom field</code>

'''Content:'''

Subject: Your ticket has been rejected due to a missing mandatory field

You sent a ticket with a missing piece of information. Since the missing information
is mandatory, the ticket has been rejected.

Please verify the informations you sent and then retry submitting the ticket.
If you feel your ticket has been rejected due to an error, please contact the administrator.

Obviously this is only an example, you can write what you want. Just be sure to have the "Subject:" line as the very first line, and to leave a blank line after that.

----

===== 4. Creating the Scrip =====

Go to Configuration -> Queues (or Global if you want this for all queues) -> (QueueName) -> Scrips -> New scrip

'''Description:''' OnCreateCheckCF

'''Condition:''' User Defined

'''Action:''' Autoreply To Requestors

'''Template:''' Global template: Error: no mandatory CF

'''Stage:''' TransactionBatch

In the "Custom condition" box enter this code:

<nowiki>my $trans = $self->TransactionObj;
return 0 unless $trans->Type eq "Create";

my $ticket = $self->TicketObj;

my $Email_Rq = $ticket->RequestorAddresses;

my $CustomFields = $ticket->QueueObj->TicketCustomFields();
while (my $CustomField = $CustomFields->Next()) {
my $nam = $CustomField->Name;
my $typ = $CustomField->Type;
my $vad = $CustomField->Pattern;

if ($vad = '(?#Mandatory)') {
my $val = $ticket->FirstCustomFieldValue($nam);
if ($val ne '') {
return 0;
} else {
$ticket->SetStatus("rejected");
}
}
}

return 1;
</nowiki>

----

That's all folks!

===Possible typo===

'''Note'''. Are you sure Cris it's:

if ($vad = '(?#Mandatory)') {

and not rather:

if ($vad == '(?#Mandatory)') {
Did you forget a char or you want to assign it?