Difference between revisions of "Conditionally Attach an Event"

From SDU
Jump to: navigation, search
m (Step 2. Create the trigger)
m
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
[[Category:Customizations]]
 +
[[Category:r6]]
 +
[[Category:r11]]
 +
[[Category:Schema Changes]]
 +
{{Global Header}}
 +
{{Global Announcement}}
 +
 +
== Overview ==
 
This article provides instructions for having an event conditionally attached to a ticket.
 
This article provides instructions for having an event conditionally attached to a ticket.
  
== Step 1. Create the script ==
+
== Procedures ==
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).
+
=== Step 1. Create the script ===
 +
{{Create Spell Script}}
  
<source lang="javascript">// User 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues
+
<source lang="javascript">// Use 'cr' for Requests, Incidents & Problems, 'chg' for Changes, and 'iss' for Issues
 
cr::zmyscript(...){
 
cr::zmyscript(...){
 
object group_leader;
 
object group_leader;
Line 29: Line 39:
 
The trigger that will be created in step 2 is the first level filtering. If you need further filtering then utilize an if statement in the [[spel code]] above.
 
The trigger that will be created in step 2 is the first level filtering. If you need further filtering then utilize an if statement in the [[spel code]] above.
  
== 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.  In the examples to follow, the trigger is designed to fire if the Status is being changed to 'Resolved'. Use whatever filter you like for attaching your [[Events and Macros|Event]].
 
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.  In the examples to follow, the trigger is designed to fire if the Status is being changed to 'Resolved'. Use whatever filter you like for attaching your [[Events and Macros|Event]].
 
  
 
''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.
 
''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(status{->'RE'});
 
  POST_VALIDATE zmyscript() 111 FILTER(status{->'RE'});
 
  
 
''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'.
 
''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'.
Line 48: Line 56:
 
};</source>
 
};</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.
+
{{Publish Schema Change}}
  
''For r11.x releases'', follow these steps:
+
== See Also ==
#Save your Schema changes
+
[[Automatically Remove Attached Events]]
#Stop the Service Desk service
+
#Run [[pdm_publish]] from a command line
+
#Start the Service Desk service
+
 
+
''For older release'' recycle the Service Desk service.
+
 
+
 
+
 
+
 
+
 
+
----
+
<div align='center'><font color="green">To make corrections or additions to this article, select the ''edit'' tab above.<br>
+
To discuss or ask questions about this article, select the ''discussion'' tab above.</font></div>
+
 
+
[[Category:Customizations]]
+

Latest revision as of 22:21, 3 December 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 an event conditionally attached to a ticket.

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(...){ object group_leader; object attached_events_table_record; send_wait(0, top_object(), "get_co_group"); if (msg_error()) { logf(ERROR, "%s - %s", ref_num, msg[0]); } group_leader = msg[0]; send_wait( 0, top_object(), "call_attr", "atev", "get_new_dob", NULL, NULL, group_leader); if (msg_error()) { logf(ERROR, "%s - %s", ref_num, msg[0]); } attached_events_table_record = msg[0]; attached_events_table_record.obj_id = persistent_id; // Enter the persid of the event attached_events_table_record.event_tmpl = "evt:400001"; send_wait(0, group_leader, "checkin"); if (msg_error()) { logf(ERROR, "%s - %s", ref_num, msg[0]); } }</source>

The trigger that will be created in step 2 is the first level filtering. If you need further filtering then utilize an if statement in the spel code above.

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. In the examples to follow, the trigger is designed to fire if the Status is being changed to 'Resolved'. Use whatever filter you like for attaching your Event.

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(status{->'RE'});

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(status{->'RE'});
 };

};</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.

See Also

Automatically Remove Attached Events