1/25

Contents

Title and Copyright Information

Preface

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

Part I Modeling OSM Solutions Overview

1 OSM Solution Modeling Overview

• About the OSM Solution Modeling Process
• About Determining the OSM Functionality to Implement
  • Solution Modeling Considerations
    • General Solution Data Modeling Principles
    • Performance Considerations
  • Planning OSM COM Solution Requirements
    • Modeling COM Order and Order Recognition Requirements
    • COM Data Modeling Considerations
    • Modeling COM Orchestration Order Items and Binding Conceptual Model Parameters
    • Modeling COM Orchestration Order Item Decomposition
    • Modeling COM Orchestration Fulfillment Patterns and Fulfillment Modes
    • Modeling COM Order Transformation Manager
    • Modeling COM Orchestration Dependencies
    • Modeling COM Processes and Tasks
    • Modeling COM Fallout Scenarios
    • Modeling COM Fulfillment States
    • Modeling COM Processing States
    • Modeling Change Order Management for COM
    • Cartridge Management Considerations for COM
  • Planning OSM SOM Solution Requirements
    • Modeling SOM Order and Order Recognition Requirements
    • SOM Data Modeling Considerations
    • Modeling SOM Orchestration Order Items and Bindings Conceptual Model Parameters
    • Modeling SOM Orchestration Order Item Decomposition
    • Modeling SOM Orchestration Fulfillment Patterns and Fulfillment Modes
    • Modeling SOM Orchestration Dependencies
    • Modeling SOM Processes and Tasks
    • Modeling SOM Fallout Scenarios
    • Modeling SOM Fulfillment States
    • Modeling SOM Processing States
    • Modeling Change Order Management for SOM
    • Cartridge Management Considerations for SOM
  • Planning OSM TOM Solution Requirements
    • Modeling TOM Order and Order Recognition Requirements
    • TOM Data Modeling Considerations
    • Modeling TOM Orchestration Order Items and Bindings Conceptual Model Parameters
    • Modeling TOM Orchestration Order Item Decomposition
    • Modeling TOM Orchestration Fulfillment Patterns and Fulfillment Modes
    • Modeling TOM Orchestration Dependencies
    • Modeling TOM Processes and Tasks
    • Modeling TOM Fallout Scenarios
    • Modeling TOM Fulfillment States
    • Modeling TOM Processing States
    • Modeling Change Order Management for TOM
    • Cartridge Management Considerations for TOM

Part II Implementing an OSM Solution

2 Modeling Orders and Permissions

• Modeling OSM Orders
  • About OSM Orders Without Orchestration
  • About OSM Orders With Orchestration
  • Modeling Roles and Setting Permissions
• About Order Types
  • About Order Updates
  • Using a Job Control Order to Manage Multiple Orders
    • About Job Control Order Operations
    • About Job Control Order Permissions
    • About Job Control Order System Configuration Files
• Viewing Orders in OSM Web Clients
  • Specifying Which Data to Display in the OSM Web Clients
  • Modeling Query Tasks for OSM Clients

3 Modeling Order Life-Cycle Policies

• Modeling Order Life-Cycle Policy States and Transitions
  • About Modeling Transition Conditions
  • About Modeling Transition Grace Periods
  • About Modeling Transition Permissions
  • OSM Order States and Transactions
  • About Order State Categories
  • Common Order State Transitions
  • Optional, Mandatory, and Prohibited Transactions
  • About the Aborted Order State
  • About the Amending Order State
  • About the Cancelled Order State
  • About the Cancelling Order State
  • About the Completed Order State
  • About the Failed Order State
  • About the In Progress Order State
  • About the Not Started Order State
  • About the Suspended Order State
  • About the Waiting Order State
  • About the Waiting for Revision Order State
  • About Deleting Orders

4 Modeling Order Recognition

• About Sending Orders to OSM and Order Recognition
• Modeling Order Recognition Rules
• Validating Incoming Order Data
• Transforming Order Data
  • Modeling the Order Data Rule to Populate the Creation Task
  • Modeling Order Priority
  • Configuring JMS Message Priority on JMS Queue
    • Creating a JMS Destination Key
    • Configuring Destination Key for a JMS resource
  • Modeling the Order Reference Number
• Modeling a Catch-All Recognition Rule
• Common Order Recognition Errors

5 Modeling Orchestration Plans

• Orchestration Plan Overview
• Modeling an Orchestration Plan
  • About Component Names and Component IDs
• About Order Items
  • About Creating Order Items from Customer Order Line Item Node-Sets
  • About Associated Order Items
  • Modeling Order Item Hierarchies
  • About Using a Distributed Order Template
  • About Mapping Order Items to Fulfillment Patterns
    • About Modeling Product Specifications
• Modeling Fulfillment Modes
• About the Decomposition of Order Items to Function Order Components
  • About Assigning Order Items to Fulfillment Pattern Function Components
  • About the Function Components Stage
  • About Order Component Control Data
  • About Fulfillment Pattern Conditions for Including Order Items
  • Summary of Order Item to Function Components Decomposition
• About the Decomposition of Function to Target System Components
  • About Decomposition Rules from Function Components to Target Systems
  • About Decomposition Rule Conditions for Choosing a Target System
  • About the Target Systems Stage
  • Summary of Configuring Target System Components Decomposition
• About the Decomposition of Target System to Granularity Components
  • About Decomposition Rules from Target System to Granularity Components
  • About Customized Component IDs for Separating Bundled Components
  • About the Granularity Components Stage
  • Summary of Configuring Granularity Components Decomposition
• About Dependencies
  • About Intra-Order Dependencies
    • Modeling an Order Item Dependency
    • About Order Item Dependency Wait Conditions
    • About Order Item Dependency Wait Conditions Based on Data Changes
    • Modeling a Fulfillment Pattern Dependency
    • Modeling an Order Item Property Correlation Dependency
    • About Inferred Dependencies
    • About Modeling Orchestration Dependencies
    • About Processing Order Items Sequentially
  • About Inter-Order Dependencies
  • About Modeling Orchestration Dependencies
  • Using Task States to Manage Orchestration Dependencies

6 Modeling the Order Transformation Manager

• Understanding the Order Transformation Manager
• Order Transformation Manager in Runtime
• The Order Transformation Manager and the Conceptual Model
• OSM Entities Used in the Order Transformation Manager
• Calling the Order Transformation Manager
• Using the Distributed Order Template with the Order Transformation Manager
• Modeling OTM With Calculate Service Order
  • Calculate Service Order Design Patterns
    • About the Calculate Service Order Provider Function
    • About Calculate Service Order Relationship Types
    • About the Calculate Service Order Transformation Sequence
  • User-Created Entities for Calculate Service Order
• Modeling OTM Without Calculate Service Order

7 Modeling Processes and Tasks

• Overview of Processes and Tasks
• Modeling Processes
  • About Process Flows
  • Adding Process Activities
  • Configuring Subprocesses
  • Understanding Parallel Process Flows
    • About Amendments and Multi-Instance Subprocesses
  • About Order Rules in Processes and Notifications
    • Modeling Order Rules in Notifications
    • Using the System Date in Delays
  • Process and Task Design and Data Considerations for Compensation
    • Order Perspectives and Data Elements in Compensation
    • Effects of Process Loops on Compensation
• Modeling Tasks Entities Common to All Task Types
  • Modeling Task States
  • Modeling Task Permissions and Execution Modes
  • About Normal and Fallout Execution Modes and Task States
  • Modeling Task Status Transitions
  • Specifying the Expected Task Duration
  • Specifying the Task Priority
  • About Extending Tasks
• About Task Types
  • Modeling Automated Tasks
    • About Automation Plug-in and Automated Tasks
    • Completing an Automation Task That Handles Concurrent Status Updates
  • Modeling Manual Tasks
    • Deploying a Custom Task Algorithm using the OSM Cartridge Management Tool
  • Modeling Transformation Tasks
  • Modeling Activation Tasks
    • About Service Action Request Mapping
    • About Service Action Response Mapping
    • About Activation Tasks and Amendment Processing
    • About State and Status Transition Mapping for Activation Tasks
• About Automation Plug-ins
  • Specifying Which Data to Provide to Automation Plug-ins
    • Modeling Query Tasks for Order Automation Plug-ins
  • About Automation Message Correlation
  • Example: Modeling a Basic Automator Plug-in for an Automated Task

8 Modeling OSM Data

• Data Modeling Overview
• Modeling Order Data
  • About the Data Dictionary
  • About the Order Template
  • Identifying Data Requirements for Order Payload
    • Adding the Input Message to an Order Recognition Rule
    • Adding the Input Message to the Order Template
  • Modeling Valid Data Keys
• Modeling Data for Tasks
  • Determine Task Data for Manual and Automated Tasks
  • Determine Task Data for Data Returned from Fulfillment Applications
  • Generating Multiple Task Instances from a Multi-Instance Field
• Modeling Data for Orchestration
  • About Order Item Control Data
  • About Order Template Data
  • About Order Item Specification Data
  • About ControlData for Order Component Data
• Modeling Data for Fulfillment States
  • About ControlData for External Fulfillment States
  • About ControlData for Order Fulfillment State
  • About ControlData for Order Item Fulfillment State
  • Fulfillment States and Point of No Return
  • Fulfillment State and Point of No Return Initial Values
  • Sample XQuery for Changing Default Data Locations
• Modeling Data for Processing States
  • About ControlData for Order Component Order Item Processing States
  • About ControlData for Order Item Processing States
• Modeling Orders With Data Fields Above 1000 Characters
  • Using XML Types for Data Fields Above 1000 Characters
  • Using Order Remarks for Data Fields Above 1000 Characters
  • Using Attachments for Data Fields Above 1000 Characters
• 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
  • Order
    • Adding a New Order Data Provider
  • Property File
  • SOAP
  • XML Attachment
  • XML File
  • XML Validation
  • JDBC
  • Web Service
    • Adding a New Web Service Data Provider
    • Sample soap.request XQuery
    • Accessing Data
  • Custom Data Providers
    • Handling Parameters

9 Modeling Behaviors

• Modeling Behaviors Overview
  • About Behavior Evaluation
    • Evaluating Behavior Levels
    • Evaluating Design Studio Final and Override Options
    • Evaluating Behavior Type Precedence and Sequence
      • Evaluation Process
      • Evaluating Multiple Behaviors of Similar Type and Level
  • About Setting Conditions in Behaviors
  • Using the Calculation Behavior
    • Calculation Behavior XPath Examples
    • Calculation Behavior Overview
  • Using the Constraint Behavior to Validate Data
    • Displaying Constraint Behavior Error Messages
    • Evaluating Constraint Behaviors
    • Using Task Statuses to Control Process Transitions
    • Task Statuses and Constraint Behavior Violation Severity Levels
    • Constraint Behavior Overview
  • Using the Data Instance Behavior to Retrieve and Store Data
    • Evaluating Data Instance Behaviors
    • Data Instance Behavior XML, XPath, and XQuery Examples
    • Data Instance Behavior Overview
  • Using the Event Behavior to Re-evaluate Data
    • Event Behavior Overview
  • Using the Information Behavior to Display Data and Online Help
    • Information Behavior XPath Examples
    • Information Behavior Overview
  • Using the Lookup Behavior to Display Data Selection Lists
    • Lookup Behavior XPath Example
    • Lookup Behavior Overview
  • Using the Read-Only Behavior
    • Read-Only Behavior Overview
  • Using the Relevant Behavior to Specify if Data Should Be Displayed in the Web Client
    • Relevant Behavior Overview
  • Using the Style Behavior to Specify How to Display Data in the Task Web Client
    • About Style Behavior Layouts
    • About Style Behavior Password Fields
    • Style Behavior Overview

Part III Modeling Run-time Order Management

10 Modeling Changes to Orders

• About Amendment Processing and Compensation
• About Revising or Canceling Orders by Using the Task Web Client
• About Order Keys
• About Submitting Multiple Revisions of an Order
• About Compensation States
• About Revising In-flight Revision Orders
  • About Insignificant Revision
  • About Terminating Compensation
  • Disabling Processing of Revisions on In-flight Revision Orders
  • Example: Revising an In-flight Revision Order
• About Controlling When Amendment Processing Starts
• About Compensation
  • About Order-Level and Task-Level Compensation Analysis
  • About Order Data Position and Order Data Keys
  • About Data Significance
  • About Task Execution Modes
  • Modeling Compensation for Tasks
    • Determining Task Compensation Strategy
    • About Compensating In Progress Tasks
    • About Task Compensation Strategy XQuery Expressions
    • About Managing Compensation in the Task Web Client
  • Modeling Compensation for Rules in Processes
  • Modeling Compensation for Task Automation Plug-Ins
  • Compensation Examples
    • Example 1: Compensation During Provisioning
    • Example 2: Compensation During Billing
    • Example 3: Amend Do Compensation
    • Examples of Changes to Orchestration Plans
• Modeling a Point of No Return
  • Fulfillment Pattern Point of No Return
  • Life-Cycle Policy Point of No Return
• About Modeling Order Change Management
  • Troubleshooting Order Change Management Modeling
• About Order Change Management at the Orchestration Layer
  • About Compensation and Orchestration
  • About Point of No Return

11 Modeling Fallout

• Overview of Fallout
• Understanding Fallout Across OSM Roles
• Understanding Fallout Sources
  • Managing Business Related Fallout Sources
  • Managing Fallout from Failures in Network or System Resources
  • Managing Fallout During Order Creation
• Managing Fallout in the OSM Web Clients
• Modeling Fallout in Tasks
  • About Failed Tasks and Execution Modes
  • About Alternate Task Fallout Management Methods
  • Modeling Task Notifications for Fallout
  • About Modeling Fallout Exceptions
  • Managing Fallout Exceptions in the Task Web Client
• Modeling Fallout in Orders
  • Modeling the Failed Order State
  • Modeling Order Notifications for Fallout
  • About Aborting or Terminating an Order
  • Managing Fallout in the OSM Order Management Web Client

12 Modeling Fulfillment States and Processing States

• About Fulfillment States, and Processing States
• Modeling Fulfillment States
  • Defining Fulfillment States
  • Modeling External Fulfillment States
  • Modeling Fulfillment State Maps
  • Modeling Fulfillment State Composition Rule Sets
• Modeling Processing States
  • Order Component Order Item Processing States
  • Order Item Processing States

13 Modeling Jeopardy and Notifications

• Best Practices for Using Notifications for Status Updates
  • Status Update Strategies
  • Strategies for Using Notifications
• Modeling Notifications
  • Using Task States and Statuses to Trigger Event Notifications
  • About Notification Priority
  • About Sending Notifications in Email
  • About Configuring Entities to Support Notifications
• About Jeopardy Notifications
  • About Modeling Jeopardy Notifications
  • About Jeopardy Notification Triggering
  • About Jeopardy Notification Conditions
    • Specifying Jeopardy Notification Conditions in the Order Jeopardy Editor
    • Specifying Jeopardy Notification Conditions in the Order Editor
    • Specifying Jeopardy Notification Conditions for a Task
• About Event Notifications
  • About Using Task Transitions to Trigger Event Notifications
  • About Using Task States and Rules to Trigger Event Notifications
  • About Using Task States to Trigger Automated Event Notifications
  • About Using Order Milestones to Trigger Event Notifications
  • About Using Order Data Changes to Trigger Notifications
  • About Enabling Order Life-Cycle Events
• Summary of Notification Functionality

14 Modeling Order Scheduling

• About Order Item Requested Delivery Date and Order Components
  • How OSM Decomposes and Processes Order Items in Order Components
  • About Grouping Order Items in Order Components by Date Range
  • Modeling Order Component Minimum Processing Duration
  • About Minimum Processing Duration Inheritance in Fulfillment Patterns
  • About Minimum Processing Duration Expressions
  • Calculating the Earliest Order Component Start Date (Order Start Date)
  • About Calculated Order Component Start Dates
  • Modeling Order Component Dependencies and Requested Delivery Dates
  • Modeling Order Items Processed by Multiple Dependent Order Components
  • Revisions of Future-Dated Orders
  • Examples of Calculating the Expected Start Date
    • Example 1: Calculating Start Dates for Order Components with No Dependencies
    • Example 2: Calculating Start Dates for Order Components with Dependencies

Part IV Managing OSM Projects

15 Managing OSM Solution Cartridges

• Solution Management Overview
• About OSM Cartridge Scope
  • Scope of OSM Entities Without Namespaces
    • Design Studio Entities
    • XML Catalogs and Resource Files
  • Scope of OSM Entities with Namespaces
  • Standalone Cartridge Scope
    • XML Catalog Files in Standalone Cartridges
    • Avoiding Namespace Collisions for Design Studio Entities
    • Avoiding Namespace Collisions for Resource and XML Catalog Files
  • Composite Cartridge Scope
  • Special Cases for Scope
    • Order Recognition Rules
    • Fulfillment Patterns
• Managing Cartridge Versions
  • Making Changes to Existing Cartridge Versions
  • Handling Multiple Cartridge Versions
  • Migrating Orders to a New Version of a Cartridge
  • Designation of the Default Cartridge Among Cartridge Versions
  • Handling Revision Orders When Multiple Cartridge Versions Are Deployed
• Building and Packaging a Cartridge
  • About Generating OSM Cartridges and Deployment Options
  • About Cartridge Types
  • About Design Studio Editors for OSM Cartridges
  • Organizing Design Studio and Naming Conventions
  • Cartridge Packaging Design
  • Modifying the Build
  • About XML Catalogs
  • Using XML Catalogs in OSM
    • Resource Packaging Considerations for Using XML Catalogs
    • Defining rewriteURI Entries in XML Catalogs
    • Specifying XML Catalogs for OSM
    • Enabling and Disabling XML Catalog Support
  • Examples of Using XML Catalogs
    • Using XML Catalogs to Support Cartridge Versioning
    • Using XML Catalogs to Load Resources from a Development File System
    • Using XML Catalogs to Insulate Run-Time Environments from Development
• Cartridge Deployment
  • Cleaning and Rebuilding Cartridges Prior to Deployment
  • Optimizing Cartridge Deployment
  • Deploying Multiple Cartridges
  • Deploying Cartridges with Dependencies
  • Building and Deploying Composite Cartridges
  • Setting Cartridge Dependencies
  • Post-Deployment Effect on Numeric Data
  • Post-Deployment Changes to Cartridge
  • Metadata Errors

Part V Appendixes

A XQuery Examples

• General XQuery Information
  • About Creating XQuery Expressions with Design Studio
  • OSM XQuery Functions
  • Referencing Items from a Distributed Order Template in XQuery Expressions
• Order Recognition Rule XQuery Expressions
  • About Recognition Rule XQuery Expressions
  • About Validation Rule XQuery Expressions
  • About Order Priority XQuery Expressions
  • About Order Reference XQuery Expressions
  • About Order Data Rule XQuery Expressions
• Decomposition XQuery Expressions
  • About Orchestration Sequence XQuery Expressions
    • About Order Sequence Order Item Selector XQuery Expressions
    • About Order Sequence Fulfillment Mode XQuery Expressions
  • About Order Item Specification XQuery Expressions
    • About Order Item Specification Order Item Property XQuery Expressions
    • About XQuery Expressions for Mapping Product Specifications and Fulfillment Patterns
    • About Order Item Specification Order Item Hierarchy XQuery Expressions
    • About Order Item Specification Condition XQuery Expressions
  • About Fulfillment Pattern Order Component XQuery Expressions
    • About Fulfillment Pattern Order Component Condition XQuery Expressions
    • About Associating Order Items Using Property Correlations XQuery Expressions
  • About Decomposition Rule Condition XQuery Expressions
  • About Component Specification Custom Component ID XQuery Expressions
    • Custom Order Component IDs Based on Hierarchy
    • Custom Component IDs Based on Requested Delivery Date and Duration
    • Custom Component IDs by Duration and Minimum Separation Duration
    • Combining Order Item Hierarchy with Duration-Based Groupings
  • About Component Specification Duration XQuery Expressions
  • About Fulfillment Pattern Duration XQuery Expressions
  • About Fulfillment Pattern Component Duration XQuery Expressions
• Dependency XQuery Expressions
  • About Order Item Dependency Property Correlation XQuery Expressions
  • About Wait Delay Duration XQuery Expressions
  • About Wait Delay Date and Time XQuery Expressions
  • About Order Data Change Wait Condition XQuery Expressions
  • About Order Item Inter-Order Dependency XQuery Expressions
• Order Transformation Manager XQuery Expressions
  • About Transformation Sequence XQuery Expressions
    • About Order Item Context XQuery Expressions
    • About Related Order Item Selector XQuery Expressions
    • About Stage Condition XQuery Expressions
  • About Mapping Rule XQuery Expressions
    • About Mapping Condition XQuery Expressions
    • About Action Mapping XQuery Expressions
    • About Entity-to-Entity Advanced Mapping XQuery Expressions
    • About Entity-to-Data-Element Advanced Mapping XQuery Expressions
    • About Data-Element-to-Data-Element Advanced Mapping XQuery Expressions
    • About Reverse Mapping XQuery Expressions
    • About Multi-Instance XQuery Expressions
  • About Order Item Parameter Binding XQuery Expressions
  • About Transformed Order Item Fulfillment State XQuery Expressions

B Behaviors Quick Reference

• OSM Behavior Type Overview
• Common Behavior Elements
  • Annotation Element
  • Description Element
  • Instance Element
  • Adapter Element [externalInstanceType]
  • Parameter Element [externalInstanceType]
  • Cache Element
  • Expression Element
• Declaring Behaviors in OSM XML Model
  • Data Dictionary Level
  • Master Order Template Level
  • View Level
• Data Provider Overview
• Programmatic Behavior Implementation Overview