Table of Contents
- Title and Copyright Information
- Preface
-
1
Development Overview
- Application architecture
-
Library architecture
- ASAP API development structure
-
API library structures
- Common API library – libasc
- Client application API library – libclient
- Server application API library – libcontrol
- Interpreter API library – libinterpret
- SRP API library – libsrp
- NEP API library – libnep
- Multi-protocol communications API library – libasccomm
- Generic external device driver library – libgedd
- Network element configuration library – libnecfg
- ASAP API application development
- SRP server application structure
- Generic NEP application structure
- Multi-protocol NEP structure
- Development of Cartridges supporting Asynchronous NEs
-
2
ASAP Database Tables
- Control database
-
SARM database
- Work order audit information
-
SARM database tables
- tbl_asap_srp
- tbl_asap_stats
- tbl_asdl_config
- tbl_asdl_log
- tbl_asdl_parm
- tbl_asdl_response
- tbl_aux_wo_prop
- tbl_blackout
- tbl_clli_route
- tbl_comm_param
- tbl_cp_mux
- tbl_csdl_asdl
- tbl_csdl_asdl_eval
- tbl_csdl_config
- tbl_err_threshold
- tbl_event_dataset
- tbl_event_template
- tbl_ext_method_lib
- tbl_host_clli
- tbl_id_routing
- tbl_info_parm
- tbl_label_value
- tbl_large_data
- tbl_msg_convert
- tbl_ne_config
- tbl_ne_event
- tbl_ne_monitor
- tbl_ne_strsub
- tbl_nep
- tbl_nep_asdl_prog
- tbl_nep_mux
- tbl_nep_jprogram
- tbl_nep_program
- tbl_nep_program_source
- tbl_nep_rte_asdl_nxx
- tbl_order_events
- tbl_order_translation
- tbl_resource_pool
- tbl_srq
- tbl_srq_asdl_parm
- tbl_srq_csdl
- tbl_srq_log
- tbl_srq_parm
- tbl_srt_bundle
- tbl_srt_bundle_csdl
- tbl_srt_config_reload
- tbl_srt_correlation
- tbl_srt_csdl_parm
- tbl_srt_ctx
- srt_header_mapping
- tbl_srt_lookup
- tbl_srt_lookup_input
- tbl_srt_lookup_output
- tbl_srt_query_spawn
- tbl_stubs
- tbl_test_rpc_parm
- tbl_stat_text
- tbl_unload_sp
- tbl_unload_param
- temp_wrk_ord
- tbl_uid_pwd
- tbl_unid
- tbl_user_err
- tbl_user_err_threshold
- tbl_usr_wo_prop
- tbl_wo_audit
- tbl_wo_event_queue
- tbl_wrk_ord (SARM)
- temp_csdl_estim
- temp_csdl_list
- NEP database
-
Admin database
-
User-created database tables
- tbl_asap_sarm
- tbl_oca_svr
- tbl_perf_asdl
- tbl_perf_csdl
- tbl_perf_ne
- tbl_perf_ne_asdl
- tbl_perf_order
- tbl_aims_msg_convert
- tbl_aims_preference
- tbl_aims_map_acl (Not used)
- tbl_aims_audit_log (Not used)
- tbl_aims_component
- tbl_aims_function
- tbl_aims_operation
- tbl_aims_param
- tbl_aims_rpc
- tbl_aims_rpc_defn
- tbl_aims_rpc_dest
- tbl_aims_rpc_dest_defn
- tbl_aims_rpc_param
- tbl_aims_rpc_param_defn
- tbl_aims_rpc_param_type
- tbl_aims_template
-
User-created database tables
- C++ SRP API emulator database
-
3
Shared Libraries
-
Common library interface
- Global variables
- Open client library API functions
- Oracle Functions
- I/O management
- Event notification and diagnostic functions
- Application configuration determination functions
- Memory management functions
- Performance parameter management
- Self-balancing trees
- Date conversion functions
- Miscellaneous functions
- Self-balancing tree examples
- Inline functions
-
Common library interface functions
- appl_initialize
- ASC_accept
- ASC_alloc
- ASC_bmove
- ASC_bzero
- ASC_close
- ASC_connect
- ASC_convert_msg
- ASC_convert_msg_user
- ASC_cpalloc
- ASC_cpcheck
- ASC_cpclose
- ASC_cpfree
- ASC_cpopen
- ASC_cprpcexec
- ASC_create_SBT
- ASC_cur_dts
- ASC_cur_tm
- ASC_delete_element_SBT
- ASC_delete_index_SBT()
- ASC_destroy_SBT
- ASC_diag
- ASC_diag_format
- ASC_diag_on
- ASC_disconnect
- ASC_dts_to_str
- ASC_event
- ASC_event_initialize
- ASC_find_first_SBT
- ASC_find_free_SBT
- ASC_find_index_SBT
- ASC_find_init_SBT
- ASC_find_next_SBT
- ASC_free
- ASC_GET_CMD
- ASC_get_config_param
- ASC_GET_CONTEXT
- ASC_GET_SERVER
- ASC_getc
- ASC_gettimeofday
- ASC_hex_dump
- ASC_hex_dump_to_file
- ASC_imsg_types
- ASC_imsg_types_user
- ASC_insert_element_SBT
- ASC_IS_OPEN
- ASC_lda_to_oci8
- ASC_listen
- ASC_load_msg_tbl
- ASC_oci8_to_lda
- ASC_ocican_cursor
- ASC_ociclose
- ASC_ociclose_cursor
- ASC_ocicreate_cmd
- ASC_ocicreate_list
- ASC_ocidestroy_list
- ASC_ocifetch
- ASC_ociopen
- ASC_ociopen_cursor
- ASC_ociparse
- ASC_ocistatus
- ASC_open
- ASC_putc
- ASC_read
- ASC_realloc
- ASC_reset_file_status
- ASC_rstrcmp
- ASC_sec_to_dBdts
- ASC_set_fd_blocking
- ASC_set_fd_nonblocking
- ASC_set_new_handler
- ASC_sleep
- ASC_str_to_dts
- ASC_walk_SBT
- ASC_write
- get_name_value
- MS_DIFF
- TODAY
- Common library interface data types
-
Server library interface
- Functions and structures
- Inline functions
-
Server application functions
- add_appl_rpc
- add_lang_handler
- add_registered_proc
- add_rpc
- ASC_alarm
- ASC_await_init_completion
- ASC_blk_alloc
- ASC_BLK_ALLOC
- ASC_BLK_FREE
- ASC_blk_realloc
- ASC_BLK_REALLOC
- ASC_cpdbpcreate
- ASC_cpdbpdestroy
- ASC_cppalloc
- ASC_cppfree
- ASC_createmsgq
- ASC_createmutex
- ASC_define_events
- ASC_define_rpc
- ASC_deletemsgq
- ASC_deletemutex
- ASC_get_reg_param
- ASC_getmsgq
- ASC_getpid
- ASC_get_securedata
- ASC_handle_results
- ASC_in_system
- ASC_in_territory
- ASC_lockmutex
- ASC_lock_strtok
- ASC_malarm
- ASC_mem_alloc
- ASC_mem_free
- ASC_msleep
- ASC_poll
- ASC_poll_timer
- ASC_putmsgq
- ASC_reg_init_func
- ASC_send_text
- ASC_sendinfo
- ASC_set_securedata
- ASC_spawn
- ASC_srv_field_bool
- ASC_srv_field_int
- ASC_srv_field_str
- ASC_srv_sleep
- ASC_stack_trace
- ASC_thread_field_bool
- ASC_thread_field_int
- ASC_thread_field_str
- ASC_threadproc
- ASC_unlockmutex
- ASC_unlock_strtok
- background_process_init
- Server application data types
- Client library interface
-
Interpreter library
- Inline functions
-
Interpreter library functions
- ASC_alloc_Interpreter
- ASC_delete_int_var
- ASC_free_Interpreter
- ASC_get_dev_sess_data
- ASC_get_int_appl_data
- ASC_get_int_var
- ASC_init_Interpreter
- ASC_Interpreter
- ASC_set_dev_sess_data
- ASC_set_int_appl_data
- ASC_store_int_var
- CMD_delete_var
- CMD_expand_action_string
- CMD_free_assignment
- CMD_free_bvar_assignment
- CMD_free_dbproc
- CMD_get_assignment
- CMD_get_bvar
- CMD_get_bvar_assignment
- CMD_get_var
- CMD_lock_regexpr
- CMD_parse_assignment
- CMD_store_bvar
- CMD_store_var
- CMD_store_zero_pad_var
- CMD_unlock_regexpr
- CMD_user_actions
-
Control configuration interface
-
Interface definitions
- CSP_db_admin
- CSP_del_alarm
- CSP_del_appl
- CSP_del_center
- CSP_del_code
- CSP_del_component
- CSP_del_db_thresh
- CSP_del_event
- CSP_del_fs_thresh
- CSP_del_listener
- CSP_del_nvp
- CSP_get_listener
- CSP_list_alarm
- CSP_list_appl
- CSP_list_center
- CSP_list_code
- CSP_list_component
- CSP_list_db_thresh
- CSP_list_event
- CSP_list_fs_thresh
- CSP_list_nvp
- CSP_new_alarm
- CSP_new_appl
- CSP_new_center
- CSP_new_code
- CSP_new_component
- CSP_new_db_thresh
- CSP_new_event
- CSP_new_fs_thresh
- CSP_new_listener
- CSP_new_nvp
-
Interface definitions
-
Object oriented (OO) common library
- ASC_Main class
- Diagnosis class
- Event class
- EventAgent class
-
ClientProc class
- Synopsis
- Constructors
- Public methods
- cprpcexec
- cpopen
- cpclose
- cpcheck
- IS_OPEN
- get_cp
- is_busy
- get_return_status
- cancelOperation
- get_db_type
- m_alloc_mtx_
- m_init_mtx_
- Public methods
- ocicreate_list
- ocidestroy_list
- ocifetch
- ocistatus
- ocican_cursor
- ociopen_cursor
- ociclose_cursor
- ociparse
- ocicreate_cmd
- ocirpcexec
- dts_to_str
- str_to_dts
- MT-Safety in shared mode
- ClntProcMgr class
- Config class
- Common class
- ASC thread library
- XML JMX interface
- ASAP daemon API
-
Common library interface
-
4
Provisioning Interfaces
-
SARM configuration interface
-
Static table configuration
- SSP_db_admin
- SSP_gather_asap_stats
- SSP_del_asdl_defn
- SSP_del_asdl_map
- SSP_del_asdl_parm
- SSP_del_clli_map
- SSP_del_comm_param
- SSP_del_csdl_asdl
- SSP_del_csdl_defn
- SSP_del_dn_map
- SSP_del_id_routing
- SSP_del_intl_msg
- SSP_del_ne_host
- SSP_del_nep
- SSP_del_nep_program
- SSP_del_net_elem
- SSP_del_resource
- SSP_del_srp
- SSP_del_stat_text
- SSP_del_user_err_threshold
- SSP_del_userid
- SSP_get_async_ne
- SSP_get_user_routing
- SSP_list_asdl
- SSP_list_asdl_defn
- SSP_list_asdl_map
- SSP_list_asdl_parm
- SSP_list_clli_map
- SSP_list_comm_param
- SSP_list_csdl
- SSP_list_csdl_asdl
- SSP_list_csdl_defn
- SSP_list_dn_map
- SSP_list_host
- SSP_list_id_routing
- SSP_list_intl_msg
- SSP_list_ne_host
- SSP_list_nep
- SSP_list_nep_program
- SSP_list_net_elem
- SSP_list_resource
- SSP_list_srp
- SSP_list_stat_text
- SSP_list_user_err_threshold
- SSP_list_userid
- SSP_ne_monitor
- SSP_new_asdl_defn
- SSP_new_asdl_map
- SSP_new_asdl_parm
- SSP_new_clli_map
- SSP_new_comm_param
- SSP_new_csdl_asdl
- SSP_new_csdl_asdl_idx
- SSP_new_csdl_defn
- SSP_new_dn_map
- SSP_new_id_routing
- SSP_new_intl_msg
- SSP_new_ne_host
- SSP_new_nep
- SSP_new_nep_program
- SSP_new_net_elem
- SSP_new_resource
- SSP_new_srp
- SSP_new_stat_text
- SSP_new_user_err_threshold
- SSP_new_userid
- SSP_orphan_purge
- Error management
- Switch blackout processing
- Switch direct interface (SWD)
- Stop work order interface
- Localizing International Messages
-
Static table configuration
-
SARM provisioning interface
- SARM interface RPCs
-
Update RPC interface definitions
- CSDL processing model
- functions
- SAS_abort_csdl
- SAS_abort_wo
- SAS_add_csdl
- SAS_add_csdl_parm
- SAS_add_wo_parm
- SAS_change_due_dt
- SAS_change_priority
- SAS_delete_csdl_parm
- SAS_delete_wo_parm
- SAS_get_csdl_stat
- SAS_get_srq_stat
- SAS_get_wo_stat
- SAS_hold_wo
- SAS_lock_wo
- SAS_move_csdl
- SAS_release_wo
- SAS_renumber_csdl
- SAS_resubmit_wo
- SAS_updt_csdl_parm
- SAS_updt_wo_parm
- Control interface RPCs
- SAS_list_alarm_log
- SAS_list_appl_proc
- SAS_list_event_log
- SAS_list_proc_info
- Real-time performance data gathering
- ADM_asdl_stats, PSP_asdl_stats
- ADM_csdl_stats, PSP_csdl_stats
- PSP_db_admin
- ADM_ne_asdl_stats, PSP_ne_asdl_stats
- ADM_ne_stats, PSP_ne_stats
- ADM_order_stats, PSP_order_stats
- Switch activation and deactivation
- SSP_ne_control
-
C++ SRP API library
- SRP_Context class
- SRP_Parameter class
- SRP_CSDL class
-
SRP_WO class
- Synopsis
- Constructors
- Work order properties
- Public methods
- getWoId
- setWoId
- getDueDate
- setDueDate
- getOperation
- setOperation
- getMisc
- setMisc
- getOrgUnit
- setOrgUnit
- getOrigin
- setOrigin
- getEstimate
- getStatus
- getAsdlTimeout
- setAsdlTimeout
- getUserId
- setUserId
- getPassword
- setPassword
- getPriority
- setPriority
- getSrqAction
- setSrqAction
- getParentWo
- setParentWo
- getWoTimeout
- setWoTimeout
- getRetry
- setRetry
- getRetryInt
- setRetryInt
- getRback
- setRback
- getDelayFail
- setDelayFail
- getDelayFailThreshold
- setDelayFailThreshold
- getBatchGroup
- setBatchGroup
- getExtSysId
- setExtSysId
- getUserData
- setUserData
- getApplName
- setApplName
- getProperty
- setProperty
- addCsdl
- addGlobalParameter
- restore
- getGlobalParameterCount
- getCsdlCount
- submit
- deleteInSarm
- changeStatus
- deleteAll
- findGlobalParameter
- removeGlobalParameter
- findCsdl
- findCsdlBySequence
- removeCsdl
- lock
- unlock
- SRP_WoUtils class
- SRP_EventInterfaceFactory class
- SRP_EventInterface class
- SRP_Event class
- SRP_WoCompleteEvent class
- SRP_WoFailureEvent class
- SRP_SoftErrorEvent class
- SRP_WoEstimateEvent class
- SRP_WoStartupEvent class
- SRP_WoRollbackEvent class
- SRP_NEUnknownEvent class
- SRP_WoBlockEvent class
- SRP_WoTimeOutEvent class
- SRP_NEAvailEvent class
- SRP_NEUnAvailEvent class
- SRP_WoAcceptEvent class
- ASC_RetrieveInfo class
- ASC_CsdlListInfo class
- ASC_CsdlLogInfo class
- ASC_WoLogInfo class
- ASC_WoParamInfo class
- ASC_WoRevInfo class
- ASC_RetrieveInfoSet class
- ASC_RetrieveRequest class
-
SARM configuration interface
-
5
Downstream Interfaces
- NEP library
- Protocol-specific libraries
-
External device driver
- External device driver architecture
- Data architecture
- Transactions
- Functions of libgedd
-
Library functions
- gedd_add_fd
- gedd_api_connect_ack
- gedd_api_disconnect_ack
- gedd_appl_poll_get_req
- gedd_block_sigio
- gedd_get_appl_data
- gedd_get_conn_param
- gedd_get_fd
- gedd_get_listen_fd
- gedd_poll
- gedd_poll_get_req
- gedd_send_to_nep
- gedd_set_appl_data
- gedd_sigio_occurred
- gedd_sigio_reset
- gedd_signal_get_req
- gedd_unblock_sigio
- Building an EDD application
-
Action functions
- State Table Components
- Customizing action functions
- State Table Interpreter action functions
-
General action functions
- # – Comment character
- BCONCAT
- CALC
- CALL
- CASE
- CHAIN
- CLEAR
- CMD_DUMP
- CMPND_COPY
- COMMENT
- CONCAT
- COPY_TO_ASCII
- DECREMENT
- DEF_REGEXPR
- DEFAULT
- DEL_REGEXPR
- DIAG
- ELSE
- ELSE_IF
- ENDIF
- ENDSWITCH
- ENDWHILE
- ERROR_STATUS
- EVENT
- EXEC
- EXEC_RPC
- EXEC_RPCV
- EXIT
- EXPR_GOSUB
- FUNCTION
- GET_REGEXPR
- GOSUB
- GOTO
- IF
- IF_THEN
- IFDEF
- IFNDEF
- INCREMENT
- IND_SET
- LENGTH
- MAP_GOSUB
- MAP_OPTION
- MASK
- NEW_MAP
- PAD_CHAR
- PAUSE
- RETURN
- SUBSTR
- SWITCH
- TRIM
- WAIT
- WHILE
- ZERO_PAD
-
NEP action functions
- ADD_HEADER
- ASC_TO_BIN
- ASDL_EXIT
- BIN_TO_ASC
- CLEAR_VS
- ERROR
- GET
- GET_INCPT
- GET_LTG
- GET_P_PARMS
- GET_SECUREDATA
- GET_SW_FEAT
- LOG
- LOG_STAT
- MSGSEND
- MSGRECV
- NVIS_PARSER
- PARAM_GROUP
- RESPONSELOG
- SCREEN_RESP
- SEND
- SEND_COMPND
- SENDECHO
- SENDKEY
- SETOPTION
- SEND_PARAM
- SEND_RESP
- SET_SECUREDATA
- STATS_ON
- VS_COPY_RESP
- VS_GET_RESP
- VS_SEND_RESP
- VS_STOP_RESP
- LAM action functions
- FTP action functions
- I/O Action Functions
- SNMP action functions
- LDAP action functions
- 6 Web Services
- A Sample Thread Framework Application
- B Oracle Execution Examples
-
C
C++ SRP API Template Design
- API library structures
- C++ SRP API components
- Communication between threads
- Multiple instances of threads
- Communications with ASAP internal systems
- Upstream system interface
- API libraries
- C++ SRP threads
- C++ SRP API specification template example
- Communication interface
- D API and Other Configuration Changes