Contents

Title and Copyright Information

Preface

• Audience
• Related Documents

1 Overview

• About Cartridge Creation Options
  • Design Studio for ASAP
  • XML
  • Stored Procedures
• About ASAP Cartridges
  • ASAP Cartridge Contents
  • Cartridge Creation Workflow
• About Cartridge XML Schemas
  • ServiceModel.xsd
  • SA_archive.xsd
• About Service Modeling

2 Creating a Cartridge Project

• About Cartridge Types
• Defining Network Cartridge Project Parameters
  • Defining Network Cartridge Identification Tokens
    • Selecting the Vendor Token
    • Selecting the Technology Token
    • Selecting the Software Load Token
  • Defining the Scope of the Network Cartridge
  • Creating a Design Studio Project
• Defining Service Cartridge Project Parameters
  • Importing and Extending Network Cartridges in Service Cartridges

3 Configuring Network Element Connections

• About Network Element Configuration Components
• About Network Elements and Network Element Connections
  • Network Elements and Network Element Connections
    • Creating and Configuring Network Element and Network Element Connections
  • Adding Target Network Elements
  • Setting Network Element Throughput Control
• About Configuring a Java Network Connection Handler or State Table
  • Creating an Network Element Connection Handler
• Mapping a Network Element to a Network Element Processor

4 Mapping Network Element Commands to Actions, Entities, and Parameters

• About Identifying Network Element Commands and Parameters
• Defining Actions and Entities
  • Selecting the Action Tokens
  • Selecting Entity Tokens
• Generating a Cartridge Layout
• About Parameter Types
  • Default Values Rules and Guidelines
• About Creating a Data Dictionary
  • Creating an ASAP Cartridge Project Data Dictionary Using Design Studio
  • Scalar Parameters
    • Creating a Scalar Parameter using Design Studio
  • Indexed Parameters
  • Compound Parameters
    • Creating a Compound Parameter using Design Studio
    • Compound Indexed Parameters
    • Compound Parameters Rules and Guidelines
  • XML Parameters
    • Creating an XML Parameter using Design Studio
  • XPath Parameters
    • Creating an XPATH Parameter using Design Studio
  • Grouping Scalar Parameters using Design Studio Structured Elements

5 Creating and Configuring Atomic Actions and Action Processors

• About Creating and Configuring Atomic Actions
  • Creating and Configuring an Atomic Action
• About Retry Properties
  • Example 1: Configuring Retry Properties at the Network Element Instance Level
  • Example 2: Configuring Retry Properties at the Atomic Action Level
• About Delayed Failure Properties
• About Composite Priorities
• About Configuring a Rollback Atomic Action
  • About Rollback Atomic Action Parameters
  • About Atomic Action Rollback Functionality
    • Rollback Order
    • Rollback Failure
    • Order Timeout
    • Rollback Completion
    • Rollback Upon Failure
    • Rollback Upon Cancellation of an Order
    • Rollback Upon Revision to an Order
  • Configuring ignore_rollback
• About Atomic Action to Java Method or State Table Mappings
  • About Atomic Action to Java Method Provisioning Command Ratio
  • Creating an Action Processor

6 Configuring Static Routing

• Configuring Static Network Element Routing
  • Configuring Atomic Action Routings by Using a Network Element
  • Configuring Atomic Action Routings by Using ID_ROUTING
    • Routing by ID_ROUTING
  • Configuring Atomic Action Routings by Using USER_ROUTING
  • Configuring Atomic Action Routings by Using a Directory Number

7 Configuring Dynamic Routing

• Configuring Dynamic Network Element Routing
  • Enabling Dynamic Routing
    • Network Template Configuration
  • Dynamic Network Element Routing Scenarios
    • Network Element Identification
    • Scenario 1 – One Service Action to Multiple Atomic Actions Routed to One NE
    • Scenario 2 – One Service Action to Multiple Atomic Actions Routed to Different NEs
    • Scenario 3 – One Service Action to Multiple Atomic Actions Routed to Different NEs
    • Scenario 4 – One Service Action to Multiple Atomic Actions Routed to Multiple NEs
    • Scenario 5 – One Service Action to Multiple Atomic Actions Routed to Different NEs
    • Scenario 6 – Common URL
    • Dynamic Routing Configuration Errors
    • Managing Communication and Order Parameters
    • Backward Support for MPM Protocols
    • Software Load and Technology Type
    • NE Configuration Parameters

8 Creating Service Actions

• About Creating and Configuring Service Actions
  • Creating Service Actions
  • Configuring Service Action Default Sequence
  • Configuring Service Action Fail and Complete Events
• About Mapping a Service Action to Atomic Actions
  • About Limiting Independent Network Element Commands to Optimizing the Network Element Interface
  • Adding Atomic Actions to a Service Action
• About Atomic Action Spawning Logic
  • Configuring Atomic Action Spawning Conditions
  • Components of Service-Action-to-Atomic-Action Translation Expressions
    • Supported Parameters for Translation Expressions
    • Supported Operators for Translation Expressions
    • Supported Values for Translation Expressions
  • Defining Service Action-Atomic Action Translation Expressions
  • Translation Function Conflicts
• About Service Actions and Rollback
  • Enabling the CSDL Rollback Functionality
  • Enabling Work Order Rollback Functionality for the Service Request Processor Emulator
  • About Configuring a Rollback Point (Point of No Return)
    • Configuring a Rollback Point

9 Configuring Base Exit and User Exit Types

• About User Errors and Thresholds
• About Base Exit Types
  • Behaviors of RETRY and RETRY_DIS
• About User Exit Types
  • Using Regular Expression Search Patterns
  • Using Search Patterns Against Long Switch Responses
  • About User Exit Types for Unknown Errors
  • About User Exit Types for Success Cases
  • Mapping User Exit Types to Base Exit Types Based on Context
  • Creating New User Exit Types
  • Configuring User Exit Types
• Examples: User Exit Types
  • Example: Unstable Network Element Connections
  • Example: Configuration of Context Sensitive Exit Types
  • Example: Exit Type Rationalization

10 Configuring Dynamic and Static Event Templates for Return Parameters

• About Static and Dynamic Event Templates for Return Parameters
• Configuring a Dynamic Events Template
• JSRP (OSS/J) Work Order Event Information
  • Extended Work Order Complete and Failure Schemas
  • FailedServicesType Schema Type
  • Services Schema Type
  • Controlling the Return of Enhanced Event Information with includeServiceActionDetail
  • JSRP Server Configuration Parameter INCLUDE_SERVICE_ACTION_DETAIL
  • Additional Event Data
  • OSS/J Support by Schema Parameters
  • Work Order Property includeServiceActionDetail
  • JSRP Server Configuration Parameter USE_ORIGINAL_INSTANCE_NUMBER

11 Creating Java Connection Handlers

• About Java Network Element Connection Handlers
• Creating New Network Element Connection Handlers
• Generating a Telnet Network Element Connection Handler Implementation
• Generating a Custom NE Connection Handler Implementation
• About Communication Protocol Parameters
  • Specifying Global or Local Communication Parameters
  • User-defined Parameters
  • Device-specific Interface Parameters
  • CORBA Interface Communication Parameters
  • Serial Port Hardwired Communication Parameters
  • Serial Port Dialup Communication Parameters
  • Telnet Port Communication Parameters
  • SSH Telnet Communication Parameters
  • Socket Port Communication Parameters
  • FTP Port Communication Parameters
  • LDAP Port Communication Parameters
  • TL1 Port Communication Parameters
  • SNMP Port Communication Parameters
  • StreamConnection Interface
• Creating Connection Methods and Helper Classes
• Creating a Provisioning Prompt
• Enabling Loopback Mode
• Implementing Secure Login Functionality
• Connection Management Issues
• Creating a Java Telnet Connection Class

12 Creating Java Action Processors

• Generating Java Stubs for the Connection Handlers and Action Processors
• Developing a Java Action Processor
  • Understanding Java with Code Generation
    • About Processor Classes and Interfaces
    • Example: Typical Processor Call Sequence
  • Understanding the Java Processor Class
    • Writing Java Processor Execute Method Logic
    • Java Processor Class Example
  • Understanding Java Libraries in Design Studio
  • Understanding Unit Testing
    • Running Unit Test Cases
    • Running Unit Tests with the JDT Debugger
    • Understanding Unit Test Property Files
    • Configuring a Unit Test
  • About Java Method Naming Convention
    • Java Package Naming Convention
    • Java Class Naming Convention
    • Java Helper and Utility Class Naming Convention
    • Java Method Naming Convention
    • Java Variables Naming Convention
    • Java Constants Naming Convention
  • Using Default Values
  • Enabling Value and Range Checking
  • Logging Diagnostic Messages
  • TCP/IP Message Parsing Options
  • Use of Journal Functionality
  • Telnet Provisioning Class Flow

13 Creating Java User Exit Types

• Developing Return Parameters in Java Action Processors
  • About Return Parameters in Java Action Processors
  • Configuring Java Methods for Return Parameters to SARM
  • Return Parameter Types
    • Global Returned Parameter
    • Service Action Returned Parameter
    • Atomic Action Returned Parameter
    • Returned Information for Upstream Purposes
    • Indexed Rollback Returned Parameter
  • Use Cases for Returning Parameters
    • Query for Rollback Information
    • Error and Diagnostic Information
  • Configuring Response Logging and Network Element History Capture
  • User Defined Exit Types

14 Documenting ASAP Cartridges

• About Design Studio Cartridge Documentation

15 Work Order Processing and Sample Work Orders

• Work Order Processing Overview
  • General Work Order Processing
  • OSS/J or Web Service Work Order Processing with XML or XPath Parameters
• About Testing Cartridge Elements with Sample Work Orders
  • About SRP Emulator Sample Work Orders
  • About JSRP Sample OSS/J Work Orders
    • Sample OSS/J Work Order with Conditional Logic Using XML Parameters
    • Sample OSS/J Work Order with Conditional Logic using XPath Parameters
  • About Web Service Sample Work Orders
• Guidelines for Creating Sample Work Orders
• Troubleshooting Atomic Action Commands
• Troubleshooting Service-Action-to-Atomic-Action Translation Errors

16 Creating and Deploying a SAR File (ASAP Cartridge)

• SAR File Creation and Deployment Options
• SAR File Folder Structure Options
  • ASAP 4.7 SAR File Folder Structure
  • ASAP 4.6 SAR File Folder Structure
• Creating an ASAP 4.6 SAR File
• Deploying Service Models with the Service Activation Deployment Tool
  • Using the SADT Command Line Interface
    • Using the SADT Command Line Interface in Interactive Mode
      • Deploying a Service Activation Model Archive
      • Undeploying a Service Activation Model Archive
      • Querying an Activation Model
      • List All Deployed Activation Models
    • Using the SADT Command Line Interface in Script Mode
  • Using the SADT Web Interface
    • Viewing Deployed Service Activation Models
    • Deploying a service activation archive file
    • Undeploying a Service Activation Model
    • Deploying Multiple Cartridges
  • Using the SADT JMX Interface
    • Configuring JMX Interfaces to Validate XML Documents
• Loading ASAP Services Dynamically

A Configuring Services Using XML

• Configuration Restrictions and Limitations
• Configuring ASAP Services
  • Planning
  • Configuring Atomic Actions
  • Adding Supporting Data
  • Configuring Service Actions
  • Mapping Atomic Actions to Service Actions
  • Mapping User Exit Types to Base Exit Types
  • Creating Activation-Model.xml
  • Configuring Network Element Throughput Using XML

B Configuring Services Using Stored Procedures

• Configuring ASAP Services Using Stored Procedures
  • Configuring Service Action Commands
  • Configuring Atomic Action Commands
  • Configuring Atomic Action Command Parameters
  • Configuring Service Action-to-Atomic Action Mappings
  • Configuring Atomic Action-to-Program Mappings
• Configuring Network Elements Using Stored Procedures
  • Configuring Host Network Elements
  • Configuring Host to Remote Network Element Mappings
  • Configuring NEP-to-Host NE Mappings
  • Configuring Resource Pools
  • Configuring Communication Parameters
  • Configuring Network Element Error Thresholds
  • Configuring User Errors and Thresholds
  • Configuring Static Routing
    • Configuring Atomic Action Routings by ID_ROUTING Using Stored Procedures
    • Configuring Atomic Action Routings by USER_ROUTING
    • Configuring Atomic Action Routings by Distinguished Name
  • Configuring Network Element Blackout Periods (optional)
    • Checking Network Element Blackout Periods
• Configuring External Device Drivers (Deprecated)
  • Adding an EDD to ASAP Start-up Procedures
  • Adding an EDD as an ASAP Component
  • Setting EDD Communication Parameters
  • Setting EDD Configuration Parameters
    • X.25 and X.29 Interface Configuration Parameters
    • SNMP Interface Configuration Parameters