View source for OnCreateCheckCF

Contributed by [[User:Cris70|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 -&gt; Custom Fields -&gt; 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 -&gt; Global -&gt; Templates -&gt; 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 -&gt; Queues (or Global if you want this for all queues) -&gt; (QueueName) -&gt; Scrips -&gt; 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:

 <pre>
    my $trans = $self-&gt;TransactionObj;
    return 0 unless $trans-&gt;Type eq "Create";
    
    my $ticket = $self-&gt;TicketObj;
    
    my $Email_Rq = $ticket-&gt;RequestorAddresses;
    
    my $CustomFields = $ticket-&gt;QueueObj-&gt;TicketCustomFields();
    while (my $CustomField = $CustomFields-&gt;Next()) {
       my $nam = $CustomField-&gt;Name;
       my $typ = $CustomField-&gt;Type;
       my $vad = $CustomField-&gt;Pattern;
    
       if ($vad == '(?#Mandatory)') {
           my $val = $ticket-&gt;FirstCustomFieldValue($nam);
           if ($val ne '') {
               next;
           } else {
               $ticket-&gt;SetStatus("rejected");
           }
       }
    }
    
    return 1;
    </pre>

----

That's all folks!



'''P.S.''': Thanks to the user who spotted a typo in my scrip!