Difference between revisions of "Only Assignee can Close"

From SDU
Jump to: navigation, search
 
(27 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Customizations]]
 
[[Category:Customizations]]
This article provides instructions for implementing custom functionality that prevents anyone but the Assignee of a ticket from closing it.
+
{{Global Header}}
 +
{{Global Announcement}}
  
== Step 1. Create the script ==
+
== Overview ==
A script is created as an .spl file and placed in the 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).
+
This article provides instructions for implementing custom functionality that prevents anyone but the Assignee of a ticket from closing it.
  
<!--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>//Enter your alert message that appears when the if statement is fulfilled<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-->
+
== 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).
  
''Note: The example script works for Requests, Incidents, and Problems. Change the 'cr' in the first line of the script to 'chg' for Change Orders or 'iss' for Issues. Also, for Change Orders, change the 'ref_num' to 'chg_ref_num'.''
+
<source lang="javascript">// Use 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues
<br><br>
+
cr::zmyscript(...){
 +
string zmsg;
 +
// Use 'int' in place of 'uuid' in the line below if for pre-r11 releases
 +
uuid login_userid,asgn_userid;
 +
// Use 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues
 +
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
 +
login_userid = msg[0];
 +
asgn_userid = assignee.id;
 +
if(asgn_userid != login_userid) {
 +
//Enter your alert message that appears when the if statement is fulfilled
 +
zmsg=format(" Assignee must be the same as the logged in user in order to close %s %s", type.sym, ref_num);
 +
//zmsg=format(" Assignee must be the same as the logged in user in order to close Change Order %s", chg_ref_num);
 +
//zmsg=format(" Assignee must be the same as the logged in user in order to close Issue %s", ref_num);
 +
set_error(1);
 +
set_return_data(zmsg);
 +
return;
 +
}
 +
}</source>
  
== Step 2. Create the trigger ==
+
=== 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.  
 
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.  
  
<font color="blue">For r11.x releases</font> triggers are created via the Schema Designer utility. Simply add the following code as a Site-Defined Trigger to the desired table.
 
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->PRE_VALIDATE zmyscript&#40;&#41; 113 FILTER&#40;active == 0&#41;;<!--c2--></div><!--ec2-->
 
''Note: This code will work for all ticket types.''
 
  
<font color="blue">For older releases</font> triggers are made by creating a .mod file and placing it in the site/mods/majic directory. Name the .mod anything you like, but it is recommended that it be preceded with a 'z'.
+
''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.  
 +
POST_VALIDATE zmyscript() 111 FILTER(active==0);
  
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->MODIFY cr PRE_VALIDATE zmyscript&#40;&#41; 113 FILTER&#40;active == 0&#41;;<!--c2--></div><!--ec2-->
+
''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'.
''Note: This code works for Requests, Incidents, and Problems. Change the 'cr' to 'chg' for Change Orders or 'iss' for Issues.''
+
<source lang="javascript">// Use OBJECT cr for Requests, Incidents & Problems
<br><br>
+
// Use OBJECT chg for Change Orders
 +
// Use OBJECT iss for Issues
 +
OBJECT cr {
 +
  TRIGGERS {
 +
    POST_VALIDATE zmyscript() 111 FILTER(active==0);
 +
  };
 +
};</source>
  
== Step 3. Publish the Schema changes ==
+
=== Step 3. Publish the Schema changes ===
 
The methods used to publish schema changes vary based on the Service Desk release.
 
The methods used to publish schema changes vary based on the Service Desk release.
  
<font color="blue">For r11.x releases</font>, follow these steps:
+
''For r11.x releases'', follow these steps:
 
#Save your Schema changes
 
#Save your Schema changes
 
#Stop the Service Desk service
 
#Stop the Service Desk service
#Run pdm_publish from a command line
+
#Run [[pdm_publish]] from a command line
 
#Start the Service Desk service
 
#Start the Service Desk service
  
<font color="blue">For older release</font> recycle the Service Desk service.
+
''For older releases'' recycle the Service Desk service.
<br>
+

Latest revision as of 16:42, 26 February 2009

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 implementing custom functionality that prevents anyone but the Assignee of a ticket from closing it.

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; // Use 'int' in place of 'uuid' in the line below if for pre-r11 releases uuid login_userid,asgn_userid; // Use 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues send_wait(0, top_object(), "call_attr", "cr", "current_user_id"); login_userid = msg[0]; asgn_userid = assignee.id; if(asgn_userid != login_userid) { //Enter your alert message that appears when the if statement is fulfilled zmsg=format(" Assignee must be the same as the logged in user in order to close %s %s", type.sym, ref_num); //zmsg=format(" Assignee must be the same as the logged in user in order to close Change Order %s", chg_ref_num); //zmsg=format(" Assignee must be the same as the logged in user in order to close Issue %s", ref_num); 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.

POST_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 {
   POST_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 releases recycle the Service Desk service.