Provisioning Interfaces

4 Provisioning Interfaces

This chapter describes the following provisioning (upstream) interfaces:

SARM Configuration Interface

SARM Configuration Interface

This section covers the functions for the SARM and includes the following subsections:

Static Table Configuration

To interface to the static configuration database tables, use the function-based interface instead of SQL insert scripts.

The function-based interface reduces the dependency between administrators who configure the system and product developers who need to make changes to the static tables to support new functionality.

This section lists the syntax, descriptions, parameters, and results for the SARM configurations and includes the delete, list, and new procedures interface definitions.

SSP_db_admin

This function performs customer-specific database administration functions, such as purging the database of completed orders, and removing orphaned definitions from the SARM database.

For more information on this function and database purging, refer to the ASAP System Administrator's Guide.

For more information about using functions, see "Oracle Examples."

Affected tables:

tbl_wrk_ord
tbl_asap_stats
tbl_info_parm
tbl_srq
tbl_srq_csdl
tbl_srq_log
tbl_asdl_log
tbl_srq_parm
tbl_srq_asdl_parm
tbl_wo_event_queue
tbl_wo_audit
tbl_usr_wo_prop
tbl_aux_wo_prop

Table 4-1 SSP_db_admin Parameters

Name	Description	Req'd	(I)nput/ (O)utput
days	Specifies the age (in days) of work orders to delete. All completed work orders older than the specified number of days are deleted.	Yes	I

SSP_gather_asap_stats

Gathers statistics for objects in the database (tbl_wrk_ord). The information includes the distribution of data, the number of rows in the table and other important statistics. Statistics gathering is governed by the following parameters in ASAP.cfg:

GATHER_STATS
GATHER_STATS_PROC
DB_PCT_ANALYZE
DB_PCT_ANALYZE_IDX
GATHER_DEGREE
DB_ADMIN_TIME

For more information about using functions, see "Oracle Examples."

Syntax:

SSP_gather_asap_stats(
a_tab_estimate_pct number,
a_ind_estimate_pct number,
a_degree number)

Table 4-2 SSP_del_asdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
a_tab_estimate_pct number	This parameter applies to Oracle only. It is used to update statistics on all user-defined tables. The updates are done when the database administrations tasks are performed. (See also DB_ADMIN_TIME.) This parameter is used to optimize the database query performance. The Oracle SQL statement is “analyze table table_name estimate statistics sample DB_PCT_ANALYZE percent". For further information, refer to “Analyze Command" in the Oracle SQL Reference manual.	Yes	I
a_ind_estimate_pct number	Percentage of the index to analyze when gathering statistics.	Yes	I
a_degree number	Degree of parallelism when gathering statistics. The degree parameter can take the value of auto_degree. When you specify the auto_degree, Oracle determines the degree of parallelism automatically. It will be either 1 (Running serially) or default_degree (the system default value based on number of CPUs and initialization parameters), according to the size of the object.	Yes	I

Name

Description

Req'd

(I)nput/(O)utput

a_tab_estimate_pct number

This parameter applies to Oracle only. It is used to update statistics on all user-defined tables. The updates are done when the database administrations tasks are performed. (See also DB_ADMIN_TIME.) This parameter is used to optimize the database query performance.

The Oracle SQL statement is “analyze table table_name estimate statistics sample DB_PCT_ANALYZE percent". For further information, refer to “Analyze Command" in the Oracle SQL Reference manual.

Yes

a_ind_estimate_pct number

Percentage of the index to analyze when gathering statistics.

Yes

a_degree number

Degree of parallelism when gathering statistics. The degree parameter can take the value of auto_degree.

When you specify the auto_degree, Oracle determines the degree of parallelism automatically. It will be either 1 (Running serially) or default_degree (the system default value based on number of CPUs and initialization parameters), according to the size of the object.

Yes

SSP_del_asdl_defn

This function deletes ASDL definitions from tbl_asdl_config. Wildcards are permitted.

Note:

If you do not specify an ASDL command, all ASDL command definitions are deleted from the configuration records.

Syntax:

var retval number;
exec :retval :=  SSP_del_asdl_defn ([‘asdl_cmd'])

Example:

var rc refcursor;
var retval number;
exec :retval :=  SSP_del_asdl_defn (:rc,‘M-CREATE_SINGLE_LINE_ACCESS');

This example removes the M-CREATE_SINGLE_LINE_ACCESS configuration record from the static configuration tables.

For more information about using functions, see "Oracle Examples."

Table 4-3 SSP_del_asdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
asdl_cmd	The ASDL command to be deleted.	No	I

SSP_del_asdl_map

This function deletes ASDL mappings from tbl_nep_asdl_prog. The mapping is based on the technology and software load.

For more information about using functions, see "Oracle Examples."

Syntax:

var retval number;
exec :retval :=  SSP_del_asdl_map [‘tech'] [, ‘sftwr_load'] [, ‘asdl_cmd']

Table 4-4 SSP_del_asdl_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
tech	The technology type of NE or SRP with which the Interpreter is to interact.	No	I
sftwr_load	The version of the software currently running on the NEP or SRP.	No	I
asdl_cmd	The ASDL command.	No	I

SSP_del_asdl_parm

This function deletes an ASDL parameter from tbl_asdl_parm.

Note:

If you do not enter a sequence number, all parameters associated with this ASDL command are deleted.

For more information about using functions, see "Oracle Examples."

This example removes the ASDL command parameter with the sequence number 4 from the configuration table for the command M-CREATE_SINGLE_LINE_ACCESS.

Table 4-5 SSP_del_asdl_parm Parameters

Name	Description	Req'd	(I)nput/(O)utput
asdl_cmd	The ASDL command.	No	I
parm_seq_no	The parameter sequence number.	No	I

SSP_del_clli_map

This function deletes a remote CLLI to host CLLI mapping in tbl_clli_route.

For more information about using functions, see "Oracle Examples."

Table 4-6 SSP_del_clli_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
mach_clli	The remote NE.	No	I
asdl_cmd	ASDL command.	No	I

SSP_del_comm_param

This function deletes communication parameter information from tbl_comm_param.

For more information about using functions, see "Oracle Examples."

Table 4-7 SSP_del_comm_param Parameters

Name	Description	Req'd	(I)nput/(O)utput
dev_type	The device type. Choose the type of connection from the following: D – Serial Port Dialup F – TCP/IP FTP Connection G – Generic Terminal Based Connection H – Serial Port Hardwired M – Generic Message Based Connection S – TCP/IP Socket Connection T – TCP/IP Telnet Connection W – LDAP Connection C – CORBA	No	I
host	Host CLLI. Set to COMMON_HOST_CFG or the host CLLI associated with the command processor. For a common host, the parameter value is the default value, otherwise, it is host-specific.	No	I
device	The physical or logical device name. Set to COMMON_DEVICE_CFG or the device associated with the command processor. For a common device, the parameter value is the default value, otherwise, it is device-specific.	No	I
param_label	Specifies the communication parameter label.	No	I
param_value	Specifies the communication parameter value.	No	I
param_desc	Specifies the communication parameter description.	No	I

SSP_del_csdl_asdl

This function deletes a CSDL-to-ASDL mapping definition from tbl_csdl_asdl.

Note:

If you do not specify an ASDL command sequence number, all mapping relationships for the specified CSDL command are removed from the configuration tables. If you do not specify a CSDL command, all mapping relationships are removed.

For more information about using functions, see "Oracle Examples."

Table 4-8 SSP_del_csdl_asdl Parameters

Name	Description	Req'd	(I)nput/(O)utput
csdl_cmd	The CSDL command.	No	I
asdl_seq_no	The sequence number of the ASDL command.	No	I

SSP_del_csdl_defn

This function deletes CSDL definitions from tbl_csdl_config.

Note:

If you do not specify a CSDL command, all CSDL command definitions are removed.

Syntax:

var retval number;
exec :retval :=  SSP_del_csdl_defn [‘csdl_cmd']

Example:

var retval number;
exec :retval :=  SSP_del_csdl_defn ‘M-CREATE_BUS_LINE'

The configuration record for M-CREATE_BUS_LINE is removed from the configuration tables.

For more information about using functions, see "Oracle Examples."

Table 4-9 SSP_del_csdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
csdl_cmd	The CSDL command.	No	I

SSP_del_dn_map

This function deletes a directory number mapping from tbl_nep_rte_asdl_nxx.

For more information about using functions, see "Oracle Examples."

Table 4-10 SSP_del_dn_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
asdl_cmd	The ASDL command identifier.	No	I
npa	The Numbering Plan Area code.	No	I
nxx	The Central Office code.	No	I
from_line	The lowest line number in the range.	No	I
to_line	The highest line number in the range.	No	I

SSP_del_id_routing

This function deletes a host NE and the ID_ROUTING mapping record from tbl_id_routing. Use this function when routing by ID_ROUTING is used.

For more information about using functions, see "Oracle Examples."

Table 4-11 SSP_del_id_routing Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier.	Yes	I
asdl_cmd	The ASDL command.	Yes	I
id_routing_from	The starting point of a range of ID_ROUTING.	Yes	I
id_routing_to	The end point of a range of ID_ROUTING.	Yes	I

SSP_del_intl_msg

This function deletes an international message record from the tbl_msg_convert.

If you do not specify a message identifier, all messages with the specified language code are deleted.

For more information about using functions, see "Oracle Examples."

Table 4-12 SSP_del_intl_msg Parameters

Name	Description	Req'd	(I)nput/(O)utput
lang_cd	The language code.	No	I
msg_id	The unique message identifier for the message to be removed from the SARM database.	No	I

The following example shows how to delete an international message:

var retval number;
exec :retval :=  SSP_del_intl_msg ‘USA', 1

This deletes American English message 1 from the SARM database.

SSP_del_ne_host

This function deletes a host NE definition from tbl_host_clli.

For more information about using functions, see "Oracle Examples."

Table 4-13 SSP_del_ne_host Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier of an NE or SRP.	No	I

SSP_del_nep

This function deletes an NEP secondary pool definition from tbl_nep.

For more information about using functions, see "Oracle Examples."

Table 4-14 SSP_del_nep Parameters

Name	Description	Req'd	(I)nput/(O)utput
nep_svr_cd	The NEP managing the secondary pool of devices.	No	I

SSP_del_nep_program

This function deletes the actions based on the specified program name and/or line number from tbl_nep_program.

If the line number is not supplied, all actions with positive line numbers are removed.

For more information about using functions, see "Oracle Examples."

Table 4-15 SSP_del_nep_program Parameters

Name	Description	Req'd	(I)nput/(O)utput
program	The program identifier.	Yes	I
line_no	The line number to delete. If set to NULL, all lines of the program are deleted.	No	I

SSP_del_net_elem

This function deletes an NE definition for an NEP from the SARM database.

This function deletes a network elements from tbl_ne_config.

For more information about using functions, see "Oracle Examples."

Table 4-16 SSP_del_net_elem Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier of an NE or SRP.	No	I
nep_svr_cd	The logical name of the NEP server that connects to the host NE.	No	I

SSP_del_resource

This function deletes a device from tbl_resource_pool.

For more information about using functions, see "Oracle Examples."

Table 4-17 SSP_del_resource Parameters

Name	Description	Req'd	(I)nput/(O)utput
asap_sys	The ASAP environment (TEST, PROD, and so on).	No	I
device	The physical or logical device name.	No	I

SSP_del_srp

This function deletes an SRP definition from the tbl_asap_srp.

For more information about using functions, see "Oracle Examples."

Table 4-18 SSP_del_srp Parameters

Name	Description	Req'd	(I)nput/(O)utput
srp_id	The logical SRP name.	No	I

SSP_del_stat_text

This function deletes static text labels used in the OCA GUI client from tbl_stat_text.

For more information about using functions, see "Oracle Examples."

Table 4-19 SSP_del_stat_text Parameters

Name	Description	Req'd	(I)nput/(O)utput
stat_id	The logical group of static text messages such as WO_STATE. If this is not specified, all entries in tbl_stat_text are deleted.	No	I
status	The integer identifier for member of logical grouping.	No	I
code	The string identifier for member of logical grouping.	No	I

SSP_del_user_err_threshold

This function deletes a user-defined error threshold or set of thresholds from tbl_user_err_threshold.

For more information about using functions, see "Oracle Examples."

Table 4-20 SSP_del_user_err_threshold Parameters

Name	Description	Req'd	(I)nput/(O)utput
host	The host NE identifier of an NE or SRP.	No	I
asdl_cmd	The ASDL command.	No	I
user_type	The user-defined error type.	No	I

SSP_del_userid

This function deletes a user ID from tbl_uid_pwd.

For more information about using functions, see "Oracle Examples."

Table 4-21 SSP_del_userid Parameters

Name	Description	Req'd	(I)nput/(O)utput
uid	The user ID.	No	I

SSP_get_async_ne

This function returns the names of all the NEs that have a ASYNC_CONN communication parameter defined with a value of TRUE or FALSE. The existence of a parameter labeled ASYNC_CONN indicates that the NE has an asynchronous interface. The parameter value of TRUE or FALSE indicates whether the NEP server should establish an NE element connection at NEP start-up. This function has no input parameters.

For more information about using functions, see "Oracle Examples."

Table 4-22 SSP_get_async_ne Parameters

Name	Description	Req'd	(I)nput/(O)utput
host	The host name of the NE having an ASYNCH_CONN communication parameter defined.	No	O
param_value	Value of the ASYNCH_CONN parameter - either TRUE or FALSE. Indicates whether the NEP server should establish an NE element connection at NEP start-up.	No	O

SSP_get_user_routing

This function returns a Host NE (host_clli) that is used to route the ASDL from tbl_user_routing. You must write this function and the associated database table based on the pre-defined interfaces and your own routing algorithm when using a user-defined routing.

For more information about using functions, see "Oracle Examples."

Table 4-23 SSP_get_user_routing Parameters

Name	Description	Req'd	(I)nput/(O)utput
user_routing	The USER_ROUTING defined as a work order parameter.	No	I
asdl_cmd	The ASDL command.	No	I
host_clli	The host NE identifier to be routed. If it fails to find the host NE associated with the USER_ROUTING, it returns NULL.	No	O

SSP_list_asdl

This function retrieves ASDL-related information from tbl_asdl_config, tbl_asdl_parm, tbl_nep_asdl_prog.

For more information about using functions, see "Oracle Examples."

Table 4-24 SSP_list_asdl Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
RC2	Oracle Database Ref Cursor.	Yes	I/O
RC3	Oracle Database Ref Cursor.	Yes	I/O
asdl	The name of the ASDL.	No	I

The shaded groupings below indicate that multiple result sets are returned: in this case, three sets of data.

For more information about using functions, see "Oracle Examples."

Table 4-25 SSP_list_asdl Results

Name	Datatype	Description
reverse_asdl	TYP_asdl_cmd	reverse ASDL command
ignore_rollback	TYP_yes_no	ignore rollback flag
route_flag	TYP_route	ASDL routing flag
description	varchar(40)	ASDL command description
asdl_lbl	TYP_parm_lbl	ASDL parameter label
csdl_lbl	TYP_parm_lbl	CSDL parameter label
param_typ	TYP_parm_typ	ASDL parameter type
default_vlu	TYP_parm_vlu	ASDL parameter default value
tech	TYP_tech	technology
sftwr_load	TYP_load	software loads
program	TYP_program	ASDL program

SSP_list_asdl_defn

This function lists all or specific ASDL definitions from the SARM database (tbl_asdl_config, tbl_csdl_asdl). You can use wildcards in this procedure. If you do not specify a parameter, all ASDL definitions are returned.

Syntax:

var rc refcursor;
var retval number;
exec :retval :=  SSP_list_asdl_defn (:rc[,‘asdl_cmd']);
print rc;

Example:

var rc refcursor;
var retval number;
exec :retval := SSP_list_asdl_defn (:rc,'M-CREATE_SINGLE_LINE_ACCESS');
print rc;

The following example lists the information for M-SINGLE_LINE_ACCESS:

asdl_cmd                       reverse_asdl                   ignore_rollback route_flag description                              
-------- ---------- ---------------------------------------- 
M-CREATE_SINGLE_LINE_ACCESS  M-DELETE_SINGLE_LINE_ACCESS    N               B       Create a single-line access service.
(1 row affected, return status = 0)

For more information about using functions, see "Oracle Examples."

Table 4-26 SSP_list_asdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
asdl_cmd	The ASDL command identifier.	No	I

Table 4-27 SSP_list_asdl_defn Results

Name	Datatype	Description
asdl_cmd	TYP_asdl_cmd	ASDL command.
reverse_asdl	TYP_asdl_cmd	Reverse ASDL command.
ignore_rollback	TYP_yes_no	Ignore rollback flag.
route_flag	TYP_route	ASDL routing flag.
description	varchar(40)	ASDL command description.

SSP_list_asdl_map

This function lists ASDL mappings according to various criteria. All parameters take wildcards. This function retrieves asdl mapping information from tbl_nep_asdl_prog.

Syntax:

var rc1 refcurson;
var retval number;
exec :retval :=  SSP_list_asdl_map (:RC1) [, ‘tech'] [, ‘sftwr_load'] [, ‘asdl_cmd'] [, ‘interpreter_type']

For more information about using functions, see "Oracle Examples."

Table 4-28 SSP_list_asdl_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
tech	The technology type of the NE or SRP with which the Interpreter is to interact.	No	I
sftwr_load	The version of the software currently running on the NEP or SRP.	No	I
asdl_cmd	The ASDL command. Wildcards are accepted.	No	I
program	The SASDLprogram.	No	I
interpreter_type	A value of J indicates a JInterpreter.	No	I

Table 4-29 SSP_list_asdl_map Results

Name	Datatype	Description
tech	TYP_tech	Technology.
sftwr_load	TYP_load	Software loads.
asdl_cmd	TYP_asdl_cmd	ASDL command.
program	TYP_program	ASDL program.

SSP_list_asdl_parm

This function lists ASDL parameters from the SARM database (tbl_asdl_parm) by ASDL command name and/or ASDL parameter label. Wildcards are allowed.

Syntax:

var rc1 refcurson;
var retval number;
exec :retval :=  SSP_list_asdl_parm (:RC1) [, ‘asdl_cmd'] [, ‘asdl_parm_lbl']

Example:

var rc refcurson;
var retval number;
exec :retval :=  SSP_list_asdl_parm ‘M-CREATE_SINGLE_LINE_ACCESS', ‘NPA'

This example retrieves configuration information for the NPA parameter for the ASDL command M-CREATE_SINGLE_LINE_ACCESS.

For more information about using functions, see "Oracle Examples."

Table 4-30 SSP_list_asdl_parm Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
asdl_cmd	The ASDL command.	No	I
asdl_parm_lbl	The ASDL parameter label.	No	I

Table 4-31 SSP_list_asdl_parm Results

Name	Datatype	Description
asdl_cmd	TYP_asdl_cmd	ASDL command.
parm_seq_no	TYP_seq_no	ASDL parameter number.
asdl_lbl	TYP_parm_lbl	ASDL parameter label.
csdl_lbl	TYP_parm_lbl	CSDL parameter label.
default_vlu	TYP_parm_vlu	ASDL parameter default value.
param_typ	TYP_parm_typ	ASDL parameter type.

SSP_list_clli_map

This function lists remote CLLI-to-Host CLLI mapping definitions that are contained in tbl_clli_route. All parameters take wildcards.

For more information about using functions, see "Oracle Examples."

Table 4-32 SSP_list_clli_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
mach_clli	The remote NE.	No	I
host_clli	The host NE identifier of an NE or SRP.	No	I

Table 4-33 SSP_list_clli_map Results

Name	Datatype	Description
mach_clli	TYP_clli	Remote NE.
host_clli	TYP_clli	Host NE.
asdl_cmd	TYP_asdl_cmd	ASDL command identifier.

SSP_list_comm_param

This function lists communication parameters based on dev_type, host, device, param_label, or for all of them. This information is retrieved from tbl_comm_param.

For more information about using functions, see "Oracle Examples".

Table 4-34 SSP_list_comm_param Parameters

Name	Description	Req'd	(I)nput/ (O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
dev_type	The device type. Choose from the following types of connections: D – Serial Port Dialup F – TCP/IP FTP Connection G – Generic Terminal Based Connection H – Serial Port Hardwired M – Generic Message Based Connection S – TCP/IP Socket Connection T – TCP/IP Telnet Connection W – LDAP Connection C – CORBA	No	I
host	The host CLLI. It is set to COMMON_HOST_CFG or the host CLLI associated with the command processor. If a common host, the parameter value is the default value, otherwise, it is host-specific.	No	I
device	The physical or logical device (port) name. Set to COMMON_DEVICE_CFG or the device associated with the command processor. If a common device, the parameter value is the default value, otherwise, it is device-specific.	No	I
param_label	The communication parameter label.	No	I

Table 4-35 SSP_list_comm_param Results

Name	Datatype	Description
dev_type	TYP_dev_type	Type of connection. Choose from: D – Serial Port Dialup F – TCP/IP FTP Connection G – Generic Terminal Based Connection H – Serial Port Hardwired M – Generic Message Based Connection S – TCP/IP Socket Connection T – TCP/IP Telnet Connection W – LDAP Connection
host	TYP_clli	Host CLLI. It is set to COMMON_HOST_CFG or the host CLLI associated with the command processor. If a common host, the parameter value is the default value, otherwise, it is host-specific.
device	TYP_device	The physical or logical device name. Set to COMMON_DEVICE_CFG or the device associated with the command processor. If a common device, the parameter value is the default value, otherwise, it is device-specific.
param_label	TYP_parm_lbl	Specifies the communication parameter label.
param_value	TYP_perf_parm_vlu	Specifies the communication parameter value.
param_desc	TYP_parm_desc	Specifies the communication parameter description.

SSP_list_csdl

This function retrieves CSDL-related information from tables tbl_csdl_config and tbl_csdl_asdl.

For more information about using functions, see "Oracle Examples."

Table 4-36 SSP_list_csdl Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
RC2	Oracle Database Ref Cursor.	Yes	I/O
csdl	The name of the CSDL.	Yes	I

Table 4-37 SSP_list_csdl Results

Name	Datatype	Description
asdl_cmd	TYP_asdl_cmd	ASDL command.
cond_flag	TYP_cond_flag	Condition flag.
label	TYP_parm_lbl	Parameter label to test the condition flag.
value	TYP_parm_vlu	Parameter value associated with the label.
rollback_req	TYP_yes_no	Flag indicating whether rollback is required.
csdl_level	TYP_csdl_level	The level of the CSDL in the SRQ. An integer between 0 and 255 that indicates the sequence level for the CSDL command within the work order. The SARM uses this integer to determine the order in which to provision CSDL commands from an SRP and then provisions CSDL commands that have lower level numbers first. Sequence levels are only relevant for inter-dependent CSDL commands.
fail_event	TYP_code	The system event to be triggered upon CSDL failure.
complete event	TYP_code	The system event to be triggered upon CSDL completion.
option_asdl	TYP_seq_no	Not used.
description	varchar(40)	ASDL command description.

SSP_list_csdl_asdl

This function lists CSDL-to-ASDL mapping definitions contained in tbl_csdl_asdl. Wildcards are allowed.

Syntax:

var rc refcursor;
var retval number;
exec :retval :=  SSP_list_csdl_asdl (:rc [,'csdl_cmd'] [, 'base_seq_no'] [,'asdl_cmd'] [,'cond_flag'] [,'parm_lbl'] [,'parm_vlu'] [,'eval_exp'])

Example:

var rc refcursor;
var retval number;
exec :retval :=  SSP_list_csdl_asdl (:rc,'M-CREATE_BUS_LINE');

This example lists all mapping relationships associated with the CSDL command M-CREATE_BUS_LINE as follows:

csdl_cmd                  asdl_seq_no asdl_cmd                              cond_flag label     
value                                                                                                                                                                                                                                                           
---------- ------------------------------ --------- -------- 
M-CREATE_BUS_LINE                   1 
M-CLEAR_INTERCEPT              A                                  
M-CREATE_BUS_LINE                   2 
M-CREATE_SINGLE_LINE_ACCESS    A                                  
M-CREATE_BUS_LINE                   3 ADD_ALWAYS_ON_3WC              D         ALWAYS_ON_AREA           
M-CREATE_BUS_LINE                   4 ADD_ALWAYS_ON_CRT              D         ALWAYS_ON_AREA

(4 rows affected, return status = 0)

Table 4-38 SSP_list_csdl_asdl Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
csdl_cmd	The CSDL command.	No	I
asdl_cmd	The ASDL command.	No	I
cond_flag	Used to specify conditions that need to be met in order for the SARM to generate the ASDL command for the CSDL command. Type one of the following values: A – Always generates the ASDL command for the CSDL command D – Generates the ASDL command if the CSDL parameter is defined (present) N – Generates the ASDL command if the CSDL parameter is not defined (present) E – Generates the ASDL command if the CSDL parameter is defined and equal to a value. The generation of each ASDL command depends upon the results of the previous ASDL. When the previous command completes successfully, it returns parameters to the SARM. When using ‘cond_flag'='E', the following values are required: ‘lbl1' ‘lbl2' ‘val1' ‘val2' When using ‘cond_flag'='D' or ‘N', the following values are required: ‘lbl1' ‘lbl2'	No	I
parm_lbl and parm_vlu parameters	Required when you use CSDL parameter-dependent conditions. Set the CSDL command parameter name for ‘D', ‘N', and ‘E' condition flags using parm_lbl. The ‘E' condition flag checks that the CSDL command parameter is equal to the value specified by parm_vlu. For more information about these condition flags, refer to the previous parameter, cond_flag.	No	I
eval_exp	Contains combination of parameter names, operators, and values to which the parameters are compared.	No	I

Table 4-39 SSP_list_csdl_asdl Results

Name	Datatype	Description
csdl_cmd	TYP_csdl_cmd	CSDL command name.
asdl_seq_no	TYP_seq_no	ASDL command sequence number.
asdl_cmd	TYP_asdl_cmd	ASDL command.
cond_flag	TYP_cond_flag	Specifies conditions that need to be met for the SARM to generate the ASDL command for the CSDL command. One of the following values: A – Always generates the ASDL command for the CSDL command D – Generates the ASDL command if the CSDL parameter is defined (present) N – Generates the ASDL command if the CSDL parameter is not defined (present) E – Generates the ASDL command if the CSDL parameter is defined and equal to a value. Each ASDL command generation depends upon the results of previous ASDL commands on the work order which returned parameters to the SARM upon successful ASDL command completion. When using ‘cond_flag'='E', the following values are required: ‘lbl1' ‘lbl2' ‘val1' ‘val2' When using ‘cond_flag'='D' or ‘N', the following values are required: ‘lbl1' ‘lbl2'
label	TYP_parm_lbl	Parameter label to test the condition flag.
value	TYP_parm_vlu	Parameter value associated with the label.

SSP_list_csdl_defn

This function lists configuration information for the CSDL command you specify from the SARM database (tbl_csdl_config). This information includes the rollback flag, CSDL command sequence number, fail and completion events, and a description of the command. If you do not specify a CSDL command, the procedure returns information on all CSDL commands currently defined in the SARM.

Syntax:

exec :retval := SSP_list_csdl_defn (:RC1[, ‘csdl_cmd']

Example:

var rc refcusror;
var retval number;
exec :retval :=  SSP_list_csdl_defn (:rc,‘M-CREATE_BUS_LINE')

For more information about using functions, see "Oracle Examples."

Table 4-40 SSP_list_csdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
csdl_cmd	The CSDL command identifier.	No	I

Table 4-41 SSP_list_csdl_defn Results

Name	Datatype	Description
csdl_cmd	TYP_csdl_cmd	CSDL command name.
rollback_req	TYP_yes_no	Flag indicating whether rollback is required.
csdl_level	TYP_csdl_level	The level of the CSDL in the SRQ. An integer between 0 and 255 that indicates the sequence level for the CSDL command within the work order. The SARM uses this integer to determine the order in which to provision CSDL commands from an SRP and then provisions CSDL commands that have lower level numbers first. Sequence levels are only relevant for inter-dependent CSDL commands.
fail_event	TYP_code	The system event to be triggered upon CSDL failure.
complete_event	TYP_code	The system event to be triggered upon CSDL completion.
description	varchar(40)	ASDL command description.

SSP_list_dn_map

This function lists directory mappings for ASDL command, directory, exchange number, or for all of them from tbl_nep_rte_asdl_nxx.

For more information about using functions, see "Oracle Examples."

Table 4-42 SSP_list_dn_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
asdl_cmd	The ASDL command.	No	I
npa	The Numbering Plan Area code.	No	I
nxx	The Central Office code.	No	I

Table 4-43 SSP_list_dn_map Results

Name	Datatype	Description
asdl_cmd	TYP_asdl_cmd	ASDL command identifier.
npa	TYP_npa	The Numbering Plan Area code.
nxx	TYP_nxx	The Central Office code.
from_line	TYP_line	Beginning LINE of DN range.
to_line	TYP_line	End LINE of DN range.
queue_nm	TYP_clli	Host NE to which the DN routing applies.

SSP_list_host

This function retrieves host-related information from the following tables: tbl_resource_pool, tbl_ne_config, tbl_clli_route.

For more information about using functions, see "Oracle Examples."

Table 4-44 SSP_list_host Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
RC2	Oracle Database Ref Cursor.	Yes	I/O
host	The host CLLI identifier.	Yes	I

Table 4-45 SSP_list_host Results

Name	Datatype	Description
device	TYP_device	The name of the logical device to be used to establish a connection to the NE.
line_type	TYP_dev_type	The communication protocol used by the specified device.
vs_key	TYP_long	Reserved. The shared memory segment identifier for the Virtual Screen buffer.
mach_clli	TYP_clli	The remote NE identifier.
asdl_cmd	TYP_asdl_cmd	The ASDL command.

SSP_list_id_routing

This function lists the host NE and the ID_ROUTING mapping record in tbl_id_routing. You can use this function when routing by ID_ROUTING is used.

For more information about using functions, see "Oracle Examples."

Table 4-46 SSP_list_id_routing Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	No	I/O
host_clli	The host NE identifier.	Yes	I

Table 4-47 SSP_list_id_routing Results

Name	Datatype	Description
host_clli	TYP_clli	The host NE identifier.
asdl_cmd	TYP_asdl_cmd	The ASDL command.
id_routing_from	Varchar	The starting point of a range of ID_ROUTING.
id_routing_to	Varchar	The end point of a range of ID_ROUTING.

SSP_list_intl_msg

This function lists the international message records from tbl_msg_convert. It either lists all messages for a specified language or, if you specify a message identifier, a single record.

A list of core ASAP messages is contained in the ASAP System Administrator's Guide.

For more information about using functions, see "Oracle Examples."

Table 4-48 SSP_list_intl_msg Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
lang_cd	The language code.	No	I
msg_id	Unique message identifier.	No	I

Table 4-49 SSP_list_intl_msg Results

Name	Datatype	Description
lang_cd	TYP_lang_cd	The language code.
msg_id	TYP_unid	Message identifier.
msg_type	TYP_msg_typ	Message formatting types: D – Dynamic S – Static
message	varchar(255)	Message text.
var_description	varchar(40)	Description of the substitute fields.
wo_audit	TYP_wo_audit	Destination for the log message.

SSP_list_ne_host

This function lists host NE definitions from tbl_host_clli. Wildcards are allowed.

For more information about using functions, see "Oracle Examples."

Table 4-50 SSP_list_ne_host Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
host_clli	The host NE identifier of an NE or SRP.	No	I

Table 4-51 SSP_list_ne_host Results

Name	Datatype	Description
host_clli	TYP_clli	The host NE identifier of an NE or SRP.
tech_type	TYP_tech	Technology type.
sftwr_load	TYP_load	Software loads.

SSP_list_nep

This function lists NEP secondary pool definitions, stored in tbl_nep. Wildcards are allowed.

For more information about using functions, see "Oracle Examples."

Table 4-52 SSP_list_nep Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
nep_svr_cd	The NEP managing the secondary pool of devices.	No	I

Table 4-53 SSP_list_nep Results

Name	Datatype	Description
nep_svr_cd	TYP_code	The NEP managing the secondary pool of devices.
dialup_pool	TYP_pool	Secondary pool of devices.

SSP_list_nep_program

This function lists the program to be used within the Interpreter. This information is retrieved from tbl_nep_program.

For more information about using functions, see "Oracle Examples."

Table 4-54 SSP_list_nep_program Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
program	The program name.	No	I

Table 4-55 SSP_list_nep_program Results

Name	Datatype	Description
program	TYP_program	The name of the NEP program.
line_no	int	The line number in the NEP program.
action	TYP_action	The action string used to identify the action performed by the Interpreter in the command processor.
act_string	TYP_action_string	The action string associated with the NEP action.
act_int	int	The action integer which represents the next line number in the NEP program at which the NEP program should continue, or a numeric field specific to the particular action function.

SSP_list_net_elem

This function lists NE definitions based on the host NE and/or NEP server you specify. This function lists NE definitions from tbl_ne_config. Wildcards are allowed.

For more information about using functions, see "Oracle Examples."

Table 4-56 SSP_list_net_elem Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
host_clli	The host NE identifier of an NE or SRP.	No	I
nep_svr_cd	The logical name of the NEP server that connects to this host NE.	No	I

Table 4-57 SSP_list_net_elem Results

Name	Datatype	Description
host_clli	TYP_clli	The host NE.
nep_svr_cd	TYP_code	The logical name of the NEP server that connects to this host NE.
primary_pool	TYP_pool	The primary resource pool used by the NEP managing this host NE.
max_connections	TYP_short	The maximum number of concurrent connections allowed to this host NE.
drop_timeout	TYP_short	The maximum inactivity (in minutes) before the NEP drops the primary connection to this host NE.
spawn_threshold	TYP_short	The number of ASDL requests in the SARM ASDL Ready Queue at which point the NEP opens a new auxiliary connection to the destination NE.
kill_threshold	TYP_short	The number of ASDL requests in the SARM ASDL Ready Queue. When the number of requests reaches the terminate threshold, the SARM disconnects one or more auxiliary connections.
template_flag	TYP_short	Flag to indicate if this network element entry identifies a static NE (N) or a dynamic network element template (Y).

SSP_list_resource

This function lists NEP resource records from tbl_resource_pool. Wildcards are allowed.

For more information about using functions, see "Oracle Examples."

Table 4-58 SSP_list_resource Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
asap_sys	The ASAP environment (for instance, “TEST", “PROD").	No	I
pool	The pool name.	No	I
device	The physical or logical device name.	No	I

Table 4-59 SSP_list_resource Results

Name	Datatype	Description
asap_sys	TYP_code	The ASAP environment.
pool	TYP_pool	The pool name.
device	TYP_device	The physical or logical device name.
line_type	TYP_dev_type	The device type.
vs_key	TYP_long	Reserved. The shared memory segment identifier for the Virtual Screen buffer.

SSP_list_srp

This function lists SRP definitions from tbl_asap_srp. Wildcards are allowed.

For more information about using functions, see "Oracle Examples."

Table 4-60 SSP_list_srp Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
srp_id	The logical SRP name.	No	I

Table 4-61 SSP_list_srp Results

Name	Datatype	Description
srp_id	TYP_code	The logical SRP name.
srp_desc	varchar(40)	The SRP description.
srp_conn_type	TYP_srp_conn_type	Connection protocol for the SARM to SRP.
srp_host_name	TYP_host_name	Name of the machine that the SRP resides upon.
srp_host_port	TYP_host_port	The port number that the SRP is listening on for socket connections.
wo_estimate_evt	TYP_code	The work order estimate notification event.
wo_failure_evt	TYP_code	The work order failure notification event.
wo_complete_evt	TYP_code	The work order completion notification event.
wo_start_evt	TYP_code	The work order startup notification event.
wo_soft_err_evt	TYP_code	The work order soft error notification event.
wo_blocked_evt	TYP_code	The work order blocked notification event.
wo_rollback_evt	TYP_code	The work order rollback notification event.
wo_timeout_evt	TYP_code	The work order timeout notification event.
wo_accept_evt	TYP_code	The work order acceptance notification event.
ne_unknown_evt	TYP_code	The unknown NE notification event.
ne_avail_evt	TYP_code	The NE available notification event.
ne_unavail_evt	TYP_code	The NE unavailable notification event.
aux_srp_id	TYP_code	The name of the sister SRP.
aux_srp_conn_type	TYP_srp_conn_type	Connection protocol for SARM to auxiliary SRP communications.
aux_srp_host_name	TYP_host_name	Name of the machine that the auxiliary SRP resides upon.
aux_srp_host_port	TYP_host_port	The number of the port that the auxiliary SRP is listening on for socket connections.

SSP_list_stat_text

This function is used to list static text located in tbl_stat_text. This information is retrieved from tbl_stat_text.

For more information about using functions, see "Oracle Examples."

Table 4-62 SSP_list_stat_text Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
stat_id	The logical group of static text messages such as WO_STATE. If this is not specified, all entries in tbl_stat_text are listed.	No	I

Table 4-63 SSP_list_stat_text Results

Name	Datatype	Description
srp_id	TYP_code	The logical SRP name.
status	TYP_stat	Integer key field for grouping.
code	TYP_stat_code	String key field for grouping.
stat_text	TYP_stat_txt	Text describing the label.

SSP_list_user_err_threshold

This function is used to list the user-defined error thresholds for a specific NE, ASDL command, and user error type. This information is retrieved from tbl_user_err_threshold.

For more information about using functions, see "Oracle Examples."

Table 4-64 SSP_list_user_err_threshold Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
host	The host NE identifier of an NE or SRP.	No	I
asdl_cmd	The ASDL command.	No	I
user_type	The user-defined error type.	No	I

Table 4-65 SSP_list_user_err_threshold Results

Name	Datatype	Description
host_clli	TYP_clli	Host NE.
asdl_cmd	TYP_asdl_cmd	ASDL command.
user_type	TYP_code	User-defined type.
minor_threshold	int	Minor event threshold.
minor_event	TYP_code	System event to be triggered when the minor threshold is reached.
major_threshold	int	Major event threshold.
major_event	TYP_code	System event to be triggered when the major threshold is reached.
critical_threshold	int	Critical event notification threshold.
critical_event	TYP_code	System event to be triggered when the critical threshold is reached.

SSP_list_userid

This function lists user ID definitions from tbl_uid_pwd for the SARM security check logic in the SARM connect handler. You can use this procedure to validate SRP connections to the SARM. Wildcards are allowed.

For more information about using functions, see "Oracle Examples."

Table 4-66 SSP_list_userid Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
uid	The user ID.	No	I

Table 4-67 SSP_list_userid Results

Name	Datatype	Description
uid	TYP_user_id	The user ID.
pwd	TYP_pwd	User password.
status	varchar(40)	User's current status.

SSP_ne_monitor

This is an ASAP function.

SSP_new_asdl_defn

This function defines an ASDL configuration record to tbl_asdl_config.

Syntax:

exec :retval :=  SSP_new_asdl_defn (‘asdl_cmd',‘reverse_asdl',‘ignore_rollback',‘route_flag',‘[description]')

Example:

exec :retval :=  SSP_new_asdl_defn (‘M-CREATE_SINGLE_LINE_ACCESS',‘M-DELETE_SINGLE_LINE_ACCESS',‘N',‘B',‘Create a single-line access service.')

For more information about using functions, see "Oracle Examples."

This example defines the ASDL command M-CREATE_SINGLE_LINE_ACCESS and routes it to the NEP. If the ASDL command fails, rollback is initiated and the ASDL command M-DELETE_SINGLE_LINE_ACCESS is generated using the parameters from the normal ASDL command.

Table 4-68 SSP_new_asdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
asdl_cmd	The ASDL command.	Yes	I
reverse_asdl	The reverse ASDL to be invoked should this ASDL require rollback. This ASDL command is only issued if the ignore_rollback flag is set to ‘N'.	Yes	I
ignore_rollback	Specifies whether or not to rollback the ASDL command. If you want rollback to be performed on the ASDL command, set this flag to ‘N', as well as specifying the reverse ASDL command.	Yes	I
route_flag	The routing of the ASDL, where: N – Routes the ASDL to the NEP. This is the only valid value.	Yes	I
description	A brief description of the ASDL command.	No	I

SSP_new_asdl_map

This function adds a new ASDL command based on the technology and software load in tbl_nep_asdl_prog. The ASDL command must be defined in the configuration records in order for this function to add a new mapping.

Syntax:

exec :retval :=  SSP_new_asdl_map ('tech',‘sftwr_load',‘asdl_cmd',‘program',‘interpreter_type')

Example:

exec :retval :=  SSP_new_asdl_map (‘DMS',‘BCS33',‘M-CREATE_SINGLE_LINE_ACCESS',‘NEW_LINE_SINGLE',‘S')

This example inserts a mapping for the ASDL command M-CREATE_SINGLE_LINE_ACCESS for a DMS switch operating with software load BCS33. For these particular conditions, the Interpreter invokes the program NEW_LINE_SINGLE.

For more information about using functions, see "Oracle Examples."

Table 4-69 SSP_new_asdl_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
tech	The technology type of the NE or SRP with which the Interpreter is to interact.	Yes	I
sftwr_load	The version of the software currently running on the NEP or SRP.	Yes	I
asdl_cmd	The ASDL command.	Yes	I
program	The program name.	Yes	I
interpreter_type	A value of 'J' indicates a JInterpreter.	Yes	I

SSP_new_asdl_parm

This function defines up to nine ASDL parameters for the specified ASDL command starting at base_seq_no in the SARM database parameters.

You cannot add an ASDL command parameter unless the configuration record for the ASDL command has been defined in the SARM database. This ensures data consistency in the static tables.

This function adds new ASDL parameters for a specified ASDL to tbl_asdl_parm.

Syntax:

exec :retval :=  SSP_new_asdl_parm (‘asdl_cmd',‘base_seq_no',‘asdl_parm_lbl',‘csdl_parm_lbl',‘[def_vlu]',‘[parm_typ]',‘asdl_parm_lbl'],‘csdl_parm_lbl', ‘[def_vlu]','[parm_typ]'...)

Example:

In the following example, seven parameters are added to the ASDL command M-CREATE_SINGLE_LINE_ACCESS, starting with parameter sequence number 1. All parameters are required, and the INPA defaults to 506 if it is not supplied. All other parameters result in a SARM translation error if the parameter is not supplied.

exec :retval :=  SSP_new_asdl_parm (‘M-CREATE_SINGLE_LINE_ACCESS', 1,

‘NPA', ‘INPA', ‘506', ‘R',
‘NXX', ‘INXX', ‘', ‘R',
‘LINE', ‘ILINE', ‘', ‘R',
‘EXT', ‘IEXT', ‘', ‘R',
‘LEN', ‘ILEN', ‘', ‘R',
‘MCLI', ‘IMCLI', ‘', ‘R',
‘TYPE', ‘TYPE', ‘', ‘R'
‘SUBSCRIPTION[++]', ‘SUBSCRIBER', ‘', ‘C')

For more information about using functions, see "Oracle Examples."

Table 4-70 SSP_new_asdl_parm Parameters

Name	Description	Req'd	(I)nput/(O)utput
asdl_cmd	The ASDL command to add parameters to. You can add up to nine parameters to asdl_cmd.	Yes	I
base_seq_no	Starting with a base parameter sequence number (). If you add new parameters to an existing ASDL command, enter the next available sequence number for the base_seq_no so that existing parameters are not overwritten.	Yes	I
asdl_parm_lbl	ASDL command parameter is transmitted to the NEP with the parameter value. The type of value for this parameter depends on the parameter format you chose: Scalar asdl_parm_lbl – Specifies the parameter label that is sent on the ASDL command. Compound asdl_parm_lbl – Specifies the base name for the parameter that is sent on the ASDL command. Indexed asdl_parm_lbl – Is the base name for the indexed parameter to be sent on the ASDL command. The current index value is specified using the special literal “++".	Yes	I
csdl_parm_lbl	The parameter label either received from the SRP with the parameter value on the CSDL command or the WO parameter label returned from NEP. The label for this parameter depends on the parameter format you choose: Scalar csdl_parm_lbl – Specifies the CSDL command or global WO parameter label. Compound csdl_parm_lbl – Specifies the base name for the compound parameter in the CSDL command or global work order parameter list. Indexed csdl_parm_lbl – Specifies the base name for the indexed parameter in the CSDL command or global work order parameter list. To specify the current index, enter the special literal “++". The initial value is 1 and each ASDL command that is sent causes the value to increment until no more parameters are found at the current index.	Yes	I
def_vlu	The default value for the scalar parameter if it is not specified in the CSDL command or global parameter list. For compound parameters, a default value is not used if a mandatory value can be found.	No	I
parm_typ	Indicates the parameter format by using one of the following values: R – Required scalar parameter O – Optional scalar parameter C – Required compound parameter N – Optional compound parameter S – Parameter count. This value gives the Java method the total number of parameters associated with this ASDL command. I – Optional indexed parameter M – Mandatory indexed parameter X – Required XML Y – Optional XML P – Required XPATH Q – Optional XPATH + – Current index value for the ASDL command parameter. This value is transmitted to the NEP and equals the current index value for the indexed parameter. Note, the previous example makes use of a compound indexed parameter (‘SUBSCRIPTION[++]', ‘SUBSCRIBER', ‘', ‘C'). For more information on compound indexed parameters, refer to the ASAP Cartridge Development Guide.	No	I
al10	Reserved.	No	I

SSP_new_clli_map

This function defines a mapping from a remote CLLI to a host CLLI in tbl_clli_route.

For more information about using functions, see "Oracle Examples."

Table 4-71 SSP_new_clli_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
mach_clli	The remote NE.	Yes	I
host_clli	The host NE identifier of an NE or SRP.	Yes	I
asdl_cmd	The ASDL command.	No	I

SSP_new_comm_param

This function adds a communication parameter for a specified device type, host, and device into tbl_comm_param. The COMMON_HOST_CFG and/or parameter definition can be used for the following combinations:

common host and common device
common host and specific device
specific host and common device
specific host and specific device

Because the second and third combinations may overlap, the system warns you when communication parameters are updated.

For more information about using functions, see "Oracle Examples."

Table 4-72 SSP_new_comm_param Parameters

Name	Description	Req'd	(I)nput/(O)utput
dev_type	The device type. Choose from the following connections: D – Serial Port Dialup F – TCP/IP FTP Connection G – Generic Terminal Based Connection H – Serial Port Hardwired M – Generic Message Based Connection S – TCP/IP Socket Connection T – TCP/IP Telnet Connection W – LDAP Connection C – CORBA	Yes	I
host	The host CLLI. Set to COMMON_HOST_CFG or the host CLLI associated with the command processor. If a common host, the parameter value is the default value, otherwise, it is host-specific.	Yes	I
device	The physical or logical device name. Set to COMMON_DEVICE_CFG, the device associated with the command processor, or the name of a multiplexing device. If a common device, the parameter value is the default value, otherwise, it is device-specific.	Yes	I
param_label	The communication parameter label.	Yes	I
param_value	The communication parameter value.	Yes	I
param_desc	The communication parameter description.	Yes	I

SSP_new_csdl_asdl

This function defines up to nine CSDL-to-ASDL mappings from an CSDL command to an ASDL command with consecutive numbers starting from base_seq_no to tbl_csdl_asdl.

CSDL and ASDL commands must be defined before adding a CSDL-to-ASDL mapping relationship, otherwise this function rejects the insertion attempt. This is an enforced integrity check that ensures configuration consistency. You can add up to nine mapping relationships with one procedure call.

Syntax:

exec :retval :=  SSP_new_csdl_asdl (‘csdl_cmd',‘base_seq_no',
‘asdl_cmd',‘cond_flag',‘parm_lbl',‘parm_vlu',‘eval_exp',‘prn',
‘[asdl_cmd]',‘[cond_flag]',‘[parm_lbl]',‘[parm_vlu]',‘[eval_exp]',

‘[prn]', ...)

Example:

exec :retval :=  SSP_new_csdl_asdl ('M-CREATE_BUS_LINE', 1,

'M-CLEAR_INTERCEPT', 'A', '', '', '', '0',
'M-CREATE_SINGLE_LINE_ACCESS', 'A', '', '', '', '0',
'ADD_ALWAYS_ON_3WC', 'D', 'ALWAYS_ON_AREA', '', '', '0',
'ADD_ALWAYS_ON_CRT', 'D', 'ALWAYS_ON_AREA', '', '', '0',
'ADD_ALWAYS_ON_CTR', 'A', '', '','' '0')

In this example, the CSDL command M-CREATE_BUS_LINE is mapped to four ASDL commands that start with the ASDL sequence number 1.

ASDL commands M-CLEAR_INTERCEPT and M-CREATE_SINGLE_LINE_ACCESS are always generated.

ADD_ALWAYS_ON_3WC and ADD_ALWAYS_ON_CRT are generated only if the CSDL command parameter ALWAYS_ON_AREA is defined.

The fifth ASDL command, ADD_ALWAYS_ON_CTR, is generated only if the CSDL command parameter TRACE_OPT is defined and has an ON value.

For more information about using functions, see "Oracle Examples."

Table 4-73 SSP_new_csdl_asdl Parameters

Name	Description	Req'd	(I)nput/(O)utput
csdl_cmd	The CSDL command identifier.	Yes	I
base_seq_no	The number of the first ASDL mapping to insert. Because each CSDL command may map to several ASDL commands, an index is kept in the static table and used to determine the order of the ASDL commands being sent to the NEP. Up to nine ASDL commands can be mapped with a single call of this procedure. Each call is assigned a sequence number based on the base_seq_no. For example, if the CSDL command maps to twelve ASDL commands, the base sequence number should be 1 for the first procedure call (which will create nine mapping relationships, ASDL command sequence numbers 1-9) and 10 for the second procedure call (which will create the remaining three mapping relationships, ASDL command sequence numbers 10-12).	Yes	I
asdl_cmd	The name of the ASDL command that the CSDL command maps to. The ASDL command is generated by the CSDL command based on the value of the condition flag (cond_flag).	Yes	I
cond_flag	Used to specify conditions that need to be met in order for the SARM to generate the ASDL command for the CSDL command. Type one of the following values: A – Always generates the ASDL command for the CSDL command D – Generates the ASDL command if the CSDL parameter is defined (present) N – Generates the ASDL command if the CSDL parameter is not defined (present) E – Generates the ASDL command if the CSDL parameter is defined and equal to a value. The generation of each ASDL command depends upon the results of the previous ASDL. When the previous command completes successfully, it returns parameters to the SARM. When using ‘cond_flag'='E', the following values are required: ‘lbl1' ‘lbl2' ‘val1' ‘val2' When using ‘cond_flag'='D' or ‘N', the following values are required: ‘lbl1' ‘lbl2'	Yes	I
parm_lbl and parm_vlu parameters	Required when you use CSDL parameter-dependent conditions. Set the CSDL command parameter name for ‘D', ‘N', and ‘E' condition flags using parm_lbl. The ‘E' condition flag checks that the CSDL command parameter is equal to the value specified by parm_vlu. For more information about these condition flags, refer to the previous parameter, cond_flag.	Yes	I
eval_exp	Contains combination of parameter names, operators, and values to which the parameters are compared.	No	I
pnr	Value of 'point of no return' for rollbacks. Values are: 0 (default) – This ASDL is not the 'point of no return' for rollback purposes 1 – This ASDL is the 'point of no return' for partial rollback. If rollback occurs, and the function has run continued beyond this point, roll back to this ASDL but no further. 2 – 'point of no return' for no rollback. Once past this ASDL, no rollback can occur.	Yes	I

SSP_new_csdl_asdl_idx

This function allows multiple conditions to be inserted into tbl_csdl_asdl_eval. Up to nine rules can be inserted with each call. If adding up to nine rules, leave append_rule set to 0. To add more than nine rules to one mapping, call the function again with append_rule set to 1.

Syntax:

exec :retval :=  SSP_new_csdl_asdl_idx (‘append_rule',‘csdl_cmd', ‘base_seq_no', 
‘asdl_cmd', c‘cond_flag', ‘parm_lbl', ‘parm_vlu',
‘eval_exp', ‘apply_from', ‘apply_to',
‘[cond_flag]', ‘[parm_lbl]', ‘[parm_vlu]', ‘[eval_exp]',‘[apply_from]', ‘[apply_to])
...

Examples:

exec :retval :=  SSP_new_csdl_asdl_idx (0,'M-CREATE_BUS_LINE',1,'M-CLEAR_INTERCEPT','0',
'A', '', '', '', 1, 1)

exec :retval :=  SSP_new_csdl_asdl_idx (0,'M-CREATE_BUS_LINE',2,
'M-CREATE_SINGLE_LINE_ACCESS', '0',

'A', '', '', '', 1, 1)

exec :retval :=  SSP_new_csdl_asdl_idx (0,'M-CREATE_BUS_LINE',3,'ADD_ALWAYS_ON_3WC','0',

'D', 'ALWAYS_ON_AREA', '', '', 1, 1)

exec :retval :=  SSP_new_csdl_asdl_idx (0,'M-CREATE_BUS_LINE',4,'ADD_ALWAYS_ON_CRT','0',
'D', 'ALWAYS_ON_AREA', '', '', 1, 1)

exec :retval :=  SSP_new_csdl_asdl_idx (0,'M-CREATE_BUS_LINE',5,'ADD_EMAIL_ACCOUT','0',

'E', 'MAX_ADDRESS_EXCEED', 'FALSE', '', 1, 9999,
'E', 'CREATE_ADDRESS_1', 'TRUE', '', 1, 1, 
'E', 'CREATE_ADDRESS_2', 'TRUE', '', 2, 2,
'E', 'CREATE_ADDRESS_3', 'TRUE', '', 3, 3,
'E', 'CREATE_ADDRESS_4', 'TRUE', '', 4, 4,
'E', 'CREATE_ADDRESS_5', 'TRUE', '', 5, 5,
'E', 'CREATE_ADDRESS_6', 'TRUE', '', 6, 6,
'E', 'CREATE_ADDRESS_7', 'TRUE', '', 7, 7,
'E', 'CREATE_ADDRESS_8', 'TRUE', '', 8, 8)

exec :retval :=  SSP_new_csdl_asdl_idx (1,'M-CREATE_BUS_LINE',5,'ADD_EMAIL_ACCOUT','0',

'E', 'CREATE_ADDRESS_9', 'TRUE', '', 9, 9,
'E', 'CREATE_ADDRESS_10', 'TRUE', '', 10, 10,
'E', 'CREATE_ADDRESS_11', 'TRUE', '', 11, 11)

In this example, the CSDL command M-CREATE_BUS_LINE is mapped to five ASDL commands that start with the ASDL sequence number 1.

ASDL commands M-CLEAR_INTERCEPT and M-CREATE_SINGLE_LINE_ACCESS are always generated.

ADD_ALWAYS_ON_3WC and ADD_ALWAYS_ON_CRT are generated only if the CSDL command parameter ALWAYS_ON_AREA is defined.

The fifth ASDL command, ADD_EMAIL_ACCOUNT, is an indexed ASDL command that contains 12 rules. Each instance of this ASDL command is generated only if the CSDL command parameter MAX_ADDRESS_EXCEED is defined and the current index rule has a FALSE value and for each index rule is evaluated to true.

For example, if the current index is 5 then this rule ('E', 'CREATE_ADDRESS_5', 'TRUE', '', 5, 5) says the CSDL command parameter CREATE_ADDRESS_5 is defined and the current index rule has a TRUE value.

Note that the last call of the fifth example has append_rule set to 1 to indicate that the rules are to be appended to those added by the previous call:

exec :retval :=  SSP_new_csdl_asdl_idx (1,'M-CREATE_BUS_LINE',5...)

For more information about using functions, see "Oracle Examples."

Table 4-74 SSP_new_csdl_asdl_idx Parameters

Name	Description	Req'd	(I)nput/(O)utput
append_rule	Indicates whether rules are inserted to a new or existing mapping. The initial call, with this parameter set to 0, can insert up to 9 rules. To add additional rules, call SSP_new_csdl_asdl_idx again, with this parameter set to 1.	Yes	I
csdl_cmd	The CSDL command identifier.	Yes	I
base_seq_no	The number of the first ASDL mapping to insert. Because each CSDL command may map to several ASDL commands, an index is kept in the static table and used to determine the order of the ASDL commands being sent to the NEP. Up to nine ASDL commands can be mapped with a single call of this procedure. Each call is assigned a sequence number based on the base_seq_no. For example, if the CSDL command maps to twelve ASDL commands, the base sequence number should be 1 for the first procedure call (which will create nine mapping relationships, ASDL command sequence numbers 1-9) and 10 for the second procedure call (which will create the remaining three mapping relationships, ASDL command sequence numbers 10-12).	Yes	I
asdl_cmd	The name of the ASDL command that the CSDL command maps to. The ASDL command is generated by the CSDL command based on the value of the condition flag (cond_flag).	Yes	I
pnr	Value of 'point of no return' for rollbacks. Values are: 0 (default) – This ASDL is not the 'point of no return' for rollback purposes 1 – This ASDL is the 'point of no return' for partial rollback. If rollback occurs, and the function has continued beyond this point, roll back to this ASDL but no further. 2 – 'point of no return' for no rollback. Once past this ASDL, no rollback can occur.	Yes	I
cond_flag	Used to specify conditions that need to be met in order for the SARM to generate the ASDL command for the CSDL command. Type one of the following values: A – Always generates the ASDL command for the CSDL command D – Generates the ASDL command if the CSDL parameter is defined (present) N – Generates the ASDL command if the CSDL parameter is not defined (present) E – Generates the ASDL command if the CSDL parameter is defined and equal to a value. The generation of each ASDL command depends upon the results of the previous ASDL. When the previous command completes successfully, it returns parameters to the SARM. When using ‘cond_flag'='E', the following values are required: ‘lbl1' ‘lbl2' ‘val1' ‘val2' When using ‘cond_flag'='D' or ‘N', the following values are required: ‘lbl1' ‘lbl2'	Yes	I
parm_lbl parm_vlu	Required when you use CSDL parameter-dependent conditions. Set the CSDL command parameter name for ‘D', ‘N', and ‘E' condition flags using parm_lbl. The ‘E' condition flag checks that the CSDL command parameter is equal to the value specified by parm_vlu. For more information about these condition flags, refer to the previous parameter, cond_flag.	Yes	I
eval_exp	Contains combination of parameter names, operators, and values to which the parameters are compared.	No	I
apply_from	The first indexed ASDL that this rule should apply to: Valid range is from 1 to 9999. Must be less than or equal to the value specified in column apply_to. If is not specified, then this rule will be applied to any indexed ASDL up to and including the one specified in column apply_to.	No	I
apply_to	The last indexed ASDL that this rule should apply to: Valid range is from 1 to 9999. Must be greater than or equal to the value specified in column apply_from. If is not specified, then this rule will be applied to any indexed ASDL starting from the one specified in column apply_from.	No	I

SSP_new_csdl_defn

This function adds a new CSDL command into tbl_csdl_config.

Syntax:

exec :retval :=  SSP_new_csdl_defn (‘csdl_cmd', ‘rollback_req', csdl_level, ‘[fail_event]', ‘[complete_event]', ‘[description]')

Example:

exec :retval :=  SSP_new_csdl_defn (‘M-CREATE_BUS_LINE', ‘Y', 82, ‘SYS_ERR', ‘SYS_INFO', ‘Add Business Access Line')

In this example, the M-CREATE_BUS_LINE CSDL command adds a business access line with a CSDL command level of 82. If the CSDL command fails, the SYS_ERR system event is triggered and rollback is performed on the entire order. Upon successful completion, the SYS_INFO system event is issued.

For more information about using functions, see "Oracle Examples."

Table 4-75 SSP_new_csdl_defn Parameters

Name	Description	Req'd	(I)nput/(O)utput
csdl_cmd	The name of the CSDL command to add. It should be a unique CSDL command label in ASAP.	Yes	I
rollback_req	A Yes/No (Y or N) flag that indicates whether rollback is required for this CSDL command. If you set this flag to Y, ASAP automatically rolls back any actions performed by the work order if the work order fails.	Yes	I
csdl_level	An integer between 0 and 255 that indicates the sequence level for the CSDL command within the work order. The SARM uses this integer to determine the order in which to provision CSDL commands from an SRP and then provisions CSDL commands that have lower level numbers first. Sequence levels are only relevant for inter-dependent CSDL commands.	Yes	I
fail_event	ASAP system events that are triggered upon completion or failure of the CSDL command. The events must be first defined in the control database if alarms are to be generated from such events. These are optional parameters.	No	I
complete_event		No	I
description	A CSDL command description. ASAP front-end tools that are monitoring the progress of the work order can use this description. This is an optional parameter.	No	I

SSP_new_dn_map

This function adds new ASDL command routings by directory number to tbl_nep_rte_asdl_nxx.

For more information about using functions, see "Oracle Examples."

Table 4-76 SSP_new_dn_map Parameters

Name	Description	Req'd	(I)nput/(O)utput
asdl_cmd	The ASDL command.	No	I
npa	The Numbering Plan Area code.	No	I
nxx	The Central Office code.	No	I
from_line	The lowest line number in the range of telephone numbers to provide routing for.	No	I
to_line	The highest line number in the range.	No	I
queue_nm	The host NE to which this ASDL should be routed.	Yes	I

SSP_new_id_routing

This function adds a new host NE and the ID_ROUTING mapping record to tbl_id_routing. You can use this function when routing by ID_ROUTING is used.

For more information about using functions, see "Oracle Examples."

Table 4-77 SSP_new_id_routing Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier.	No	I
asdl_cmd	The ASDL command.	Yes	I
id_routing_from	The starting point of a range of ID_ROUTING.	No	I
id_routing_to	The end point of a range of ID_ROUTING.	No	I

SSP_new_intl_msg

This function defines an international message for a particular language in tbl_msg_convert.

For more information about using functions, see "Oracle Examples."

Table 4-78 SSP_new_intl_msg Parameters

Name	Description	Req'd	(I)nput/(O)utput
lang_cd	The language code.	Yes	I
msg_id	The unique message identifier.	Yes	I
type	The type of message formatting.	Yes	I
message	The message text.	Yes	I
var_description	The description of the substitutable fields, if any, within the message.	No	I
wo_audit	Destination for the log message.	No	I

The following example shows how to add an international message:

exec :retval :=  SSP_new_intl_msg ('USA', 1, 'D', 'Work Order %s Timed Out',  'WO Id: %s')

This example adds an international message to the SARM database for American English (USA). International messages use parameters to identify the entity they are associated with. The var_description parameter (‘WO id: %s') specifies the format and the arguments that are used to generate the actual message.

SSP_new_ne_host

This function defines a host NE with its technology type, software version, and inventory manager in the SARM database table, tbl_host_clli.

For more information about using functions, see "Oracle Examples."

Table 4-79 SSP_new_ne_host Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE to which the remote NE is connected.	Yes	I
tech_type	The technology type of the host NE or SRP.	Yes	I
sftwr_load	The version of the software currently running on the NEP or SRP.	Yes	I

SSP_new_nep

This function defines a secondary (dialup) pool of devices or connections for a specified NEP in the SARM database. This function adds a pool of devices or connections to tbl_nep.

For more information about using functions, see "Oracle Examples."

Table 4-80 SSP_new_nep Parameters

Name	Description	Req'd	(I)nput/(O)utput
nep_svr_cd	The NEP managing the secondary pool of devices.	Yes	I
dialup_pool	The secondary pool of devices.	No	I

SSP_new_nep_program

This function inserts or updates a line of code into tbl_nep_program. If the line exists, it will be updated.

If there is no ASDL mapping relationship, the user is warned that the mapping relationship does not exist. The insertion of the program, however, is not affected.

For more information about using functions, see "Oracle Examples."

Table 4-81 SSP_new_nep_program Parameters

Name	Description	Req'd	(I)nput/(O)utput
program	The NEP program identifier.	Yes	I
line_no	The line number to delete. If set to NULL, all lines of the program are deleted.	Yes	I
action	The action string identifying a particular action performed by the Interpreter.	Yes	I
act_string	The action string associated with the interpreter.	Yes	I
act_int	The action integer.	Yes	I

SSP_new_net_elem

This function defines a host NE in the SARM database (tbl_ne_config).

For more information about using functions, see "Oracle Examples."

Table 4-82 SSP_new_net_elem Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier of an NE or SRP.	Yes	I
nep_svr_cd	The logical name of the NEP that connects to this host NE.	Yes	I
primary_pool	The primary resource pool used by the NEP managing this host NE to determine the devices to use to connect to it.	Yes	I
max_connections	The maximum number of concurrent connections allowed to this host NE.	Yes	I
drop_timeout	The maximum inactivity (in minutes) before NEP drops the primary connection to this host NE.	Yes	I
spawn_threshold	Number of ASDL requests in the SARM ASDL Ready Queue to be exceeded before the NEP opens a new auxiliary connection to that NE.	Yes	I
kill_threshold	Once the SARM has fewer ASDL requests in its ASDL Ready Queue than this number, it disconnects one or more auxiliary connections.	Yes	I
template_flag	Flag to indicate whether this network element entry identifies a static NE (N) or a dynamic network element template (Y).	Y	I

SSP_new_resource

This function defines an NEP resource (“device") to be used for NE access in the SARM database (tbl_resource_pool).

For more information about using functions, see "Oracle Examples."

Table 4-83 SSP_new_resource Parameters

Name	Description	Req'd	(I)nput/(O)utput
asap_sys	The ASAP environment (TEST, PROD, etc.)	Yes	I
pool	The pool name.	Yes	I
device	The physical or logical device name.	Yes	I
line_type	The type of line for the serial communication.	Yes	I
vs_key	Reserved. The shared memory segment identifier for the Virtual Screen buffer.	No	I

SSP_new_srp

This function adds an SRP to tbl_asap_srp.

For more information about using functions, see "Oracle Examples."

Table 4-84 SSP_new_srp Parameters

Name	Description	Req'd	(I)nput/(O)utput
srp_id	The logical SRP name.	Yes	I
srp_desc	The SRP description.	Yes	I
aux_srp_id	The name of the sister SRP.	No	I
wo_estimate_evt	The work order estimate notification event.	No	I
wo_failure_evt	The work order failure notification event.	No	I
wo_complete_evt	The work order completion notification event.	No	I
wo_start_evt	The work order startup notification event.	No	I
wo_soft-err_evt	The work order soft error notification event.	No	I
wo_blocked_evt	The work order blocked notification event.	No	I
wo_rollback_evt	The work order rollback notification event.	No	I
wo_timeout_evt	The work order timeout notification event.	No	I
ne_unknown_evt	The unknown NE notification event.	No	I
ne_avail_evt	The NE available notification event.	No	I
ne_unavail_evt	The NE available notification event.	No	I
wo_accept_evt	The system event to be issued.	No	I
srp_conn_type	Connection protocol for SARM to SRP.	No	I
srp_host_name	SRP host machine name.	No	I
srp_host_port	Port number for socket connections.	No	I
aux_srp_conn_type	Connection protocol for SARM communication to the auxiliary SRP.	No	I
aux_srp_host_name	Host machine name of the auxiliary SRP.	No	I
aux_srp_host_port	Port number for socket connections on an auxiliary SRP.	No	I

SSP_new_stat_text

This function adds new static text into tbl_stat_text. If an entry already exists for the static text identifier, the static text is updated with the new information.

For more information about using functions, see "Oracle Examples."

Table 4-85 SSP_new_stat_text Parameters

Name	Description	Req'd	(I)nput/(O)utput
stat_id	The logical group of static text messages.	Yes	I
status	The integer identifier for member of a logical grouping.	No	I
code	The string identifier for a member of a logical grouping.	No	I
stat_text	The actual text message to use in place of a string/integer identifier.	Yes	I

SSP_new_user_err_threshold

This function creates a new user-defined error threshold in the system for the specified NE, ASDL command, and the user-defined error type in tbl_user_err_threshold.

For more information about using functions, see "Oracle Examples."

Table 4-86 SSP_new_user_err_threshold Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier of an NE or SRP.	Yes	I
asdl_cmd	The ASDL command.	Yes	I
user_type	The user-defined error type.	Yes	I
minor_threshold	The threshold for minor system events. This is the number of times the user_type can be returned before the corresponding minor event is generated.	Yes	I
minor_event	The minor system event to be generated when the threshold is exceeded.	Yes	I
major_threshold	The threshold for major system events. This is the number of times the user_type can be returned before the corresponding major event is generated.	Yes	I
major_event	The major system event to be generated when the major threshold is reached.	Yes	I
critical_threshold	The threshold for critical event notifications. This is the number of times the user_type can be returned before the corresponding critical event is generated.	Yes	I
critical_event	The critical system event to be generated when the critical threshold is reached.	Yes	I

SSP_new_userid

This function adds a new user account for the SARM to control access from the SRP in tbl_uid_pwd.

For more information about using functions, see "Oracle Examples."

Table 4-87 SSP_new_userid Parameters

Name	Description	Req'd	(I)nput/(O)utput
uid	The user ID.	Yes	I
pwd	The password.	Yes	I
status	The user's current status.	No	I

SSP_orphan_purge

This stored procedure scans SARM database tables and deletes fragments of old work orders that do not have an entry in tbl_wrk_ord. Occasionally, the database becomes fragmented and records are left behind in various tables, including:

tbl_asap_stats
tbl_info_parm
tbl_srq
tbl_srq_csdl
tbl_srq_log
tbl_asdl_log
tbl_srq_parm
tbl_srq_asdl_parm
tbl_wo_event_queue

This stored procedure is time-consuming and requires considerable system resources. Therefore, it should not run during peak hours.

For more information, see Database Purging in the ASAP System Administrator's Guide.

For more information about using functions, see "Oracle Examples."

Error Management

The management of errors related to provisioning by an NEP provides a detailed error tracking scheme and lets the administrator configure error-processing thresholds using NE and ASDL commands. The thresholds control the release of specific ASDL commands to the NE to prevent an excessive number of errors from occurring.

The following table lists the types or errors that can occur:

SUCCEED: The ASDL provisioning was successful.
FAIL: Fails the current order and stops any subsequent processing.
RETRY: Retries the current ASDL command after a user-configured interval and up to a user-configured number of times before failing the order.
MAINTENANCE: Causes the current ASDL command to wait for the NE to come out of maintenance before processing continues.
SOFT_FAIL: An error has occurred at the NE but order processing can continue.
DELAYED_FAIL: An ASDL had failed during provisioning. The SARM skips any subsequent ASDL in the CSDL, continues provisioning at the next CSDL, and then fails the order.

Refer to the ASAP Cartridge Development Guide for more detailed descriptions of these base_types.

User-configured history windows and polling intervals that update the ASAP database are also supported. Information is available in real-time from the SARM server or in a batch from the ASAP database. This batch information can then be used by administrative tools to perform root cause analysis.

SSP_del_err_threshold

This function deletes error thresholds for a specific NE and ASDL command from tbl_err_threshold.

For more information about using functions, see "Oracle Examples."

Table 4-88 SSP_del_err_threshold Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier of an NE or SRP.	No	I
asdl_cmd	The ASDL command associated with the threshold. This can be NULL to indicate an NE threshold.	No	I

SSP_del_err_type

This function deletes mappings between base and user exit types. These mappings are defined in tbl_user_err.

For more information about using functions, see "Oracle Examples."

Table 4-89 SSP_del_err_type parameters

Name	Description	Req'd	(I)nput/(O)utput
user_type	The user-defined error type.	Yes	I
asdl	The ASDL that is running. Error types can be defined for user_type and ASDL combinations.	No	I
csdl	The CSDL that is running. Error types can be defined for user_type and CSDL combinations.	No	I
ne_vendor	The vendor of the network element.	No	I
tech_type	The technology of the network element.	No	I
sftwr_load	Software version of the host network element.	No	I

SSP_err_enable

This function enables the provisioning of an ASDL command that has been disabled because it exceeded an error threshold. If the NE is down, the NE will be enabled by this function. A particular ASDL may also be marked as disabled to an NE, therefore it may be re-enabled to that NE by specifying it along with the NE in the call to SSP_err_enable.

Note:

The action performed by this function is not persistent. That is, if the SARM is taken down after this function has been run, the changes made to the state of the NE and ASDL are lost.

For more information about using functions, see "Oracle Examples."

Table 4-90 SSP_err_enable Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier of an NE or SRP.	Yes	I
asdl_cmd	The optional ASDL command to enable a specific type of provisioning.	No	I

SSP_list_err_host

This function lists the NEs and the ASDL commands that have been disabled for provisioning.

For more information about using functions, see "Oracle Examples."

Table 4-91 SSP_list_err_host Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
host_clli	The host NE identifier of an NE or SRP.	No	I
asdl_cmd	The ASDL command.	No	I

Table 4-92 SSP_list_err_host Results

Name	DataType	Description
host_clli	TYP_clli	Host NE.
disable_dts	datetime	Timestamp when the NE was disabled.
asdl_cmd	TYP_asdl_cmd	ASDL command that has been disabled.
order_count	TYP_long	Number of orders waiting for the NE.

SSP_list_err_threshold

This function lists the error thresholds for a specific NE and ASDL command. Error thresholds are stored in tbl_err_threshold.

For more information about using functions, see "Oracle Examples."

Table 4-93 SSP_list_err_threshold Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
host_clli	The host NE identifier of an NE or SRP.	No	I
asdl_cmd	The ASDL command associated with the threshold. This can be NULL to indicate an NE threshold.	No	I

Table 4-94 SSP_list_err_threshold Results

Name	DataType	Description
host_clli	varchar(64)	The host NE identifier.
asdl_cmd	varchar(30)	The ASDL command associated with the threshold. This can be NULL to indicate an NE threshold.
threshold	TYP_long	Error threshold.

SSP_list_err_type

This function lists the mapping between user exit types and base exit types. This mapping is stored in tbl_user_err.

You cannot define both user_type and base_type at the same time.

For more information about using functions, see "Oracle Examples."

Table 4-95 SSP_list_err_type Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
user_type	The user-defined error type.	No	I
base_type	The base error type.	No	I

Table 4-96 SSP_list_err_type Results

Name	DataType	Description
user_type	TYP_code	User-defined type.
base_type	TYP_code	Base error type.
description	varchar(50)	A brief description of the user exit type.

SSP_new_err_threshold

This function adds a new threshold for a specific NE and ASDL command in tbl_err_threshold.

For more information about using functions, see "Oracle Examples."

Table 4-97 SSP_new_err_threshold Parameters

Name	Description	Req'd	(I)nput/(O)utput
host_clli	The host NE identifier.	Yes	I
asdl_cmd	The ASDL command associated with the threshold. This can be NULL to indicate an NE threshold.	Yes	I
threshold	The error threshold for the time period (consecutive number of errors before connection to an NE should be disabled).	Yes	I

SSP_new_err_type

This function adds a new mapping between user exit types and the base exit types in tbl_user_err.

For more information about using functions, see "Oracle Examples."

Table 4-98 SSP_new_err_type Parameters

Name	Description	Req'd	(I)nput/(O)utput
user_type	The user-defined error type.	Yes	I
base_type	The base error type.	Yes	I
description	A brief description of the ASDL command.	No	I
asdl	The ASDL that is running. Error types can be defined for user_type and ASDL combinations.	No	I
csdl	The CSDL that is running. Error types can be defined for user_type and CSDL combinations.	No	I
ne_vendor	The vendor of the network element.	No	I
tech_type	The technology of the network element.	No	I
sftwr_load	Software version of the host network element.	No	I
search_pattern	Regular expression pattern that is used to match on network element responses.	No	I

Switch Blackout Processing

If ASAP shared a port to an NE with another system or if regular NE maintenance must be performed, you can define the NE blackout period during which time the NEP will not connect to that NE.

To identify switch blackout periods, ASAP checks a database table to see if the current time is within the user-defined blackout period. You can configure both static (keyed by date and time) and dynamic (keyed by specific day and time) blackout periods. If a blackout period is detected, the switch is placed into maintenance mode automatically.

SSP_add_blackout

This function configures the static and dynamic blackout periods for a specific NE host. Blackout information is stored in tbl_blackout.

For more information about using functions, see "Oracle Examples."

Table 4-99 SSP_add_blackout Parameters

Name	Description	Req'd	(I)nput/(O)utput
dayname	The name of the day of the week for a weekly blackout (such as Mondays). Set to NULL to use specific date and time intervals for blackout.	No	I
host_clli	The Host NE identifier of an NE or SRP.	Yes	I
start_tm, end_tm	The start time and end time for the blackout interval. If you have specified a dayname blackout, the blackout is based on the day and the start time and end time. If the dayname parameter is set to NULL, the blackout is based on a specified date and time.	Yes	I
descr	A brief description of the blackout.	No	I

SSP_check_blackout

This function determines whether or not the specified NE is currently blacked out. An NE is blacked out if an entry exists in tbl_blackout for the specified NE, where the current time is between the entry's start time and end time.

For more information about using functions, see "Oracle Examples."

Table 4-100 SSP_check_blackout Parameters

Name	Description	Req'd	(I)nput/(O)utput
curday	The current day.	Yes	I
host_clli	The Host NE identifier.	Yes	I
curr_dt_tm	The current time.	Yes	I
ret	The return status.	Yes	O

SSP_del_blackout

This procedure removes blackout periods for a specific NE host from tbl_blackout.

For more information about using functions, see "Oracle Examples."

Table 4-101 SSP_del_blackout Parameters

Name	Description	Req'd	(I)nput/(O)utput
dayname	The name of the day of the week for default setup (e.g., Monday). Set to NULL to use specific day and time intervals for the blackout.	No	I
host_clli	The host NE identifier of an NE or SRP.	No	I
start_tm	The start time for the blackout interval. If the dayname parameter is not NULL, then these fields are used as time intervals for the day. If the dayname parameter is NULL, this field must include both date and time.	No	I

SSP_list_blackout

This procedure lists blackout periods for a specific NE host. This information is stored in tbl_blackout.

For more information about using functions, see "Oracle Examples."

Table 4-102 SSP_list_blackout Parameters

Name	Description	Req'd	(I)nput/(O)utput
RC1	Oracle Database Ref Cursor.	Yes	I/O
RC2	Oracle Database Ref Cursor.	Yes	I/O
RC3	Oracle Database Ref Cursor.	Yes	I/O
dayname	The name of the day of the week for default setup (e.g., Monday). Set to NULL to use specific date and time intervals for the blackout.	No	I
host_clli	The host NE identifier of an NE or SRP.	No	I
start_tm	The start time for the blackout interval. If the dayname parameter is not NULL, then these fields are used as time intervals for the day. If the dayname parameter is NULL, this field must include both date and time.	No	I

Table 4-103 SSP_list_blackout Results

Name	Datatype	Description
dayname	varchar(10)	The name of the day.
host_clli	TYP_clli	The host CLLI.
start_tm	datetime	The start time for the blackout interval.
end_tm	datetime	The end time for the blackout interval.
description	varchar(40)	The description of the blackout period.
dayname	varchar(10)	The name of the day.
host_clli	TYP_clli	The host CLLI.
start_tm	datetime	The start time for the blackout interval.
end_tm	datetime	The end time for the blackout interval.
description	varchar(40)	The description of the blackout period.
dayname	varchar(10)	The name of the day.
host_clli	TYP_clli	The host CLLI.
start_tm	datetime	The start time for the blackout interval.
end_tm	datetime	The end time for the blackout interval.
description	varchar(40)	The description of the blackout period.

Stop Work Order Interface

The Stop Work Order feature is a user-generated event from the OCA client or the JSRP that is received directly by the SARM and applied to a specific work order. The event is received as a function aims_stop_wo.

Syntax:

CS_RETCODE aims_stop_wo_rpc(SRV_PROC *srvproc)
{
    ASAP_WO_ID wo_id;
    CS_INT rollback;
    CS_RETCODE ret_status;
    CS_CHAR tmp[ASAP_SRQ_EVENT_TEXT_L],evt_text[ASAP_SRQ_EVENT_TEXT_L];
    CS_CHAR audit_flag[10];
    CS_CHAR user_id[32];

The aims_stop_wo function stops a work order that is in progress. This allows the user to correct any problems that may be occurring before continuing the work order.

The function determines:

When to stop a work order.
When to roll back a work order once it has been stopped. Once the function has been received, the SARM applies it as an asynchronous event to the specified work order.
When to send a return status variable to indicate whether or not the operation was successful.
A work order for which an aims_stop_wo function was received can go through two states:
- WO_STOP_WAIT if rollback is required and is in progress. While in this state, the work order can be cancelled.
- WO_STOPPED if rollback is not required or has finished. While in this state, the work order can be cancelled or its status changed to WO_HELD, WO_INIT, or WO_REVIEW.

A work order is stopped only if it is in the WO_IN PROGRESS state when the aims_stop_wo function is received. A request for a work order in any other state is rejected immediately without affecting the work order.

Table 4-104 aims_stop_wo Arguments

Name	Description	Req'd	(I)nput/(O)utput
wo_id	The work order identifier.	Yes	I
rollback	An integer value that specifies whether or not to roll back the work order before it is stopped. Valid values are: 1 – Rollback 0 – Do not rollback Any other value causes the work order to be stopped without rollback.	Yes	I
ret_status	A return parameter that stores the return value of the RPC. Valid values are: 0 – Request to stop the work order was not accepted. 1 – Request to stop the work order was accepted.	Yes	O
evt_text	The text of the message associated with the event.	No	I
audit_flag	Indicates which audit log receives the message: S – SRQ log W – Work order audit log B – Both N – Neither	No	I
userid	Optional user identification for audit log. Set to NULL to disable the audit log. Set to the user ID of the user who runs the procedure to enable the audit log.	No	I

Localizing International Messages

Localization is the process of preparing a product for use with a single language and character set. Localization can include:

Translating the user interface and documentation
Adapting time, date, and number formats
Adding punctuation conventions
Reconstructing icons and symbols

With the support of the ASAP localization toolkit, you can localize software and non-software components to any language based on the Roman alphabet (English, German, French, Spanish, etc.). Localization usually involves translating the user interface and documentation and adapting time, date, and number formats. In some cases, more significant changes may be required, and sometimes icons, symbols, metaphors, and even concepts must be reconsidered.

The localization toolkit does not let you localize or translate the system messages generated by third-party tools or operating systems.

The stored procedures locate international messages in the SARM database. The default language of American English is provided in the base release for ASAP. You can use it as a guide for defining other languages in ASAP.

Such messages are generated by the SARM and logged in the SARM database. They may be retrieved by the SRP and passed back to the originating system.

Use the following stored procedures to add, remove, and query international messages.

Table 4-105 lists the current messages used by ASAP and distributed as part of the core release.

Table 4-105 ASAP Messages

lang_cd	msg_id	type	message	var_description
USA	1	D	Work Order %s Timed Out	WO Id: %s
USA	2	D	ASDL Command %s Skipped	ASDL: %s
USA	3	D	Cannot Find Mandatory Parameter %s, ASDL %s Fails	Parameter: %s, ASDL: %s
USA	4	D	Soft Error on ASDL %s, WO Processing Continuing	ASDL: %s
USA	5	D	ASDL %s of SRQ %d Completed	ASDL: %s, SRQ Id: %d
USA	6	D	ASDL %s of SRQ %d Failed	ASDL: %s, SRQ Id: %d
USA	7	D	Start of ASDL Provisioning Request for SRQ %d	SRQ Id: %d
USA	8	D	Sent ASDL %s to NE, Awaiting NE Response	ASDL: %s
USA	9	D	Unable to get ASDL Command %s of SRQ %d	ASDL: %s, SRQ Id: %d
USA	10	D	SRQ %d (Last CSDL %s) has Completed	SRQ Id: %d, CSDL: %s
USA	11	D	CSDL %s of SRQ %d has Completed	CSDL: %s, SRQ Id: %d
USA	12	D	Will Retry ASDL Command %s of SRQ %d. Current Retry # is %d	ASDL: %s, SRQ Id: %d, Retry #: %d
USA	13	D	ASDL Command %s of SRQ %d Failed after %d Retries	ASDL: %s, SRQ Id: %d
USA	14	D	NE %s Unavailable while Processing %s	Host Clli: %s, ASDL: %s
USA	15	D	Q Info: Queued: %02d:%02d:%02d, Start: %02d:%02d:%02d, Comp: %02d:%02d:%02d	NEP Queue Information
USA	16	D	ASDL Failure Msg: %s	NE %s ASDL Failed Message
USA	17	D	ASDL Command %s of SRQ %d Failed on Unknown NE Return Status	ASDL: %s, SRQ Id: %d
USA	18	D	NE Command: %s\nASDL Command: %s	NE Command Returned From NE: %s
USA	19	D	Network Element Routing Error, Failed SRQ %d	SRQ Id: %d
USA	20	D	ASDL %s of SRQ %d Rollback Ignored	ASDL: %s, SRQ Id: %d
USA	21	D	NE %s Unavailable while Rolling Back ASDL %s of SRQ %d	Host Clli: %s, ASDL: %s, SRQ Id: %d
USA	22	D	Roll Back ASDL %s Sent to NE	ASDL: %s
USA	23	D	Roll Back ASDL %s Rejected by NE %s	ASDL: %s
USA	24	D	Will Retry Roll Back of ASDL %s, SRQ %d, Current Retry # %d	ASDL: %s, SRQ Id: %d, Retry #: %d
USA	25	D	Roll Back ASDL %s, SRQ %d Failed After %d Retries	ASDL: %s, SRQ Id: %d, # Retries: %d
USA	26	D	Roll Back ASDL %s, SRQ %d Completed	ASDL: %s, SRQ Id: %d
USA	27	D	Roll Back ASDL %s of SRQ %d Failed\nNEP Message %s	ASDL: %s, SRQ Id: %d, NEP Message: %s
USA	28	D	Roll Back ASDL %s Failed due to Unknown NE Return Status	ASDL: %s
USA	29	D	Syntax Error Processing %s	ASDL: %s
USA	30	D	Error Detected for ASDL %s	ASDL: %s
USA	31	D	Unknown ASDL Error %s	ASDL: %s
USA	32	D	Continue to Process Next ASDL	ASDL: %s
USA	33	D	N.E. Host %s	ASDL: %s Host %s
USA	34	S	Invalid ASDL Parameter Type in Configuration	-
USA	35	D	No ASDL Configuration defined for %s	ASDL: %s
USA	36	D	Network Element %s is in maintenance	Host: %s
USA	37	D	Port Failure on Connection to %s	Host: %s
USA	38	S	SRQ Provisioning Stopped
USA	39	D	Updated for ASDL %s of SRQ %d	ASDL: %s SRQ %d
USA	40	D	End of Indexed Parameters for ASDL %s	ASDL: %s
USA	41	D	ASDL %s Provisioning Request to %s	ASDL: %s Host: %s
USA	42	D	ASDL %s for %s Route to NE %s	ASDL: %s MCLI/DN: %s Host: %s
USA	43	D	Delay failure threshold exceeded, SRQ Provisioning Stopped	-
USA	44	S	Delay failure with rollback required, SRQ Provisioning Stopped	-