| Oracle® Communications ASAP Cartridge Development Guide Release 7.2 E22486-01 |
|
 Previous |
This appendix describes stored procedures used to create Oracle Communications ASAP service models.
|
Note: Stored procedures have been deprecated. |
The configuration of ASAP services using stored procedures consists of the following steps:
Use the following stored procedures to define, list, and delete service action commands:
SSP_new_csdl_defn – Defines a service action command in the SARM database.
SSP_list_csdl_defn – Lists configuration information for the service action command you specify from the SARM database. This information includes the rollback flag, service action command service action level, fail and completion events, and a description of the command. If you do not specify a service action command, the procedure returns information on all service action commands currently defined in the SARM.
SSP_del_csdl_defn – Deletes service action definitions from the SARM database.
For more information on these stored procedures and tbl_csdl_config, refer to the ASAP Developer Reference.
Use the following stored procedures to define, list, and delete atomic action commands:
SSP_new_asdl_defn – Defines an atomic action configuration record in the SARM database.
SSP_list_asdl_defn – Lists all or specific atomic action definitions from the SARM database. You can use wildcards in this procedure. If you do not specify a parameter, all atomic action definitions are listed.
SSP_del_asdl_defn – Deletes atomic action definitions from the SARM database.
For more information on these stored procedures and tbl_asdl_config, refer to the ASAP Developer Reference.
Use the following stored procedures to define, list, and delete atomic action parameters:
SSP_new_asdl_parm – This stored procedure defines up to nine atomic action parameters in a single stored procedure call for the specified atomic action command starting at base_seq_no.
SSP_list_asdl_parm – This stored procedure lists atomic action parameters from the SARM database by atomic action command name and/or atomic action parameter label.
SSP_del_asdl_parm – This stored procedure deletes an atomic action parameter from the specified atomic action command.
These stored procedures populate tbl_asdl_parm. For more information, refer to the ASAP Developer Reference.
The following stored procedures update tbl_csdl_asdl. tbl_csdl_asdl is a static table that is used by the SARM and contains the mapping between service action commands and atomic action commands. For each atomic action associated with a service action, the SARM verifies whether the atomic action should be spawned for the specified service action. The final determination of whether the atomic action is spawned depends on the atomic action parameter translation process specified by tbl_asdl_parm.
Use the following stored procedures to define, list, and delete service action to atomic action mappings:
SSP_new_csdl_asdl – This stored procedure defines up to nine service action-to-atomic action mappings at a time from a service action command to one or more atomic action commands with consecutive numbers starting at base_seq_no=1 in the SARM database.
SSP_new_csdl_asdl_idx – This stored procedure allow multiple conditions to be inserted into tbl_csdl_asdl_eval.
SSP_list_csdl_asdl – This stored procedure lists service action-to-atomic action mapping definitions.
SSP_del_csdl_asdl – This stored procedure deletes service action-to-atomic action mapping definitions from the SARM database.
These stored procedures populate tbl_csdl_asdl and tbl_csdl_asdl_eval. For more information, refer to the ASAP Developer Reference.
Use the following stored procedures to define, list, and delete atomic action-to-program mappings:
SSP_new_asdl_map – This stored procedure defines a mapping from an atomic action command to a program based on the technology and software load in the SARM database.
SSP_list_asdl_map – This stored procedure lists atomic action-to-program mappings according to various criteria.
SSP_del_asdl_map – This stored procedure deletes atomic action-to-program mappings. The mapping is based on the technology and software load.
For more information on these stored procedures and tbl_nep_asdl_prog, refer to the ASAP Developer Reference.
The definition of host network elements (NEs) consists of the following procedures:
tbl_host_clli is a static table that contains the host NE, the technology, and the software load of each NE in the ASAP system. It also contains records for each host NE to which the NEPs interface. You must populate this table to determine which NEs the NEP interfaces with.
Use the following stored procedures to define, list, and delete host NEs:
SSP_new_ne_host – This stored procedure defines a host NE with its technology type, software version, and inventory manager in the SARM database.
SSP_list_ne_host – This stored procedure lists host NE definitions.
SSP_list_host – This stored procedure retrieves host-related information from tbl_resource_pool, tbl_ne_config, and tbl_clli_route.
SSP_del_ne_host – This stored procedure deletes a host NE definition from the SARM database.
|
Note: You cannot delete a host NE that has a mapping relationship with either an NEP or a remote NE. Any mapping relationship must therefore be deleted prior to deleting the host NE. |
For more information on these stored procedures and tbl_host_clli, refer to the ASAP Developer Reference.
tbl_clli_route is a static table that contains the mapping between a remote NE and its host NE. You must populate this table to specify remote NE to host NE mappings.
Use the following stored procedures to define, list, and delete mappings from a remote NE to a host NE:
SSP_new_clli_map – This stored procedure defines a mapping from a remote CLLI to a Host CLLI in the SARM database.
SSP_list_clli_map – This stored procedure lists remote CLLI-to-Host CLLI mapping definitions.
SSP_del_clli_map – This stored procedure deletes a remote CLLI to host CLLI mapping.
For more information on these stored procedures and tbl_clli_route, refer to the ASAP Developer Reference.
Any changes you make to the mapping relationships between host NEs to remote NEs, only take effect at runtime. All other changes require that you restart the SARM.
NEP to host NE mappings are defined in tbl_ne_config.
Use the following stored procedures to configure NEP to host NE mappings.
SSP_new_net_elem – This stored procedure defines a host NE in the SARM database and identifies the logical name of the NEP that connects to this host NE. It also defines the loopback setting for the NE.
SSP_list_net_elem – This stored procedure lists NE definitions based on the host NE and/or NEP server you specify.
SSP_del_net_elem – This stored procedure deletes an NE definition for an NEP from the SARM database.
SSP_set_ne_loopback – This stored function is called by NEP server to update the table tbl_ne_config when the loop back state is set to ON, OFF, or GLOBAL through the utility tool asap_utils.
For more information on these stored procedures and tbl_ne_config, refer to the ASAP Developer Reference.
tbl_resource_pool is a static table that defines the collection of command processors (devices) that the NEP uses to establish connections to NEs. Groups of command processors are called resource pools. Each NE configuration determines a primary resource pool that defines one or more devices the NEP uses to connect to that NE. These devices are not used to connect to other NEs. Each NEP has an auxiliary resource pool that contains devices used by the NEP to establish connections to any NE managed by the NEP. These primary and auxiliary resource pools are defined in this table. You must populate this table to add command processors.
Use the following stored procedures to define, delete, and list command processors:
SSP_new_resource – This stored procedure defines an NEP resource (“device”) to be used for NE access in the SARM database.
SSP_del_resource – This stored procedure deletes an NEP resource record from the SARM database.
SSP_list_resource – This stored procedure lists NEP resource records.
For more information on these stored procedures and tbl_resource_pool, refer to the ASAP Developer Reference.
tbl_comm_param contains communication parameters required for the NEP to communicate with various external systems. You must populate this table to configure communication parameters.
For more information on tbl_comm_param, refer to the ASAP Developer Reference.
Use the following stored procedures to define, list, and delete communication parameters:
SSP_new_comm_param – This stored procedure defines a communication parameter for a specified device type, host, and device into the SARM database.
SSP_list_comm_param – This stored procedure lists communication parameter information for dev_type, host, device, param_label, or for all of them.
SSP_del_comm_param – This stored procedure deletes communication parameter information from the SARM database.
Use the following stored procedures to define, list, and delete error thresholds.
SSP_new_err_threshold – This stored procedure defines error thresholds for a specific NE and atomic action command.
SSP_list_err_threshold – This stored procedure lists the error thresholds for a specific NE and atomic action command.
SSP_del_err_threshold – This stored procedure deletes error thresholds for a specific NE and atomic action command.
For more information on these stored procedures, refer to ASAP Developer Reference.
Use the following stored procedures to define, list, and delete user errors.
SSP_new_err_type – This function configures the mapping between user-defined error types and the base-error types.
SSP_list_err_type – This function lists the mapping between user-defined error types and the base-error types.
SSP_del_err_type – This function deletes the mapping of user-defined error types.
Use the following stored procedures to define, list, and delete user error thresholds.
SSP_new_user_err_threshold – This stored procedure creates a new user-defined error threshold in the system for the specified NE, atomic action command, and the user-defined error type.
SSP_list_user_err_threshold – This stored procedure is used to list the user-defined error thresholds for a specific NE, atomic action command, and user error type.
SSP_del_user_err_threshold – This stored procedure deletes a user-defined error threshold or set of thresholds.
For more information on these stored procedures, refer to ASAP Developer Reference.
The stored procedures that you can use as external interfaces are the following:
SSP_list_id_routing (RC1, host_clli) – Lists the host NE and ID_ROUTING mapping records in the SARM database.
SSP_new_id_routing (host_clli, asdl_cmd, id_routing_from, id_routing_to) – Defines the host NE and ID_ROUTING mapping records in the SARM database.
SSP_del_id_routing (host_clli, asdl_cmd, id_routing_from, id_routing_to) – Deletes the host NE and ID_ROUTING mapping records from the SARM database.
For more information on these stored procedures, refer to the ASAP Developer Reference.
The following steps must be followed when routing by ID_ROUTING:
Populating the routing table (tbl_id_routing).
Defining the atomic action parameter. A sample is located in ..\samples\ASDL_ROUTE\oraRoutingServices.
Defining the work order. A sample is located in ..\samples\ASDL_ROUTE\RoutingSrpInput.
Starting ASAP and submitting the work order.
The following examples provide samples of how each step can be configured.
The following example displays how to populate tbl_id_routing.
sqlplus -s $SARM_USER/$(GetPassword $SARM_USER 2)
<<HERE | grep -v "successfully completed”
set serveroutput on
var retval number
prompt Defining the ID_ROUTING Configurations
exec :retval := SSP_del_id_routing ;
exec :retval := SSP_new_id_routing ('BALTIMORE', '', 'BAL', 'CAL');
exec :retval := SSP_new_id_routing ('BALTIMORE', '', 'DEL', 'FAL);
exec :retval := SSP_new_id_routing ('BOSTON', '', '120000', '220000');
HERE
You can add new records to the database dynamically without downtime on the server by using the “Add new NE Configuration” command (113) of asap_utils. This command must be used after loading the ASAP database.
For more information on asap_utils, see the ASAP Server Configuration Guide.
For more information on the tbl_id_routing table, see the ASAP Developer Reference.
You can perform atomic action routing by using a user-defined procedure. Routing by user-defined procedure provides the following:
Allows for custom provided logic for atomic action routing.
Uses the atomic action parameter USER_ROUTING.
Uses the external interface SSP_get_user_routing.
Allows you to write your own routing logic using the predefined external user interface.
The USER_ROUTING parameter can be represented as any string of characters to a maximum of 255 characters. You can define it as part of a work order, or as a service action parameter.
If the atomic action parameter USER_ROUTING information is provided in the work order, then the user-defined stored procedure is called. The user-defined procedure takes the asdl_cmd and the value of USER_ROUTING as input arguments, and returns the host NE to be routed.
You can use the following stored procedure as an external interface:
SSP_get_user_routing (user_routing, asdl_cmd, host_clli, ret_val) – Returns a host NE (host_clli) that is used to route the atomic action. You must provide your own routing logic in the body of SSP_get_user_routing to find the host NE (CLLI) using the USER_ROUTING atomic action parameters, and the asdl_cmd if required.
For more information on the above stored procedure, refer to the ASAP Developer Reference.
To use USER_ROUTING, perform the following steps:
Write the stored procedure SSP_USER_ROUTING. A sample is located in ..\samples\ASDL_ROUTE\user_routing_proc.sp.
Define and populate the routing table, if required. A sample is located in ..\samples\ASDL_ROUTE\user_routing_table.tbl and ..\samples\ASDL_ROUTE\oraLoadRouting.
Define the atomic action parameter. A sample is located in ..\samples\ASDL_ROUTE\oraRoutingServices.
Define the work order. A sample is located in ..\samples\ASDL_ROUTE\RoutingSrpInput.
Run ASAP and submit the work order.
When you choose a user-defined procedure with a database table, the database must be accessed every time the routing is requested. Consequently, there will be a slight performance degradation.
You can edit routing definitions provided the new routing definition does not already exist in ASAP.
SSP_new_dn_map – This stored procedure defines atomic action command routings by directory number.
SSP_list_dn_map – This stored procedure lists directory mappings for atomic action command, directory, exchange number, or for all of them.
SSP_del_dn_map – This stored procedure deletes a directory number mapping from the SARM database.
Use the following stored procedures to define, list, and delete blackout definitions.
SSP_add_blackout – This procedure configures the static and dynamic blackout periods for a specific NE host.
SSP_list_blackout – This procedure lists blackout periods for a specific NE host.
SSP_del_blackout – This procedure removes blackout periods for a specific NE host.
For more information on these stored procedures, refer to ASAP Developer Reference.
The NEP communicates directly with NEs. However, support for a communications protocol may require a library that cannot co-exist with the libraries used by the NEP. In this case the required library is embedded in an External Device Driver (EDD), and the NEP communicates with the NEs through the EDD.
ASAP provides an EDD for non-UNIX or non-Linux devices (X.25, X.29, and SNMP) that communicate with NEs. The EDD acts as a gateway to transmit data between the NE and the NEP. The EDD can be used for either terminal emulation-type and message-type communication.
To configure an EDD, you must perform the following steps:
Refer also to the ASAP Developer Reference.
tbl_appl_proc is a static table that contains ASAP application information. ASAP uses this table to determine which applications to start, and the startup sequence. You must populate this table to add an EDD to the start-up procedure.
For more information on tbl_appl_proc, see tbl_appl_proc.
Use the following stored procedures to define, list, and delete EDDs:
CSP_new_appl – This stored procedure defines a new ASAP client or server application.
CSP_list_appl – This stored procedure lists ASAP application registration information for the specified appl_cd or all applications from the Control database.
CSP_del_appl – This stored procedure deletes ASAP application registration information from the Control database.
For more information on these stored procedures, refer to the ASAP Developer Reference.
tbl_component is a static table that contains a list of ASAP components for each ASAP territory and system. You must populate this table to add an EDD as an ASAP component.
For more information on tbl_component, see tbl_component.
Use the following stored procedures to define, list, and delete EDDs in a territory are:
CSP_new_component – This stored procedure defines an ASAP component in a territory.
CSP_list_component – This stored procedure lists ASAP components.
CSP_del_component – This stored procedure deletes an ASAP component.
For more information on these stored procedures, refer to the ASAP Developer Reference.
tbl_comm_param contains communication parameters required for the NEP to communicate with various external systems. You must populate this table to configure communication parameters.
Each device (command processor) in the NEP must be instructed as to which EDD it connects to. You must add the EDD IP address and port number to the tbl_comm_param table. The following tables identify the optional parameters that define the behavior of the EDD.
Device drivers for some device interfaces cannot exist within the NEP. To handle these external device drivers, the NEP has a generic terminal-based device driver.
Table B-1 Generic Port Terminal-based Communication Parameters
| Parameter | Default | Description |
|---|---|---|
|
Mandatory Parameters |
N/A |
- |
|
EDD_HOST_IPADDR |
N/A |
Network IP address for the machine on which the external device driver runs. |
|
EDD_PORT |
N/A |
EDD Listener Service port number. |
|
Optional Parameters |
N/A |
- |
|
OPEN_TIMEOUT |
N/A |
The wait timeout period, in seconds, that ASAP waits to open the device. The wait timeout parameter is only applicable to the serial interface. |
|
WRITE_TIMEOUT |
10 |
The wait timeout period, in seconds, that ASAP waits to write to the device. |
|
READ_TIMEOUT |
N/A |
The wait timeout period, in seconds, that ASAP waits to read from the device. Currently, this is only applicable to the socket interface. |
|
DISABLE_PORT_ON_LOGIN |
N/A |
Determines whether the port should be disabled if login to the NE fails. If the parameter is equal to zero, then the port is not disabled. |
|
VS_WIDTH |
N/A |
Virtual Screen width. |
|
VS_LENGTH |
N/A |
Virtual Screen length. |
|
VS_CRLF_MAP |
N/A |
A boolean flag that you can set to map LF to CR_LF automatically. The default is set not to map. |
|
GR_WAIT_TIMEOUT |
N/A |
The wait timeout period, in seconds, that the thread reading from the Virtual Screen waits for the thread writing to the Virtual Screen to notify it of any new data. Increase this value if the State Table processing fails before data arrives from the NE. |
|
SOCKET_CLIENT |
N/A |
Socket server or client. The only valid value is 'C' because the communication is a Telnet client. Not valid for the Java Telnet Interface. |
|
HOST_NAME |
N/A |
Machine name for the host NE. |
|
HOST_IPADDR |
N/A |
Network IP address for the host NE. |
|
PORT |
N/A |
Telnet service port. |
|
EDD_SOCKET_CLIENT |
C |
Socket server or client. The only valid value is 'C' because the communication from the NEP to the EDD is a socket client. |
|
EDD_SA_FAMILY |
2 |
The only valid value is '2' because only the Internet address family is supported. |
|
EDD_HOST_NAME |
"" |
Name of the machine on which the external device driver runs. |
Device drivers for some device interfaces cannot exist within the NEP. To handle these external device drivers, the NEP has a generic message-based device driver.
Table B-2 Generic Port Message-based Communication Parameters
| Parameter | Default | Description |
|---|---|---|
|
Mandatory Parameters |
N/A |
N/A |
|
EDD_HOST_IPADDR |
N/A |
Network IP address for the machine on which the external device driver runs. |
|
EDD_PORT |
N/A |
EDD Listener Service port number. |
|
Optional Parameters |
N/A |
N/A |
|
OPEN_TIMEOUT |
N/A |
The wait timeout period, in seconds, that ASAP waits to open the device. The wait timeout parameter is only applicable to the serial interface. |
|
WRITE_TIMEOUT |
10 |
The wait timeout period, in seconds, that ASAP waits to write to the device. |
|
READ_TIMEOUT |
N/A |
The wait timeout period, in seconds, that ASAP waits to read from the device. Currently, this is only applicable to the socket interface. |
|
DISABLE_PORT_ON_LOGIN |
N/A |
Determines whether the port should be disabled if login to the NE fails. If the parameter is equal to zero, then the port is not disabled. |
|
SOCKET_CLIENT |
N/A |
Socket server or client. The only valid value is 'C' because the communication is a Telnet client. Not valid for the Java Telnet Interface. |
|
EDD_SOCKET_CLIENT |
C |
Socket server or client. The only valid value is 'C' because the communication from the NEP to the EDD is a socket client. |
|
EDD_SA_FAMILY |
2 |
The only valid value is '2' because only the Internet address family is supported. |
|
EDD_HOST_NAME |
"" |
Name of the machine on which the external device driver runs. |
Setting Communication Parameters for X.25 and X.29 Interfaces
You must ensure that all mandatory parameters are set in tbl_comm_param before starting ASAP. The parameters must be set up properly in order for the NEP to establish a connection to the X.2X EDD.
For more information on tbl_comm_param, see tbl_comm_param in the ASAP Developer Reference.
Table B-3 X. 25 and X.29 Interface Communication Parameters
| Parameter Label | Default | Description |
|---|---|---|
|
EDD_HOST_IPADDR |
None |
The IP address of X.2X EDD for the NEP to establish connections. |
|
EDD_PORT |
None |
The port number of X.2X EDD for the NEP to establish connections. |
|
X25_VC_TYPE |
S |
The virtual circuit, either SVC or PVC. Possible values:
|
|
X25_CALLING_ADDR |
None |
The calling address on X.25. |
|
X25_CALLED_ADDR |
None |
The called address on X.25. |
|
X25_CUD |
NULL |
The call user data. The data should be hexadecimal format. If the protocol for the connection is X.29, the first 8 characters must be '01000000'. |
|
X25_LINK_ID |
0xff |
The X.25 link ID number. When this parameter is 0xff, SunLink X.25 attempts to match the called address with an entry in a routing configuration file. If it cannot find a match, it routes the call over the lowest numbered WAN link. |
|
X25_INTERFACE |
NULL |
The name of the X.25 interface set during the set up of the X.25 configuration. For HP, the “Programmatic Access Name” value is equivalent to the X25_INTERFACE value. |
|
yX25_LOG_CHANNEL_ID |
None |
The logical channel numbers on X.25. |
|
X25_D_BIT |
1 |
Boolean flag that enables D bit on X.25. Possible values: '1' or '0'. If the flag is '1', the NE always responds to the previous data packet for the remote DTE. |
|
EDD_CONNECTION_TIME |
60 |
The connection timeout interval to retrieve EDD header information. |
The following table describes the SNMP State Table API communication parameters for the EDD in the tbl_comm_param SARM database.
For more information on tbl_comm_param, see tbl_comm_param in the ASAP Developer Reference.
Table B-4 SNMP NE Interface Communication Parameters
| Parameter | Required | Description |
|---|---|---|
|
REMOTE_AGT_NAME |
Optional |
Specifies the name of the SNMP agent. |
|
REMOTE_AGT_IP_ADDR |
Optional |
Specifies the IP address of the SNMP agent. |
|
REMOTE_AGT_PORT |
Optional |
Specifies the port number of the SNMP agent. |
|
REMOTE_MGR_NAME |
Optional |
Specifies the name of the SNMP Manager. |
|
REMOTE_MGR_IP_ADDR |
Optional |
Specifies the IP address of the SNMP Manager. |
|
REMOTE_MGR_PORT |
Optional |
Specifies the port number of the SNMP Manager. |
|
SNMP_V1_AUTH_INFO |
Mandatory for SNMPv1 |
Specifies the community string for SNMP version 1. |
|
SNMP_V2C_AUTH_INFO |
Mandatory for SNMPv2c |
Specifies the community string for the SNMP version 2C. |
|
SNMPv3_AUTH_USER |
Mandatory for SNMPv3 |
Specifies the authorized user for SNMP version 3. |
|
SNMP_TRAP_PORT |
Optional |
Specifies the port number which the SNMP trap will be delivered. If it is not specified, no trap message is delivered. |
|
SNMP_NEED_INFORM |
Optional |
Specifies whether the EDD accepts the SNMP Inform Request. Set this value to 1 if Inform request is accepted. |
|
WRITE_TIMEOUT |
Optional |
Specifies the maximum amount of time in seconds that a State Table program waits for the response to become available. The default value is 5 seconds. |
|
EDD_HOST_IP_ADDR |
Mandatory |
Network IP address for the machine on which the EDD runs. |
|
EDD_PORT |
Mandatory |
EDD Listener Service port number. |
|
EDD_SA_FAMILY |
Mandatory |
Socket family. The only valid value is 2, because only Internet Address Family is supported. |
Use the following stored procedures to define and delete communication parameters:
SSP_new_comm_param – This stored procedure defines a communication parameter for a specified device type, host, and device into the SARM database.
SSP_del_comm_param – This stored procedure deletes communication parameter information from the SARM database.
For more information on these stored procedures, see the ASAP Developer Reference.
The EDD determines its IP address and port number from the ASAP.cfg file. The IP address is specified by the variable SERVER_IPADDR and the port number is specified by SERVER_PORT.
For more information on configuration parameters for each optional NE interface, refer to the appropriate NE Interface section of this chapter.
The NEP supports the X.25 and X.29 protocols. The X.2X EDD is an external device driver that allows the NEP to easily communicate with an NE through either the X.25 or X.29 protocol.
The EDD acts as a gateway where each connection goes into the X.25 EDD and comes out as one X.25 logical channel. Each command processor deals with one X.25 logical channel.
The X.2X EDD communicates with an NE through X.25 when the NE is in packet mode. The X.2X EDD is also able to communicate with an NE through X.29 when the NE is in non-packet mode DTE (Data Terminal Equipment), or start-stop mode DTE.
For more information, see the discussion on BX25_EDD configuration parameters in the ASAP Server Configuration Guide.
ASAP includes NEP support for the SNMP NE Interface.
This section describes the configurable aspects of the SNMP NE interface and the configuration process.
SNMP Research Toolkit Configuration
The SNMP Research BRASS (Bilingual Request and Security Subsystem) Server is used to support the SNMP option. The BRASS Server is a management multiplexer that is used with the ASAP SNMP NEP. The BRASS Server maintains information about MIB variables, performs SNMP requests and filters incoming SNMP Trap messages. As a multiplexer, the BRASS Server coordinates SNMP management operations for many connected instances of ASAP SNMP NEP applications.
SNMP Research Asynchronous Request Library requires an environment variable named SR_MGR_CONF_DIR to determine where the MIB compiler generated configuration files are located.
The BRASS Server is bundled with ASAP, however, it must be started manually prior to starting the SNMP NEP.
For more information, refer to SNMP Research documentation.
|
 Copyright © 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
