• TIBCO® Order Management - Long Running Installation and Configuration Guide
  • About this Product
  • Installation Overview
    • Operating System and Database Requirements
    • Required Products
      • Required Third-Party Products
        • 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 Order Management
    • Installing in GUI Mode
    • Installing in Console Mode
    • Installing in Silent Mode
    • Uninstalling TIBCO Order Management
  • Post-Installation Tasks
    • Post-Installation Task 1: Copying Dependencies
    • Post-Installation Task 2: 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 a PostgreSQL Database for the Admin User and Default Tenant
      • Creating a PostgreSQL Database for the Order Capture System
    • Post-Installation Task 3: Creating the TIBCO Enterprise Message Service Channel
    • Post-Installation Task 4: Integrating with TIBCO Fulfillment Subscriber Inventory
    • Post-Installation Task 5: Starting the TIBCO Order Management - Long Running Engines
  • Configuring and Verifying Installation
    • Configuring the Libraries
    • Configuring the Database and Messaging Through Configurator
      • Configuration Properties
    • Starting or Restarting the Services
    • Verifying Installation
      • Deploying and Running the TIBCO BusinessWorks 6 and TIBCO BusinessWorks Container Edition Projects
  • Migrating TIBCO Fulfillment Order Management 4.0.2 HF3 to TIBCO Order Management - Long Running 5.0
  • Installation FAQs and Troubleshooting
• TIBCO® Order Management - Long Running Getting Started
  • About this Product
  • Use Case Submitting an Order
    • Create Products by using TIBCO Product and Service Catalog
      • Logging in to TIBCO Product and Service 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 by using SOAP UI
    • Searching for Orders by using Order Reference
    • Viewing the Execution Plan
    • Viewing the Gantt Chart to Confirm Fulfillment of Order
  • Use Case Amending an Order
    • Create Products by using TIBCO Product and Service Catalog
      • Logging in to TIBCO Product and Service 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 by using SOAP UI
    • Searching for Orders by 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 by using the Order Reference
    • Viewing the Execution Plan of Amended Order
    • Viewing the Gantt Chart to Confirm Fulfillment of Amended Order
• TIBCO® Order Management - Long Running Concepts and Architecture Guide
  • About this Product
  • Introduction
    • About TIBCO Order Management - Long Running
    • TIBCO® Fulfillment Orchestration Suite Overview
      • TIBCO Fulfillment Orchestration Suite Components
      • User Interface Integration
    • TIBCO® Order Management Long Running 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 Manual Order Plan Development Enabled
      • Amend Order Fulfillment
        • Before Plan Creation
        • Amend Order Fulfillment
        • Processing Amended Order with Manual Order Plan Development Enabled
      • Cancel Order
  • Architecture
    • Order Management Server
    • Orchestrator
    • Automated Order Plan Development
    • Manual Order Plan Development
    • Order Capture System
    • Process Components
    • Feasibility Provider
    • Jeopardy Management
    • Router
    • Key Functionality
• TIBCO® Order Management - Long Running Administration Guide
  • About this Product
  • Deployment
    • Recommended Setup for a TIBCO Order Management - Long Running Development Environment
    • Microservices
      • Node Discovery
    • Deployment Topologies
      • Single Node Single Instance Topology
      • Single Node Multi-Instance Topology
      • Multi-Node Multi-Instance Topology
    • Predeployment Configuration
    • Components Deployment
      • Configurator Deployment
      • Automated Order Plan Development Deployment
      • Order Capture System Deployment
      • Order Management Server Deployment
      • Configuring SSL for TIBCO Order Management - Long Running
      • Connecting TIBCO Order Management - Long Running to TIBCO® EMS Server with SSL Enabled
      • Jeopardy Deployment
      • Order Management Server UI 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 Enterprise Message Service topics
    • Jeopardy Management System
      • Jeopardy Management System Configuration
    • Order Management Server Components
    • Order Management Server Configuration
      • Messaging Configuration
      • User Interface Configuration
      • Plan Preview Integration with Order Management Server UI
        • Implementing OMSUIClient.jar
        • URL to Access Order Management Server UI Component
          • Target Parameters for Order Management Server UI
          • Additional Parameters for Order Management Server UI
      • 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
      • Order Management Server Web Service
        • Order Management Server Web Service Authentication
      • Collecting Order Summary Data
      • Audit Trail
        • Custom Audit Trail
      • Enabling Manual Order Plan Development Support
        • Manual Order Plan Development Orders Identification
        • Additional Manual Order Plan Development Configuration
        • Server Side Validation of Manual Order Plan Development
      • Enabling Internal Error Handler Support
      • State Machine Pagination
        • State Machine Configuration
        • State Machine Context Checkpoint
    • 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
      • ocs-util Docker Image
      • Preparing Docker Volumes
      • Setting Up the .env File
      • Configuring for Order Management Server Docker Containers
      • Running the Docker Containers
      • Enabling the RMI Port for the Order Management Server Container
      • Running the Order Management 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 Sequencing
      • Enabling or Disabling Order Sequencing
    • 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 Scenarios
      • 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
    • Multitenancy
      • Adding a New Tenant
      • Removing a Tenant
      • Manage Tenant Script Options
      • Cloning a Pluggable Database (PDB)
        • Creating a Source Pluggable Database
        • 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
    • Managing Health Check Endpoint
  • Tuning Performance
    • Order Management Server Performance Tuning
      • Status Listener Queues
    • Changing Transient Data Store Operation Messages to Non-Persistent
  • TIBCO Order Management - Long Running Disaster Recovery
    • TIBCO Order Management - Long Running 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® Order Management - Long Running User's Guide
  • About this Product
  • 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 + ProductComprisedOf Conflicts and Single Use + ProductComprisedOf 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 user-defined field Change
          • OrderPriority Change
          • OrderLine Addition
        • Execution Plan Modification Rules (EPMR)
          • COMPENSATE_RESTART
          • COMPENSATE
          • RESTART
          • IGNORE
          • No Execution Plan Modification Rules 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 Order Capture System
    • Amending an Order in Order Capture System
    • Canceling an Order in Order Capture System
    • Order Capture System Error Codes and Messages
    • Search Syntax
  • Order Management Long Running User Interface
    • Navigation
    • Changing Password
    • Order Management Server User Interface Logging Notifications
      • Alert and Confirmation Box
      • Growls for Information and Error Messages
      • Notification Logger
    • Order Management - Long Running 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
        • Performing Bulk Action on Orders
        • Submit Order and Import XML
          • Adding an Order
      • Plans Page
        • Searching for a Plan
        • Grid View
        • GANTT Chart View
        • Accessing Dependency View of Plan Items and their Status
      • 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
        • Jeopardy Management System
        • 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 Order Management - Long Running Functionality User Interface
      • Implementing OMSUIClient.jar
      • Single URI to Access Order Management Server User Interface Component
  • 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 TIBCO Order Management - Long Running
    • 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 Order Management - Long Running 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
    • Automated Order Plan Development Global Variables
    • Orchestrator Global Variables
    • Global Variables and Configurations
• TIBCO® Order Management - Long Running Web Services Guide
  • About this Product
  • 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
        • Handle Plan Item In Error
        • Activate Order
        • Suspend Order
        • Fetch Authentication Token
        • Get Enriched Execution Plan
          • Enriched Execution Plan Request Operation
          • Enriched Execution Plan Response Operation
      • Purge Orders
      • Automated Order Plan Development Service
        • Generate Plan
        • Generate Partial Plan
      • Product Model Purge
      • Offline Catalog Loading
  • 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® Order Management - Long Running Best Practices Guide
  • About this Product
  • Introduction to TIBCO Order Management - Long Running 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 TIBCO Product and Service Catalog
    • Software Configuration Guidelines for TIBCO Order Management - Long Running
  • Architecture
    • TIBCO Product and Service Catalog Strategy
    • Other Considerations
    • Order Enrichment
  • 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
  • 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 TIBCO Order Management - Long Running
    • Performance Tuning Guidelines for Infrastructure
  • Guidelines for Operations
    • Guidelines for Monitoring
    • Guidelines for Logging
    • Database Purging or Cleanup Guidelines
• TIBCO Documentation and Support Services
• Legal and Third-Party Notices