CA Service Management

Where can I find Spel functions documentation?

Recommend

Jun 06, 2015 07:14 PM

TMACUL

What is spel

Spel is a procedural language closely resembling C, with some additional statements for handling the Business Object Process (BOP) messaging architecture.

(Integrations Vol2 p124)

Overview

Spel is CA proprietary code language script for CA Service Desk Manager where is a interpreted language executed by Method Engine called SPEL_SRVR - "Spel code interpretation server" (CA WIKI )
- Spel code can be interpreted not only by spel server but also by webengine if it is placed in www directory and defined as custom webengine operation, know how more SPEL: Register custom webengine OP by cdtj
All changes using spel changes on CA Service Desk Manager will change factory standard
All changes using spel code it´s a customization and don't have support by CA Support. (CA Support Brief)
All custom changes on CA SDM is located in $NX_ROOT\site\mods\
Spel code can be found in .spl and .maj files located in $NX_ROOT\bopcfg\majic and $NX_ROOT\site\mods\majic directories. (Integrations Vol2 p122)
Examples can be found in the $NX_ROOT\samples (CA WIKI)
.spl files with a pcd preceding the .spl are encrypted files, such as chgpcd.spl or itilpcd.spl.
We are using usually spel to do attribute validation and/or notification

Be Careful

By Kyle_R

WARNING: Incorrect SPL code customization can stop your system

Click here for more information

Data Types

int 32 bit integer	long 32 bit integer	float or double (same)
date	duration	string C++ object
object BOP object	uuid

Logical operators

A programming-language symbol that denotes a logical operation, are generally derived from Boolean algebra, which is a mathematical way of manipulating the truth values of concepts

Logical operator AND.

understanding

Logical operator OR

understanding

logical or bitwise OR

Relational operators

Relational operators allow comparison of values. (know more...)

Equal to

Not Equal to

Less than or equal to

Less than

Greater than or equal to

Greater than

Example:

x == y

x != y

x <= y

x < y

x >= y

x > y

Arithmetic operators

Arithmetic operators able to add, subtract, multiply, and divide. (know more...)

+
Addition

-
Subtraction

*
Multiplication

/
Division

Concatenation operators

Concatenation is the process of appending one string to the end of another string. When you concatenate string literals or string constants by using the + operator, the spel creates a single string.

Assignment operators

Assign a value to a name. (more...)

=
simple assignment

+=>
Compound addition

-=
Compound subtraction

*=
Compound multiplication

/=
Compound division

%=
Compound modulo

Statements

Conditional statements are evaluated condition where are compared values, Example: if (x % 2 == 0)

FOR

Loops are used in performing repetitive task in programming.

WHILE

Loop statement in programming language repeatedly executes a target statement as long as a given condition

Functions


downcase	exec	format	getenv	gsub
is_empty	is_null	misc:find_mang	now	sindex
strlen	substr	upcase	workshift_abs2work	workshift_work2abs
send_wait	send	send_catch	workshift_validate
sendf	sendf_wait	sendf_catch	free_context	wait_context
logf	printf	split	extract	expand
getenv	setenv	access	event	class
sleep	switch	break	continue	set_ilimit
return	set_error	set_return_data	tobase64	thread_userid
format_to_js	dump_args	send_frame_resp	thread_object_ptr	clear_return_data
find_msg	get_pos_date	add_time_animator	delete_animator	fork
tz_delta	thread_session_id	thread_id	spell_object	is_server
setval_by_name	set_workflow	set_properties	set_thread_userid	rpc_object
is_client	getval_by_name	getval_from_context	get_servlet_path	get_background_server
get_notify_contacts_list	get_multi_tenancy_option	get_gmt_date	create_process	create_icalendar
context_set_error	context_error_text	check_process

SPEL API methods


update_object_super	insert_object	delete_wc	get_access_for_contact	get_func_access
get_system_users	get_attr_list_for_object	get_attr_information	get_object_values	generic_activity_log
notify_contacts	add_request	add_change_order	add_issue	get_valid_tasks_wc
get_workflow	get_list	get_list_values	get_val_for_wc	generic_status_change
get_properties	update_object	get_list_length	api_select_count	fetch_more
delete_workflow	add_contact	add_workflow

msg_lenght()
msg_length(), which returns length of msg array after send_wait usage Example Code: for (i=0;i<msg_length();i++) { logf(SIGNIFICANT, "msg[%d]: '%s'", i, msg[i]); }

msg_lenght()

msg_length(), which returns length of msg array after send_wait usage

Example Code:

for (i=0;i<msg_length();i++) {

logf(SIGNIFICANT, "msg[%d]: '%s'", i, msg[i]);

}

upd_val
SPEL: Object update upd_val, update objects Example code: macro::upd_val("iss", // object factory format("id=%d",other_issue_id), // where clause to get object (or objects) 30, // delay to new retry if first iteration fails 3, // amount of retries "summary", // attribute to update "test 1", // new value "description", // another attr "test 2", // another value "z_etc_param", // amount of attributes that can be updated in 1 iteration is infinite "here is etc value"); // value can be string, integer or anything else.

upd_val

SPEL: Object update

upd_val, update objects

Example code:

macro::upd_val("iss", // object factory
format("id=%d",other_issue_id), // where clause to get object (or objects)
30, // delay to new retry if first iteration fails
3, // amount of retries
"summary", // attribute to update
"test 1", // new value
"description", // another attr
"test 2", // another value
"z_etc_param", // amount of attributes that can be updated in 1 iteration is infinite
"here is etc value"); // value can be string, integer or anything else.

Spel files and Advanced Availability
1. create your files 2. run pdm_server control -b on standby it will become background 3. run pdm_server_control -v on standby former background 4. run pdm_server control -b on standby former background it will become background 5. restart standby and application servers By Gutis

Spel files and Advanced Availability

1. create your files

2. run pdm_server control -b on standby it will become background

3. run pdm_server_control -v on standby former background

4. run pdm_server control -b on standby former background it will become background

5. restart standby and application servers

By Gutis

Makes SPEL code easier to understand

References - To find out more about Spell, then go to:

http://www.servicedeskusers.com/Spel_Reference_Guide

http://www.servicedeskusers.com/Get_dob_Spell_method

Technical Reference Guide Release 12.9.00