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

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 (serial execution) or default_degree (the system default value based on number of CPUs and initialization parameters), according to the size of the object.

Yes

I

asdl_cmd

The ASDL command to be deleted.

No

I

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

asdl_cmd

The ASDL command.

No

I

parm_seq_no

The parameter sequence number.

No

I

mach_clli

The remote NE.

No

I

asdl_cmd

ASDL command.

No

I

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

• P – SNMP 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

csdl_cmd

The CSDL command.

No

I

asdl_seq_no

The sequence number of the ASDL command.

No

I

csdl_cmd

The CSDL command.

No

I

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

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

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

host_clli

The host NE identifier of an NE or SRP.

No

I

nep_svr_cd

The NEP managing the secondary pool of devices.

No

I

program

The State Table program identifier.

Yes

I

line_no

The State Table line number to delete. If set to NULL, all lines of the State Table are deleted.

No

I

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

asap_sys

The ASAP environment (TEST, PROD, and so on).

No

I

device

The physical or logical device name.

No

I

srp_id

The logical SRP name.

No

I

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

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

uid

The user ID.

No

I

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

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

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

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

State Table program

RC1

Oracle Database Ref Cursor.

Yes

I/O

asdl_cmd

The ASDL command identifier.

No

I

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.

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 State Table program.

No

I

interpreter_type

A value of 'S' indicates a State Table interpreter. A value of J indicates a JInterpreter. A null value defaults to S.

No

I

tech

TYP_tech

Technology.

sftwr_load

TYP_load

Software loads.

asdl_cmd

TYP_asdl_cmd

ASDL command.

program

TYP_program

State Table program.

RC1

Oracle Database Ref Cursor.

Yes

I/O

asdl_cmd

The ASDL command.

No

I

asdl_parm_lbl

The ASDL parameter label.

No

I

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.

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

mach_clli

TYP_clli

Remote NE.

host_clli

TYP_clli

Host NE.

asdl_cmd

TYP_asdl_cmd

ASDL command identifier.

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

• P – SNMP 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

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

• P – SNMP 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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

RC2

Oracle Database Ref Cursor.

Yes

I/O

csdl

The name of the CSDL.

Yes

I

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.

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

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

csdl_cmd

The CSDL command identifier.

No

I

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.

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

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

RC2

Oracle Database Ref Cursor.

Yes

I/O

host

The host CLLI identifier.

Yes

I

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.

RC1

Oracle Database Ref Cursor.

No

I/O

host_clli

The host NE identifier.

Yes

I

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

lang_cd

The language code.

No

I

msg_id

Unique message identifier.

No

I

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

host_clli

The host NE identifier of an NE or SRP.

No

I

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

nep_svr_cd

The NEP managing the secondary pool of devices.

No

I

nep_svr_cd

TYP_code

The NEP managing the secondary pool of devices.

dialup_pool

TYP_pool

Secondary pool of devices.

RC1

Oracle Database Ref Cursor.

Yes

I/O

program

The State Table program name.

No

I

program

TYP_program

The name of the State Table program.

line_no

int

The line number in the State Table 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 State Table action.

act_int

int

The action integer which represents the next line number in the State Table program at which the execution of the State Table should continue, or a numeric field specific to the particular action function.

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

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 kill 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).

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

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

srp_id

The logical SRP name.

No

I

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.

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

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.

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

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.

RC1

Oracle Database Ref Cursor.

Yes

I/O

uid

The user ID.

No

I

uid

TYP_user_id

The user ID.

pwd

TYP_pwd

User password.

status

varchar(40)

User's current status.

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

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 State Table name.

Yes

I

interpreter_type

A value of 'S' indicates a State Table interpreter, whereas a value of 'J' indicates a JInterpreter. A null value defaults to 'S'.

Yes

I

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 the NEP State Tables. 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 State Table or 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

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

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

• P – SNMP 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

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 execution 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

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 execution 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

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

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

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

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

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

nep_svr_cd

The NEP managing the secondary pool of devices.

Yes

I

dialup_pool

The secondary pool of devices.

No

I

program

The State Table program identifier.

Yes

I

line_no

The State Table line number to delete. If set to NULL, all lines of the State Table 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 State Table.

Yes

I

act_int

The action integer.

Yes

I

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

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

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

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

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

uid

The user ID.

Yes

I

pwd

The password.

Yes

I

status

The user's current status.

No

I

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

user_type

The user-defined error type.

Yes

I

asdl

The ASDL that is executing. Error types can be defined for user_type and ASDL combinations.

No

I

csdl

The CSDL that is executing. 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

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

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

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.

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

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.

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

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.

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

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 executing. Error types can be defined for user_type and ASDL combinations.

No

I

csdl

The CSDL that is executing. 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

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

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

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

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

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.

SWD_LISTEN_PORT

N/A

Global

TCP/IP listen port for the SARM server.

SWD_IDLE_TIMEOUT

120

Global

Idle period in seconds for automatically disconnecting the SWD session if no activity is detected.

Message Type

0

4

Integer message type to be processed.

Data Length

4

4

Integer message data length.

Message Data

8

variable

Optional message data. The format is dependent on message type and is specified below for each type.

1

HOST=<hostname>; USERID=<userid>

Connect to the specified NE for an SWD session (SWD_CLT_\CONNECT).

2

keystroke data

User entered keystroke data. This is binary data (SWD_CLT_DATA).

3

User entered break key (SWD_CLT_BREAK_KEY).

4

SWD session complete (SWD_CLT_NE_DISCONNECT).

10

STATUS=<2-digit status value>; ERR_MSG=<error message>

Connection acknowledgment message (SWD_SESS_CONNECT_ACK).

11

session data

Session data returned by the NE (SWD_SESS_DATA).

12

Unexpected port disconnection (SWD_SESS_NE_PORT_FAILURE).

13

SWD session timeout (SWD_SESS_TIMEOUT).

1

SWD Session to Host established successfully.

Connected successfully to Host.

2

Time out waiting for NE Connection Request from SWD Client.

Timed out waiting for SWD Connect Request.

3

ASAP not configured to connect to NE.

Invalid Host CLLI.

4

NE does not support SWD Session.

NEP does not support SWD Sessions

5

NEP in loopback mode.

NEP in loopback mode.

6

SWD Session to NE already attempted or in use.

SWD Session to NE already exists or attempted.

7

NEP connecting to NE is down.

NEP down.

8

NE is down.

NE down.

9

NEP connecting to NE is in maintenance mode.

NE in maintenance or blackout mode.

10

NE is disabled.

NE is disabled.

11

NE is busy provisioning for more than the “SWD_CONNECT_WAIT_TIMEOUT" seconds.

Timed out waiting for connection. NE is busy provisioning.

12

Resource Allocation Error; Cannot connect to NEP.

System Resource Error.

13

Not connected yet.

Data/Break/Disconnect request from SWD Client rejected because NE Connect Request not received yet.

14

Connected already.

NE Connect Request rejected since the SWD Client is already connected to an NE.

srq_id

Service request identifier.

Yes

I

asdl_unid

ASDL identifier.

Yes

I

num_sw_history

Number of ASDL switch history occurrences for this ASDL.

Yes

O

num_params

Number of parameters used by this ASDL.

Yes

1

RC1

Oracle Database Ref Cursor.

Yes

I/O

srq_id

Service request identifier.

Yes

I

csdl_seq_no

CSDL sequence number.

Yes

I

asdl_cmd

TYP_asdl_cmd

ASDL command.

asdl_stat

TYP_asdl_stat

ASDL status updated while this ASDL is in progress.

asdl_unid

TYP_seq_no

A unique ASDL identifier generated when an ASDL is routed to an NE.

host_clli

TYP_clli

The Host NE to which the ASDL command is routed by the SARM.

rollback_asdl

TYP_asdl_cmd

ASDL command used to roll back the original ASDL.

comp_dts

datetime

The completion date and time of the ASDL processing.

rollback_dts

datetime

The date and time of the ASDL rollback, if rollback was required on this ASDL.

description

varchar(40)

ASDL command description.

queue_dts

datetime

Queuing date and time for the ASDL command to the NE.

start_dts

datetime

Provisioning start date and time for the ASDL command.

retry_count

TYP_long

Number of times the ASDL command was retried.

stat_text

TYP_stat_text

The status text for the ASDL.

RC1

Oracle Database Ref Cursor.

Yes

I/O

srq_id

Service request identifier.

Yes

I

asdl_unid

ASDL identifier.

Yes

I

parm_lbl

TYP_parm_lbl

Parameter name.

parm_vlu

TYP_parm_vlu

Parameter value.

RC1

Oracle Database Ref Cursor.

Yes

I/O

srq_id

Service request identifier.

Yes

I

asdl_unid

ASDL identifier.

Yes

I

evt_dt_tm

datetime

Event timestamp.

csdl_seq_no

TYP_seq_no

Sequence number for the CSDL associated with the ASDL command.

srq_stat

TYP_srq_stat

Service request status.

evt_text

TYP_evt_text

Switch history record. Note that each returned event text field may contain new line characters within the event text itself.

srq_id

Service request identifier.

Yes

I

csdl_seq_no

CSDL sequence number.

Yes

I

num_events

Number of CSDL provisioning events for this CSDL.

Yes

O

num_sw_history

Number of ASDL switch history occurrences for this ASDL.

Yes

O

num_asdl

Number of ASDLs which have been executed for this CSDL.

Yes

O

num_csdl_params

Number of CSDL parameters for this CSDL.

Yes

O

RC1

Oracle Database Ref Cursor.

Yes

I/O

srq_id

Service request identifier.

Yes

I

csdl_seq_no

CSDL sequence number.

Yes

I

evt_dt_tm

datetime

Date and time that the event occurred.

evt_text

TYP_evt_text

Switch history record. Note that each returned event text field may contain new line characters within the event text itself.

srq_evt

TYP_srq_evt

The service request log event.

srq_stat

TYP_srq_stat

Status of the service request at the time the event occurred.

stat_text

TYP_stat_text

Status text for the service request.

RC1

Oracle Database Ref Cursor.

Yes

I/O

srq_id

Service request identifier.

Yes

I

csdl_seq_no

TYP_seq_no

Sequence number for the CSDL associated with the ASDL command.

actn_noun_lbl

TYP_csdl_cmd

CSDL command.

csdl_st

TYP_csdl_st

CSDL command status.

asdl_seq_no

TYP_seq_no

ASDL command sequence number.

index_parm_cnt

TYP_seq_no

Index parameter count for the current ASDL command.

asdl_route

TYP_asdl_route

Routing status of the current ASDL command.

csdl_id

TYP_unid

CSDL identification specified by SRP.

asdl_route_rep_1

TYP_asdl_route

Routing status of the current ASDL command.

csdl_type

TYP_csdl_type

Type of CSDL command (for example, ORIGINAL, REVISION, SAS_ORIGINAL, SAS_REVISION).

orig_seq_no

TYP_seq_no

Original CSDL command sequence number associated with revision CSDL commands.

estimate

TYP_long

Initial estimate for ASDL processing calculated when the CSDL command was received.

start_dts

datetime