1/8

Contents

Title and Copyright Information

Preface

• Audience
• Related Documentation
• Documentation Accessibility

1 Web Services Overview

• About UIM Web Service Standards and Specifications
• About the UIM Web Services Framework
  • About the UIM Web Service Module
  • About Message Queues
    • About Message Queues for Custom Web Services
  • About Transaction Handling
  • About Exception Stacktraces
• About UIM Web Services

2 Working with the Service Fulfillment Web Service

• About the Service Fulfillment Web Service
  • About Business Interactions and Services
  • About Engineering Work Orders
• About the Web Service Packaging
• About the WSDL and Schema Files
  • About the WSDL File
  • About the Schema Files
    • Reference Schemas
    • Web Service Schemas
    • Business Schemas
• CaptureInteraction
  • Associating Business Interactions
  • CaptureInteraction Logic Flow
  • Validating Input Data
  • captureInteractionRequest
    • Business Interaction
    • Business Interaction Item
    • Business Interaction Item Parameter
    • Service
    • Associated Business Interaction
    • ExecuteProcess Element
    • ResponseLevel Element
  • captureInteractionResponse
• ProcessInteraction
  • ProcessInteraction Logic Flow
    • Service Configuration Association
  • Customizing ProcessInteraction
    • Modeling the Service in Design Studio
    • Customizing Service Actions
    • Customizing the Automation of Service Configurations
      • Developing the Custom Code
    • ProcessInteraction Example
  • processInteractionResponse
• GetInteraction
  • GetInteraction Logic Flow
  • getInteractionResponse
• UpdateInteraction
  • UpdateInteraction Logic Flow
  • updateInteractionResponse
• GetConfiguration
  • getConfigurationRequest
    • Request Search Options
    • Request Search Option Examples
    • Additional Request Options
    • Additional Request Options Example
    • ResponseLevel Element
  • GetConfiguration Logic Flow
  • getConfigurationResponse
  • Customizing GetConfiguration
    • Extension Points
    • Customization Steps
    • Customized Response
• GetConfigurationDifferences
  • getConfigurationDifferencesRequest
    • Request Search Options
    • Request Search Option Examples
    • Additional Request Options
    • Additional Request Options Example
  • GetConfigurationDifferences Logic Flow
  • Child Configurations
    • Example 1
    • Example 2
    • Example 3
    • Overriding the Process Logic that Determines Child Configurations
  • getConfigurationDifferencesResponse
  • Customizing GetConfigurationDifferences
• UpdateConfiguration
  • updateConfigurationResponse
• Customizing the Web Service Operations
• Extending Web Service Requests and Responses
  • Additional Information
• Deploying, Testing, and Securing the Web Service

3 Working with the Network Resource Management Web Service

• About the NRM Web Service
• About the Web Service Packaging
• About the WSDL and Schema Files
  • About the WSDL File
  • About the Schema Files
    • Reference Schemas
    • Web Service Schemas
    • Business Schemas
• CreateEntity
  • createEntityRequest
    • Multiple Entities
    • Optional Elements
    • Example
  • createEntityResponse
• FindEntity
  • findEntityRequest
    • Multiple Entities
    • Examples
  • findEntityResponse
• FindTNBlock
  • findTNBlockRequest
    • Example
  • findTNBlockResponse
• UpdateEntity
  • updateEntityRequest
    • Multiple Entities
    • Optional Elements
    • Examples
  • updateEntityResponse
• DeleteEntity
  • deleteEntityRequest
    • Multiple Entities
    • Optional Elements
    • Examples
  • deleteEntityResponse
• ReserveEntity
  • reserveEntityRequest
    • Resource Entity Search Criteria
    • Multiple Entities
    • Optional Elements
    • Example
  • reserveEntityResponse
• ReserveTNBlock
  • reserveTNBlockRequest
    • Telephone Number Block Search Criteria
    • Example
  • reserveTNBlockResponse
• UnreserveEntity
  • unreserveEntityRequest
    • Resource Entity Search Criteria
    • Multiple Entities
    • Optional Elements
    • Examples
  • unreserveEntityResponse
• UpdateReservation
  • updateReservationRequest
    • Multiple Reservations
    • Optional Elements
    • Example
  • updateReservationResponse
• AssociateEntity
  • associateEntityRequest
    • Multiple Entities
    • Example
  • associateEntityResponse
• DisassociateEntity
  • disassociateEntityRequest
    • Multiple Entities
    • Example
  • disassociateEntityResponse
• ImportEntity
  • importEntityRequest
    • Multiple Entities
    • Example
    • Spreadsheet Format
    • Spreadsheet Row Order
  • importEntityResponse
• ExportEntity
  • exportEntityRequest
    • Multiple Entities
    • Example
  • exportEntityResponse
    • TelephoneNumber Sheet
    • LogicalDevice Sheet
    • LogicalDeviceAccount Sheet
    • PhysicalDevice Sheet
    • exportEntityResponse Faults
• Determining Criteria Item Names
• Customizing the Web Service Operations
• Extending Web Service Requests and Responses
• Deploying, Testing, and Securing the Web Service

4 Developing Custom Web Services

• About the UIM Reference Web Service
• About the WSDL and Schema Files
  • About the WSDL File
  • About the Schema Files
• About Namespaces
• About the Ant Build File
• Guidelines for Developing Custom Web Services
  • Using the WSDL-First Approach to Developing Custom Web Services
  • Class Diagrams
  • WSDL Interface Guidelines
  • Operation Signatures
    • Signature Components
    • Signature Pattern and Examples
  • Schema Guidelines
  • Transaction Guidelines
• Developing and Running Custom Web Services
  • Configuring Your Work Environment
    • WebLogic Server
    • UIM
    • Design Studio
  • Importing the Reference Web Service Project
  • Configuring the Imported Project
    • Configuring the COMPUTERNAME.properties File
    • Configuring the web.xml File
    • Configuring the Project Library List
  • Locating the API Method Signature in the Javadoc
    • Information to Capture
  • Developing the Web Service
    • Creating the WSDL File
    • Creating Schema Files
    • Creating Java Source Files
  • Generating Java Source Based on the WSDL
  • Creating the WAR File
  • Packaging the WAR File in the EAR File
    • Extracting and Updating the application.xml File
    • Additional Custom Work
    • Importing the WAR File into the EAR File
  • Deploying the EAR File
    • Verifying the Deployment
    • Specifying a Deployment Plan
• Deploying, Testing, and Securing the Web Service

5 Deploying, Testing, and Securing UIM Web Services

• Deploying Web Services
  • Verifying Deployments
• Testing Web Services
  • Test Input XML
  • Pre-configuration for Testing
• Securing Web Services
  • About Policy Files
  • Modifying Web Service Security
    • Accessing Security
    • Associating a Policy File
    • Disassociating a Policy File
    • Modifying the Deployment Plan
• Securing Custom Web Services