Difference between revisions of "Automatically Set System Generated Activities to Internal"

From SDU
Jump to: navigation, search
(Step 1. Create the script)
m
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
[[Category:Change Orders]]
 
[[Category:Customizations]]
 
[[Category:Customizations]]
This article provides instructions for having system generated Activities set to ''Internal'' so it cannot be viewed by users of the Employee or Customer Interfaces.
+
[[Category:Incidents]]
 +
[[Category:Issues]]
 +
[[Category:Problems]]
 +
[[Category:r6]]
 +
[[Category:r11]]
 +
[[Category:Requests]]
 +
[[Category:Schema Changes]]
 +
{{Global Header}}
 +
{{Global Announcement}}
  
== Step 1. Create the script ==
+
== Overview ==
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).
+
This article provides instructions for having system generated [[Activities]] set to ''Internal'' so it cannot be viewed by users of the Employee or Customer Interfaces.
  
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->alg&#58;&#58;zmyscript&#40;...&#41; {<br> send_wait&#40;0, this, "call_attr", "internal", "set_val", "1", "SURE_SET"&#41;;<br> &nbsp;if &#40;msg_error&#40;&#41;&#41; { <br> &nbsp; logf&#40;ERROR, "error updating alg internal with 1&#58; &#39;%s&#39;", msg&#91;0&#93;&#41;; <br> &nbsp;}<br>}<!--c2--></div><!--ec2-->
+
== Procedures ==
 +
=== Step 1. Create the script ===
 +
{{Create Spell Script}}
  
''Note: The example script works for Requests, Incidents, and Problems. Change the 'alg' in the first line of the script to 'chgalg' for Change Orders or 'issalg' for Issues.''
+
<source lang="javascript">// Use 'alg' for Requests, Incidents & Problems, 'chgalg' for Changes, and 'issalg' for Issues
<br><br>
+
alg::zmyscript(...) {
 +
send_wait(0, this, "call_attr", "internal", "set_val", "1", "SURE_SET");
 +
if (msg_error()) {
 +
logf(ERROR, "error updating alg internal with 1: '%s'", msg[0]);
 +
}
 +
}</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.
+
''For r11.x releases'' triggers are created via the [[Schema Designer]] utility. Simply add the following code as a [[Site-Defined Trigger]] to the '''[[Act Log Table|alg (Request Activity Log)]]''', '''[[Change Act Log Table|chgalg (Change Order Activity Log)]]''', or '''[[Issue Act Log Table|issalg (Issue Activity Log)]]''' tables.
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->POST_VALIDATE zmyscript&#40;&#41; 100 FILTER &#40;type { -&#62; &#39;EVT&#39; } &#41;&#59;<!--c2--></div><!--ec2-->
+
POST_VALIDATE zmyscript() 111 FILTER(type{->'EVT'});
''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 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'.
 +
<source lang="javascript">// Use OBJECT alg for Requests, Incidents & Problems
 +
// Use OBJECT chgalg for Change Orders
 +
// Use OBJECT issalg for IssuesOBJECT alg {
 +
  TRIGGERS {
 +
    POST_VALIDATE zmyscript() 111 FILTER(type{->'EVT'});
 +
  };
 +
};</source>
  
<!--c1--><div class='codetop'>CODE</div><div class='codemain'><!--ec1-->MODIFY alg POST_VALIDATE zmyscript&#40;&#41; 100 FILTER &#40;type { -&#62; &#39;EVT&#39; } &#41;&#59;<!--c2--></div><!--ec2-->
+
=== Step 3. Publish the Schema changes ===
''Note: This code works for Requests, Incidents, and Problems. Change the 'alg' to 'chgalg' for Change Orders or 'issalg' for Issues.''
+
{{Publish Schema Change}}
<br><br>
+
 
+
== Step 3. Publish the Schema changes ==
+
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:
+
#Save your Schema changes
+
#Stop the Service Desk service
+
#Run pdm_publish from a command line
+
#Start the Service Desk service
+
 
+
<font color="blue">For older release</font> recycle the Service Desk service.
+
<br>
+

Latest revision as of 17:58, 13 August 2008

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 having system generated Activities set to Internal so it cannot be viewed by users of the Employee or Customer Interfaces.

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 'alg' for Requests, Incidents & Problems, 'chgalg' for Changes, and 'issalg' for Issues alg::zmyscript(...) { send_wait(0, this, "call_attr", "internal", "set_val", "1", "SURE_SET"); if (msg_error()) { logf(ERROR, "error updating alg internal with 1: '%s'", msg[0]); } }</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 alg (Request Activity Log), chgalg (Change Order Activity Log), or issalg (Issue Activity Log) tables.

POST_VALIDATE zmyscript() 111 FILTER(type{->'EVT'});

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 alg for Requests, Incidents & Problems // Use OBJECT chgalg for Change Orders // Use OBJECT issalg for IssuesOBJECT alg {

 TRIGGERS {
   POST_VALIDATE zmyscript() 111 FILTER(type{->'EVT'});
 };

};</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 (Applicable if you made changes via WSP)
  4. Start the Service Desk service

For older releases recycle the Service Desk service.