Alcatel in

Oracle Communications ASAP Cartridge 1.
0
GA Release for Alcatel IN
Alcatel IN 1.0 Cartridge

Guide
Fourth Edition
July 2008
Copyright and Trademark Information

Copyright 1992, 2008, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of
their respective owners.
This software and related documentation are provided under a license agreement containing restrictions on use
and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license
agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit,
distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering,
disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of
the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data
delivered to U.S. Government customers are "commercial computer software" or "commercial technical data"
pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As
such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license
terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the
Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License
(December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software is developed for general use in a variety of information management applications. It is not
developed or intended for use in any inherently dangerous applications, including applications which may create
a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take
all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle
Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous
applications.
This software and documentation may provide access to or information on content, products and services from
third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of
any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not
be responsible for any loss, costs, or damages incurred due to your access to or use of third party content,
products or services.
Contents
1. Contents ......................................................................................................... i
1. Cartridge Overview ...................................................................................... 1
Cartridge content ................................................................................................................... 2
Prerequisites ......................................................................................................................... 2
About this guide .................................................................................................................... 2
Services, features, and options ............................................................................................. 3
Hardware and software requirements ................................................................................... 5
Network element (NE) interface ...................................................................................... 5
ASAP version ................................................................................................................. 5
Connecting to the NE ............................................................................................................ 6
2. Installing and Testing the Cartridge ........................................................... 7

Downloading the cartridge .................................................................................................... 7
Starting ASAP ....................................................................................................................... 8
Installing the cartridge ........................................................................................................... 9
Configuring the communication parameters (tbl_comm_param) .................................. 10
Uninstalling the cartridge ..................................................................................................... 11
Testing the cartridge installation ......................................................................................... 12
Configuring loopback and live mode parameters ......................................................... 12
Modifying Alcatel_IN_1400_VPN_ServiceModel.xml ................................................... 13
Testing the installation .................................................................................................. 14
3. Atomic Service Description Layer (ASDL) Commands .......................... 15

A_ALA-IN_1400_ADD_CUG-MEMBER ....................................................................... 18
A_ALA-IN_1400_ADD_VPN-BLACK-MEMBER ........................................................... 19
A_ALA-IN_1400_ADD_VPN-BW-NUMBER ................................................................. 20
A_ALA-IN_1400_ADD_VPN-CORPORATE ................................................................. 21
A_ALA-IN_1400_ADD_VPN-MEMBER ........................................................................ 23
A_ALA-IN_1400_ADD_VPN-PSTN .............................................................................. 24
A_ALA-IN_1400_ADD_VPN-SCR-GROUP .................................................................. 25
A_ALA-IN_1400_ADD_VPN-TIER ............................................................................... 26
A_ALA-IN_1400_ADD_VPN-USER .............................................................................. 27
A_ALA-IN_1400_ADD_VPN-WHITE-MEMBER ........................................................... 27
A_ALA-IN_1400_DEL_CUG-MEMBER ........................................................................ 28
A_ALA-IN_1400_DEL_VPN-BLACK-MEMBER ........................................................... 29
A_ALA-IN_1400_DEL_VPN-BW-NUMBER .................................................................. 30
A_ALA-IN_1400_DEL_VPN-CORPORATE ................................................................. 31
A_ALA-IN_1400_DEL_VPN-MEMBER ........................................................................ 32
A_ALA-IN_1400_DEL_VPN-PSTN .............................................................................. 32
A_ALA-IN_1400_DEL_VPN-SCR-GROUP .................................................................. 33
A_ALA-IN_1400_DEL_VPN-TIER ................................................................................ 34
A_ALA-IN_1400_DEL_VPN-USER .............................................................................. 35
A_ALA-IN_1400_DEL_VPN-WHITE-MEMBER ............................................................ 35
Alcatel IN 1.0 Cartridge Guide
Contents
A_ALA-IN_1400_LIST_VPN-BLACK-MEMBER ........................................................... 36
A_ALA-IN_1400_LIST_VPN-WHITE-MEMBER ........................................................... 38
A_ALA-IN_1400_MOD_CUG-MEMBER ...................................................................... 39
A_ALA-IN_1400_MOD_VPN-BLACK-MEMBER .......................................................... 40
A_ALA-IN_1400_MOD_VPN-CORPORATE ................................................................ 41
A_ALA-IN_1400_MOD_VPN-MEMBER ....................................................................... 43
A_ALA-IN_1400_MOD_VPN-PSTN ............................................................................. 44
A_ALA-IN_1400_MOD_VPN-SCR-GROUP ................................................................. 45
A_ALA-IN_1400_MOD_VPN-TIER ............................................................................... 46
A_ALA-IN_1400_MOD_VPN-WHITE-MEMBER .......................................................... 47
A_ALA-IN_1400_QRY_CUG-MEMBER ....................................................................... 48
A_ALA-IN_1400_QRY_VPN-BLACK-MEMBER ........................................................... 49
A_ALA-IN_1400_QRY_VPN-BW-NUMBER ................................................................. 50
A_ALA-IN_1400_QRY_VPN-CORPORATE ................................................................. 51
A_ALA-IN_1400_QRY_VPN-MEMBER ........................................................................ 52
A_ALA-IN_1400_QRY_VPN-PSTN .............................................................................. 53
A_ALA-IN_1400_QRY_VPN-SCR-GROUP ................................................................. 54
A_ALA-IN_1400_QRY_VPN-TIER ............................................................................... 55
A_ALA-IN_1400_QRY_VPN-USER ............................................................................. 56
A_ALA-IN_1400_QRY_VPN-WHITE-MEMBER ........................................................... 57
User defined exit types (tbl_user_err) ................................................................................. 57
4. Service Definition ....................................................................................... 59

CSDL commands ................................................................................................................ 61
C_ALA-IN_1400_ADD_CUG-MEMBER ....................................................................... 62
C_ALA-IN_1400_ADD_VPN-BLACK-MEMBER ........................................................... 63
C_ALA-IN_1400_ADD_VPN-BW-NUMBER ................................................................. 64
C_ALA-IN_1400_ADD_VPN-CORPORATE ................................................................. 64
C_ALA-IN_1400_ADD_VPN-MEMBER ........................................................................ 66
C_ALA-IN_1400_ADD_VPN-PSTN .............................................................................. 67
C_ALA-IN_1400_ADD_VPN-SCR-GROUP ................................................................. 67
C_ALA-IN_1400_ADD_VPN-TIER ............................................................................... 68
C_ALA-IN_1400_ADD_VPN-USER ............................................................................. 69
C_ALA-IN_1400_ADD_VPN-WHITE-MEMBER ........................................................... 70
C_ALA-IN_1400_DEL_CUG-MEMBER ........................................................................ 70
C_ALA-IN_1400_DEL_VPN-BLACK-MEMBER ........................................................... 71
C_ALA-IN_1400_DEL_VPN-BW-NUMBER ................................................................. 72
C_ALA-IN_1400_DEL_VPN-CORPORATE ................................................................. 72
C_ALA-IN_1400_DEL_VPN-MEMBER ........................................................................ 73
C_ALA-IN_1400_DEL_VPN-PSTN .............................................................................. 74
C_ALA-IN_1400_DEL_VPN-SCR-GROUP .................................................................. 74
C_ALA-IN_1400_DEL_VPN-TIER ................................................................................ 75
C_ALA-IN_1400_DEL_VPN-USER .............................................................................. 75
C_ALA-IN_1400_DEL_VPN-WHITE-MEMBER ........................................................... 76
C_ALA-IN_1400_LIST_VPN-BLACK-MEMBER ........................................................... 77
C_ALA-IN_1400_LIST_VPN-WHITE-MEMBER ........................................................... 78
C_ALA-IN_1400_MOD_CUG-MEMBER ...................................................................... 78
C_ALA-IN_1400_MOD_VPN-BLACK-MEMBER .......................................................... 79
ii
Oracle Corporation
Contents
C_ALA-IN_1400_MOD_VPN-CORPORATE ................................................................ 80
C_ALA-IN_1400_MOD_VPN-MEMBER ....................................................................... 82
C_ALA-IN_1400_MOD_VPN-PSTN ............................................................................. 83
C_ALA-IN_1400_MOD_VPN-SCR-GROUP ................................................................. 84
C_ALA-IN_1400_MOD_VPN-TIER .............................................................................. 84
C_ALA-IN_1400_MOD_VPN-WHITE-MEMBER .......................................................... 85
C_ALA-IN_1400_QRY_CUG-MEMBER ....................................................................... 86
C_ALA-IN_1400_QRY_VPN-BLACK-MEMBER .......................................................... 87
C_ALA-IN_1400_QRY_VPN-BW-NUMBER ................................................................. 87
C_ALA-IN_1400_QRY_VPN-CORPORATE ................................................................ 88
C_ALA-IN_1400_QRY_VPN-MEMBER ....................................................................... 89
C_ALA-IN_1400_QRY_VPN-PSTN .............................................................................. 89
C_ALA-IN_1400_QRY_VPN-SCR-GROUP ................................................................. 90
C_ALA-IN_1400_QRY_VPN-TIER ............................................................................... 91
C_ALA-IN_1400_QRY_VPN-USER ............................................................................. 91
C_ALA-IN_1400_QRY_VPN-WHITE-MEMBER ........................................................... 92
5. Configuring ASAP to Support Additional NE Instances ........................ 93

Extracting source files ......................................................................................................... 96
Loading a new XML file ................................................................................................ 96
iii
Contents
iv
Oracle Corporation
Cartridge Overview
ASAP cartridges are discrete software components that are developed for the ASAP product.
An ASAP cartridge offers specific domain behavior on top of the core ASAP software, and
provides the configuration that supports a set of services on a network element (NE).
An ASAP cartridge is not a stand-alone component, but operates in conjunction with the
ASAP core product. ASAP cartridges offer the following benefits:
Reduced Time to Markettime to market of new services is reduced through simplified

development, implementation, and extension of cartridges on customer sites.
Extendablecartridges can be extended to include additional services and components
that deliver business value, without requiring changes to the original cartridge.
Simplified Effortthe effort and technical knowledge that is required to perform
customizations is reduced.
Ease of Installationcartridges can be installed into an ASAP environment without
interfering with the existing install base.
An ASAP cartridge can be used to configure ASAP to provision the following:
NEs from a specific vendor, such as Nortel or Lucent.

Technologies, such as Asynchronous Transfer Mode (ATM) and Frame Relay switches, or
Internet Protocol (IP) routers.
Services that are supported on the NE, such as ATM, IP Virtual Private Networks (VPN),
Wireless, or Optical.
Cartridges are designed for a specific technology, software load, and service.
An ASAP cartridge supports a particular set of services on an NE. These services are
independent of customer-specific service definitions. Professional Services or systems
integrators can perform extensions to the cartridge to support customer-specific requirements.
For more information on extending a cartridge, refer to the ASAP Cartridge Development
Guide for Service Activation.
Chapter 1: Cartridge Overview
Cartridge content
An ASAP cartridge contains the following:
An interface to the NE
A set of scripts, such as State Tables or Java methods
A set of atomic actions in the form of Atomic Service Description Layer (ASDL)
commands
A set of Common Service Description Layer (CSDL) commands that form meaningful
services
Sample work orders
Installation scripts
Prerequisites
System integrators such as managers, designers, programmers, and testers who are responsible
for the adaptation and integration of ASAP-based solutions should use this manual as a
reference. It assumes that readers possess the following skills:
A knowledge of ASAP programming concepts

A good working knowledge of the UNIX operating system
A thorough understanding of service and network provisioning
Familiarity with telecommunications
About this guide

This guide provides a detailed description of the Alcatel IN cartridge. It contains overview and
technical information to assist with extending and integrating the cartridge into a customer
environment.
The scope of this guide includes ASAP as it pertains to this cartridge. It is not a complete
ASAP reference guide.
For additional ASAP information when using this cartridge, refer to the following supporting
documentation:
ASAP documentation setfor detailed information on the ASAP core product.

ASAP Cartridge Development Guide for Service Activationfor information on how
to extend a cartridge.
The Alcatel IN cartridge provides the ASAP service configuration and network element (NE)
interface to activate Intelligent Network services on IN NEs.
Oracle Corporation
Services, features, and options
Services, features, and options

This section describes the types of Intelligent Network services supported by this cartridge.
Table 1: Supported services
Service
CUG members
Service Description
Creates a new CUG (Closed User Group)
member using CUG member proposition.
Modifies an existing CUG customer
member.
Deletes an existing CUG customer member
from a CUG.
Queries an existing CUG customer
member.
VPN Corporate
Creates a new VPN corporate.

Modifies an existing VPN corporate.
Deletes an existing VPN corporate.
Queries an existing VPN corporate.
PSTN
Creates a new VPN PSTN.

Modifies an existing VPN PSTN.
Deletes an existing VPN PSTN.
Queries an existing VPN PSTN.
VPN members
Creates a new VPN member.

Modifies an existing VPN member.
Deletes an existing VPN member.
Queries an existing VPN member.

Service
VPN Screen Group
Service Description
Creates a new VPN screen group.
Modifies an existing VPN screen group.
Deletes an existing VPN screen group.
Queries an existing VPN screen group.
VPN username
Creates a new VPN customer username for

login.
Deletes an existing VPN customer
username.
Queries an existing VPN customer
username.
VPN Customer Black White Numbers
Creates a new VPN customer black white

number.
Deletes an existing VPN customer black
white number.
Queries an existing VPN customer black
white number.
White Number of the VPN Members
Creates a new white number of the VPN

member.
Modifies an existing white number of the
VPN member.
Deletes an existing white number of the
VPN member.
Queries an existing white number of the
VPN member.
Lists existing white numbers of the VPN
member.
Oracle Corporation
Hardware and software requirements

Service
Black Number of the VPN Members
Service Description
Creates a new black number of the VPN
member.
Modifies an existing black number of the
VPN member.
Deletes an existing black number of the
VPN member.
Queries an existing black number of the
VPN member.
Lists existing black numbers of the VPN
member.
VPN Tier
Creates a new VPN tier.

Modifies an existing VPN tier.
Deletes an existing VPN tier.
Queries an existing VPN tier.
Hardware and software requirements

The following sections contain the high-level software and hardware environment
requirements for provisioning Intelligent Network services using this cartridge, including:
Network element (NE) interface

ASAP version
Network element (NE) interface

This cartridge operates with the following:
NE SMP CORBA interface Release 2.3.

Software Load Alcatel IN 1400.
Protocol CORBA version Orbacus 3.3.1 using CORBA IIOP, CORBA 2 compliant.
ASAP version
This cartridge was developed and tested using ASAP 4.6.3.
For more information on the operating environment of this ASAP version, refer to the ASAP
4.6.3 Release Record.
Connecting to the NE
The Alcatel IN cartridge interfaces with the IN network element via CORBA (Iona Orbixweb
3.2).
Oracle Corporation
Installing and Testing the Cartridge

This chapter describes the following procedures related to installing and testing the cartridge:
Downloading the cartridge

Installing the cartridge
Uninstalling the cartridge
Testing the cartridge installation
Downloading the cartridge

Before you can install the cartridge, you must use the internet to download the cartridges
TAR file from Oracles Customer Portal.
Use the following instructions to download, then unTAR the TAR file.
To download the TAR file
1. Login to Oracle MetaLink internet home page (http://www.metalink.oracle.com).
2. Download the cartridge patch to your workstation.
To unTAR the TAR file
1. On you workstation, create a repository directorythe naming of which is your choice.
mkdir <repository dir>
2. Untar AlcatelIN_R1_0_0.bx.tar.
tar xvf AlcatelIN_R1_0_0.bx.tar
3. Copy the resulting //ALCATEL_IN_1400_VPN directory and its contents to the

repository directory.
cp -rf //ALCATEL_IN_1400_VPN <repository_dir>
The directory structure in the repository directory should look like the following illustration.
(this illustration describes the minimum required structure; you can enhance this directory
structure with additional directories based on your requirements and deliverables).
Chapter 2: Installing and Testing the Cartridge
<repository_directory>
/ALCATEL_IN_1400_VPN
/README
/installCartridge
/uninstallCartridge
/ALCATEL_IN_1400_VPN_1_0.sar
Starting ASAP
Before installing the cartridge, ensure that ASAP is running.
To start ASAP
1. To start ASAP, execute the following script:
start_asap_sys
2. Ensure the ASAP Daemon (DAM_$ENV_ID) is running by checking the ASAP status
using the ASAP script status.
3. Check whether the WebLogic instance for this ASAP environment is running. If not, start
the WebLogic instance.
The ASAP System Configuration and Management Guide contains more information on
starting ASAP, the ASAP Daemon, and WebLogic.
Oracle Corporation

Run the installation script installCartridge to install the cartridge. You will find this script
under //ALCATEL_IN_1400_VPN. The script executes the following tasks:
Configures the Alcatel IN-specific NE using the SACT.

Deploys the Alcatel IN cartridge service model (only if the Alcatel IN service model is not
yet deployed) using the Service Activation Deployment Tool (SADT).
Copies the Alcatel IN-specific jar files and the cpp library file to the ASAP environment.
Loads the sample work orders to the SRP database.
For information on the SACT and the SADT, refer to the ASAP System Configuration and
Management Guide.
1. Before you install the cartridge, take note of the following:
The ala_in.properties file defines the ports used by NEP_AL.
MY_INT_PORT=48882
MY_JINT_PORT=48883
Where:
MY_INT_PORT = Sybase interface port used by NEP_ALA
MY_JINT_PORT = Socket listener port used for SARM - NEP_ALA communication.
You can edit the parameter values if the default port numbers are already in use.
2. The JIntepreter_ala.in.template file is used to define the startup script used to start
JNEP_ALA. You must change the values of the Java system property options shown
below to the corresponding Oracle Hostname and Oracle listener port. These values are
obtained by running the command: tnsping $DSQUERY
Property Options
DDB_HOST
DDB_PORT
To install the cartridge

1. Run the installCartridge script from //ALCATEL_IN_1400_VPN. At the prompt, type:
installCartridge ALCATEL_IN_1400_VPN_1_0.sar
2. The script prompts you for the values of the following WebLogic login parameters:
WebLogic Hostname
WebLogic HTTP Port
WebLogic Login User ID
WebLogic Login Password
The script loads the NEP-NE configuration and the CSDL-ASDL configuration to the
SARM database, and loads sample work orders to the SRP database. The script also copies
the cartridge-specific jar files and cpp library file to the ASAP environment.
3. Restart ASAP to upload the cartridge configuration into ASAP.
Configuring the communication parameters (tbl_comm_param)

This static database table contains the communication parameters required to communicate
with various external systems. The table consists of the following fields:
dev_type - the protocol used to connect to the device.

host - the host NE to which the configured parameter value applies.
device - the device for which this parameter value applies.
param_label - the label of the communication parameter.
param_value - the value of the communication parameter.
param_desc - a thorough and accurate description of the communication parameter
The following table lists the contents of tbl_comm_param.

Table 2: Contents of tbl_comm_param
DEV_
TYPE
HOST
DEVICE
PARAM_LABEL
PARAM_
VALUE
PARAM_DESC
ALA-IN-HOST ALA_IN_DEVICE1 IOR_INSTANCE
/config/
access.ior
Interoperable Object
Reference. User
needs to provide full
path name.
ALA-IN-HOST ALA_IN_DEVICE1 NE_DIALOG_

LOGGING
TRUE
Flag to turn On or Off

the logging of API
commands and
responses.
ALA-IN-HOST ALA_IN_DEVICE1 USERNAME
alcatel_userid
User name for login
ALA-IN-HOST ALA_IN_DEVICE1 PASSWORD
alcatel_password The password for

login.
ALA-IN-HOST ALA_IN_DEVICE1 ORBINITIALHOST 127.0.0.1
CORBA Host IP
address (obsolete
now).
ALA-IN-HOST ALA_IN_DEVICE1 ORBINITIALPORT 1570
CORBAHost Port
(obsolete now).
10
Oracle Corporation
Table 2: Contents of tbl_comm_param

DEV_
TYPE
HOST
DEVICE
PARAM_
VALUE
PARAM_LABEL
PARAM_DESC
ALA-IN-HOST ALA_IN_DEVICE1 USER_ERROR_

TYPES_FILE
/config/
Alcatel_IN_140
0_UserExitType
s.cfg
Configuration file
mapping the NE
response code to user
exit type. This file is
relative to
ASAP_BASE
directory.
ALA-IN-HOST ALA_IN_DEVICE1 VPN_SERVICE_

PROFILE
vpnvaService
VPN Service Profile

Name, used to find
index of the service
and IOR of the
associated service
server factory.
ALA-IN-HOST ALA_IN_DEVICE1 READ_TIMEOUT
30
Read timeout in
seconds. If set to 0 a
timer will not be
started.
ALA-IN-HOST ALA_IN_DEVICE1 LOOPBACK_

TIMEOUT
Loopback timeout to
simulate loopback
mode timeout and if
value is bigger then
READ_
TIMEOUT to
simulate
InterruptedException.

Run the uninstallation script uninstallCartridge to uninstall the Alcatel IN cartridge. This script
is located under /ALCATEL_IN_1400_VPN. The script executes the following tasks:
Unconfigures Alcatel IN-specific NEs using the SACT.

Undeploys the Alcatel IN cartridge service model (only if the Alcatel IN service model is
already deployed) using the Service Activation Deployment Tool (SADT).
Removes the Alcatel IN-specific jar files and cpp library file from the ASAP environment.
For more information on the SACT and the SADT, refer to the ASAP System Configuration
and Management Guide.
11
To uninstall the cartridge

1. Run the uninstallCartridge script from //ALCATEL_IN_1400_VPN. At the prompt, type
uninstallCartridge ALCATEL_IN_1400_VPN_1_0.<timestamp>.sar
2. The script prompts you for the values of the following parameters:
WebLogic Hostname
WebLogic HTTP Port
WebLogic Login User ID
WebLogic Login Password
The script unloads the NEP-NE configuration and CSDL-ASDL configuration from SARM
database. It also removes the cartridge specific jar files and cpp library file from the ASAP
environment.

To test this cartridge installation, you need to know about the network element (NE), services,
and basic ASAP configuration. You may need to perform adjustments to provision a service
for a specific NE, network, or connectivity configuration.
You can test the cartridge installation using one of the following methods:
Loopback modedoes not actually connect to or send commands to the NE.

Live modeconnects to and sends commands to a live NE.
Configuring loopback and live mode parameters

The following sections tell you which variables you must configure in to use the loopback and
live testing modes.
Loopback mode
Set the following parameter to test the cartridge in loopback mode.
Table 3: Loopback Mode Parameter Settings
Configuration Variable
LOOPBACK_ON
Parameter Settings
1 (default setting)
Location
ASAP.cfg
(in the Global section)
12
Oracle Corporation
Live mode
Set the following parameter to test the cartridge in live mode.
Table 4: Live Mode Parameter Settings
Configuration Variable
LOOPBACK_ON
Parameter Settings
0
Location
ASAP.cfg
(in the Global section)
Modifying Alcatel_IN_1400_VPN_ServiceModel.xml
Use the following procedure to modify Alcatel_IN_1400_VPN_ServiceModel.xml.
To modify Alcatel_IN_1400_VPN_ServiceModel.xml
1. Create a new source directory under //ALCATEL_IN_1400_VPN. You can give this
directory any appropriate, meaningful name you want to.
mkdir <new_source_directory>
2. Copy ALCATEL_IN_1400_VPN_1_0.sar to this new source directory.

cp ALCATEL_IN_1400_VPN_1_0.sar ./<new_source_directory>
3. Change directory to <new_source_directory>.

cd <new_source_directory>
4. Un-jar ALCATEL_IN_1400_VPN_1_0.sar This extracts the contents of the sar file.

jar xvf ALCATEL_IN_1400_VPN_1_0.sar
5. Edit <new_source_directory>//ALCATEL_IN_1400_VPN/common/application_config/
Alcatel_IN_1400_VPN_ServiceModel.xml in with the appropriate changes.
6. Create a new sar file at the <new_source_directory> level.
CreateSar $PWD
7. Uninstall the cartridge using ALCATEL_IN_1400_VPN_1_0.sar in

//ALCATEL_IN_1400_VPN (That is, use the original sar file that you copied in Step 2
abovesee Uninstalling the cartridge on page 11 for uninstallation instructions).
8. After you uninstall the cartridge, rename the sar file in //ALCATEL_IN_1400_VPN so
you have a backup copy of it.
9. Copy the new sar file from <new_source_directory> to //ALCATEL_IN_1400_VPN.
10. Reinstall the cartridge (see Installing the cartridge on page 9 for installation
instructions).
13
Testing the installation

The following procedure describes the steps required to test the cartridge installation in
loopback mode. We recommend that you perform the initial cartridge installation test in
loopback mode.
To test in loopback mode
1. Stop ASAP by typing the following command at the UNIX prompt:
stop_asap_sys
2. Ensure loop back mode is on. See Loopback mode on page 12 for a description of how
to set the loop back parameter to On.
3. Start ASAP by typing:
start_asap_sys
4. Send the sample work orders through the SRP Emulator by typing:
run_suite $SRP <ctrl_password> <suite name>
You can locate the suite names in //ALCATEL_IN_1400_VPN/sample_wo by typing:

grep
SUITE * | grep -v END
A list of all available suites appears.

To see the sample work orders, refer to Viewing the sample work orders, below.
For more information on the SRP Emulator, refer to the ASAP System Configuration and
Management Guide.
5. Verify the status of the sample work orders by typing:
asap_utils l
All successful work orders return the 104 state.

To view the sample work orders provided with this cartridge, refer to the Alcatel IN
cartridge source.
Viewing the sample work orders

You find the sample work orders under the sample_wo directory in the sar file. The following
procedure describes how to view the sample work orders.
To view the sample work orders
1. If necessary, create a repository directory under /ALCATEL_IN_1400_VPN, copy the sar
file to the new directory and un-jar the sar file, as described by Step 1 through Step 4 in
Modifying Alcatel_IN_1400_VPN_ServiceModel.xml on page 13.
2. Locate and view the sample work order files under /Alcatel/ALA_IN_1400/VPN/
sample_wo.
14
Oracle Corporation
Atomic Service Description Layer (ASDL)

Commands
ASDL commands represent a set of atomic actions that ASAP can perform on a network
element (NE). ASAP can combine ASDLs to create meaningful services (CSDLs) within a
cartridge.
This chapter presents detailed information on the ASDL parameters that we provide with this
cartridge. The following table lists and describes the type of parameter information that is
included.
Table 5: ASDL parameter information
Item
Description
Parameter Name
Identifies the parameter that is configured for the stated

service.
Description
Describes the parameter.
Range
Describes or lists the range of values that can be used to

satisfy this parameter.
Default Value
Configures a default value for the parameter so that it is not

mandatory for the upstream system to provide a value.
15
Chapter 3: Atomic Service Description Layer (ASDL) Commands

Item
Type
Description
Indicates one of the following parameter types:
SScalar, specifies the parameter label transmitted on

the ASDL command. Scalar parameters are conventional
name-value pair parameters.
CCompound, specifies the base name of the
compound parameter transmitted on the ASDL
command. A compound parameter contains structures or
arrays of information that are represented by a particular
structure name or compound parameter name. Each
compound parameter can contain a large number of
elements. If you use compound parameters, you only
require a single entry in the ASAP translation tables to
call the compound parameter and all its associated
parameter elements.
IIndexed, identifies a parameter that contains a
sequential numerical index value to tell the SARM that it
should execute the same operation (for example, an
ASDL command) for all occurrences of that index.
Consequently, if there are several options on a particular
CSDL command (OPT1, OPT2, OPT3, etc.), you can
specify the OPT parameter as an indexed parameter.
When you specify the OPT parameter as an indexed
parameter, the SARM generates several occurrences of
that same ASDL command and each command has a
different value for the option being transmitted to the
NEP.
For more information on parameter types, refer to the ASAP

Developers Reference.
Class
Indicates one of the following parameter classifications:
RRequired scalar parameter

OOptional scalar parameter
CRequired compound parameter
NOptional compound parameter
MMandatory indexed parameter
IOptional indexed parameter
SParameter count
For a detailed description of the Required and Optional parameter classifications, refer to the
ASAP System Configuration and Management Guide.
16
Oracle Corporation
This cartridge provides the following ASDL commands:
A_ALA-IN_1400_ADD_CUG-MEMBER
A_ALA-IN_1400_ADD_VPN-BLACK-MEMBER
A_ALA-IN_1400_ADD_VPN-BW-NUMBER
A_ALA-IN_1400_ADD_VPN-CORPORATE
A_ALA-IN_1400_ADD_VPN-MEMBER
A_ALA-IN_1400_ADD_VPN-PSTN
A_ALA-IN_1400_ADD_VPN-SCR-GROUP
A_ALA-IN_1400_ADD_VPN-TIER
A_ALA-IN_1400_ADD_VPN-USER
A_ALA-IN_1400_ADD_VPN-WHITE-MEMBER
A_ALA-IN_1400_DEL_CUG-MEMBER
A_ALA-IN_1400_DEL_VPN-BLACK-MEMBER
A_ALA-IN_1400_DEL_VPN-BW-NUMBER
A_ALA-IN_1400_DEL_VPN-CORPORATE
A_ALA-IN_1400_DEL_VPN-MEMBER
A_ALA-IN_1400_DEL_VPN-PSTN
A_ALA-IN_1400_DEL_VPN-SCR-GROUP
A_ALA-IN_1400_DEL_VPN-TIER
A_ALA-IN_1400_DEL_VPN-USER
A_ALA-IN_1400_DEL_VPN-WHITE-MEMBER
A_ALA-IN_1400_LIST_VPN-BLACK-MEMBER
A_ALA-IN_1400_LIST_VPN-WHITE-MEMBER
A_ALA-IN_1400_MOD_CUG-MEMBER
A_ALA-IN_1400_MOD_VPN-BLACK-MEMBER
A_ALA-IN_1400_MOD_VPN-CORPORATE
A_ALA-IN_1400_MOD_VPN-MEMBER
A_ALA-IN_1400_MOD_VPN-PSTN
A_ALA-IN_1400_MOD_VPN-SCR-GROUP
A_ALA-IN_1400_MOD_VPN-TIER
A_ALA-IN_1400_MOD_VPN-WHITE-MEMBER
A_ALA-IN_1400_QRY_CUG-MEMBER
A_ALA-IN_1400_QRY_VPN-BLACK-MEMBER
A_ALA-IN_1400_QRY_VPN-BW-NUMBER
A_ALA-IN_1400_QRY_VPN-CORPORATE
A_ALA-IN_1400_QRY_VPN-MEMBER
17
A_ALA-IN_1400_QRY_VPN-PSTN
A_ALA-IN_1400_QRY_VPN-SCR-GROUP
A_ALA-IN_1400_QRY_VPN-TIER
A_ALA-IN_1400_QRY_VPN-USER
A_ALA-IN_1400_QRY_VPN-WHITE-MEMBER
Creates a new CUG (Closed User Group) member, using the CUG member proposition. It is
implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPN.addCugMember.
Table 6: A_ALA-IN_1400_ADD_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI
The name of the host

NE.
CUS_REF
The customer
reference object.
GRP_REF
The Screening
Group Reference
(also called: Closed
User Group).
MSISDN
The Mobile Station

Integrated Services
Digital Network
(MSISDN)
parameter.
PABXEXT
The length of the

PABX extension.
PABXFLG
The PABX flag

parameter.
PNP_NBR
The Private Number

Plan (PNP) number.
0 (Single) and 1
(PABX)
MML command
// method : int create(PARAMETERS,out string cmdResult)
18
Oracle Corporation
int create(in string cus_ref,in string grp_ref,in string msisdn,in string

pabxe
xt,in string pabxflg,in string pnp_nbr,out string cmdResult) raises
(inObject::e
nvError,inObject::syntaxError,inObject::semanticError);
Output parameters
ALA_ADD_CUG_MEM_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_CUG_MEM_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
See Table 48 on page 58 for the values of the return parameters.
Creates a new black number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBlackMbr.addBlackM
br.
Table 7: A_ALA-IN_1400_ADD_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BLACKFLG
Black number
override flag.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
// method : long create(PARAMETERS,out string cmdResult)
long create(in string blackflg,in string bw_nbr,in string cus_ref,in string
mbr_ref,out string cmdResult) raises
(inObject::envError,inObject::syntaxError,inObject::semanticError);
19
Output parameters
ALA_ADD_VPN_BLACK_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_BLACK_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Creates a new VPN customer black white number. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBWNumber.addBWN
umber.
Table 8: A_ALA-IN_1400_ADD_VPN-BW-NUMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
BWFLG
Black white flag.
CUS_REF
The customer
reference object.
0-Black, 1- White
MML command
long create(in string bw_nbr,in string bwflg,in string cus_ref,out string
cmdResult) raises
Output parameters
ALA_ADD_VPN_BWNUMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_BWNUMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
20
Oracle Corporation
Creates a new corporate VPN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNCorporate.addVpnCo
rporate.
Table 9: A_ALA-IN_1400_ADD_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
END_DATE
End date of the

validity period.
INQ_PASS
Inquiry password.
OFFNET_ACC_CO Offnet access code.

DE
OVERRIDE_ACC_ Override access

CODE
code.
PNP_CODE
PNP code.
RES_REF
Reference to a
reseller object.
START_DATE
Start date of the

validity period.
TIER_REF
Reference to a tier
object.
ADDRESS_1
Customer
administrator's
address 1.
ADDRESS_2
Customer
administrator's
address 2.
ADDRESS_3
Customer
administrator's
address 3.
21
Table 9: A_ALA-IN_1400_ADD_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
ADMIN_NAME
Customer
administrator's
name.
EMAIL
Customer email
address.
PHONE
Customer phone
number.
MNEMONIC
Customer
mnemonic.
MML command
long create(in string enddate,in string inqpass,in string offnet_c,in string
override,in string pnp_code,in string res_ref,in string strdate,in string
tier_ref,in string addr1,in string addr2,in string addr3,in string
adminame,in string email,in string phone,in string mn,out string cmdResult)
raises (inObject::envError,inObject::syntaxError,inObject::semanticError);
Output parameters
ALA_ADD_VPN_CORPORATE_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_ VPN_CORPORATE _RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
22
Oracle Corporation
Creates a new VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNMember.addMember.
Table 10: A_ALA-IN_1400_ADD_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
GRPBITS
Screen group bits.
JOB_REF
Reference to the job

description.
MEMBER_NAME
Member name.
OFNETFLG
Offnet rights.
PNPREF
Reference to PNP
object.
MML command
long create(in string cus_ref,in string grpbits,in string job_ref,in string
mbr_name,in string ofnetflg,in string pnpref,out string cmdResult) raises
Output parameters
ALA_ADD_VPN_MEMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_MEMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
23
Creates a new VPN PSTN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNPSTN.addPSTN.
Table 11: A_ALA-IN_1400_ADD_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
IMPLIED
Implied A number.
LOCATION
Location of the fixed

line (PSTN).
PSTN_ANB
PSTN A number
(fixed).
MML command
long create(in string cus_ref,in string implied,in string location,in string
pstn_anb,out string cmdResult) raises
Output parameters
ALA_ADD_VPN_PSTN_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_PSTN_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
24
Oracle Corporation
Creates a new VPN screen group. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNScrGroup.addScrGro
up.
Table 12: A_ALA-IN_1400_ADD_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
SCR_MNEMONIC
Mnemonic of an
attribute.
SCR_NBR
Screen group
number.
MML command
long create(in string cus_ref,in string mn20,in string scr_nbr,out string
cmdResult) raises
Output parameters
ALA_ADD_VPN_SCR_GROUP_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_SCR_GROUP_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
25
Creates a new VPN tier. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNTier.addTier.
Table 13: A_ALA-IN_1400_ADD_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_SCRN
Black and white list

screening right.
FONETFLG
Tier forced on net

right.
FONFLGFX
Forced on net flag

for fixed orig calls.
TIER_LBL
TIER label.
TIER_ID
TIER ID.
MML command
long create(in string bw_scrn,in string fonetflg,in string fonflgfx,in string
tier_lbl,in string tier_id,out string cmdResult) raises
Output parameters
ALA_ADD_VPN_TIER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_TIER_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
26
Oracle Corporation
Creates a new VPN customer username for login. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNUser.addUser.
Table 14: A_ALA-IN_1400_ADD_VPN-USER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
USERNAME
Username for login.
MML command
long create(in string cus_ref,in string username,out string cmdResult)
raises(inObject::envError,inObject::syntaxError,inObject::semanticError);
Output parameters
ALA_ADD_VPN_USER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_USER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Creates a new white number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNWhiteMbr.addWhite
Mbr.
Table 15: A_ALA-IN_1400_ADD_VPN-WHITE-MEMBER
Parameter Name
MCLI
Description
NE.
Range
Default
Value
Type
S
Class
R
27
Table 15: A_ALA-IN_1400_ADD_VPN-WHITE-MEMBER

Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
long create(in string bw_nbr,in string cus_ref,in string mbr_ref,out string
cmdResult) raises
Output parameters
ALA_ADD_VPN_WHITE_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_ADD_VPN_WHITE_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes a CUG (Closed User Group) member from a CUG. It is implemented by the Java
method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPN.delCugMember.
Table 16: A_ALA-IN_1400_DEL_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
28
Oracle Corporation
Table 16: A_ALA-IN_1400_DEL_CUG-MEMBER

Parameter Name
PNP_NBR
Description
Range
Default
Value
The Private Number

Plan (PNP) number.
Type
S
Class
R
MML command
// method : int remove(PARAMETERS,out string cmdResult)
int remove(in string cus_ref,in string pnp_nbr,out string cmdResult) raises
Output parameters
ALA_DEL_CUG_MEM_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_CUG_MEM_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing black number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBlackMbr.delBlackM
br.
Table 17: A_ALA-IN_1400_DEL_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
29
MML command
// method : long remove(PARAMETERS,out string cmdResult)
long remove(in string bw_nbr,in string cus_ref,in string mbr_ref,out string
cmdResult) raises
Output parameters
ALA_DEL_VPN_BLACK_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_BLACK_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing VPN customer black white number. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBWNumber.delBWNu
mber.
Table 18: A_ALA-IN_1400_DEL_VPN-BW-NUMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
BWFLG
Black white flag.
CUS_REF
The customer
reference object.
0-Black, 1- White
MML command
long remove(in string bw_nbr,in string bwflg,in string cus_ref,out string
cmdResult) raises
30
Oracle Corporation
Output parameters
ALA_DEL_VPN_BWNUMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_BWNUMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing corporate VPN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNCorporate.delVpnCor
porate.
Table 19: A_ALA-IN_1400_DEL_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
MNEMONIC
Customer
mnemonic.
MML command
long remove(in string mn,out string cmdResult) raises
Output parameters
ALA_DEL_VPN_CORPORATE_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_CORPORATE_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
31
Deletes an existing VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNMember.delMember.
Table 20: A_ALA-IN_1400_DEL_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
MEMBER_NAME
Member name.
MML command
long remove(in string cus_ref,in string mbr_name,out string cmdResult) raises
Output parameters
ALA_DEL_VPN_MEMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_MEMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing VPN PSTN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNPSTN.delPSTN.
Table 21: A_ALA-IN_1400_DEL_VPN-PSTN
Parameter Name
MCLI
32
Description
NE.
Oracle Corporation
Range
Default
Value
Type
S
Class
R
Table 21: A_ALA-IN_1400_DEL_VPN-PSTN

Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
PSTN_ANB
PSTN A number
(fixed).
MML command
long remove(in string cus_ref,in string pstn_anb,out string cmdResult) raises
Output parameters
ALA_DEL_VPN_PSTN_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_PSTN_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing VPN screen group. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNScrGroup.delScrGrou
p.
Table 22: A_ALA-IN_1400_DEL_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
SCR_MNEMONIC
Mnemonic of an
attribute.
33
MML command
long remove(in string cus_ref,in string mn20,out string cmdResult) raises
Output parameters
ALA_DEL_VPN_SCR_GROUP_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_SCR_GROUP_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing VPN tier. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNTier.delTier.
Table 23: A_ALA-IN_1400_DEL_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
TIER_ID
TIER ID.
MML command
long remove(in string tier_id,out string cmdResult) raises
Output parameters
ALA_DEL_VPN_TIER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_TIER_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
34
Oracle Corporation
Deletes an existing VPN customer username. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNUser.delUser.
Table 24: A_ALA-IN_1400_DEL_VPN-USER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
USERNAME
Username for login.
MML command
long remove(in string username,out string cmdResult) raises
Output parameters
ALA_DEL_VPN_USER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_USER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Deletes an existing white number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNWhiteMbr.delWhiteM
br.
Table 25: A_ALA-IN_1400_DEL_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
35
Table 25: A_ALA-IN_1400_DEL_VPN-WHITE-MEMBER

Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
long remove(in string bw_nbr,in string cus_ref,in string mbr_ref,out string
cmdResult) raises
Output parameters
ALA_DEL_VPN_WHITE_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_DEL_VPN_WHITE_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Lists existing black members. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBlackMbr.listBlackM
br.
Table 26: A_ALA-IN_1400_LIST_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
36
Oracle Corporation
Table 26: A_ALA-IN_1400_LIST_VPN-BLACK-MEMBER

Parameter Name
Description
Range
Default
Value
Type
Class
MBR_REF
The member
reference object.
BLACKFLG
Black number
override flag.
NBSTART
NB start.
SQLADDCRIT
SQL add criteria.
BITMAP
Bitmap.
MML command
// method : long list(PARAMETERS,out string cmdResult,inout string nbstart,in
string sqlAddCrit,in string bitmap)
long list(inout inObject::INSequence blackflg,inout inObject::INSequence
bw_nbr,inout inObject::INSequence cus_ref,inout inObject::INSequence
mbr_ref,out string cmdResult,inout string nbstart,in string sqlAddCrit,in
string bitmap) raises
Output parameters
ALA_LIST_VPN_BLACK_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_LIST_VPN_BLACK_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters LBM.BLACKFLGi, LBM.CUS_REFi, LBM.BW_NBRi,
LBM.MBR_REFi, LBM.NBSTART are returned to the SARM tables TBL_SRQ_PARM and
table TBL_INFO_PARM.
Where i = 1.n
37
Lists existing white members. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNWhiteMbr.listWhiteM
br.
Table 27: A_ALA-IN_1400_LIST_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NBSTART
NB start.
SQLADDCRIT
SQL add criteria.
BITMAP
Bitmap.
MML command
// method : long list(PARAMETERS,out string cmdResult,inout string nbstart,in
string sqlAddCrit,in string bitmap)
long list(inout inObject::INSequence bw_nbr,inout inObject::INSequence
cus_ref,inout inObject::INSequence mbr_ref,out string cmdResult,inout string
nbstart,in string sqlAddCrit,in string bitmap) raises
Output parameters
ALA_LIST_VPN_WHITE_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_LIST_VPN_WHITE_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters, LWM.CUS_REFi, LWM.BW_NBRi, LWM.MBR_REFi,
LWM.NBSTART are returned to the SARM tables TBL_SRQ_PARM and table
TBL_INFO_PARM.
38
Oracle Corporation
Where i = 1.n
Modifies an existing CUG (Closed User Group) member. It is implemented by the Java
method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPN.modCugMember.
Table 28: A_ALA-IN_1400_MOD_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
GRP_REF
The Screening
Group Reference
User Group).
PABXEXT
The length of the

PABX extension.
PABXFLG
The PABX flag

parameter.
PNP_NBR
The Private Number

Plan (PNP) number.
0 (Single) and 1
(PABX)
MML command
// method : int modify(PARAMETERS,out string cmdResult)
int modify(in string cus_ref,in string grp_ref,in string pabxext,in string
pabx
flg,in string pnp_nbr,out string cmdResult) raises
(inObject::envError,inObject:
:syntaxError,inObject::semanticError);
39
Output parameters
ALA_MOD_CUG_MEM_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_CUG_MEM_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
Modifies an existing black number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBlackMbr.modBlack
Mbr.
Table 29: A_ALA-IN_1400_MOD_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BLACKFLG
Black number
override flag.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
// method : long modify(PARAMETERS,out string cmdResult)
long modify(in string blackflg,in string bw_nbr,in string cus_ref,in string
Output parameters
ALA_MOD_VPN_BLACK_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_BLACK_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
40
Oracle Corporation
Modifies an existing corporate VPN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNCorporate.modVpnCo
rporate.
Table 30: A_ALA-IN_1400_MOD_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CHNGMN30
Allows changing of
mnemonic size 30.
END_DATE
End date of the

validity period.
INQ_PASS
Inquiry password.

DE

CODE
code.
PNP_CODE
PNP code.
RES_REF
Reference to a
reseller object.
START_DATE
Start date of the

validity period.
TIER_REF
Reference to tier
object.
ADDRESS_1
Customer
administrator's
address 1.
ADDRESS_2
Customer
administrator's
address 2.
41
Table 30: A_ALA-IN_1400_MOD_VPN-CORPORATE

Parameter Name
Description
Range
Default
Value
Type
Class
ADDRESS_3
Customer
administrator's
address 3.
ADMIN_NAME
Customer
administrator name.
EMAIL
Customer email
address.
PHONE
Customer phone
number.
MNEMONIC
Customer
mnemonic.
MML command
long modify(in string chngmn30,in string enddate,in string inqpass,in string
offnet_c,in string override,in string pnp_code,in string res_ref,in string
strdate,in string tier_ref,in string addr1,in string addr2,in string addr3,in
string adminame,in string email,in string phone,in string mn,out string
cmdResult) raises
Output parameters
ALA_MOD_VPN_CORPORATE_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_CORPORATE_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
42
Oracle Corporation
Modifies an existing VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNMember.modMember.
Table 31: A_ALA-IN_1400_MOD_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CHNGMN30
Allows changing of
mnemonic size 30.
CUS_REF
The customer
reference object.
GRPBITS
Screen group bits.
JOB_REF

description.
MEMBER_NAME
Member name.
OFNETFLG
Offnet rights.
PNPREF
Reference to PNP
object.
MML command
long modify(in string chngmn30,in string cus_ref,in string grpbits,in string
job_ref,in string mbr_name,in string ofnetflg,in string pnpref,out string
cmdResult) raises
Output parameters
ALA_MOD_VPN_MEMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_MEMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
43
Modifies an existing VPN PSTN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNPSTN.modPSTN.
Table 32: A_ALA-IN_1400_MOD_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
IMPLIED
Implied A number.
LOCATION

line (PSTN).
PSTN_ANB
PSTN A number
(fixed).
MML command
long modify(in string cus_ref,in string implied,in string location,in string
pstn_anb,out string cmdResult) raises
Output parameters
ALA_MOD_VPN_PSTN_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_PSTN_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
44
Oracle Corporation
Modifies an existing VPN screen group. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNScrGroup.modScrGro
up.
Table 33: A_ALA-IN_1400_MOD_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CHNGMN20
Allows changing of
mnemonic size 20.
CUS_REF
The customer
reference object.
SCR_MNEMONIC
Mnemonic of an
attribute.
SCR_NBR
Screen group
number
MML command
long modify(in string chngmn20,in string cus_ref,in string mn20,in string
scr_nbr,out string cmdResult) raises
Output parameters
ALA_MOD_VPN_SCR_GROUP_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_SCR_GROUP_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
45
Modifies an existing VPN tier. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNTier.modTier.
Table 34: A_ALA-IN_1400_MOD_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_SCRN

screening right.
FONETFLG
Tier forced on net

right.
FONFLGFX
Forced on net flag

TIER_LBL
TIER label.
TIER_ID
TIER ID.
MML command
long modify(in string bw_scrn,in string fonetflg,in string fonflgfx,in string
tier_lbl,in string tier_id,out string cmdResult) raises
Output parameters
ALA_MOD_VPN_TIER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_TIER_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
46
Oracle Corporation
Modifies an existing white number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNWhiteMbr.modWhite
Mbr.
Table 35: A_ALA-IN_1400_MOD_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
long modify(in string bw_nbr,in string cus_ref,in string mbr_ref,out string
cmdResult) raises
Output parameters
ALA_MOD_VPN_WHITE_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_MOD_VPN_WHITE_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
47
Queries a CUG (Closed User Group) member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPN.qryCugMember.
Table 36: A_ALA-IN_1400_QRY_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
PNP_NBR
The Private Number

Plan (PNP) number.
MML command
// method : int display(PARAMETERS,out string cmdResult)
int display(inout string cus_ref,out string grp_ref,out string msisdn,out
strin
g pabxext,out string pabxflg,inout string pnp_nbr,out string cmdResult)
raises (
inObject::envError,inObject::syntaxError,inObject::semanticError);
Output parameters
ALA_QRY_CUG_MEM_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_CUG_MEM_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CUS_REF, GRP_REF, MSISDN, PABXEXT, PABXFLG,
PNP_NBR are returned to the SARM tables TBL_SRQ_PARM and table
TBL_INFO_PARM.
48
Oracle Corporation
Queries an existing black member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBlackMbr.qryBlackM
br.
Table 37: A_ALA-IN_1400_QRY_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
// method : long display(PARAMETERS,out string cmdResult)
long display(out string blackflg,inout string bw_nbr,inout string
cus_ref,inout string mbr_ref,out string cmdResult) raises
Output parameters
ALA_QRY_VPN_BLACK_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_BLACK_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters BLACKFLG, CUS_REF, BW_NBR, MBR_REF are returned to
the SARM tables TBL_SRQ_PARM and table TBL_INFO_PARM.
49
Queries an existing black white number. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNBWNumber.qryBWN
umber.
Table 38: A_ALA-IN_1400_QRY_VPN-BW-NUMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
BWFLG
Black white flag.
CUS_REF
The customer
reference object.
0-Black, 1- White
MML command
long display(inout string bw_nbr,inout string bwflg,inout string cus_ref,out
string cmdResult) raises
Output parameters
ALA_QRY_VPN_BWNUMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_BWNUMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CUS_REF, BW_NBR, BWFLG are returned to the SARM tables
TBL_SRQ_PARM and table TBL_INFO_PARM.
50
Oracle Corporation
Queries an existing corporate VPN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNCorporate.qryVpnCor
porate.
Table 39: A_ALA-IN_1400_QRY_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
MNEMONIC
Customer
mnemonic.
MML command
long display(out string CAC_ref,out string custid,out string enddate,out
inObject::INSequence groups00,out string inqpass,out string maxblack,out
string maxext,out string maxpnp,out string maxwhite,out string minblack,out
string minext,out string minpnp,out string minwhite,out string offnet_c,out
string override,out string pnp_code,out string res_ref,out string strdate,out
string tier_ref,out string addr1,out string addr2,out string addr3,out string
adminame,out string email,out string phone,inout string mn,out string
cmdResult) raises
Output parameters
ALA_QRY_VPN_CORPORATE_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_CORPORATE_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CAC_REF, CUST_ID, END_DATE, INQ_PASS,
MAX_BLACK, MAX_EXT, MAX_PNP, MAX_WHITE, MIN_BLACK, MIN_EXT,
MIN_PNP, MIN_WHITE, OFFNET_ACC_COD, OVERRIDE_ACC_CODE, PNP_CODE,
RES_REF, START_DATE, TIER_REF, ADDRESS_1, ADDRESS_2, ADDRESS_3,
ADMIN_NAME, EMAIL, PHONE, MNEMONIC, SCREEN_GROUPS[n] are returned to
51
Queries an existing VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNMember.qryMember.
Table 40: A_ALA-IN_1400_QRY_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
MEMBER_NAME
Member name.
MML command
long display(out string CAC_ref,inout string cus_ref,out inObject::INSequence
groups00,out string grpbits,out string job_ref,out string maxblack,out string
maxwhite,inout string mbr_name,out string minblack,out string minwhite,out
string msisdn,out string ofnetflg,out string pnpref,out string cmdResult)
raises (inObject::envError,inObject::syntaxError,inObject::semanticError);
Output parameters
ALA_QRY_VPN_MEMBER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_MEMBER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CAC_REF, CUST_ID, GRPBITS, JOB_REF, MEMBER_NAME,
MAX_BLACK, MAX_WHITE, MIN_BLACK, MIN_WHITE, MSISDN, OFNETFLG,
PNPREF, SCREEN_GROUPS[n] are returned to the SARM tables TBL_SRQ_PARM and
table TBL_INFO_PARM.
52
Oracle Corporation
Queries an existing VPN PSTN. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNPSTN.qryPSTN.
Table 41: A_ALA-IN_1400_QRY_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
PSTN_ANB
PSTN A number
(fixed).
MML command
long display(inout string cus_ref,out string implied,out string
location,inout string pstn_anb,out string cmdResult) raises
Output parameters
ALA_QRY_VPN_PSTN_ RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_PSTN_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CUST_ID, IMPLIED, LOCATION, PSTN_ANB are returned to
53
Queries an existing VPN screen group. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNScrGroup.qryScrGrou
p.
Table 42: A_ALA-IN_1400_QRY_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
CUS_REF
The customer
reference object.
SCR_MNEMONIC
Mnemonic of an
attribute.
MML command
long display(inout string cus_ref,inout string mn20,out string scr_nbr,out
Output parameters
ALA_QRY_VPN_SCR_GROUP_ RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_SCR_GROUP_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CUST_ID, SCR_MNEMONIC, SCR_NBR are returned to the
SARM tables TBL_SRQ_PARM and table TBL_INFO_PARM.
54
Oracle Corporation
Queries an existing VPN tier. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNTier.qryTier.
Table 43: A_ALA-IN_1400_QRY_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
TIER_ID
TIER ID.
MML command
long display(out string bw_scrn,out string CAC_ref,out string fonetflg,out
string fonflgfx,out string tier_lbl,out string maxexclu,out string
maxinclu,out string minexclu,out string mininclu,inout string tier_id,out
Output parameters
ALA_QRY_VPN_TIER_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_TIER_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters BW_SCRN, CAC_REF, FONETFLG FONFLGFX, TIER_LBL,
MAXEXCLU, MAXINCLU, MINEXCLU, MININCLU, TIER_ID are returned to the SARM
tables TBL_SRQ_PARM and table TBL_INFO_PARM.
55
Queries an existing VPN customer username. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNUser.qryUser.
Table 44: A_ALA-IN_1400_QRY_VPN-USER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
USERNAME
Username for login.
MML command
long display(out string cus_ref,inout string username,out string
cmdResult)raises
Output parameters
ALA_QRY_VPN_USER_ RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_USER_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CUS_REF, USERNAME are returned to the SARM tables
TBL_SRQ_PARM and table TBL_INFO_PARM.
56
Oracle Corporation
User defined exit types (tbl_user_err)
Queries an existing white number of the VPN member. It is implemented by the Java method
com.metasolv.cartridge.oss.alcatel_in_1400.prov.AlaIN_ProvVPNWhiteMbr.qryWhite
Mbr.
Table 45: A_ALA-IN_1400_QRY_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
MCLI

NE.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
MML command
long display(inout string bw_nbr,inout string cus_ref,inout string
Output parameters
ALA_QRY_VPN_WHITE_MBR_RETCODE as CSDL parameter to the SARM table
TBL_SRQ_PARM.
ALA_QRY_VPN_WHITE_MBR_RETCODE as INFO parameter to the SARM table
TBL_INFO_PARM.
CSDL and Info parameters CUS_REF, BW_NBR, MBR_REF are returned to the SARM
tables TBL_SRQ_PARM and table TBL_INFO_PARM.
User defined exit types (tbl_user_err)

The user defined exit types, which maps to the NE error response code are placed in file
Alcatel_IN_1400_UserExitTypes.cfg. The following table lists the contents of the file. The
user has full control over this file. The user can add additional error codes to this file when
57
they are discovered. The user exit types defined in this file must exist in tbl_user_err and
should be mapped to a ASAP exit type in tbl_user_err.
Table 46: Contents of User Exit Types cfg file
Error code
User Exit Type
ALAIN_COMM_SUCCEED
ALAIN_COMM_FAILED
ALAIN_COMM_FAILED
ALAIN_COMM_FAILED
LOOPBACK
ALAIN_SUCCEED
Table 47: Mapping between User Exit Types and Base Types
User Exit Type
ALAIN_COMM_FAILED
ASAP Base Exit Type

FAIL
Description
Command Failure
ALAIN_COMM_SUCCEE SUCCEED
D
Command Succeed
ALAIN_SUCCEED
SUCCEED
Succeed
NO_MATCH_FOUND
FAIL
No match found
Table 48: Values for the return CSDL and Info parameters
CSDL and Info parameter values
58
Description
ALAIN_COMM_FAILED
Command Failure
ALAIN_COMM_SUCCEED
Command Succeed
ALAIN_SUCCEED
Succeed
NO_MATCH_FOUND
No match found
Oracle Corporation
Service Definition
The Alcatel IN cartridge contains a set of CSDLs that map to one or more ASDL commands.
You can also create additional CSDLs that map to existing and newly-created ASDLs. An
upstream system can assemble any of these CSDL commands onto a work order for
provisioning.
This chapter presents detailed information on the CSDL parameters that we provide in this
cartridge. The following table lists and describes the type of parameter information that is
included.
Item
Description
Parameter Name
Identifies the parameter that is configured for the stated

service.
Description
Describes the parameter.
Range
Describes or lists the range of values that can be used to

satisfy this parameter.
Default Value
Configures a default value for the parameter so that it is not

mandatory for the upstream system to provide a value.
59
Chapter 4: Service Definition

Item
Type
Description
Indicates one of the following parameter types:
SScalar, specifies the parameter label transmitted on

the ASDL command. Scalar parameters are conventional
name-value pair parameters.
CCompound, specifies the base name of the
compound parameter transmitted on the ASDL
command. A compound parameter contains structures or
arrays of information that are represented by a particular
structure name or compound parameter name. Each
compound parameter can contain a large number of
elements. If you use compound parameters, you only
require a single entry in the ASAP translation tables to
call the compound parameter and all its associated
parameter elements.
IIndexed, identifies a parameter that contains a
sequential numerical index value to tell the SARM that it
should execute the same operation (for example, an
ASDL command) for all occurrences of that index.
Consequently, if there are several options on a particular
CSDL command (OPT1, OPT2, OPT3, etc.), you can
specify the OPT parameter as an indexed parameter.
When you specify the OPT parameter as an indexed
parameter, the SARM generates several occurrences of
that same ASDL command and each command has a
different value for the option being transmitted to the
NEP.
For more information on parameter types, refer to the ASAP

Developers Reference.
Class
Indicates one of the following parameter classifications:
RRequired scalar parameter

OOptional scalar parameter
CRequired compound parameter
NOptional compound parameter
MMandatory indexed parameter
IOptional indexed parameter
SParameter count
For a detailed description of the Required and Optional parameter classifications, refer to the
ASAP System Configuration and Management Guide.
60
Oracle Corporation
CSDL commands
CSDL commands
This cartridge provides the following CSDL commands:
C_ALA-IN_1400_ADD_CUG-MEMBER
C_ALA-IN_1400_ADD_VPN-BLACK-MEMBER
C_ALA-IN_1400_ADD_VPN-BW-NUMBER
C_ALA-IN_1400_ADD_VPN-CORPORATE
C_ALA-IN_1400_ADD_VPN-MEMBER
C_ALA-IN_1400_ADD_VPN-PSTN
C_ALA-IN_1400_ADD_VPN-SCR-GROUP
C_ALA-IN_1400_ADD_VPN-TIER
C_ALA-IN_1400_ADD_VPN-USER
C_ALA-IN_1400_ADD_VPN-WHITE-MEMBER
C_ALA-IN_1400_DEL_CUG-MEMBER
C_ALA-IN_1400_DEL_VPN-BLACK-MEMBER
C_ALA-IN_1400_DEL_VPN-BW-NUMBER
C_ALA-IN_1400_DEL_VPN-CORPORATE
C_ALA-IN_1400_DEL_VPN-MEMBER
C_ALA-IN_1400_DEL_VPN-PSTN
C_ALA-IN_1400_DEL_VPN-SCR-GROUP
C_ALA-IN_1400_DEL_VPN-TIER
C_ALA-IN_1400_DEL_VPN-USER
C_ALA-IN_1400_DEL_VPN-WHITE-MEMBER
C_ALA-IN_1400_LIST_VPN-BLACK-MEMBER
C_ALA-IN_1400_LIST_VPN-WHITE-MEMBER
C_ALA-IN_1400_MOD_CUG-MEMBER
C_ALA-IN_1400_MOD_VPN-BLACK-MEMBER
C_ALA-IN_1400_MOD_VPN-CORPORATE
C_ALA-IN_1400_MOD_VPN-MEMBER
C_ALA-IN_1400_MOD_VPN-PSTN
C_ALA-IN_1400_MOD_VPN-SCR-GROUP
C_ALA-IN_1400_MOD_VPN-TIER
C_ALA-IN_1400_MOD_VPN-WHITE-MEMBER
C_ALA-IN_1400_QRY_CUG-MEMBER
C_ALA-IN_1400_QRY_VPN-BLACK-MEMBER
C_ALA-IN_1400_QRY_VPN-BW-NUMBER
61
C_ALA-IN_1400_QRY_VPN-CORPORATE
C_ALA-IN_1400_QRY_VPN-MEMBER
C_ALA-IN_1400_QRY_VPN-PSTN
C_ALA-IN_1400_QRY_VPN-SCR-GROUP
C_ALA-IN_1400_QRY_VPN-TIER
C_ALA-IN_1400_QRY_VPN-USER
C_ALA-IN_1400_QRY_VPN-WHITE-MEMBER
Creates a new CUG (Closed User Group) member using the CUG member proposition.
Table 50: C_ALA-IN_1400_ADD_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
GRP_REF
The Screening
Group Reference
User Group).
MSISDN
The Mobile Station

Integrated Services
Digital Network
(MSISDN)
parameter.
NE_ID_ALA-IN

NE.
PABXEXT
The length of the

PABX extension.
PABXFLG
The PABX flag

parameter.
PNP_NBR
The Private Number

Plan (PNP) number.
62
Oracle Corporation
0 (Single) and 1
(PABX)
CSDL commands
Mapping to ASDLs
The following table illustrates the CSDL to ASDL mapping for this service.
Table 51: CSDL to ASDL Mapping
CSDL
ASDL
Creates a new black number of the VPN member.
Table 52: C_ALA-IN_1400_ADD_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BLACKFLG
Black number
override flag.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
63
Creates a new VPN customer black white number.
Table 54: C_ALA-IN_1400_ADD_VPN-BW-NUMBER
Parameter Name
Description
BWFLG
Black white flag.
BW_NBR
Range
Default
Value
0-Black, 1- White
Type
Class
Black white number.
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
Creates new corporate VPN.
Table 56: C_ALA-IN_1400_ADD_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
ADDRESS_1
Customer
administrator's
address 1.
ADDRESS_2
Customer
administrator's
address 2.
64
Oracle Corporation
CSDL commands
Table 56: C_ALA-IN_1400_ADD_VPN-CORPORATE

Parameter Name
Description
Range
Default
Value
Type
Class
ADDRESS_3
Customer
administrator's
address 3.
ADMIN_NAME
Customer
administrator's
name.
EMAIL
Customer email
address.
END_DATE
End date of the

validity period.
INQ_PASS
Inquiry password.
MNEMONIC
Customer
mnemonic.
NE_ID_ALA-IN

NE.

DE

CODE
code.
PHONE
Customer phone
number.
PNP_CODE
PNP code.
RES_REF
Reference to a
reseller object.
START_DATE
Start date of the

validity period.
TIER_REF
Reference to a tier
object.
65
Mapping to ASDLs
CSDL
ASDL
Creates new VPN member.
Table 58: C_ALA-IN_1400_ADD_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
GRPBITS
Screen group bits.
JOB_REF

description.
MEMBER_NAME
Member name.
NE_ID_ALA-IN

NE.
OFNETFLG
Offnet rights.
PNPREF
Reference to PNP
object.
Mapping to ASDLs
CSDL
66
Oracle Corporation
ASDL
CSDL commands
Creates new VPN PSTN.
Table 60: C_ALA-IN_1400_ADD_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
IMPLIED
Implied A number.
LOCATION

line (PSTN).
NE_ID_ALA-IN

NE.
PSTN_ANB
PSTN A number
(fixed).
Mapping to ASDLs
CSDL
ASDL
Creates a new VPN screen group.
Table 62: C_ALA-IN_1400_ADD_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
67
Table 62: C_ALA-IN_1400_ADD_VPN-SCR-GROUP

Parameter Name
Description
Range
Default
Value
Type
Class
SCR_MNEMONIC
Mnemonic of an
attribute.
SCR_NBR
Screen group
number.
Mapping to ASDLs
CSDL
ASDL
Creates a new VPN tier.
Table 64: C_ALA-IN_1400_ADD_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_SCRN

screening right.
FONETFLG
Tier forced on net

right.
FONFLGFX
Forced on net flag

NE_ID_ALA-IN

NE.
TIER_ID
TIER ID.
TIER_LBL
TIER label.
68
Oracle Corporation
CSDL commands
Mapping to ASDLs
CSDL
ASDL
Creates a new VPN customer username.
Table 66: C_ALA-IN_1400_ADD_VPN-USER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
USERNAME
Username for login.
Mapping to ASDLs
CSDL
ASDL
69
Creates a new white number of the VPN member.
Table 68: C_ALA-IN_1400_ADD_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
Deletes a CUG (Closed User Group) member from a CUG.
Table 70: C_ALA-IN_1400_DEL_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
PNP_NBR
The Private Number

Plan (PNP) number.
70
Oracle Corporation
CSDL commands
Mapping to ASDLs
CSDL
ASDL
Queries an existing black number of the VPN member.
Table 72: C_ALA-IN_1400_DEL_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
71
Deletes an existing VPN customer black white number.
Table 74: C_ALA-IN_1400_DEL_VPN-BW-NUMBER
Parameter Name
Description
BWFLG
Black white flag.
BW_NBR
Range
Default
Value
0-Black, 1- White
Type
Class
Black white number.
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
Queries an existing corporate VPN.
Table 76: C_ALA-IN_1400_DEL_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
MNEMONIC
Customer
mnemonic.
NE_ID_ALA-IN

NE.
72
Oracle Corporation
CSDL commands
Mapping to ASDLs
CSDL
ASDL
Queries an existing VPN member.
Table 78: C_ALA-IN_1400_DEL_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
MEMBER_NAME
Member name.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
73
Queries an existing VPN PSTN.
Table 80: C_ALA-IN_1400_DEL_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
PSTN_ANB
PSTN A number
(fixed).
Mapping to ASDLs
CSDL
ASDL
Queries an existing VPN screen group.
Table 82: C_ALA-IN_1400_DEL_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
SCR_MNEMONIC
Mnemonic of an
attribute.
74
Oracle Corporation
CSDL commands
Mapping to ASDLs
CSDL
ASDL
Queries an existing VPN tier.
Table 84: C_ALA-IN_1400_DEL_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
NE_ID_ALA-IN

NE.
TIER_ID
TIER ID.
Mapping to ASDLs
CSDL
ASDL
Queries an existing VPN customer username.
Table 86: C_ALA-IN_1400_DEL_VPN-USER
Parameter Name
NE_ID_ALA-IN
Description
NE.
Range
Default
Value
Type
S
Class
R
75
Table 86: C_ALA-IN_1400_DEL_VPN-USER

Parameter Name
USERNAME
Description
Range
Default
Value
Username for login.
Type
S
Class
R
Mapping to ASDLs
CSDL
ASDL
Deletes an existing white number of the VPN member.
Table 88: C_ALA-IN_1400_DEL_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
76
Oracle Corporation
ASDL
CSDL commands
List existing black numbers of the VPN members.
Table 90: C_ALA-IN_1400_LIST_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BITMAP
Bitmap.
BLACKFLG
Black number
override flag.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NBSTART
NB start.
NE_ID_ALA-IN

NE.
SQLADDCRIT
SQL add criteria.
Mapping to ASDLs
CSDL
ASDL
77
Lists existing white numbers of the VPN member.
Table 92: C_ALA-IN_1400_LIST_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BITMAP
Bitmap.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NBSTART
NB start.
NE_ID_ALA-IN

NE.
SQLADDCRIT
SQL add criteria.
Mapping to ASDLs
CSDL
ASDL
Modifies an existing CUG (Closed User Group) member.
Table 94: C_ALA-IN_1400_MOD_CUG-MEMBER
Parameter Name
CUS_REF
78
Description
The customer
reference object.
Oracle Corporation
Range
Default
Value
Type
S
Class
R
CSDL commands
Table 94: C_ALA-IN_1400_MOD_CUG-MEMBER

Parameter Name
Description
Range
Default
Value
Type
Class
GRP_REF
The Screening
Group Reference
User Group).
NE_ID_ALA-IN

NE.
PABXEXT
The length of the

PABX extension.
PABXFLG
The PABX flag

parameter.
PNP_NBR
The Private Number

Plan (PNP) number.
0 (Single) and 1
(PABX)
Mapping to ASDLs
CSDL
ASDL
Modifies an existing black number of the VPN member.
Table 96: C_ALA-IN_1400_MOD_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BLACKFLG
Black number
override flag.
BW_NBR
Black white number.
79
Table 96: C_ALA-IN_1400_MOD_VPN-BLACK-MEMBER

Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
Modifies an existing corporate VPN.
Table 98: C_ALA-IN_1400_MOD_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
ADDRESS_1
Customer
administrator's
address 1.
ADDRESS_2
Customer
administrator's
address 2.
ADDRESS_3
Customer
administrator's
address 3.
ADMIN_NAME
Customer
administrator name.
80
Oracle Corporation
CSDL commands
Table 98: C_ALA-IN_1400_MOD_VPN-CORPORATE

Parameter Name
Description
Range
Default
Value
Type
Class
CHNGMN30
Allows changing of
mnemonic size 30.
EMAIL
Customer email
address.
END_DATE
End date of the

validity period.
INQ_PASS
Inquiry password.
MNEMONIC
Customer
mnemonic.
NE_ID_ALA-IN

NE.

DE

CODE
code.
PHONE
Customer phone
number.
PNP_CODE
PNP code.
RES_REF
Reference to a
reseller object.
START_DATE
Start date of the

validity period.
TIER_REF
Reference to tier
object.
81
Mapping to ASDLs
CSDL
ASDL
Modifies an existing VPN member.
Table 100: C_ALA-IN_1400_MOD_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CHNGMN30
Allows changing of
mnemonic size 30.
CUS_REF
The customer
reference object.
GRPBITS
Screen group bits.
JOB_REF

description.
MEMBER_NAME
Member name.
NE_ID_ALA-IN

NE.
OFNETFLG
Offnet rights.
PNPREF
Reference to PNP
object.
82
Oracle Corporation
CSDL commands
Mapping to ASDLs
CSDL
ASDL
Modifies an existing VPN PSTN.
Table 102: C_ALA-IN_1400_MOD_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
IMPLIED
Implied A number.
LOCATION

line (PSTN).
NE_ID_ALA-IN

NE.
PSTN_ANB
PSTN A number
(fixed).
Mapping to ASDLs
CSDL
ASDL
83
Modifies an existing VPN screen group.
Table 104: C_ALA-IN_1400_MOD_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
CHNGMN20
Allows changing of
mnemonic size 20.
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
SCR_MNEMONIC
Mnemonic of an
attribute.
SCR_NBR
Screen group
number
Mapping to ASDLs
CSDL
ASDL
Modifies an existing VPN tier.
Table 106: C_ALA-IN_1400_MOD_VPN-TIER
Parameter Name
BW_SCRN
84
Description
screening right.
Oracle Corporation
Range
Default
Value
Type
S
Class
R
CSDL commands
Table 106: C_ALA-IN_1400_MOD_VPN-TIER

Parameter Name
Description
Range
Default
Value
Type
Class
FONETFLG
Tier forced on net

right.
FONFLGFX
Forced on net flag

NE_ID_ALA-IN

NE.
TIER_ID
TIER ID.
TIER_LBL
TIER label.
Mapping to ASDLs
CSDL
ASDL
Modifies an existing white number of the VPN member.
Table 108: C_ALA-IN_1400_MOD_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
85
Mapping to ASDLs
CSDL
ASDL
Queries a CUG (Closed User Group) member.
Table 110: C_ALA-IN_1400_QRY_CUG-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
PNP_NBR
The Private Number

Plan (PNP) number.
Mapping to ASDLs
CSDL
86
Oracle Corporation
ASDL
CSDL commands
Deletes an existing black number of the VPN member.
Table 112: C_ALA-IN_1400_QRY_VPN-BLACK-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
Queries an existing VPN customer black white number.
Table 114: C_ALA-IN_1400_QRY_VPN-BW-NUMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BWFLG
Black white flag. 0Black, 1- White.
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
87
Table 114: C_ALA-IN_1400_QRY_VPN-BW-NUMBER

Parameter Name
NE_ID_ALA-IN
Description
Range
Default
Value

NE.
Type
S
Class
R
Mapping to ASDLs
CSDL
ASDL
Deletes an existing corporate VPN.
Table 116: C_ALA-IN_1400_QRY_VPN-CORPORATE
Parameter Name
Description
Range
Default
Value
Type
Class
MNEMONIC
Customer
mnemonic.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
88
Oracle Corporation
ASDL
CSDL commands
Deletes an existing VPN member.
Table 118: C_ALA-IN_1400_QRY_VPN-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
MEMBER_NAME
Member name.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
ASDL
Deletes an existing VPN PSTN.
Table 120: C_ALA-IN_1400_QRY_VPN-PSTN
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
PSTN_ANB
PSTN A number
(fixed).
89
Mapping to ASDLs
CSDL
ASDL
Deletes an existing VPN screen group.
Table 122: C_ALA-IN_1400_QRY_VPN-SCR-GROUP
Parameter Name
Description
Range
Default
Value
Type
Class
CUS_REF
The customer
reference object.
NE_ID_ALA-IN

NE.
SCR_MNEMONIC
Mnemonic of an
attribute.
Mapping to ASDLs
CSDL
90
Oracle Corporation
ASDL
CSDL commands
Deletes an existing VPN tier.
Table 124: C_ALA-IN_1400_QRY_VPN-TIER
Parameter Name
Description
Range
Default
Value
Type
Class
NE_ID_ALA-IN

NE.
TIER_ID
TIER ID.
Mapping to ASDLs
CSDL
ASDL
Deletes an existing VPN customer username.
Table 126: C_ALA-IN_1400_QRY_VPN-USER
Parameter Name
Description
Range
Default
Value
Type
Class
NE_ID_ALA-IN

NE.
USERNAME
Username for login.
91
Mapping to ASDLs
CSDL
ASDL
Queries an existing white number of the VPN member.
Table 128: C_ALA-IN_1400_QRY_VPN-WHITE-MEMBER
Parameter Name
Description
Range
Default
Value
Type
Class
BW_NBR
Black white number.
CUS_REF
The customer
reference object.
MBR_REF
The member
reference object.
NE_ID_ALA-IN

NE.
Mapping to ASDLs
CSDL
92
Oracle Corporation
ASDL
Configuring ASAP to Support

Additional NE Instances
You can configure ASAP to support the IN - NEP configuration using the Service Activation
Configuration Tool (SACT). Refer to the ASAP System Configuration and Management Guide
fore more information.
Below is an example of the Activation.Configuration.XML file for the Alcatel IN cartridge.
<?xml version="1.0" encoding="UTF-8"?>
<activationConfig xmlns="http://www.metasolv.com/ServiceActivation/2003/
ActivationConfig" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.metasolv.com/ServiceActivation/2003/
ActivationConfig
C:\ASAP4.6.4\ActivationConfig.xsd">
<connectionPool name="ALA_IN_1">
<device name="ALA_IN_DEVICE1">
<environment>MY_ASAP_SYS</environment>
<lineType>CORBA_CONNECTION</lineType>
</device>
</connectionPool>
<nepServer name="NEP__ALA" xsi:type="NEPServerType">
<description>NEP Server for Alcatel IN 1400</description>
<system>$ASAP_ENV</system>
<territory>$ASAP_ENV</territory>
<diagnosticFilename>NEP__ALA.diag</diagnosticFilename>
<diagnosticLevel>LOW_LEVEL</diagnosticLevel>
<autoStart>true</autoStart>
<controlServer>$CTRL</controlServer>
<interfaceHostname>
<hostname>MY_LOCALHOST</hostname>
</interfaceHostname>
<interfacePort>MY_INT_PORT</interfacePort>
<secondaryPool/>
<jinterpreterPort>MY_JINT_PORT</jinterpreterPort>
<enableJInterpreter>true</enableJInterpreter>
</nepServer>
<element name="ALA-IN-HOST">
<technology>ALA-IN</technology>
<softwareLoad>1400</softwareLoad>
<nepServerName>NEP__ALA</nepServerName>
<primaryPool>ALA_IN_1</primaryPool>
93
Chapter 5: Configuring ASAP to Support Additional NE Instances
<maximumConnections>2</maximumConnections>
<dropTimeout>2</dropTimeout>
<spawnThreshold>10</spawnThreshold>
<killThreshold>3</killThreshold>
<routingElement name="ALA-IN-HOST">
<atomicService/>
</routingElement>
<communicationParameter>
<label>RESPONSELOG</label>
<value>
<value>TRUE</value>
</value>
<description>Flag to turn On or Off logging of API commands and
responses</description>
<deviceName>ALA_IN_DEVICE1</deviceName>
</communicationParameter>
<label>IOR_INSTANCE</label>
<value>
<value>/config/access.ior</value>
</value>
<description>Interoperable Object Reference. User needs to provide
full path name.</description>
<label>USERNAME</label>
<value>
<value>alcatel_userid</value>
</value>
<description>User Name</description>
<label>PASSWORD</label>
<value>
<value>alcatel_password</value>
</value>
<description>Password</description>
<label>ORBINITIALHOST</label>
<value>
<value>127.0.0.1</value>
</value>
<description>CORBA Host IP address (obsolete now)</description>
94
Oracle Corporation
<label>ORBINITIALPORT</label>
<value>
<value>1570</value>
</value>
<description>CORBAHost Port (obsolete now)</description>
<label>USER_ERROR_TYPES_FILE</label>
<value>
<value>/config/Alcatel_IN_1400_UserExitTypes.cfg</value>
</value>
<description>The User Exit types file. This file is relative to
ASAP_BASE directory.</description>
<label>VPN_SERVICE_PROFILE</label>
<value>
<value>vpnvaService</value>
</value>
<description>VPN Service Profile Name, used to find index of the
service and IOR of the associated service server factory.
</description>
<label>READ_TIMEOUT</label>
<value>
<value>30</value>
</value>
<description>Read timeout in seconds.</description>
<label>LOOPACK_TIMEOUT</label>
<value>
<value>1</value>
</value>
<description>Loopback Timeout to simulate loopback mode timeout and
if value is bigger then READ_TIMEOUT to simulate InterruptedException.</
description>
95
Chapter 5: Configuring ASAP to Support Additional NE Instances
</element>
</activationConfig>
Extracting source files

Before you can access an XML file to modify it, you must extract it from the sar file. Use the
following procedure to extract source files from the sar file.
To extract source files
1. If necessary, create a repository directory under /ALCATEL_IN_1400_VPN, copy the .sar
file to the new directory and un-jar the sar file, as described by Step 1 through Step 4 in
Modifying Alcatel_IN_1400_VPN_ServiceModel.xml on page 13.
2. After you un-jar the sar file, you can access the XML files.
Loading a new XML file

When you finish modifying an XML, you must create a new sar file, then restart the cartridge
using the new file.
Follow the instructions in Modifying Alcatel_IN_1400_VPN_ServiceModel.xml on
page 13 for directions on how to load a new XML file.
96
Oracle Corporation

Alcatel in

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Alcatel in

Uploaded by

Copyright:

Available Formats

Oracle Communications ASAP Cartridge 1.

Alcatel IN 1.0 Cartridge

Copyright and Trademark Information

2. Installing and Testing the Cartridge ........................................................... 7

3. Atomic Service Description Layer (ASDL) Commands .......................... 15

Alcatel IN 1.0 Cartridge Guide

4. Service Definition ....................................................................................... 59

5. Configuring ASAP to Support Additional NE Instances ........................ 93

Alcatel IN 1.0 Cartridge Guide

Reduced Time to Markettime to market of new services is reduced through simplified

An ASAP cartridge can be used to configure ASAP to provision the following:

NEs from a specific vendor, such as Nortel or Lucent.

Alcatel IN 1.0 Cartridge Guide

Chapter 1: Cartridge Overview

A knowledge of ASAP programming concepts

About this guide

ASAP documentation setfor detailed information on the ASAP core product.

Services, features, and options

Services, features, and options

Creates a new VPN corporate.

Creates a new VPN PSTN.

Creates a new VPN member.

Alcatel IN 1.0 Cartridge Guide

Chapter 1: Cartridge Overview

Table 1: Supported services

Creates a new VPN customer username for

VPN Customer Black White Numbers

Creates a new VPN customer black white

White Number of the VPN Members

Creates a new white number of the VPN

Hardware and software requirements

Table 1: Supported services

Creates a new VPN tier.

Hardware and software requirements

Network element (NE) interface

Network element (NE) interface

NE SMP CORBA interface Release 2.3.

Alcatel IN 1.0 Cartridge Guide

Chapter 1: Cartridge Overview

Installing and Testing the Cartridge

Downloading the cartridge

Downloading the cartridge

3. Copy the resulting //ALCATEL_IN_1400_VPN directory and its contents to the

Alcatel IN 1.0 Cartridge Guide

Chapter 2: Installing and Testing the Cartridge

Installing the cartridge

Installing the cartridge

Configures the Alcatel IN-specific NE using the SACT.

To install the cartridge

Alcatel IN 1.0 Cartridge Guide

Chapter 2: Installing and Testing the Cartridge

Configuring the communication parameters (tbl_comm_param)

dev_type - the protocol used to connect to the device.

The following table lists the contents of tbl_comm_param.

ALA-IN-HOST ALA_IN_DEVICE1 IOR_INSTANCE

ALA-IN-HOST ALA_IN_DEVICE1 NE_DIALOG_

Flag to turn On or Off

ALA-IN-HOST ALA_IN_DEVICE1 USERNAME

User name for login

ALA-IN-HOST ALA_IN_DEVICE1 PASSWORD

alcatel_password The password for

ALA-IN-HOST ALA_IN_DEVICE1 ORBINITIALHOST 127.0.0.1