Contents

Title and Copyright Information

Preface

• Audience
• Accessing Oracle Communications Documentation
• Documentation Accessibility
• Document Revision History

1 Introduction

• Planning and Designing
• Customizing OSM
• External Interfaces
  • OSM Web Services
  • OSM Automation
  • OSM Security Callback
  • The OSM XML API
• User Interfaces
  • Behaviors
  • Custom Menu Items and Actions
  • Localizing OSM
  • Logging with ODL
• Tools for Customizing OSM
  • Design Studio
  • Apache Ant
  • The XML Import/Export Application
• About XPath and XQuery
• Performance Considerations

2 Using OSM Order Management Web Services

• About Web Services
• About Order Management Web Services
  • Request Validations
  • Accessing the WSDL Files
  • Using the SOAP Standard Message Format
    • Message Header
    • Message Body
    • White Space in Message Text
  • Testing OSM Web Services
  • Order States and Transitions
  • Web Services Sample
• About Order Management Web Service Operations
  • Parameters
  • Fault Types and OSM Web Service Client Error Processing
  • Request and Response Examples
• Web Service Operations Used for Order Management
  • CreateOrderBySpecification
  • CreateOrder
  • FindOrder
  • GetOrder
  • UpdateOrder
  • SuspendOrder
  • ResumeOrder
  • CancelOrder
  • AbortOrder
  • FailOrder
  • ResolveFailure
  • RetryOrder
• Web Service Operations Used for Problem Order Diagnosis
  • GetOrderProcessHistory
  • GetOrderCompensations
  • GetCompensationPlan
• Navigating WSDL and XSD Files
  • Order Management WSDL File
  • Order Management XSD File
• Order Management Request and Response Examples
  • CreateOrderBySpecification Examples
  • GetOrder Examples
  • UpdateOrder Examples
  • SuspendOrder Examples
  • ResumeOrder Examples
  • CancelOrder Examples
  • RetryOrder and ResolveFailure Examples
  • GetOrderProcessHistory Examples
  • GetOrderCompensations Examples
  • GetCompensationPlan Examples

3 Using OSM Entity Management Web Services

• About Entity Management Web Services
  • About Request Validations
  • Accessing the WSDL File
• About Entity Management Web Service Operations
• Entity Management Web Service Operations
  • CreateEntities
  • UpdateEntities
  • GetEntity
  • FindEntity
• Entity Management Request and Response Examples
  • CreateEntities Examples for Asset Entities
  • CreateEntities Examples for Account Entities
  • UpdateEntities Examples for Asset Entities
  • UpdateEntities Examples for Account Entities
  • GetEntity Examples for Asset Entities
  • GetEntity Examples for Account Entities
  • FindEntity Examples for Asset Entities
  • FindEntity Examples for Account Entities

4 Using the OSM XML API

• About Using the XML API
  • Audience
  • About Using the OrderID, View, and OrderHistID
• About Accessing the XML API
  • Login/Logout
  • Message Formats
    • Input XML Message Format
    • Output XML Message Format
    • Date/Time Formats
    • White Space in Message Text
  • Authentication
  • Reserved Mnemonics
• XML API Functionality
  • AddOrderThread
  • Acknowledgments
  • AcknowledgeNotification
  • AssignOrder
  • CancelOrder
  • CompleteOrder
  • CopyOrder
  • CreateOrder
  • FalloutTask
  • FailOrder
  • GetNextOrderAtTask
  • GetOrder
  • GetOrderAtTask
  • GetOrderDataHistory
  • GetOrderProcessHistory
  • GetOrderStateHistory
  • GetTaskStatuses
  • GetUserInfo
  • ListExceptions
  • ListStatesNStatuses
  • ListViews
  • ModifyRemark
  • Notifications
  • OrderTypesNSources
  • OrderViewTemplate
  • Query
  • ReceiveOrder
  • ResolveFailure
  • ResumeOrder
  • RetryTask
  • SetException
  • SuspendOrder
  • TaskDescription
  • UpdateOrder
  • Worklist
• Warning and Error Code Descriptions
• Document Type Definitions (DTD)
  • AddOrderThread
  • AssignOrder
  • CompleteOrder
  • CopyOrder
  • CreateOrder
  • Error
  • GetOrder
  • GetNextOrderAtTask
  • GetOrderDataHistory
  • GetOrderProcessHistory
  • GetOrderStateHistory
  • GetUserInfo
  • ListExceptions
  • ListStatesNStatuses
  • ListViews
  • ModifyRemark
  • OrderTypeNSource
  • OrderViewTemplate
  • Query
  • ResumeOrder
  • SetException
  • SuspendOrder
  • TaskDescription
  • UpdateOrder
  • Warning
  • Worklist

5 Using OSM Security Callback

• About Security Callback
• About the Security Callback Interface
  • Exceptions
• Security Callback Sample
  • Configuring Security Callbacks

6 Using Custom Menu Items and Actions

• About Custom Menu Items and Actions
• About the File Name and Location
• About the Model Definition
  • Action Definition
  • OrderContext and Orders
  • Calling the XML API
  • Sample Action Implementations
  • Menu Item Definition
  • Sample Menu Item Definition
• Setting Up the Environment
  • Setting Up the oms-config.xml File
  • File System Path Environment Configuration Method
  • XML Catalog (Static Relative Location) Environment Configuration Method
  • XML Catalog (rewriteURI) Environment Configuration Method
  • Verifying the Changes

7 Using Data Providers to Retrieve Data

• About Data Providers and Adapters
• Data Provider Interface Tab
• Accessing Data through Data Providers
• Augmenting or Overriding Data
• Objectel
  • Parameters
• Order
  • Parameters
  • Adding a New Order Data Provider
• Property File
  • Parameters
• SOAP
  • Parameters
  • Example of soap.body Parameter
  • Example of soap.envelope Parameter
• XML Attachment
  • Parameters
• XML File
  • Parameters
• XML Validation
  • Parameters
• JDBC
  • Parameters
• Web Service
  • Parameters
  • Adding a New Web Service Data Provider
  • Sample soap.request XQuery
  • Accessing Data
• Custom Data Providers
  • Handling Parameters

8 Using Automation

• About Automations and the Automation Framework
  • About Sender and Automator Automation Types
  • About Automations in the Order and Task Contexts
  • About Internal and External Events that Trigger Automations
  • About Accessing the XML API in Automations
  • About Queues, Correlation, and Property Selectors
    • OSM Request and Response Message Queues
    • Correlating Requests from OSM to Responses from External Systems
    • Intercommunication Between Orders in the Same Domain
    • About Message Property Selectors
  • About Automation Plug-in Communication Options
    • No External Communication: Data Processing Only
    • Fire-and-Forget Communication: Message Sent to External Systems
    • Synchronous Communication: Single Request and Response
    • Synchronous Communication: Multiple Requests and Responses
    • Asynchronous Communication: Single or Multiple Requests and Responses
  • Storing Response Message as XML Type Parameters
• About Custom Automation Plug-ins
  • Defining the Custom Automation Plug-in
    • About the XML Template
  • About Creating Custom Automation Plug-ins
    • inputXML Argument
    • AutomationContext Argument and Casting the Context Argument
    • outboundMessage Argument
  • Accessing JDBC from Within an Automation Plug-in
  • Compiling the Custom Automation Plug-in
• About Predefined Automation Plug-ins
  • XSLT Sender
    • Defining the Automation
    • Writing the XSLT
    • Steps to Follow When Using XSLT Sender
  • XSLT Automator
    • Defining the Automation
    • Writing the XSLT
    • Steps to Follow When Using XSLT Automator
  • XQuery Sender
    • Defining the Automation
    • Writing the XQuery
    • Steps to Follow When Using XQuery Sender
  • XQuery Automator
    • Defining the Automation
    • Writing the XQuery
    • Steps to Follow When Using XQuery Automator
  • DatabasePlugin
    • Defining the Custom Automation Plug-in
    • Creating the JDBC Data Source
• About Large Orders and Automation Plug-ins
  • Limiting Automation Concurrency in Large Orders
  • Using GetOrder and UpdateOrder API Functions in Large Orders
• About Compensation for Automations
  • About Execution Modes for Automations
  • About Automations that Update Order Data and Compensation Analysis
  • About Using GetOrder Responses to View Compensation Perspectives
• About Creating Automations in Design Studio
  • About Building and Deploying Automation Plug-ins
  • About Automation Maps
    • About Editing the Automation Map
    • About Mnemonic Values for Design Studio Entities in Automation Maps
• About Managing Automations
  • Building and Deploying Automation Plug-ins
    • Automating the Build and Deploy
  • Troubleshooting Automations
  • Upgrading Automation Plug-ins

9 Using Order Metrics Manager

• About Order Metrics Manager ADML Files
• Viewing Metrics

10 Localizing OSM

• About Localization
• Localizing OSM
  • Localizing the XML Import/Export Application
• Additional Considerations for Localizing OSM
  • Support for Different Locales
  • Character Set Encoding
  • Localization of Settings
• About NLS Database Configuration
  • Oracle Database Character Set
  • NLS Environment
    • NLS_LANG Parameter
    • ORA_NLS33 Environment Variable
• About OSM Database Error Messages
• About Application Server Strings
• About OSM Process Definition Data
  • om_application_function
  • om_attribute_type
  • om_order_data_dictionary
  • om_order_remarks_type
  • om_order_type_category
  • om_process
  • om_process_status
  • om_responsibility
  • om_rule_def
  • om_state
  • om_state_category
  • om_status_category
  • om_task
  • om_view_order_node_label
• About Generic Preferences
  • om_generic_mnemonic
• Localizing the Task Web Client
  • Task Web Client Localization Resource Bundles
  • Localizing Date, Time and Currency Formats
  • Localizing Text and Error Messages
  • Localizing Page Titles
  • Localizing Image References
  • Inserting New Images
  • Editing the First Day of the Week
  • Editing the Task Web Client Gantt Chart
  • Editing the Boolean Data Element Values
  • Editing the Number of Records Displayed in the Worklist
  • Editing and Replacing Task Web Client Icons
• Localizing the Order Management Web Client
  • Changing the Order Management Web Client Logo Image and Text
• Working with the oms.ear File
  • Unpacking the oms.ear File
  • Packing the oms.ear File
  • Undeploying and Redeploying the oms.ear File

11 Using XPath Functions

• About XPath Functions
• Node Set Functions
  • number last()
  • number position()
  • number count(node-set)
  • node-set id(object)
  • string local-name(node-set?)
  • string namespace-uri(node-set?)
  • string name(node-set?)
  • node-set evaluate(string)
  • node-set match(node-set, string)
  • node-set instance(string)
• String Functions
  • string string(object?)
  • string concat(string, string, string*)
  • string starts-with(string, string)
  • string contains(string, string)
  • string substring-before(string, string)
  • string substring-after(string, string)
  • string substring(string, number, number?)
  • number string-length(string?)
  • string normalize-space(string?)
  • string translate(string, string, string)
  • string lower-case(string?)
  • string upper-case(string?)
  • string ends-with(string, string)
• Boolean Functions
  • Boolean boolean(object)
  • Boolean not(boolean)
  • Boolean true()
  • Boolean false()
  • Boolean boolean-from-string(string)
  • object if(boolean,object,object)
• Number Functions
  • number number(object?)
  • number sum(node-set)
  • number floor(number)
  • number ceiling(number)
  • number round(number)
  • number avg(node-set)
  • number min(node-set)
  • number max(node-set)
  • number count-not-empty(node-set)
• XPath 1.0 Reference
  • Location Paths [XPath §2]
  • Location Paths [XPath §2.1]
  • Axis Specifiers [XPath §2.2]
  • Node Tests [XPath §2.]
  • Abbreviated Syntax for Location Paths
  • Predicate [XPath §2.4]
  • Variable Reference [XPath §3.7]
  • XPath
  • XPath Operators
    • Node-sets [XPath §3.3]
    • Booleans [XPath §3.4]
    • Numbers [XPath §3.5]
  • Node Types [XPath §5]
  • Object Types [§11.1, XPath §1]
  • XPath Core Function Library
    • Node Set Functions [XPath §4.1]
    • String Functions [XPath §4.2]
    • Boolean Functions [XPath §4.3]
    • Number Functions [XPath §4.4]
  • OSM Behavior XPath Functions
    • Node Set Functions
    • String Functions
    • Boolean Functions
    • Number Functions

A Automation and Compensation Examples

• Predefined Automation Plug-ins
  • Message Example
  • Automation Plug-in XQuery Examples
    • Internal XQuery Sender
    • External XQuery Automator
    • External XQuery Sender
    • Internal XQuery Automator
  • Automation Plug-in XSLT Examples
    • Internal XSLT Sender
    • External XSLT Automator
    • External XSLT Sender
    • Internal XSLT Automator
  • Automation Plug-in Examples for Events, Jeopardies, and Notifications
    • Event Automators
    • Jeopardy Automators
    • Order Notification Automation Plug-ins
• Custom Java Automation Plug-ins
  • Internal Custom Java Automator
  • Internal Custom Java Sender
  • External Custom Java Automator that Changes the OSM Task Status
  • External Custom Java Automator that Updates Order Data
  • Using OrderDataUpdate Elements to Pass Order Modification Data
  • Examples of Sending Messages to External Systems
  • Examples of Handling Responses from External Systems
• Compensation XQuery Expressions
  • Task Re-Evaluation and Rollback XQuery Expressions
  • In Progress Compensation Include XQuery Expressions
  • In Progress Compensation Complete XQuery Expressions
  • In Progress Compensation Grace Period XQuery Expressions
• Order Jeopardy Automation XQuery Plug-ins
• Asset Parameter Binding XQuery Expressions

B AutomationMap.xml File

• AutomationMap.xml Examples for Automated Tasks
  • XSLTSender Internal Event Receiver
    • Notes Common to All Examples
    • Notes on Example
  • XSLTSender External Event Receiver
    • Notes on Example
  • XSLTAutomator Internal Event Receiver
    • Notes on Example
  • XSLTAutomator External Event Receiver
    • Notes on Example
  • Custom Automation Internal Event Receiver
    • Notes on Example
  • Custom Automation External Event Receiver
    • Notes on Example
• AutomationMap.xml Examples for Automated Notifications
  • Order Milestone-Based Notification
  • Task State-Based Notifications
  • Task Status-Based Notification
  • Order Data Changed Notification
  • Order Jeopardy Notification
  • Task Jeopardy Notification
• Generated Entity-Specific XML Files

C Automation: Start to Finish

• Assumptions
• Getting Started
• Defining an Automated Task
• Writing the Custom Automation Plug-in
• Defining the Custom Automation Plug-in
• Defining the Automation
• Defining the Process
• Building the Cartridge
• Packaging and Deploying the Cartridge
• Triggering the Automation in OSM