Difference between revisions of "Make a Field Conditionally Required"

From SDU
Jump to: navigation, search
(→‎Step 1. Create the script)
 
(68 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
This article provides instructions for making a field conditionally required.
+
__NOTOC__
 +
[[Category:Customizations]]
 +
[[Category:r6]]
 +
[[Category:r11]]
 +
[[Category:Schema Change]]
 +
{{Global Header}}
 +
{{Global Announcement}}
  
−
In the steps that follow, the example code is used to ensure the Assignee is the only only able to close a ticket. Other examples are displayed at the bottom of this article.
+
== Overview ==
 +
This article provides instructions for making a field conditionally required. The example that follows makes a field conditionally required when a ticket is being closed. However, the concept of this customization could be expanded to make a field required only if the condition has been fulfilled.  
  
−
== Step 1. Create the script ==
+
== Procedures ==
−
The script is created as a .spl file and placed in the site/mods/majic directory.
+
=== Step 1. Create the script ===
 +
A script is created as an [[.spl file]] and placed in the [[$NX_ROOT]]/site/mods/majic directory. When the Service Desk service starts, the contents of the majic directory are processed and cached. You can use any naming scheme you like for your [[.spl file]], but it is recommended that the file be preceded with a 'z' for easy identification as a custom file (eg zMyCompany.spl, zcr_scripts.spl, zMyScripts.spl).
  
−
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->cr&#58;&#58;zmyscript&#40;...&#41; {<br>string zmsg; <br>if&#40;assignee.userid != cst.userid&#41; {<br>zmsg=format&#40;" Assignee must be the same as the logged in user in order to close %s", ref_num&#41;; <br>set_error&#40;1&#41;; <br>set_return_data&#40;zmsg&#41;; <br>return; <br>} <br>}<!--c2--></div><!--ec2-->
+
<source lang="javascript">// Use 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues
 +
cr::zmyscript(...) {
 +
string zmsg;
 +
// Enter an if statement, the string1 value should be replaced with the field you want required, for example "impact" for a change order
 +
if(is_null(string1)) {
 +
// Enter an alert message that appears when the if statement is fulfilled
 +
zmsg=format(" string1 is required in order to close this ticket");
 +
set_error(1);
 +
set_return_data(zmsg);
 +
return;
 +
}
 +
}</source>
  
 +
=== Step 2. Create the trigger ===
 +
This step is to create the trigger that will initiate the script. The methods used to implement the trigger vary based on the Service Desk release.
  
−
== Step 2. Create the trigger ==
+
''For r11.x releases'' triggers are created via the [[Schema Designer]] utility. Simply add the following code as a [[Site-Defined Trigger]] to the '''[[Call Req Table|cr (Request)]]''', '''[[Change Request Table|chg (Change Order)]]''', or '''[[Issue Table|iss (Issue)]]''' table.  
−
The trigger is responsible for "triggering" the script.
+
PRE_VALIDATE zmyscript() 111 FILTER(active==0);
  
−
r11.x triggers are created via the Schema Designer utility. Simply add a Site-Defined Trigger to the desired table.
+
''For older releases'' triggers are made by creating a [[.mod file]] and placing it in the [[$NX_ROOT]]/site/mods/majic directory. Name the [[.mod file|.mod]] anything you like, but it is recommended that it be preceded with a 'z'.
  
−
Example:
+
<source lang="javascript">// Use OBJECT cr for Requests, Incidents & Problems
−
PRE_VALIDATE zmyscript() 113 FILTER(active == 0);
+
// Use OBJECT chg for Change Orders
 +
// Use OBJECT iss for Issues
 +
OBJECT cr {
 +
  TRIGGERS {
 +
    PRE_VALIDATE zmyscript() 111 FILTER(active==0);
 +
  };
 +
};</source>
  
−
pre-r11.x triggers are made by creating a .mod file and placing it in the site/mods/majic directory.
+
=== Step 3. Publish the Schema changes ===
 +
The methods used to publish schema changes vary based on the Service Desk release.
  
−
Example:
+
''For r11.x releases'', follow these steps:
−
MODIFY cr PRE_VALIDATE zmyscript() 113 FILTER(active == 0);
+
#Save your Schema changes
 +
#Stop the Service Desk service
 +
#Run [[pdm_publish]] from a command line
 +
#Start the Service Desk service
  
−
== Step 3. Publish the Schema changes ==
+
''For older release'' recycle the Service Desk service.
−
 
+
−
r11.x
+
−
1. Save your Schema changes
+
−
2. Stop the Service Desk service
+
−
3. Run pdm_publish from a command line
+
−
4. Start the Service Desk service
+
−
 
+
−
pre-r11.x
+
−
Recycle the Service Desk service
+
−
 
+
−
 
+
−
Note: This logic can be used to greatly expand system functionality by ensuring that data gets collected when any number of conditions exist.
+
−
 
+
−
 
+
−
== Another Example ==
+
−
Root Cause required when a Request is closed
+
−
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->cr&#58;&#58;zmyscript&#40;...&#41; {<br>string zmsg; <br>if&#40;is_null&#40;rootcause&#41;&#41; {<br>zmsg=format&#40;"Root Cause is required to close Request %s",ref_num&#41;; <br>set_error&#40;1&#41;; <br>set_return_data&#40;zmsg&#41;; <br>return; <br>} <br>}<!--c2--></div><!--ec2-->
+
−
 
+
−
Trigger:
+
−
PRE_VALIDATE zmyscript() 113 FILTER(status == "CL");
+
−
 
+
−
 
+
−
== Tips ==
+
−
String statements together using &&
+
−
Example
+
−
(is_null(anyfield1) && is_null(anyfield2))
+
−
 
+
−
 
+
−
For not null add an !
+
−
Example
+
−
(!is_null(anyfield))
+

Latest revision as of 16:26, 4 June 2010

To make corrections or additions to this article, select the edit tab above.
To discuss or ask questions about this article, select the discussion tab above.

Overview

This article provides instructions for making a field conditionally required. The example that follows makes a field conditionally required when a ticket is being closed. However, the concept of this customization could be expanded to make a field required only if the condition has been fulfilled.

Procedures

Step 1. Create the script

A script is created as an .spl file and placed in the $NX_ROOT/site/mods/majic directory. When the Service Desk service starts, the contents of the majic directory are processed and cached. You can use any naming scheme you like for your .spl file, but it is recommended that the file be preceded with a 'z' for easy identification as a custom file (eg zMyCompany.spl, zcr_scripts.spl, zMyScripts.spl).

<source lang="javascript">// Use 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues cr::zmyscript(...) { string zmsg; // Enter an if statement, the string1 value should be replaced with the field you want required, for example "impact" for a change order if(is_null(string1)) { // Enter an alert message that appears when the if statement is fulfilled zmsg=format(" string1 is required in order to close this ticket"); set_error(1); set_return_data(zmsg); return; } }</source>

Step 2. Create the trigger

This step is to create the trigger that will initiate the script. The methods used to implement the trigger vary based on the Service Desk release.

For r11.x releases triggers are created via the Schema Designer utility. Simply add the following code as a Site-Defined Trigger to the cr (Request), chg (Change Order), or iss (Issue) table. 

PRE_VALIDATE zmyscript() 111 FILTER(active==0);

For older releases triggers are made by creating a .mod file and placing it in the $NX_ROOT/site/mods/majic directory. Name the .mod anything you like, but it is recommended that it be preceded with a 'z'.

<source lang="javascript">// Use OBJECT cr for Requests, Incidents & Problems // Use OBJECT chg for Change Orders // Use OBJECT iss for Issues OBJECT cr { 

 TRIGGERS {
   PRE_VALIDATE zmyscript() 111 FILTER(active==0);
 };

};</source>

Step 3. Publish the Schema changes

The methods used to publish schema changes vary based on the Service Desk release.

For r11.x releases, follow these steps:

  1. Save your Schema changes
  2. Stop the Service Desk service
  3. Run pdm_publish from a command line
  4. Start the Service Desk service

For older release recycle the Service Desk service.

Retrieved from "http://greggsmith.net/wiki/index.php?title=Make_a_Field_Conditionally_Required&oldid=4074"