What's New in This Release
TIBCO® Fulfillment Order Management Installation and Configuration Guide
Important Information
TIBCO Documentation and Support Services
Installation Overview
Operating System and Database Requirements
Required Products
Required Third-Party Products
Installing JDK
Installing ANT
Required TIBCO Products
Installation Options
TIBCO Environment
Installation Scenarios
Installation Environment Variables
Installer Disk Space Requirements in Temporary Area
Installation Registry History and Log Files
Installation and Deployment Options
Typical or Custom Install
Installation Modes
GUI Mode
Console Mode
Silent Mode
Installing TIBCO Fulfillment Order Management
Installing in GUI Mode
Installing in Console Mode
Installing in Silent Mode
Uninstalling TIBCO Fulfillment Order Management
Post-Installation Tasks
Post-Installation Task 1: Backing up the OMS Database Schema
Post-Installation Task 2: Copying Dependencies
Post-Installation Task 3: Creating the Database
Creating an OMS Oracle Database for the Admin User
Creating an OMS Oracle Database for the Default Tenant
Creating an OCS Oracle Database
Creating an OMS PostgreSQL Database for the Admin User and Default Tenant
Creating an OCS PostgreSQL Database
Post-Installation Task 4: Creating the TIBCO EMS Channel
Post-Installation Task 5: Integrating with TIBCO Fulfillment Subscriber Inventory
Post-Installation Task 6: Backing up TDS-AF_Orchestrator_ForDesigner.projlib
Post-Installation Task 7: Starting the TIBCO FOM Engines
Configuring and Verifying Installation
Configuring the Database and Messaging Through Configurator
Database Configuration Properties
Restarting the Server
Verifying Installation
Deploying and Running the TIBCO BusinessWorks 6 and TIBCO BusinessWorks Container Edition Projects
TIBCO Fulfillment Order Management Upgrade
Upgrade from Version 3.0.2 HF-4 to Version 4.0
Converting from a Non-Partitioned Database to a Partitioned Database
Preparing Messages for the Upgrade
Backing Up the Database
Installing TIBCO Fulfillment Order Management 4.0
Creating Databases for TIBCO Fulfillment Order Management 4.0
Migrating the Database
Merging 3.0.2HF-4 Configurations to 4.0 Configurations
Upgrading the TIBCO EMS Channel
Shredding the Database Privilege
Possible Changes in Process Components
Start the TIBCO Fulfillment Order Management 4.0 Environment
Installation FAQs and Troubleshooting
TIBCO® Fulfillment Orchestration Suite Getting Started
Important Information
TIBCO Documentation and Support Services
Use Case Submitting an Order
Create Products using TIBCO Fulfillment Catalog
Logging in to TIBCO Fulfillment Catalog
Creating the START-END Milestone Pair
Creating Plan Fragments for Products
Creating the Products
Creating the Product Bundle
Publishing the Products and Making the Products Available
Starting the Test Harness
Submitting Order and Retrieving Order Reference using SOAP UI
Searching for Orders using Order Reference
Viewing the Execution Plan
Viewing the Gantt Chart to Confirm Fulfillment of Order
Use Case Amending an Order
Create Products using TIBCO Fulfillment Catalog
Logging in to TIBCO Fulfillment Catalog
Creating the START-END Milestone Pair
Ways to Create Plan Fragments for Products
Creating Plan Fragments for Products
Creating the Products
Creating the Product Bundle
Publishing the Products and Making the Products Available
Starting the Test Harness
Submitting Order and Retrieving Order Reference using SOAP UI
Searching for Orders using Order Reference
Viewing the Execution Plan
Viewing the Gantt Chart to Confirm Fulfillment of Order
Submitting Order Amendment by Changing the Original Order
Searching the Amended Order using the Order Reference
Viewing the Execution Plan of Amended Order
Viewing the Gantt Chart to Confirm Fulfillment of Amended Order
TIBCO® Fulfillment Order Management Concepts and Architecture Guide
Important Information
TIBCO Documentation and Support Services
Introduction
About TIBCO® Fulfillment Order Management
TIBCO® Fulfillment Orchestration Suite Overview
TIBCO Fulfillment Orchestration Components
User Interface Integration
TIBCO® Fulfillment Order Management Overview
Basic Order Management Concepts
Order
Characteristics
Product
Plan
Plan Item
Milestone
Dependency
Plan Fragment
Error Handling
SLA Notification
Plan Development
Lifecycle
Order
Order Line
Order Amendment
Plan
Plan Item
Milestone
Dependency
Sequences
Standard Order
Successful Completion
Feasibility Failed
Plan Development Failed
Plan Item Execution Failed
Processing New Order with MOPD Enabled
Amend Order Fulfillment
Before Plan Creation
Amend Order Fulfillment
Processing Amended Order with MOPD Enabled
Cancel Order
Architecture
Order Management Server
Orchestrator
Automated Order Plan Development
Manual Order Plan Development
Order Capture System
Offer and Price Engine
Process Components
Feasibility Provider
Jeopardy Management
Router
Key Functionality
TIBCO® Fulfillment Order Management Administration Guide
Important Information
TIBCO Documentation and Support Services
Deployment
Recommended Setup for a Fulfillment Order Management Development Environment
Micro-Services
Node Discovery
Deployment Topologies
Single Node Single Instance Topology
Single Node Multi-Instance Topology
Multi-Node Multi-Instance Topology
Pre-Deployment Configuration
Components Deployment
Configurator Deployment
AOPD Deployment
Order Capture System Deployment
OMS Server Deployment
Jeopardy Deployment
OMS UI Deployment
Offer and Price Engine Deployment
Demo Subscriber Directory Toggling
Colocation
Configuration
Queue Management
Data Models
Model Loading Process
Online Model Loading
Offline Model Loading
Reading Offline XML Files
Model Processing
Enabling and Disabling Model Cache Persistence
Enabling and Disabling Posting Models on EMS topics
Jeopardy Management System
JeOMS Configuration
OMS Components
OMS Configuration
Messaging Configuration
User Interface Configuration
Plan Preview Integration with OMSUI
Implementing OMSUIClient.jar
URL to Access OMSUI Component
Target Parameters for OMSUI
Additional Parameters for OMSUI
Router Configuration
Routing Orders to Other Engines
Configuring Router Context
Multi-Tenancy Configuration
Managing Application Security
Managing Users and Roles
Creating User
Reading User Details
Deleting User
Resetting Password
Load Balancing
OMS WebService
OMS Web Service Authentication
Collecting Order Summary Data
Audit Trail
Custom Audit Trail
Enabling MOPD Support
MOPD Orders Identification
Additional MOPD Configuration
Server Side Validation of MOPD
Enabling Internal Error Handler Support
State Machine Pagination
State Machine Configuration
State Machine Context Checkpoint
Offer and Price Engine Configuration
Order Capture System Configuration
Order Capture System External Component Configuration
Order Service Configuration
Subscriber Inventory Web Service Configuration
Eligibility and Pricing Web Service Configuration
Order Plan Preview Configuration
Pooled Database Source Configuration
PostgreSQL Database Configuration
Creating PostgreSQL Tables
Multi-Tenancy Configuration
Security Configuration
Catalog Directory Configuration
Access Points Common Configuration
Log File Configuration
Logging
How Logging Works
Contents of the Log Message
Controlling Log Levels
Configuring Logging for Java Components
Administration Tasks
Docker
Building a Docker Image Without an Internet Connection
Copying Files to Docker Context
Building Docker Images
Preparing Docker Volumes
Setting Up the .env File
Configuring for OMS Docker Containers
Running the Docker Containers
Enabling the RMI Port for the OMS Server Container
Running the OMS Server Container on a Predefined Port
Scaling the Docker Container
Extend Docker-Compose Files
Adding Environment Variables
Modifying a Container Time-Zone
Reading Container Logs
Troubleshooting Error from Building Docker Images
Order purging Through SQL
Purge Configuration
Archiving the Database
PurgeThreadCount
Purging Orders Within a Given Time Period and Matching Order Type
Database Partitioning
Installing a Fresh Copy of a Database
Adding Future Partitions to an Existing Database
Truncating Old Partitions
Dropping Old Partitions
Database Partitioning with an Oracle Database
Database Partitioning with a Postgres Database
Migrating From a Non-Partitioned AUDIT_TRAIL Table
Product Model Purge
Purge Model Server Cache Impact
Bulk Order Actions
Bulk Order Actions
WSDL Location
Error Codes
Invoke Bulk Order Operation
Tracking the Request Status
Logging
Schema
Bulk Order Schema
Bulk Orders Operation Request Schema
Bulk Orders Operation Response Schema
Sample Request
Sample Response
Resource Failure Handling
Resource Failure Scenario
Detection of Resource Failure
Action on Resource Failure
Action on Resource Recovery
Configuration of Resource Failure Handling
Advisory Messages and Impact on Fault Tolerance Processing
Event Processing on Orchestrator when it is Not Started
Multi-Tenancy
Adding a New Tenant
Removing a Tenant
Manage Tenant Script Options
Cloning a Pluggable Database (PDB)
Creating a Source PDB
Preparing the Cloning Script
Order Capture System User Interface Tasks
Configuring the System
User Management
Entering Users
Editing Users
Deleting Users
Demo Subscriber Directory
Accessing the List of Subscribers
Entering Subscribers
Editing Subscribers
Deleting Subscribers
Accessing the List of Stores
Entering Stores
Editing Stores
Deleting Stores
Reloading the Catalog
Back Office
Search Syntax
Tuning Performance
OMS Performance Tuning
Status Listener Queues
Fulfillment Order Management Disaster Recovery
Fulfillment Order Management Topology for Disaster Recovery
Storage and Volumes
Network
Database
Messaging Server
Schema References
Plan Item
Result Status
Message
Order Request
Order Request Header
Order Request Line
Process Component Model
TIBCO® Fulfillment Order Management User's Guide
Important Information
TIBCO Documentation and Support Services
Orchestrator
Architecture
Backing Store
Deployment
Resource Failure Handling
Batch Notification
Sub-batching
Batch Event Processing
Locking Strategy
Failover
Notification
Throttling
Configuring the Default Load Capacity
Configuring the Individual Load Capacity
Configuring the Activation Threshold
Formulas
Order Request Optimization
Sort Criteria
Dead Letter Queue
External Dependency
Enabling Enrichment
Configuration
Logging
Time Dependency
Non-Executing Plan Item
Process Component Destination
Order Types
Standard New Order Fulfillment
Partially Completed Order Fulfillment
Amend Order
Suspend and Activate Order
Order Submission
Synchronous Order Submission
Large Plan and Order Orchestration
Execution Plan
Plan Tasks with Associated Process Components
Actions
Dependencies
Order Header
Order Line
Orchestrator Interfaces
Feasibility Providers
Feasibility Request
Feasibility Response
Process Components
Plan Item Execute Request Event
Plan Item Milestone Release Request Event
Plan Item Milestone Notify Request Event
Plan Item Execute Response Event
Plan Item Suspend Request Event
Plan Item Suspend Response Event
Plan Item Activate Request Event
Pre-qualification Failed Handlers
Pre-Qualification Failed Request Event
Pre-qualification Failed Response Event
Plan Item External Error Handlers
Plan Item Failed Request Event
Plan Item Failed Response Event
Automated Order Plan Development
Overview
Architecture
Deployment
Model Deployment
Configuration
Main Configuration
Logs
Integration with Orchestrator
Features
Autoprovision
Dynamic Bundles
Static Bundles
Time Dependency
Product Specification Field Decomposition
Custom Action Based Product Decomposition
Sequencing
Delta Provisioning
Single Use
Product Affinity (Plan Item Level)
Inlink
Crosslink
Affinity Sequencing
Conditional Affinity
Conditional Affinity Sample
Configurable Handling of CrossLink +PCO Conflicts And Single Use +PCO Conflicts
Sort Plan
Attribute Based Decomposition
ProductDependsOn and ProductRequiredFor Relationships
Dependent and Sibling Products
Shared Attributes
Shared Attributes - Sample Test Scenarios
Intermediate Milestones Dependencies
Milestone to START Dependency
END to Milestone Dependency
Milestone to Milestone Dependency
Milestone without Dependency
Conditional Milestones Dependency
Order Amendment
Amendment Workflow
Modeling of the Required Characteristics in Fulfillment Catalog
Types of Amendment
OrderLine Action Change
RequiredbyDate Change
OrderLine UDF Change
OrderPriority Change
OrderLine Addition
Execution Plan Modification Rules (EPMR)
COMPENSATE_RESTART
COMPENSATE
RESTART
IGNORE
No EPMR Characteristic in Product
Amendment Configuration Flags
Impact on Dependencies
Multiple Amendments
Order Priority
Understanding Order Priority
Order Schema Changes
Lower Priority Orders
Custom Action
Manual Order Plan Development
Searching Orders for Manual Order Plan Development
Modifying the Plan in Draft Mode through Grid View
Create a New Plan Item
Create a New Milestone
Delete Plan Item
Delete Milestone
Modify Plan Item
Modify Milestones
Creating New Dependencies
Deleting Dependencies
Validations
Modifying the Plan in Draft Mode through Gantt View
Create a New Plan Item
Create a New Milestone
Delete Plan Item
Delete Milestone
Modify Plan Item
Modify Milestones
Creating New Dependencies
Validations
Saving the Modified Plan
Saving and Executing the Modified Plan
Discarding Changes
Modifying Plan in EXECUTION State
Jeopardy Management System
Jeopardy Management System
Jeopardy Management
Understanding Plan
Understanding Critical Path
Critical Path Calculation
Understanding Dependencies
Milestone Dependencies
End Milestones
Jeopardy Management for Execution Plans
Jeopardy Management for Plan Task
Must Start On Dependencies
Consequential Actions
Jeopardy Pre-release Order Processing
Predictive Jeopardy
Jeopardy Events
Plan Item Jeopardy
Plan Jeopardy
Order Selection for Jeopardy Management
Router
Internal Error Handler
Internal Error Handler Data Flow Diagram
Understanding Data Flow in Internal Error Handler
Internal Error Handler Sequence Diagram
Searching for Plans with Plan Item in ERROR State
Modifying the Plan Item State
Choosing Error Resolution for the Plan Item in Error State
Details of Each Resolution Choice
Submit the Error Resolution
State Machine Pagination
State Machine Pagination Sequence Diagram
State Machine Pagination Flow Diagram
Order Capture System Overview
Order Capture System User Interface Overview
Searching for Subscribers
Submitting an Order in OCS
Amending an Order in OCS
Canceling an Order in OCS
Order Capture System Error Codes and Messages
Search Syntax
Offer and Price Engine
Offer and Price Engine Product Model
Decomposition
Product Integrity
Segment Eligibility
Data Validations
Get Offer Compatibilities
Validate Offer Compatibilities
Group and Record Constraints
Offer and Price Engine Price Model
Integrating TIBCO Fulfillment Catalog Price Models Offline
Get Prices Determinations and Calculations
Offer and Price Engine Discount Model
Integrating TIBCO Fulfillment Catalog Discount Model Offline
Offer and Price Engine Use Cases
Testing Product Eligibility Scenarios
Scenario 1 - Testing with the SegmentsCompatibleWith Filter
Scenario 2 - Testing with the SegmentCompatibleWith RecordType Filter
Scenario 3 - Testing with the Flag ReturnBundleOfferings Enabled
Scenario 4 - Testing with the Focus Filter with Different Product Types and autoprovision=true
Scenario 5 - Testing with Maximum Number of Products in a Group is Reached
Testing Product Validation Scenarios
Scenario 1 - Testing with Maximum Number of Products in a Group is Reached
Scenario 2 - Testing with Minimum Number of Products in a Group is Not Reached
Scenario 3 - Testing with the Compatibility Relationship
Scenario 4 - Testing with Multiple Combinations
Scenario 5 - Testing with Required UDF Input
Scenario 6 - Testing with ProductRequiredFor with a Group and One Element Passed
Scenario 7 - Testing ProductRequiredFor with No Group and One Element Not Passed
Scenario 8 - Testing LinkDefinitions with Restrictions with Maximum Number of Products
Scenario 9 - Testing LinkDefinitions with Restrictions with Maximum Number of Products in a Group
Scenario 10 - Testing with Multiple Minimum Number of Products in a Group Not Reached
Scenario 11 - Testing with Products of the Same Name but Different Parents
Fulfillment Order Management User Interface
Navigation
Changing Password
OMS User Interface Logging Notifications
Alert and Confirmation Box
Growls for Information and Error Messages
Notification Logger
Fulfillment Order Management Functionality
Dashboard
Dashboard Components
Order Summary
Auto-refreshing the Interval
Viewing Order Summary Data Based on the Definite Time Period
Backlog Orders
Amended Orders
Setting Display Preferences for Amended Orders
Orders in Execution
Inflow Orders
Jeopardy Dashboard
Orders In Jeopardy
Jeopardy Live Alerts
Jeopardy Recorded Alerts
Orders Page
Viewing Order Priority
Searching for an Order
Viewing Order Information
Suspending an Order
Resuming an Order
Canceling an Order
Amending an Order
Submit Order and Import XML
Adding an Order
Plans Page
Searching for a Plan
Grid View
GANTT Chart View
Dependency View
Jeopardy Rule Configuration
Plan Item Jeopardy
Plan Jeopardy
Adding and Configuring Rule
Adding Condition to Rule
Rule Actions
Configure Actions
Webservice Configuration
Notification Action Configuration
Hot Deployment
GANTT Chart
JEOMS
Viewing a GANTT Chart
GANTT Chart Components
Top Tool Bar
Bottom Tool Bar
Grid Header
GANTT Chart Diagram
GANTT Chart Details
Tooltips
Activity Log
About Activity Log
Viewing the Activity Log
Searching for an Order in the Activity Log
Interpreting the Log Messages
Understanding the Types of Log Messages
Fulfillment Provisioning Service Order Hierarchy
Fulfillment Provisioning Attributes and Parameters
Searching for Fulfillment Provisioning Components
Third Party Access to Fulfillment Order Management User Interface
Implementing OMSUIClient.jar
Single URI to Access OMSUI Component
Analytical Reports Dashboard Using TIBCO® Live DataMart
Installing LDM Dashboard
Configuring for the LDM Dashboard
Building a Project
LDM Dashboard Reports
Customizing Provided LDM Dashboard Reports
New LDM Reports
Deploying the LDM Dashboard
LDM Logging
Data Access Interfaces
Get Order
Get Order Request
Get Order Response
Get Order Messages and Message Codes
Get Plan
Get Plan Request
Get Plan Response
Get Plan Messages and Message Codes
Get Plan Items
Get Plan Items Request
Get Plan Items Response
Get Plan Items Messages and Message Codes
Set Plan
Set Plan Request
Set Plan Response
Set Plan Messages and Message Codes
Set Plan Item
Set Plan Item Request
Set Plan Item Response
Set Plan Item Messages and Message Codes
Get Key Mapping
Get Key Mapping Request
Get Key Mapping Response
Get Key Mapping Messages and Message Codes
Best Practices for Fulfillment Order Management
Process Component Design Guidelines
Process Component Technology Selection
BusinessWorks - Asynchronous Process Component
BusinessWorks - Synchronous Process Component
BusinessEvents - Process Component
Exception Handling Guidelines
General Approach
Example Approach
Plan Item Failed Handler
Process Component Considerations
Pre Qualification Failed Handler
Technical Exception Handling
Types of Technical Exception
TIBCO Fulfillment Order Management Components for Technical Exception Handling
Schema References
Plan Item
ResultStatus
Message
Order Request
Samples
Sample Order XML
Sample Plan Item XML
Sample XPATHs
Global Variables
AOPD Global Variables
Orchestrator Global Variables
Global Variables and Configurations
TIBCO® Fulfillment Order Management Web Services Guide
Important Information
TIBCO Documentation and Support Services
Architecture
Services and Operations
Integration Channels
SOAP Over HTTP
SOAP Over JMS
TIBCO Fulfillment Orchestration Suite Overview
TIBCO Fulfillment Orchestration Suite Components
Fulfillment Management Services
Security Header
Order Management Services
Order Service
Cancel Order
Get Order Details
Get Orders
Get Order Execution Plan
Submit Order
Synchronous Submit Order
Amend Order
Perform Bulk Order Action
Withdraw Order
Activate Order
Suspend Order
Fetch Authentication Token
Get Enriched Execution Plan
Enriched Execution Plan Request Operation
Enriched Execution Plan Response Operation
Purge Orders
AOPD Service
Generate Plan
Generate Partial Plan
Product Model Purge
Price and Discount Model Purge
Offline Catalog Loading
Offer and Price Engine Services
Get Offer Service
Validate Offer Service
Get Price Service
Get Product Information Service
Get Price Information Service
Order Capture System Interfaces
CRM Configuration
Subscriber Inventory Pagination
Subscriber Inventory Interface
Common Data Format Specifications
ResultStatus
ResultFault
Notification
Order Notification
Plan Notification
Role
Order
OrderHeader
OrderLine
Product
Characteristic
Execution Plan
PlanFragment
Pagination Type
SubscriberListType
AddressType
Response Codes and Messages
Error Codes
Orchestrator Pre-processors and Rules
TIBCO® Fulfillment Orchestration Suite Best Practices Guide
Important Information
TIBCO Documentation and Support Services
Introduction to FOS Best Practices Guide
Purpose of the Document
Scope of the Document
General Installation Guidelines
Hardware Configuration Guidelines
Hardware Selection Guidelines
Hardware Sizing Guidelines
Fault Tolerance or Load Balancing Considerations
Software Configuration Guidelines
Software Configuration Guidelines for FC
Software Configuration Guidelines for FOM
Architecture
Fulfillment Catalog Strategy
Offer and Price Engine Considerations
Order Enrichment
Other Considerations
Product Catalog Guidelines
Best Practices for Catalog Modeling
Product Modelling Patterns
Functional Product Initializer
Helper Product Layer
Functional Coordination Helper Product
Use Case Layer Pattern
Offer and Price Engine
Eligibility for Offer and Price Engine
Order Fulfillment Guidelines
Order Management System Guidelines
Orchestrator Guidelines
Automatic Order Plan Development Guidelines
Transient Data Store Guidelines
Development Guidelines
Team Organization Guidelines
Code Organization Guidelines
Environment Organization Guidelines
Performance Tuning Guidelines
Performance Tuning Guidelines for FOM
Performance Tuning Guidelines for Infrastructure
Guidelines for Operations
Guidelines for Monitoring
Guidelines for Logging
Database Purging or Clean Up Guidelines