SDU - User contributions [en]

Attrs by index

2012-03-16T14:11:41Z

Kowy:

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method can be used to fetch attributes from a recordset just returned from [[Send_WaitCall_attrSync_fetch|sync_fetch]] and it should be faster then [[dob_by_index|dob_by_index]] method, because it doesn't need to create full dob in memory, but only specified attributes. It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object recordset, "attrs_by_index", int start_index, int end_index, "DEFAULT", int attrs_num [, var attrs])
</source>

* ''timeout'' - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* ''recordset'' - object returned from [[Send_WaitCall_attrSync_fetch|sync_fetch]] method
* ''start_index'' - from which index do you want to iterate? Must by between 0 and item_count-1
* ''end_index'' - to which index do you want to iterate? Must by between 0 and item_count-1
* ''attrs_num'' - number of following attributes
* ''attributes'' - each attribute of fetched object you want to return should be passed its name as a string here

== Results ==
On success the resulted list is filled into a global array '''msg''' as follows:
* msg[0] - SD system attribute used for enumeration (NEXT, LAST or EOF can be here)
* msg[1] - item Persistent ID
* msg[2] - empty?
* msg[3] - index in the recordset
* msg[4] - number of returned attributes (should be same as attrs_num)
* msg[5] - value of the first asked attribute
* msg[6] - value of the second asked attribute
* ...

Send wait

2012-03-01T15:21:57Z

Kowy: /* Available methods */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is the most tricky function and it is the main reason of difficulty of reading [[Spel_Reference_Guide|SPELL code]]. It is used for calling methods on objects. On every SD object (ie. cr, chg, alg...) are defined methods and using ''send_wait'' function you can call them. Definitions of some of them are in *.maj files in [[$NX_ROOT]]/bopcfg/majic folder.

== Usage ==
void send_wait (int timeout, object top_object, string method, [ var parameters… ])

* timeout - how long (in seconds) should the method wait for finishing the method (0 means infinite). A timeout mean time after which the function is considering as failure, returning to caller with error and no result. Nearly every time the 0 is used.
* top_object - root object for the method (on which the method is called)
* method - name of the called method
* parameters - variable number of parameters based on the called method

== Results ==
Function doesn't return value, but methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called method.

== Available methods ==
{| width="100%"
|-
! colspan=3|'''Defined on current (TOP) object'''
|-
|colspan=3|These methods are defined on all objects (maybe)
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[attrs_by_index|attrs_by_index]]
*[[Send_WaitCall_Attr|call_attr]]
| width="33%" align="left" style="vertical-align:top;" |
*[[get_attr_vals]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitGet_Co_group|get_co_group]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CR object'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitAuto_assign|auto_assign]]
*[[Send_WaitChange_status|change_status]]
*[[Send_WaitClose_call_request|close_call_request]]
*[[Send_WaitCopy_cr|copy_cr]]
*[[Send_WaitCopy_cr_site|copy_cr_site]]
*[[Send_WaitCob_mark_delete|dob_mark_delete]]
*[[Send_WaitCo_expand|do_expand]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitEscalate|escalate]]
*[[Send_WaitIinit_activity|init_activity]]
*[[Send_WaitInit_call_request|init_call_request]]
*[[Send_WaitLog_callback|log_callback]]
*[[Send_WaitLog_comment|log_comment]]
*[[Send_WaitLog_comment_no_checkout|log_comment_no_checkout]]
*[[Send_WaitLog_event|log_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitLog_research|log_research]]
*[[Send_WaitMake_from_template|make_from_template]]
*[[Send_WaitMake_from_template_site|make_from_template_site]]
*[[Send_WaitManual_notify|manual_notify]]
*[[Send_WaitReopen_call_request|reopen_call_request]]
*[[Send_WaitSend_api_msg|send_api_msg]]
*[[Send_WaitTransfer|transfer]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CHG object'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitAccumulate|accumulate]]
*[[Send_WaitAccumulate_change|accumulate_change]]
*[[Send_WaitAccumulate_workflows|accumulate_workflows]]
*[[Send_WaitAdd_assets|add_assets]]
*[[Send_WaitAdd_auditlog|add_auditlog]]
*[[Send_WaitAuto_assign|auto_assign]]
*[[Send_WaitChange_status|change_status]]
*[[Send_WaitClose_change_descedents|close_change_descendents]]
*[[Send_WaitClose_change_request|close_change_request]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCopy_chg|copy_chg]]
*[[Send_WaitCopy_chg_site|copy_chg_site]]
*[[Send_WaitDo_expand|do_expand]]
*[[Send_WaitDob_mark_delete|dob_mark_delete]]
*[[Send_WaitEscalate|escalate]]
*[[Send_WaitFast_track|fast_track]]
*[[Send_WaitImpact_analysis|impact_analysis]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitInit_activity|init_activity]]
*[[Send_WaitInit_change_request|init_change_request]]
*[[Send_WaitLog_event|log_event]]
*[[Send_WaitMake_from_template|make_from_template ]]
*[[Send_WaitMake_from_template_site|make_from_template_site ]]
*[[Send_WaitManual_notify|manual_notify]]
*[[Send_WaitOk_close_descedents|ok_close_descendents]]
*[[Send_WaitRemove_all_assets|remove_all_assets]]
*[[Send_WaitTransfer|transfer]]
|-
|}

== Examples ==

Send WaitCall Attr

2012-03-01T15:20:18Z

Kowy: Undo revision 4528 by Kowy (Talk)

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on TOP object). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object attributes or on other factories. So we can distinguish between usage of this method on '''current object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string method_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action/method - name of the called action/method
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available method/actions ==
=== Defined on Object attributes ===
{| width="100%"
|-
! colspan=3|'''Object attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[get_dob Spell method|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[get_val Spell method|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[set_val Spell method|set_val]]
|-
|}

=== Defined on factories ===
{| width="100%"
|-
! colspan=3|'''Defined for all factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[dob_attr_type_info|dob_attr_type_info]]
*[[dob_by_persid|dob_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[get_domset]]
*[[get_new_dob]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNew_attached_event|new_attached_event]]
*[[Send_WaitCall_attrSync_fetch|sync_fetch]]
*[[val_by_key]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CNT factory'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[Send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[cnt.get_members_to_notify_by_persid|get_members_to_notify_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNotify_list|notify_list]]

|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Attrs by index

2012-03-01T15:17:29Z

Kowy: attrs_by_index

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method can be used to fetch attributes from a recordset just returned from [[Send_WaitCall_attrSync_fetch|sync_fetch]] and it should be faster then [[dob_by_index|dob_by_index]] method, because it doesn't need to create full dob in memory, but only specified attributes. It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object recordset, "attrs_by_index", int start_index, int end_index, "DEFAULT", int attrs_num [, var attrs])
</source>

* ''timeout'' - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* ''recordset'' - object returned from [[Send_WaitCall_attrSync_fetch|sync_fetch]] method
* ''start_index'' - from which index do you want to iterate? Must by between 0 and item_count-1
* ''end_index'' - to which index do you want to iterate? Must by between 0 and item_count-1
* ''attrs_num'' - number of following attributes
* ''attributes'' - each attribute of fetched object you want to return should be passed its name as a string here

== Results ==
On success the resulted list is filled into a global array '''msg''' as follows:
* msg[0] - SD system attribute used for enumeration (NEXT or EOF can be here)
* msg[1] - item Persistent ID
* msg[2] - empty?
* msg[3] - index in the recordset
* msg[4] - number of returned attributes (should be same as attrs_num)
* msg[5] - value of the first asked attribute
* msg[6] - value of the second asked attribute
* ...

Send WaitCall Attr

2012-03-01T14:34:04Z

Kowy: /* Defined on factories */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on TOP object). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object attributes or on other factories. So we can distinguish between usage of this method on '''current object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string method_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action/method - name of the called action/method
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available method/actions ==
=== Defined on Object attributes ===
{| width="100%"
|-
! colspan=3|'''Object attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[get_dob Spell method|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[get_val Spell method|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[set_val Spell method|set_val]]
|-
|}

=== Defined on factories ===
{| width="100%"
|-
! colspan=3|'''Defined for all factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[attrs_by_index|attrs_by_index]]
*[[Send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[dob_attr_type_info|dob_attr_type_info]]

| width="33%" align="left" style="vertical-align:top;" |
*[[dob_by_persid|dob_by_persid]]
*[[get_domset]]
*[[get_new_dob]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNew_attached_event|new_attached_event]]
*[[Send_WaitCall_attrSync_fetch|sync_fetch]]
*[[val_by_key]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CNT factory'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[Send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[cnt.get_members_to_notify_by_persid|get_members_to_notify_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNotify_list|notify_list]]

|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Dob attr type info

2011-10-25T13:34:45Z

Kowy: /* Type = LREL */

__NOTOC__
[[Category:Customizations]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method metadata information about one attribute on a factory. It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "dob_attr_type_info", string attribute_name)
</source>

* ''timeout'' - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* ''top_object'' - root object for the method (on which the method is called)
* ''factory_name'' - a factory containing the attribute (could be anything like pcat, cnt, cr, alg, ...)
* ''attr_name'' - a name of an attribute that we are looking for

== Results ==
On success the resulted list is filled into a global array '''msg'''. Content of the array depends on an attribute type:
==== Type = VALUE ====
* msg[0] = attribute name
* msg[1] = "VALUE"
* msg[2] = exact attribute datatype
** 0 = INTEGER
** 1 = DOUBLE
** 2 = STRING
** 6 = LOCAL_TIME
** 7 = DATE
** 8 = DURATION
** 9 = UUID
* msg[3] = string length in characters if msg[2] == 2
* msg[4] = Private/Public
* msg[5] = Required/Non-Required
* msg[6] = display name
* msg[7] = UI_INFO
==== Type = SREL ====
* msg[0] = attribute name
* msg[1] = "SREL"
* msg[2] = foreign factory name
* msg[3] = relation attribute of a foreign factory
* msg[4] = Private/Public
* msg[5] = Required/Non-Required
* msg[6] = display name
* msg[7] = ???
* msg[8] = UI_INFO
==== Type = BREL/QREL ====
* msg[0] = attribute name
* msg[1] = "QREL"
* msg[2] = foreign factory name
* msg[3] = WHERE query for QREL relations
* msg[4] = list of attributes used as parameters to WHERE query in msg[3]
* msg[5] = DOMSET name
* msg[6] = sorting definition
* msg[7] = list columns
* msg[8] = attribute name
* msg[9] = foreign attribute name for BREL relations
* msg[10] = UI_INFO
==== Type = LREL ====
* msg[0] = attribute name
* msg[1] = "LREL"
* msg[2] = name of intermediate relation factory (table)
* msg[3] = factory handler?
* msg[4] = attribute name
* msg[5] = UI_INFO

== Examples ==
<source lang="javascript">
int i, num_args;
send_wait( 0, top_object(), "call_attr", "cnt", "dob_attr_type_info", "last_name");
if ( msg_error()) {
printf("Error: Can't get attributes info: %s\n", msg[0]);
type = "VALUE";
}
num_args = msg_length();
logf(SIGNIFICANT, "num_args = %s", num_args);
for (i=0; i<num_args; i++)
logf(SIGNIFICANT, "msg[%s] = %s", i, msg[i]);
</source>

Dob attr type info

2011-10-21T14:17:16Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method metadata information about one attribute...

__NOTOC__
[[Category:Customizations]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method metadata information about one attribute on a factory. It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "dob_attr_type_info", string attribute_name)
</source>

* ''timeout'' - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* ''top_object'' - root object for the method (on which the method is called)
* ''factory_name'' - a factory containing the attribute (could be anything like pcat, cnt, cr, alg, ...)
* ''attr_name'' - a name of an attribute that we are looking for

== Results ==
On success the resulted list is filled into a global array '''msg'''. Content of the array depends on an attribute type:
==== Type = VALUE ====
* msg[0] = attribute name
* msg[1] = "VALUE"
* msg[2] = exact attribute datatype
** 0 = INTEGER
** 1 = DOUBLE
** 2 = STRING
** 6 = LOCAL_TIME
** 7 = DATE
** 8 = DURATION
** 9 = UUID
* msg[3] = string length in characters if msg[2] == 2
* msg[4] = Private/Public
* msg[5] = Required/Non-Required
* msg[6] = display name
* msg[7] = UI_INFO
==== Type = SREL ====
* msg[0] = attribute name
* msg[1] = "SREL"
* msg[2] = foreign factory name
* msg[3] = relation attribute of a foreign factory
* msg[4] = Private/Public
* msg[5] = Required/Non-Required
* msg[6] = display name
* msg[7] = ???
* msg[8] = UI_INFO
==== Type = BREL/QREL ====
* msg[0] = attribute name
* msg[1] = "QREL"
* msg[2] = foreign factory name
* msg[3] = WHERE query for QREL relations
* msg[4] = list of attributes used as parameters to WHERE query in msg[3]
* msg[5] = DOMSET name
* msg[6] = sorting definition
* msg[7] = list columns
* msg[8] = attribute name
* msg[9] = foreign attribute name for BREL relations
* msg[10] = UI_INFO
==== Type = LREL ====
* msg[0] = attribute name
* msg[1] = "QREL"
* msg[2] = name of intermediate relation factory (table)
* msg[3] = factory handler?
* msg[4] = attribute name
* msg[5] = UI_INFO

== Examples ==
<source lang="javascript">
int i, num_args;
send_wait( 0, top_object(), "call_attr", "cnt", "dob_attr_type_info", "last_name");
if ( msg_error()) {
printf("Error: Can't get attributes info: %s\n", msg[0]);
type = "VALUE";
}
num_args = msg_length();
logf(SIGNIFICANT, "num_args = %s", num_args);
for (i=0; i<num_args; i++)
logf(SIGNIFICANT, "msg[%s] = %s", i, msg[i]);
</source>

Send WaitCall Attr

2011-10-21T13:44:50Z

Kowy:

Cnt.get members to notify by persid

2011-07-19T14:35:07Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method gets a list of members ...

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method gets a list of members with Notify flag set ON for specified group .

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] (or [[send]]) using [[Send_WaitCall_Attr|call_attr]] action.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", "cnt", "get_members_to_notify_by_persid", contact_persid)
</source>

* timeout - how long (in seconds) should the method wait for finishing the method (0 means infinite [no timeout] and is generally the value used)
* top_object - root object for the method (on which the method is called)
* contact_persid - persistent ID of a group for which members you are looking for

== Results ==
success or failure is tested with msg_error() (boolean function)

On success the resulted list is filled into a global array '''msg''' as follows:
* msg[0] - the number of assigned groups
* msg[1] - one string with a list of member persistent IDs separated by spaces (" ")

On failure
* msg[0] - failure reason

== Examples ==
<source lang="javascript">
int i;
send_wait(0, top_object(), "call_attr", "cnt", "get_members_to_notify_by_persid", "cnt:776B094702EABB4B87F04A139E72D44B");
if( msg_error()) {
logf (ERROR, "failure in send_wait ..... .Reason: %s",msg[0]);
} else {
string member_persids[msg[0]];
split(member_persids, msg[1], " ");
for (i=0;i<msg[0];i++) {
logf (SIGNIFICANT, "Notify %s", member_persids[i]);
}
}
</source>
<source lang="javascript">
string notify_list;
send_wait(0, top_object(), "call_attr", "cnt", "get_members_to_notify_by_persid", msg_target);
if (msg_error()) {
logf(ERROR, "%s: Error in get_members_to_notify_by_persid(%s)", method, msg_target);
return 1;
} else {
notify_list = msg[1] + " " + msg_target;
}

logf(TRACE, "%s: Going to notify these users: %s", method, notify_list);
send_wait(0, top_object(), "call_attr", "cnt", "notify_list", notify_list, msg_level, msg_title, msg_body, "" /* msg_ack */,
tran_pt, ticket, is_internal, 0 /* cmth_override */);
</source>

Send WaitCall Attr

2011-07-19T12:50:29Z

Kowy: /* Usage */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on TOP object). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object attributes or on other factories. So we can distinguish between usage of this method on '''current object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string method_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action/method - name of the called action/method
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available method/actions ==
=== Defined on Object attributes ===
{| width="100%"
|-
! colspan=3|'''Object attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[get_dob Spell method|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[get_val Spell method|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[set_val Spell method|set_val]]
|-
|}

=== Defined on factories ===
{| width="100%"
|-
! colspan=3|'''Defined for all factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[dob_by_persid|dob_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[get_domset]]
*[[get_new_dob]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNew_attached_event|new_attached_event]]
*[[Send_WaitCall_attrSync_fetch|sync_fetch]]
*[[val_by_key]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CNT factory'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[Send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[cnt.get_members_to_notify_by_persid|get_members_to_notify_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNotify_list|notify_list]]

|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Send WaitCall Attr

2011-07-19T12:48:25Z

Kowy: /* Available actions */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on TOP object). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object attributes or on other factories. So we can distinguish between usage of this method on '''current object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available method/actions ==
=== Defined on Object attributes ===
{| width="100%"
|-
! colspan=3|'''Object attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[get_dob Spell method|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[get_val Spell method|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[set_val Spell method|set_val]]
|-
|}

=== Defined on factories ===
{| width="100%"
|-
! colspan=3|'''Defined for all factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[dob_by_persid|dob_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[get_domset]]
*[[get_new_dob]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNew_attached_event|new_attached_event]]
*[[Send_WaitCall_attrSync_fetch|sync_fetch]]
*[[val_by_key]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CNT factory'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[Send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[cnt.get_members_to_notify_by_persid|get_members_to_notify_by_persid]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_attrNotify_list|notify_list]]

|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Send wait

2011-07-19T12:46:29Z

Kowy: /* Available methods */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is the most tricky function and it is the main reason of difficulty of reading [[Spel_Reference_Guide|SPELL code]]. It is used for calling methods on objects. On every SD object (ie. cr, chg, alg...) are defined methods and using ''send_wait'' function you can call them. Definitions of some of them are in *.maj files in [[$NX_ROOT]]/bopcfg/majic folder.

== Usage ==
void send_wait (int timeout, object top_object, string method, [ var parameters… ])

* timeout - how long (in seconds) should the method wait for finishing the method (0 means infinite). A timeout mean time after which the function is considering as failure, returning to caller with error and no result. Nearly every time the 0 is used.
* top_object - root object for the method (on which the method is called)
* method - name of the called method
* parameters - variable number of parameters based on the called method

== Results ==
Function doesn't return value, but methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called method.

== Available methods ==
{| width="100%"
|-
! colspan=3|'''Defined on current (TOP) object'''
|-
|colspan=3|These methods are defined on all objects (maybe)
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitCall_Attr|call_attr]]
| width="33%" align="left" style="vertical-align:top;" |
*[[get_attr_vals]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitGet_Co_group|get_co_group]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CR object'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitAuto_assign|auto_assign]]
*[[Send_WaitChange_status|change_status]]
*[[Send_WaitClose_call_request|close_call_request]]
*[[Send_WaitCopy_cr|copy_cr]]
*[[Send_WaitCopy_cr_site|copy_cr_site]]
*[[Send_WaitCob_mark_delete|dob_mark_delete]]
*[[Send_WaitCo_expand|do_expand]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitEscalate|escalate]]
*[[Send_WaitIinit_activity|init_activity]]
*[[Send_WaitInit_call_request|init_call_request]]
*[[Send_WaitLog_callback|log_callback]]
*[[Send_WaitLog_comment|log_comment]]
*[[Send_WaitLog_comment_no_checkout|log_comment_no_checkout]]
*[[Send_WaitLog_event|log_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitLog_research|log_research]]
*[[Send_WaitMake_from_template|make_from_template]]
*[[Send_WaitMake_from_template_site|make_from_template_site]]
*[[Send_WaitManual_notify|manual_notify]]
*[[Send_WaitReopen_call_request|reopen_call_request]]
*[[Send_WaitSend_api_msg|send_api_msg]]
*[[Send_WaitTransfer|transfer]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Defined on CHG object'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Send_WaitAccumulate|accumulate]]
*[[Send_WaitAccumulate_change|accumulate_change]]
*[[Send_WaitAccumulate_workflows|accumulate_workflows]]
*[[Send_WaitAdd_assets|add_assets]]
*[[Send_WaitAdd_auditlog|add_auditlog]]
*[[Send_WaitAuto_assign|auto_assign]]
*[[Send_WaitChange_status|change_status]]
*[[Send_WaitClose_change_descedents|close_change_descendents]]
*[[Send_WaitClose_change_request|close_change_request]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitCopy_chg|copy_chg]]
*[[Send_WaitCopy_chg_site|copy_chg_site]]
*[[Send_WaitDo_expand|do_expand]]
*[[Send_WaitDob_mark_delete|dob_mark_delete]]
*[[Send_WaitEscalate|escalate]]
*[[Send_WaitFast_track|fast_track]]
*[[Send_WaitImpact_analysis|impact_analysis]]

| width="33%" align="left" style="vertical-align:top;" |
*[[Send_WaitInit_activity|init_activity]]
*[[Send_WaitInit_change_request|init_change_request]]
*[[Send_WaitLog_event|log_event]]
*[[Send_WaitMake_from_template|make_from_template ]]
*[[Send_WaitMake_from_template_site|make_from_template_site ]]
*[[Send_WaitManual_notify|manual_notify]]
*[[Send_WaitOk_close_descedents|ok_close_descendents]]
*[[Send_WaitRemove_all_assets|remove_all_assets]]
*[[Send_WaitTransfer|transfer]]
|-
|}

== Examples ==

Send WaitCall Attr

2011-07-19T12:11:45Z

Kowy: /* Overview */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on TOP object). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object attributes or on other factories. So we can distinguish between usage of this method on '''current object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available actions ==
{| width="100%"
|-
! colspan=3|'''Object's attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[get_dob Spell method|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[get_val Spell method|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[set_val Spell method|set_val]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[send_WaitCall_attrDob_by_persid|dob_by_persid]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_domset|get_domset]]
*[[send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]
*[[send_WaitCall_attrGet_new_dob|get_new_dob]]
*[[send_WaitCall_attrNew_attached_event|new_attached_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrNotify_list|notify_list]]
*[[send_WaitCall_attrSync_fetch|sync_fetch]]
*[[send_WaitCall_attrVal_by_key|val_by_key]]
|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Get dob Spell method

2011-06-03T14:16:48Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r6 Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method loads f...

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method loads from database an object connected over SREL relation to an another object and return it as full DOB object.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] for [[Send_WaitCall_Attr|call_attr]].

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, "get_dob")
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - object where the attribute is placed
* attr_name - name of SREL attribute

== Results ==
On success attribute DOB object is in the first position of global array '''msg'''.
<source lang="javascript">
object retval;
retval = msg[0];
</source>

== Examples ==
<source lang="javascript">
// Part of code to read request Affected End User
send_wait(0, this, "call_attr", "customer", "get_dob");
if (msg_error()) {
logf(ERROR, "%s: error in get_dob(customer): %s", method, msg[0]);
return;
}
object aff_eu;
aff_eu = msg[0];
....
</source>

Get val Spell method

2011-06-03T12:35:51Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r6 Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method gets va...

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method gets value of some single (not REL) attribute and returns it. It also preserves datatype of column. It is suitable for accessing attributes with reserved name (bool, function, class...), n-th item of multivalue (group.member_list.0.combo_name) or dynamic reading, where attribute name is in variable.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] for [[Send_WaitCall_Attr|call_attr]].

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, "get_val")
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - object where the attribute is placed
* attr_name - name of attribute which value should be get

== Results ==
On success attribute value is in the first position of global array '''msg'''.
<source lang="javascript">
retval = msg[0];
</source>

== Examples ==
<source lang="javascript">
// Part of code to read group members
for( iLoop = 0; iLoop < member_count; iLoop++ ) {
send_wait(0, some_group, "call_attr", format("member_list.%d.combo_name",iLoop), "get_val");
if (msg_error()) {
logf(ERROR, "%s: error in get_val: %s", method, msg[0]);
continue;
}
member_name = msg[0];
....
}
</source>

Send WaitCall Attr

2011-06-03T10:19:49Z

Kowy: /* Available actions */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on all objects). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object's attributes or on other factories. So we can distinguis between usage of this method on '''object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available actions ==
{| width="100%"
|-
! colspan=3|'''Object's attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[get_dob Spell method|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[get_val Spell method|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[set_val Spell method|set_val]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[send_WaitCall_attrDob_by_persid|dob_by_persid]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_domset|get_domset]]
*[[send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]
*[[send_WaitCall_attrGet_new_dob|get_new_dob]]
*[[send_WaitCall_attrNew_attached_event|new_attached_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrNotify_list|notify_list]]
*[[send_WaitCall_attrSync_fetch|sync_fetch]]
*[[send_WaitCall_attrVal_by_key|val_by_key]]
|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Send WaitCall Attr

2011-06-03T09:18:39Z

Kowy: /* Available actions */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on all objects). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object's attributes or on other factories. So we can distinguis between usage of this method on '''object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available actions ==
{| width="100%"
|-
! colspan=3|'''Object's attributes'''
|-
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_dob|get_dob]]
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_val|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrSet_val|set_val]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[send_WaitCall_attrDob_by_persid|dob_by_persid]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_domset|get_domset]]
*[[send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]
*[[send_WaitCall_attrGet_new_dob|get_new_dob]]
*[[send_WaitCall_attrNew_attached_event|new_attached_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrNotify_list|notify_list]]
*[[send_WaitCall_attrSync_fetch|sync_fetch]]
*[[send_WaitCall_attrVal_by_key|val_by_key]]
|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Upcase

2011-05-16T14:22:18Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r6 Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == Spell function con...

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
Spell function converting string to a uppercase (coverts all characters in string to uppercase)

== Usage ==
<source lang="javascript">
string upcase(string attr);
</source>

* attr - any string

== Results ==
Returns converted string.

== Examples ==
<source lang="javascript">
acc_type_name = upcase(acc_type_name);
if (acc_type_name == 'EMPLOYEE') cnt_type = 2305;
</source>

Downcase

2011-05-16T13:36:43Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r6 Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == Spell function con...

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
Spell function converting string to a lowercase (coverts all characters in string to lowercase)

== Usage ==
<source lang="javascript">
string downcase(string attr);
</source>

* attr - any string

== Results ==
Returns converted string.

== Examples ==
<source lang="javascript">
if(downcase(option_value) == "yes" ) {
option_value="Yes";
} else if (downcase(option_value) == "no") {
option_value="No";
}
</source>

Spel Reference Guide

2011-05-16T13:31:35Z

Kowy: /* Reference Sections */

__NOTOC__
[[Category:Customizations]]
{{Global Header}}
{{Global Announcement}}

Note: please treat SPELL as SPEL
== Overview ==
Spell is CA proprietary code used to script Service Desk core operations. Spell code can be found in .spl and .maj files located in [[$NX_ROOT]]\bopcfg\majic and [[$NX_ROOT]]\site\mods\majic directories. Other examples can be found in the [[$NX_ROOT]]\samples directory.

Note: .spl files with a ''pcd'' preceding the .spl are encrypted files, such as chgpcd.spl or itilpcd.spl.

Spell is usually used to write methods for object or attribute triggers. Examples may be attribute validation, notification, post processing, etc.

Spell is interpreted and executed by the Method Engine (spel_srvr), it can also be executed from the command line with bop_cmd command that interprets the fragment (.frg) files and executes the code.

The language resembles C++. Unlike C or C++, Spell does not support pointers or structures.

== Reference Sections ==
{| width="100%"
|-
! colspan=3|'''Functions'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[downcase]]
*[[exec]]
*[[format]]
*[[getenv]]
*[[gsub]]
| width="33%" align="left" style="vertical-align:top;" |
*[[is_empty]]
*[[is_null]]
*[[misc:find_mang]]
*[[now]]
*[[send_wait]]
*[[sindex]]
| width="33%" align="left" style="vertical-align:top;" |
*[[strlen]]
*[[substr]]
*[[upcase]]
*[[workshift_abs2work]]
*[[workshift_work2abs]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Statements'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[if]]
| width="33%" align="left" style="vertical-align:top;" |
*[[for]]
| width="33%" align="left" style="vertical-align:top;" |
*[[while]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Data Type Conversion]]
*[[Operators]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Spel FAQ]]
*[[Triggering Reaction]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Troubleshooting Spell Code|Troubleshooting]]
*[[Variables and Types]]
*[[Methods handling]]
|-
|}

== See Also ==
[[WSSIWYG]] by Nero Le Velu

Data Type Conversion

2011-05-16T13:17:38Z

Kowy: /* Details */

__NOTOC__
{{Global Header}}
{{Global Announcement}}

== Overview ==
This This article details how to convert from one data type to another in [[Spel Reference Guide|Spel code]]. This concept is regarded as ''casting''.

== Details ==
Primary data types used in USD spell.
* string
* int
* float
* date
* duration
* bool
* uuid ''(introduced in r11.x)''
* object

Example:
<source lang="javascript">string MyString;
int MyInt;
float MyFloat;
date MyDate;
duration MyDuration;
uuid MyUUID;

MyString = "Hello world no: " +(string) 1; // result: "Hello world no: 1"
MyInt = (int) "2 times"); // result: 2
MyFloat = (float)MyInt; // result: 2.00000
MyDate = (date)( (string) now()); // result: the actual date depending of your system time configuration
MyDuration = (duration)((int) "2" + 3), // result: duration of 5 sec.
MyUUID = (uuid)expand( "&{'mylogin'=cnt.userid->id}"); // result: the id of contact having userid "mylogin"</source>

== Arrays ==
In Spell code you can use arrays as well.

Accessing array fields is very similar to other languages, simply use
<source lang="javascript">
myArray[3]
</source>
to access forth element of an array myArray. Arrays are 0-based.

Here is the example of declarantion of a new array of strings with 4 elements:
<source lang="javascript">string msgs[4];</source>

Send WaitCall attrNotify list

2011-05-16T09:47:18Z

Kowy: /* Usage */

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method sends notifications to a list of concrete recipients.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] (or [[send]]) using [[Send_WaitCall_Attr|call_attr]] action.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "notify_list",
string contact_persid, int evt_level, string evt_mtitle, string evt_mbody, string msg_ack,
int trans_pt, string parent_object, int is_internal, int cmth_override)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - "cnt" in this case
* contact_persid - list of space (' ') separated persistent IDs of notified contacts
* evt_level - notification level (low, normal, high, emergency)
* evt_mtitle - message subject
* evtmbody - message body (plain text format)
* msg_ack - unknown, but usually empty string: ""
* trans_pt - unknown, but has these values: 28 - for request; 29 - for change and issue
* parent_object - peristent ID of a base object (request, change...); this ticket will refer this notification in a Notification log
* is_internal - probably 0/1; usually 0
* cmth_override - ID of forced Notification method or 0 if method defined for given contact and evt_level should be used

== Results ==
No results.

== Examples ==
<source lang="javascript">
string evt_mtitle, evt_mbody;
evt_mtitle = format("Change Order %s - '%s' Event Notify Group", chg_ref_num, event_tmpl.condition.sym);
evt_mbody = format("change %s event notification\n", chg_ref_num);
evt_mbody += format("priority: %d\n", priority.sym);
evt_mbody += format("assigned to: %s\n", assignee.combo_name);
evt_mbody += format("requester: %s\n", requestor.combo_name);
evt_mbody += format("description: %s\n", description);

int evt_level;
evt_level = 2;
int trans_pt;
trans_pt = 29;
string contact_persid;

if (!is_null(group))
{
contact_persid = misc::find_mang(group);
if(!is_empty(contact_persid)) {
send(top_object(), "call_attr", "cnt", "notify_list",
contact_persid, evt_level, evt_mtitle, evt_mbody, "", trans_pt, persistent_id, 0, 0);
if (msg_error()) {
logf(ERROR, format("macro event error on notify_list '%s'", msg[0]));
}
}
}
</source>

Send WaitCall attrNotify list

2011-01-25T07:56:29Z

Kowy:

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method sends notifications to a list of concrete recipients.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] (or [[send]]) using [[Send_WaitCall_Attr|call_attr]] action.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "notify_list",
string contact_persid, int evt_level, string evt_mtitle, string evt_mbody, string msg_ack,
int trans_pt, string parent_object, int is_internal, int cmth_override)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called (could be "cr" for requsts and incidents, "chg" for changes, "iss" for issues)
* contact_persid - list of space (' ') separated persistent IDs of notified contacts
* evt_level - notification level (low, normal, high, emergency)
* evt_mtitle - message subject
* evtmbody - message body (plain text format)
* msg_ack - unknown, but usually empty string: ""
* trans_pt - unknown, but has these values: 28 - for request; 29 - for change and issue
* parent_object - peristent ID of a base object (request, change...); this ticket will refer this notification in a Notification log
* is_internal - probably 0/1; usually 0
* cmth_override - ID of forced Notification method or 0 if method defined for given contact and evt_level should be used

== Results ==
No results.

== Examples ==
<source lang="javascript">
string evt_mtitle, evt_mbody;
evt_mtitle = format("Change Order %s - '%s' Event Notify Group", chg_ref_num, event_tmpl.condition.sym);
evt_mbody = format("change %s event notification\n", chg_ref_num);
evt_mbody += format("priority: %d\n", priority.sym);
evt_mbody += format("assigned to: %s\n", assignee.combo_name);
evt_mbody += format("requester: %s\n", requestor.combo_name);
evt_mbody += format("description: %s\n", description);

int evt_level;
evt_level = 2;
int trans_pt;
trans_pt = 29;
string contact_persid;

if (!is_null(group))
{
contact_persid = misc::find_mang(group);
if(!is_empty(contact_persid)) {
send(top_object(), "call_attr", "cnt", "notify_list",
contact_persid, evt_level, evt_mtitle, evt_mbody, "", trans_pt, persistent_id, 0, 0);
if (msg_error()) {
logf(ERROR, format("macro event error on notify_list '%s'", msg[0]));
}
}
}
</source>

Send WaitCall attrNotify list

2011-01-21T14:50:26Z

Kowy: /* Usage */

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method sends notifications to a list of concrete recipients.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] (or [[send]]) using [[Send_WaitCall_Attr|call_attr]] action.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "notify_list",
string contact_persid, int evt_level, string evt_mtitle, string evt_mbody, string msg_ack,
int trans_pt, string parent_object, int is_internal, int cmth_override)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called (could be "cr" for requsts and incidents, "chg" for changes, "iss" for issues)
* contact_persid - list of space (' ') separated persistent IDs of notified contacts
* evt_level - notification level (low, normal, high, emergency)
* evt_mtitle - message subject
* evtmbody - message body (plain text format)
* msg_ack - unknown, but usually empty string: ""
* trans_pt - unknown, but has these values: 28 - for request; 29 - for change and issue
* parent_object - peristent ID of a base object (request, change...)
* is_internal - probably 0/1; usually 0
* cmth_override - ID of forced Notification method or 0 if method defined for given contact and evt_level should be used

== Results ==
No results.

== Examples ==
<source lang="javascript">
string evt_mtitle, evt_mbody;
evt_mtitle = format("Change Order %s - '%s' Event Notify Group", chg_ref_num, event_tmpl.condition.sym);
evt_mbody = format("change %s event notification\n", chg_ref_num);
evt_mbody += format("priority: %d\n", priority.sym);
evt_mbody += format("assigned to: %s\n", assignee.combo_name);
evt_mbody += format("requester: %s\n", requestor.combo_name);
evt_mbody += format("description: %s\n", description);

int evt_level;
evt_level = 2;
int trans_pt;
trans_pt = 29;
string contact_persid;

if (!is_null(group))
{
contact_persid = misc::find_mang(group);
if(!is_empty(contact_persid)) {
send(top_object(), "call_attr", "cnt", "notify_list",
contact_persid, evt_level, evt_mtitle, evt_mbody, "", trans_pt, persistent_id, 0, 0);
if (msg_error()) {
logf(ERROR, format("macro event error on notify_list '%s'", msg[0]));
}
}
}
</source>

Custom Lookup method for TextAPI

2011-01-11T17:04:49Z

Kowy: New page: __NOTOC__ Category:Customizations Category:R12 {{Global Header}} {{Global Announcement}} == Overview == In text_api.cfg you can configure new attributes, which can be used in stru...

__NOTOC__
[[Category:Customizations]]
[[Category:R12]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
In text_api.cfg you can configure new attributes, which can be used in structured emails to create or modify SD objects. And the definition of a new attribute can use lookup method to convert some text field (i.e. user login) to object ID. A list of all standard conversion methods is in CMDB Administration Guide in chapter Conversion methods on page 189 in R12.1 documentation. And this article describes how to develop custom lookup method.

== Procedures ==
=== Step 1. Create Spell method ===
First at all create free spell method (not connected to any object) with 4 parameters:
* string value - string value to convert
* string obj_name - name of object to which the returned value will be set
* object obj - real object to which the returned value will be set
* string attribute - name of attribute to which the returned value will be set

Here is the example for custom lookup_cnt_by_phone method:
<source lang="javascript">
uuid lookup_cnt_by_phone(string phone, string obj_type, object obj, string attribute)
{
string method;
method = "lookup_cnt_by_phone";
uuid contact;

logf(MILESTONE, "%s: Entering method: %s", method, phone);
logf(VERBOSE, "%s: obj_type=%s", method, obj_type);
logf(VERBOSE, "%s: attribute=%s", method, attribute);
logf(VERBOSE, "%s: obj.id=%s", method, obj.id);

contact = (uuid)expand(format("&{'%s' = cnt.phone_number->id}", phone));
if (is_null(contact))
logf(MILESTONE, "%s: User not found", method);
else
logf(MILESTONE, "%s: User found: %s", method, contact);

return contact;
}
</source>

=== Step 2. Update configuration in text_api.cfg ===
To text_api.cfg configuration file insert this line after the last row begining with REQUEST:
<source lang="ini">
REQUEST.CUSTOMER_PHONE=customer.UUID.lookup_cnt_by_phone
</source>

Finally restart Service Desk service.

Sample Customizations

2011-01-11T16:32:05Z

Kowy:

__NOTOC__
[[Category:Customization]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
Customizations are regarded as changes to the system that are not supportable by CA.

== List of Customizations ==
[[image:exclaim.gif]][[SDU:SDU r12 EP1|SDU Enhancement Pack 1 for r12]]
*[[Action Macro to Log Solution and Resolve Ticket]]
*[[Add Checkbox, Date, Drop-down, Lookup, Readonly and Text Fields to Properties]]
*[[Add Contact Search to Employee/Customer Interface]]
*[[Add Custom Activity Log Action Macro]]
*[[Add Log Entry for Updates to Custom Fields]]
*[[Add Log Entry When a Property Value Changes on a Ticket]]
*[[Add Personalized Response to Manual Notification]]
*[[Add Posted By to Announcements Page]]
*[[Add Properties Count to Area/Category List]]
*[[Add Ticket and CI Links to Announcements]]
*[[Add Workflow to Employee/Customer Interface]]
*[[Attachments on Configuration Items]]
*[[Attachments on Contacts]]
*[[Auto-fill Fields Left Blank]]
*[[Automatically Attach an Asset/CI to a Change Order or Issue]]
*[[Automatically Remove Attached Events]]
*[[Automatically Set Assignee to Closing Analyst]]
*[[Automatically Set System Generated Activities to Internal]]
*[[Changing Announcements Order By]]
*[[Changing Error Alert Color and adding Error Alert Pop-ups]]
*[[Changing Requests to Incidents]]
*[[Changing Display of Contacts]]
*[[Conditional Display of Drop-Down Content]]
*[[Conditionally Attach an Event]]
*[[Control the Request Areas Displayed to the End Users]]
*[[Count Ticket Reopens]]
*[[Custom Lookup method for TextAPI]]
*[[Displaying the System and User Descriptions in the Activity Log]]
*[[Display Web Site within Service Desk]]
*[[Default Properties Tab on New Ticket Creation]]
*[[Generate Notifications Only for Employee Comments]]
*[[Increasing Default Field Size]]
*[[List Tickets ORDER BY Group]]
*[[Make a Field Conditionally Required]]
*[[Modify Action and Condition Macros via the GUI]]
*[[Only Assignee can Close]]
*[[Prevent Close of Requests/Incidents/Problems if Change Order is Active]]
*[[Prevent Update to Past Activities]]
*[[Propagate Solution to Children]]
*[[Propagate Status to Children]]
*[[Priority and Impact Default to Empty]]
*[[Refresh Customer Info Before Saving the Ticket]]
*[[Remove Second Message on Timeout]]
*[[Remove SLA Violation from Employee View]]
*[[Require a Solution in Order to Resolve]]
*[[Require Assignee to be a Member of the selected Group]]
*[[Search Requests, Incidents, and Problems Simultaneously for Ticket Number]]
*[[Send Notification at Callback Time]]
*[[Send Notification to CI's Attached Contacts]]
*[[Send Survey based on Variables]]
*[[Separate Prefixes for Requests, Incidents, and Problems]]
*[[Set Defaults on Manual Notify]]
*[[Set Priority Based on Urgency and Impact]]
*[[Set Request/Incident/Problem Status from Change Order]]
*[[Set Request/Incident/Problem Status on Dispatch Change]]
*[[Simplified Child Creation]]
*[[Single Sign-on with Cookies]]
*[[EIAM Services dont start on fresh install]]
*[[SPELL CODE to Make ACT / EVT INTERNAL]]

Is empty

2010-09-24T09:36:43Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r6 Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == A spell function c...

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
A spell function checking if a given attribute is an empty string or equals to a NULL value.

== Usage ==
<source lang="javascript">
bool is_empty(attr);
</source>

* attr - any string variable to be checked

== Results ==
Returns true if attr is NULL or is an empty string, otherwise returns false.

== Examples ==
<source lang="javascript">
if(is_empty(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>
<source lang="javascript">
string contact_persid;
if(!is_empty(contact_persid)) {
// ...
}
</source>

Is null

2010-09-24T09:30:41Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r6 Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == A spell function c...

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
A spell function checking if a given attribute equals to a NULL value or not.

== Usage ==
<source lang="javascript">
bool is_null(attr);
</source>

* attr - any variable to be checked

== Results ==
Returns true if attr is NULL otherwise false.

== Examples ==
<source lang="javascript">
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>
<source lang="javascript">
string contact_persid;
if (!is_null(group))
{
contact_persid = misc::find_mang(group);
}
</source>

Spel Reference Guide

2010-09-24T09:21:11Z

Kowy: /* Reference Sections */

__NOTOC__
[[Category:Customizations]]
{{Global Header}}
{{Global Announcement}}

Note: please treat SPELL as SPEL
== Overview ==
Spell is CA proprietary code used to script Service Desk core operations. Spell code can be found in .spl and .maj files located in [[$NX_ROOT]]\bopcfg\majic and [[$NX_ROOT]]\site\mods\majic directories. Other examples can be found in the [[$NX_ROOT]]\samples directory.

Note: .spl files with a ''pcd'' preceding the .spl are encrypted files, such as chgpcd.spl or itilpcd.spl.

Spell is usually used to write methods for object or attribute triggers. Examples may be attribute validation, notification, post processing, etc.

Spell is interpreted and executed by the Method Engine (spel_srvr), it can also be executed from the command line with bop_cmd command that interprets the fragment (.frg) files and executes the code.

The language resembles C++. Unlike C or C++, Spell does not support pointers or structures.

== Reference Sections ==
{| width="100%"
|-
! colspan=3|'''Functions'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[format]]
*[[getenv]]
*[[gsub]]
*[[is_empty]]
*[[is_null]]
| width="33%" align="left" style="vertical-align:top;" |
*[[misc:find_mang]]
*[[now]]
*[[send_wait]]
*[[sindex]]
| width="33%" align="left" style="vertical-align:top;" |
*[[strlen]]
*[[substr]]
*[[workshift_abs2work]]
*[[workshift_work2abs]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Statements'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[if]]
| width="33%" align="left" style="vertical-align:top;" |
*[[for]]
| width="33%" align="left" style="vertical-align:top;" |
*[[while]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Data Type Conversion]]
*[[Operators]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Spel FAQ]]
*[[Triggering Reaction]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Troubleshooting Spell Code|Troubleshooting]]
*[[Variables and Types]]
*[[Methods handling]]
|-
|}

== See Also ==
[[WSSIWYG]] by Nero Le Velu

Send WaitCall attrSync fetch

2010-09-09T08:30:30Z

Kowy:

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method synchronously fetch list of items from SD database. It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "sync_fetch", string rs_type, string query, int unknown, int param_num [, var parameters])
</source>

* ''timeout'' - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* ''top_object'' - root object for the method (on which the method is called)
* ''attr_name'' - name of attribute on which the action is called
* ''factory_name'' - the factory you want to call against (could be anything like pcat, cnt, cr, alg, ...)
* ''query'' - query determining what record(s) you want to be returned; query is on an Object level (so you can use similar queries used in Stored Queries, Additional Search arguments or bop_odump command)
* ''rs_type'' - the type of recordset you want returned. Should be one of these options:
** STATIC
** DYNAMIC
** MLIST_STATIC
** MLIST_DYNAMIC
** RLIST_STATIC
** RLIST_DYNAMIC
* ''unknown'' - don't know, but usually -1
* ''param_num'' - number of following parameters
* ''parameters'' - variable number of parameters based on given query (for each ? must be exactly one parameter, which value will provide data for corresponding ?)

== Results ==
On success the resulted list is filled into a global array '''msg''' as follows:
* msg[0] - the recordset (object)
* msg[1] - the length of the recordset (records returned, int)

== Examples ==
<source lang="javascript">
// get template by its persistent id
send_wait(0, top_object(), "call_attr", "cr_tpl", "sync_fetch", "RLIST_DYNAMIC", "template = ?", -1, 1, cr.persistent_id);
// get group by id
send_wait(0, top_object(), "call_attr", "grp", "sync_fetch", "RLIST_STATIC", "id = ? AND delete_flag = 0", -1, 1, new_group);
// get list of all remote referencies
send_wait( 0, top_object(), "call_attr","rrf","sync_fetch", "RLIST_DYNAMIC", "", -1, 0);
</source>

Gsub

2010-09-08T12:41:27Z

Kowy: New page: __NOTOC__ {{Global Header}} {{Global Announcement}} == Overview == A spell function returning the string with every occurence of a given pattern replaced by another string. == Usage == <...

__NOTOC__
{{Global Header}}
{{Global Announcement}}

== Overview ==
A spell function returning the string with every occurence of a given pattern replaced by another string.

== Usage ==
<source lang="javascript">
string gsub(strSource, strRegEx, strReplacement);
</source>

* strSource - source string to be replaced
* strRegEx - regular expression pattern
* strReplacement - by which string should be pattern replaced

== Results ==
Returns changed string or the same string if pattern does not match.

== Examples ==
* Convert several lines to a one comma separated string
<source lang="javascript">
gsub(errorStr,"\n", ", ")
</source>

Spel Reference Guide

2010-09-08T12:25:11Z

Kowy:

__NOTOC__
[[Category:Customizations]]
{{Global Header}}
{{Global Announcement}}

Note: please treat SPELL as SPEL
== Overview ==
Spell is CA proprietary code used to script Service Desk core operations. Spell code can be found in .spl and .maj files located in [[$NX_ROOT]]\bopcfg\majic and [[$NX_ROOT]]\site\mods\majic directories. Other examples can be found in the [[$NX_ROOT]]\samples directory.

Note: .spl files with a ''pcd'' preceding the .spl are encrypted files, such as chgpcd.spl or itilpcd.spl.

Spell is usually used to write methods for object or attribute triggers. Examples may be attribute validation, notification, post processing, etc.

Spell is interpreted and executed by the Method Engine (spel_srvr), it can also be executed from the command line with bop_cmd command that interprets the fragment (.frg) files and executes the code.

The language resembles C++. Unlike C or C++, Spell does not support pointers or structures.

== Reference Sections ==
{| width="100%"
|-
! colspan=3|'''Functions'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[format]]
*[[getenv]]
*[[gsub]]
*[[misc:find_mang]]
| width="33%" align="left" style="vertical-align:top;" |
*[[now]]
*[[send_wait]]
*[[sindex]]
| width="33%" align="left" style="vertical-align:top;" |
*[[strlen]]
*[[substr]]
*[[workshift_abs2work]]
*[[workshift_work2abs]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Statements'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[if]]
| width="33%" align="left" style="vertical-align:top;" |
*[[for]]
| width="33%" align="left" style="vertical-align:top;" |
*[[while]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Data Type Conversion]]
*[[Operators]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Spel FAQ]]
*[[Triggering Reaction]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Troubleshooting Spell Code|Troubleshooting]]
*[[Variables and Types]]
*[[Methods handling]]
|-
|}

== See Also ==
[[WSSIWYG]] by Nero Le Velu

Send WaitCall attrGet groups by persid

2010-08-25T11:36:52Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method gets a list of groups f...

Send WaitCall Attr

2010-08-25T11:29:18Z

Kowy: /* Available actions */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on all objects). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object's attributes or on other factories. So we can distinguis between usage of this method on '''object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available actions ==
{| width="100%"
|-
! colspan=3|'''Object's attributes'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_val|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrSet_val|set_val]]
|-
| width="33%" align="left" style="vertical-align:top;" |
 
|-
|}

{| width="100%"
|-
! colspan=3|'''Other factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[send_WaitCall_attrDob_by_persid|dob_by_persid]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_domset|get_domset]]
*[[send_WaitCall_attrGet_groups_by_persid|get_groups_by_persid]]
*[[send_WaitCall_attrGet_new_dob|get_new_dob]]
*[[send_WaitCall_attrNew_attached_event|new_attached_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrNotify_list|notify_list]]
*[[send_WaitCall_attrSync_fetch|sync_fetch]]
*[[send_WaitCall_attrVal_by_key|val_by_key]]
|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Send WaitCall Attr

2010-08-25T11:27:55Z

Kowy: /* Available actions */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on all objects). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object's attributes or on other factories. So we can distinguis between usage of this method on '''object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available actions ==
{| width="100%"
|-
! colspan=3|'''Object's attributes'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_val|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrSet_val|set_val]]
|-
| width="33%" align="left" style="vertical-align:top;" |
 
|-
|}

{| width="100%"
|-
! colspan=3|'''Other factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[send_WaitCall_attrDob_by_persid|dob_by_persid]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_domset|get_domset]]
*[[send_WaitCall_attrGet_groups_by_persid|get_group_by_persid]]
*[[send_WaitCall_attrGet_new_dob|get_new_dob]]
*[[send_WaitCall_attrNew_attached_event|new_attached_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrNotify_list|notify_list]]
*[[send_WaitCall_attrSync_fetch|sync_fetch]]
*[[send_WaitCall_attrVal_by_key|val_by_key]]
|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Send WaitLog event

2009-12-07T13:23:53Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:r12 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method create activity Event O...

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:r12]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method create activity Event Occured to object's activity log. This method is valid for CR as well for CHG objects.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]].

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "log_event", object group_leader, uuid userid, string message)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* group_leader - Group leader object obtained from [[Send_WaitGet_Co_group|get_co_group]] method
* userid - user designated as action creator
* message - user description in object's activity

== Results ==
On success nothing. If error occured msg[0] contains error message.

== Examples ==
<source lang="javascript">
/ add an activity log. requires the macro be locked.
uuid log_userid;
// log_userid = Administrator
log_userid = (uuid)"4FE1477A236A2A44A3B05A628DCBE661";

// get info from event to store in log description
string log;
log = format("event '%s' triggered by condition '%s'.", event_tmpl.sym, event_tmpl.condition.sym);

send_wait(0, this, "log_event", group_leader, log_userid, log);
if (msg_error()) {
logf(ERROR, format("macro event error '%s'", msg[0]));
} </source>

Send WaitCall attrNew attached event

2009-12-07T10:18:18Z

Kowy: /* Usage */

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method for attaching events to CR or CHG objects.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] for [[Send_WaitCall_Attr|call_attr]].

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "new_attached_event",
object group_leader, string obj_persid, string evt_name, duration NULL|override_duration,
date NULL|override_starttime, string goup_name, int unknown1, int unknown2, string timezone)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called (could be "cr" for requsts and incidents, "chg" for changes, "iss" for issues)
* group_leader - Group leader object obtained from [[Send_WaitGet_Co_group|get_co_group]] method
* obj_persid - persistence_id of CR or CHG object which the event will be connected to
* evt_name - name provided in evt.sym field
* override_duration - if you want to pass NULL it must be casted: (duration)NULL
* override_starttime - if you want to pass NULL it must be casted: (date)NULL
* group_name - simple string which will be stored in atev.group_name field; this is usefull for later filtering
* unknown1 - simply put 0 there
* unknown2 - ['''R11+'''] simply put 0 there
* timezone - ['''R12+'''] persistent_id form tz object. Run ''bop_odump domsrvr tz "" sym code gmt_delta'' in command line and find your timezone and put Persid value here

== Results ==
On success nothing. If error occured msg[0] contains error message.

== Examples ==
<source lang="javascript">
object group_leader;
send_wait(0, top_object(), "get_co_group");
group_leader = msg[0];
send_wait(0, top_object(), "call_attr", "evt", "new_attached_event",
group_leader, argv[3], "Close Incident", (duration) NULL,
(date) NULL, "CLS", 0, 0);
if (msg_error()) {
logf(ERROR, "new_attached_event failed: (%s)", msg[0]);
return;
}
</source>

Display Buttons for Group members only

2009-12-02T11:03:31Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:r12 {{Global Header}} {{Global Announcement}} == Overview == This article describe in example how to simply show a butt...

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:r12]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
This article describe in example how to simply show a button (or anything else, button code of course can be easily changed) on page only for members of group filled in ticket.

== Code ==
We need to show button Take, which change status from Assigned to Work in progress and set Assignee to logged in user, but this button must be shown only for members of a group filled in ticket. Here is a solution for Incident object, but for change object is the solution very similar:

<source lang="html4strict">
<PDM_IF "$cst.group_list.length" \> "0">
// check if logged user is in ticket's group
if (false // to prevent || operator as a first literal in command, add this "non-sense" literal (false) to if condition
<PDM_LIST PREFIX="list" FACTORY="grpmem" WHERE="member = U'$cst.id'">
|| '$list.group' == '$args.group'
</PDM_LIST>
) {
// this is ticket on one of my groups and isn't mine, so draw Take/Control button
popupURLtk = '$cgi?SID=$SESSION.SID+FID=' + fid_generator() +
'+FACTORY=cr+PERSID=$args.persistent_id+OP=UPDATE+ACTIVITY_LOG_TYPE=ST+HTMPL=xfer_take_cr.htmpl';
ImgBtnCreate('take', 'Take', "popupActivityWithURL(popupURLtk, 'status')", true, 120);
}
</PDM_IF>
</source>

Screen Changes

2009-12-02T10:52:12Z

Kowy: /* See Also */

__NOTOC__
[[Category:Customization]]
{{Global Header}}
{{Global Announcement}}

== See Also ==
[[Additional Sorting on List Panel]]

[[Display Buttons for Group members only]]

[[Display Buttons for specific Roles only]]

[[How to Script Buttons]]

[[Web Screen Painter]]

Display Buttons for specific Roles only

2009-12-02T10:49:54Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r12 {{Global Header}} {{Global Announcement}} == Overview == This article describe in example how to simply show a button (or anything e...

__NOTOC__
[[Category:Customizations]]
[[Category:r12]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
This article describe in example how to simply show a button (or anything else, button code of course can be easily changed) on page only for some specific roles.

== Code ==
This example draws a button "Convert to incident" only for roles ''Administrator'', ''Level 1 Analyst'' and ''Service Desk Manager''. You can place it anywhere into detail_cr.htmpl page.

<source lang="javascript">
var role_list_txt = <PDM_FMT ESC_STYLE=C PAD=NO>"$SESSION.ROLE_LIST"</PDM_FMT>;
var role_list = role_list_txt.split( "@,@" );
if (role_list.length > 2)
{
var roleName = '';
for (var i=1; i<role_list.length; i+=2) {
if (role_list[i] == $SESSION.ROLE_ID) {
roleName = role_list[i-1];
break;
}
}

if (roleName == 'Administrator' || roleName == 'Level 1 Analyst' || roleName == 'Service Desk Manager') {
var popupURL = '$cgi?SID=$SESSION.SID+FID=' + fid_generator() +
'+FACTORY=cr+PERSID=$args.persistent_id+OP=UPDATE+ACTIVITY_LOG_TYPE=FLD+HTMPL=act_chgtype_cr.htmpl';
<PDM_MACRO NAME=button CAPTION="Convert to incident" ID=convert_to_incident
FUNC="popupActivityWithURL(popupURL, 'crtype')" WIDTH=180 NEWROW=yes ENDROW=yes>
}
}
</source>

'''This example works only on SD R12!!!'''

Screen Changes

2009-12-02T10:21:35Z

Kowy: /* See Also */

__NOTOC__
[[Category:Customization]]
{{Global Header}}
{{Global Announcement}}

== See Also ==
[[Additional Sorting on List Panel]]

[[Display Buttons for specific Roles only]]

[[How to Script Buttons]]

[[Web Screen Painter]]

Send WaitCall attrNotify list

2009-09-10T12:06:26Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method sends notifications to a list of concret...

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method sends notifications to a list of concrete recipients.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] (or [[send]]) using [[Send_WaitCall_Attr|call_attr]] action.

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "notify_list",
string contact_persid, int evt_level, string evt_mtitle, string evt_mbody, string unknown1,
int trans_pt, string parent_object, int uknown2, int unknown3)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called (could be "cr" for requsts and incidents, "chg" for changes, "iss" for issues)
* contact_persid - list of space (' ') separated persistent IDs of notified contacts
* evt_level - notification level (low, normal, high, emergency)
* evt_mtitle - message subject
* evtmbody - message body (plain text format)
* unknown1 - usually empty string: ""
* trans_pt - unknown, but has these values: 28 - for request; 29 - for change and issue
* parent_object - peristent ID of a base object (request, change...)
* unknown2 - usually 0
* unknown3 - usually 0

== Results ==
No results.

== Examples ==
<source lang="javascript">
string evt_mtitle, evt_mbody;
evt_mtitle = format("Change Order %s - '%s' Event Notify Group", chg_ref_num, event_tmpl.condition.sym);
evt_mbody = format("change %s event notification\n", chg_ref_num);
evt_mbody += format("priority: %d\n", priority.sym);
evt_mbody += format("assigned to: %s\n", assignee.combo_name);
evt_mbody += format("requester: %s\n", requestor.combo_name);
evt_mbody += format("description: %s\n", description);

int evt_level;
evt_level = 2;
int trans_pt;
trans_pt = 29;
string contact_persid;

if (!is_null(group))
{
contact_persid = misc::find_mang(group);
if(!is_empty(contact_persid)) {
send(top_object(), "call_attr", "cnt", "notify_list",
contact_persid, evt_level, evt_mtitle, evt_mbody, "", trans_pt, persistent_id, 0, 0);
if (msg_error()) {
logf(ERROR, format("macro event error on notify_list '%s'", msg[0]));
}
}
}
</source>

Send WaitCall Attr

2009-09-10T11:46:59Z

Kowy: /* Available actions */

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This is some kind of global method (callable on all objects). It can be called in [[Spel_Reference_Guide|Spell Code]] using [[send_wait]] method.

Using this method you can call some actions on object's attributes or on other factories. So we can distinguis between usage of this method on '''object's attributes''' and '''other factories'''.

== Usage ==
When calling action on some of top_object's attribute:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string attr_name, string action_name, [ var parameters… ])
</source>
or when calling action on some distinct factory:
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, string action_name, [ var parameters… ])
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called
* action - name of the called action
* parameters - variable number of parameters based on the called action

== Results ==
Methods usually fill global '''msg''' array with return values. What values are on what positions depends on the called action.

== Available actions ==
{| width="100%"
|-
! colspan=3|'''Object's attributes'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_val|get_val]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrSet_val|set_val]]
|-
| width="33%" align="left" style="vertical-align:top;" |
 
|-
|}

{| width="100%"
|-
! colspan=3|'''Other factories'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrCurrent_user_id|current_user_id]]
*[[send_WaitCall_attrDob_attr_list|dob_attr_list]]
*[[send_WaitCall_attrDob_by_persid|dob_by_persid]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrGet_domset|get_domset]]
*[[send_WaitCall_attrGet_new_dob|get_new_dob]]
*[[send_WaitCall_attrNew_attached_event|new_attached_event]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_WaitCall_attrNotify_list|notify_list]]
*[[send_WaitCall_attrSync_fetch|sync_fetch]]
*[[send_WaitCall_attrVal_by_key|val_by_key]]
|-
|}

== Examples ==
<source lang="javascript">
// Get currently logged in user
uuid login_userid
send_wait(0, top_object(), "call_attr", "cr", "current_user_id");
login_userid = msg[0];
</source>

Misc:find mang

2009-09-10T11:27:26Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == Returna a list of managers of one specific group. Fo...

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
Returna a list of managers of one specific group. For a group provided in the first argument get list of all managers '''with notify_flag checked'''.

It is used in macro Notify Group Manager.

== Usage ==
<source lang="javascript">
string misc_find_mang(uuid group)
</source>

== Results ==
Return space (' ') separated list of persids to contact table (returned managers).

== Examples ==
<source lang="javascript">
string contact_persid;
if (!is_null(group))
{
contact_persid = misc::find_mang(group);
}
</source>

Spel Reference Guide

2009-09-10T11:19:41Z

Kowy: /* Reference Sections */

__NOTOC__
[[Category:Customizations]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
Spell is CA proprietary code used to script Service Desk core operations. Spell code can be found in .spl and .maj files located in [[$NX_ROOT]]\bopcfg\majic and [[$NX_ROOT]]\site\mods\majic directories. Other examples can be found in the [[$NX_ROOT]]\samples directory.

Note: .spl files with a ''pcd'' preceding the .spl are encrypted files, such as chgpcd.spl or itilpcd.spl.

Spell is usually used to write methods for object or attribute triggers. Examples may be attribute validation, notification, post processing, etc.

Spell is interpreted and executed by the Method Engine (spel_srvr), it can also be executed from the command line with bop_cmd command that interprets the fragment (.frg) files and executes the code.

The language resembles C++. Unlike C or C++, Spell does not support pointers or structures.

== Reference Sections ==
{| width="100%"
|-
! colspan=3|'''Functions'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[format]]
*[[getenv]]
*[[misc:find_mang]]
*[[now]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_wait]]
*[[sindex]]
*[[strlen]]
*[[substr]]
| width="33%" align="left" style="vertical-align:top;" |
*[[workshift_abs2work]]
*[[workshift_work2abs]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Statements'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[if]]
| width="33%" align="left" style="vertical-align:top;" |
*[[for]]
| width="33%" align="left" style="vertical-align:top;" |
*[[while]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Data Type Conversion]]
*[[Operators]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Spel FAQ]]
*[[Triggering Reaction]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Troubleshooting Spell Code|Troubleshooting]]
*[[Variables and Types]]
*[[Methods handling]]
|-
|}

== See Also ==
[[WSSIWYG]] by Nero Le Velu

Spel Reference Guide

2009-09-10T11:17:45Z

Kowy:

__NOTOC__
[[Category:Customizations]]
{{Global Header}}
{{Global Announcement}}

== Overview ==
Spell is CA proprietary code used to script Service Desk core operations. Spell code can be found in .spl and .maj files located in [[$NX_ROOT]]\bopcfg\majic and [[$NX_ROOT]]\site\mods\majic directories. Other examples can be found in the [[$NX_ROOT]]\samples directory.

Note: .spl files with a ''pcd'' preceding the .spl are encrypted files, such as chgpcd.spl or itilpcd.spl.

Spell is usually used to write methods for object or attribute triggers. Examples may be attribute validation, notification, post processing, etc.

Spell is interpreted and executed by the Method Engine (spel_srvr), it can also be executed from the command line with bop_cmd command that interprets the fragment (.frg) files and executes the code.

The language resembles C++. Unlike C or C++, Spell does not support pointers or structures.

== Reference Sections ==
{| width="100%"
|-
! colspan=3|'''Functions'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[format]]
*[[getenv]]
*[[now]]
| width="33%" align="left" style="vertical-align:top;" |
*[[send_wait]]
*[[sindex]]
*[[strlen]]
*[[substr]]
| width="33%" align="left" style="vertical-align:top;" |
*[[workshift_abs2work]]
*[[workshift_work2abs]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Statements'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[if]]
| width="33%" align="left" style="vertical-align:top;" |
*[[for]]
| width="33%" align="left" style="vertical-align:top;" |
*[[while]]
|-
|}

{| width="100%"
|-
! colspan=3|'''Other'''
|-
| width="34%" align="left" style="vertical-align:top;" |
*[[Data Type Conversion]]
*[[Operators]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Spel FAQ]]
*[[Triggering Reaction]]
| width="33%" align="left" style="vertical-align:top;" |
*[[Troubleshooting Spell Code|Troubleshooting]]
*[[Variables and Types]]
*[[Methods handling]]
|-
|}

== See Also ==
[[WSSIWYG]] by Nero Le Velu

Now

2009-08-21T13:11:21Z

Kowy:

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
Return current date and time in datetime format. It can be converted to Unix timestamp using cast to int.

== Usage ==
<source lang="javascript">
date now()
</source>

== Results ==
Current date and time in datetime format.

== Examples ==
<source lang="javascript">
chg.modified_date = now();
alg.time_spent = now() - time_stamp;

if ((int)now() > (int)need_by-600) {
set_return_data(TRUE);
} else {
set_return_data(FALSE);
}
</source>

Now

2009-08-21T06:39:30Z

Kowy:

__NOTOC__
[[Category:Customizations]]
[[Category:r6]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
Return current date and time in Unix datetime format.

== Usage ==
<source lang="javascript">
int now()
</source>

== Results ==
Current date and time in Unix datetime format.

== Examples ==
<source lang="javascript">
chg.modified_date = now();
alg.time_spent = now() - time_stamp;

if (now() > need_by) {
set_return_data(TRUE);
} else {
set_return_data(FALSE);
}
</source>

Send WaitCall attrNew attached event

2009-07-30T06:43:58Z

Kowy: New page: __NOTOC__ Category:Customizations Category:r11 Category:Spell Code {{Global Header}} {{Global Announcement}} == Overview == This method for attaching events to CR or CHG object...

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method for attaching events to CR or CHG objects.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] for [[Send_WaitCall_Attr|call_attr]].

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "new_attached_event",
object group_leader, string obj_persid, string evt_name, duration NULL|override_duration,
date NULL|override_starttime, string goup_name, int unknown, int unknown)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called (could be "cr" for requsts and incidents, "chg" for changes, "iss" for issues)
* group_leader - Group leader object obtained from [[Send_WaitGet_Co_group|get_co_group]] method
* obj_persid - persistence_id of CR or CHG object which the event will be connected to
* evt_name - name provided in evt.sym field
* override_duration - if you want to pass NULL it must be casted: (duration)NULL
* override_starttime - if you want to pass NULL it must be casted: (date)NULL
* group_name - simple string which will be stored in atev.group_name field; this is usefull for later filtering
* unknown - simply put 0 there

== Results ==
On success nothing. If error occured msg[0] contains error message.

== Examples ==
<source lang="javascript">
object group_leader;
send_wait(0, top_object(), "get_co_group");
group_leader = msg[0];
send_wait(0, top_object(), "call_attr", "evt", "new_attached_event",
group_leader, argv[3], "Close Incident", (duration) NULL,
(date) NULL, "CLS", 0, 0);
if (msg_error()) {
logf(ERROR, "new_attached_event failed: (%s)", msg[0]);
return;
}
</source>

Send WaitGet Co group

2009-07-29T10:10:40Z

Kowy:

__NOTOC__
[[Category:Customizations]]
[[Category:r11]]
[[Category:Spell Code]]
{{Global Header}}
{{Global Announcement}}
== Overview ==
This method for attaching events to CR or CHG objects.

This action can be called in [[Spel_Reference_Guide|spell code]] in method [[send_wait]] for [[Send_WaitCall_Attr|call_attr]].

== Usage ==
<source lang="javascript">
void send_wait (int timeout, object top_object, "call_attr", string factory_name, "new_attached_event",
object group_leader, string obj_persid, string evt_name, duration NULL|override_duration,
date NULL|override_starttime, string goup_name, int unknown, int unknown)
</source>

* timeout - how long (?in seconds?) should the method wait for finishing the method (0 means infinite)
* top_object - root object for the method (on which the method is called)
* attr_name - name of attribute on which the action is called
* factory_name - name of factory on which the action is called (could be "cr" for requsts and incidents, "chg" for changes, "iss" for issues)
* group_leader - Group leader object obtained from [[Send_WaitGet_Co_group|get_co_group]] method
* obj_persid - persistence_id of CR or CHG object which the event will be connected to
* evt_name - name provided in evt.sym field
* override_duration - if you want to pass NULL it must be casted: (duration)NULL
* override_starttime - if you want to pass NULL it must be casted: (date)NULL
* group_name - simple string which will be stored in atev.group_name field; this is usefull for later filtering
* unknown - simply put 0 there

== Results ==
On success nothing. If error occured msg[0] contains error message.

== Examples ==
<source lang="javascript">
object group_leader;
send_wait(0, top_object(), "get_co_group");
group_leader = msg[0];
send_wait(0, top_object(), "call_attr", "evt", "new_attached_event",
group_leader, argv[3], "Close Incident", (duration) NULL,
(date) NULL, "CLS", 0, 0);
if (msg_error()) {
logf(ERROR, "new_attached_event failed: (%s)", msg[0]);
return;
}
</source>