Contents

What's New
About this Product
Installation Overview
Operating System and Database Requirements
Required Products
Required Third-Party Jars
Required TIBCO Products
TIBCO Environment
Installation Scenario
Installation Environment Variables
Deployment Guidelines for Optimal CPU Usage
Installation and Deployment
Post-Installation Tasks
Task 1: Copying Dependencies
Task 2: Creating the Database
Creating a PostgreSQL Database for the Admin User
Creating a PostgreSQL Database for Catalog User
Creating a PostgreSQL Database for the Order User
Creating a PostgreSQL Database for the Archival Service
Creating a PostgreSQL Database for Jeopardy Service User
Creating a PostgreSQL User Database
Creating a PostgreSQL Database for the Broker Service User
Creating an Oracle Database for the Admin User
Creating an Oracle Database for Catalog User
Creating an Oracle Database for the Order User
Creating an Oracle Database for the Archival Service User
Creating an Oracle Database for Jeopardy Service User
Creating an Oracle User Database
Creating an Oracle Database for the Broker Service User
Task 3: Creating or Upgrading the TIBCO Enterprise Message Service Channel
Task 4: Configuring and Starting the Authorization Service
Task 5: Registering Tenant
Task 6: Creating Mandatory Users
Task 7: Configuring and Starting the Configurator Service
Task 8: Configuring and Starting Configurator UI
Task 9: Uploading Metadata file, App Properties, Config Files through Configurator UI
Task 10: Configuring minimum requirements through Configurator UI
Task 11: Starting or Restarting the Services
Deployment of TIBCO® Order Management On Kubernetes
Order Management Resource Allocation
Installing Helm Chart
Migration
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
Submitting Order and Retrieving Order Reference by using the REST service
Searching for Orders
Viewing the Execution Plan
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
Submitting Order and Retrieving Order Reference by using the REST service
Searching for Orders
Viewing the Execution Plan
Submitting Order Amendments by Changing the Original Order
Searching the Amended Order
Viewing the Execution Plan of the Amended Order
Introduction
About TIBCO Order Management
TIBCO Fulfillment Orchestration Suite Overview
TIBCO Fulfillment Orchestration Suite Components
User Interface Integration
TIBCO® Order Management Overview
Required Products
TIBCO Enterprise Message Service™ (EMS)
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
Architecture
Orchestrator
Automated Order Plan Development
Process Components
Feasibility Provider
Key Functionality
Deployment
Recommended Setup for a TIBCO Order Management Development Environment
Microservices
Connecting TIBCO Order Management to TIBCO® EMS Server with SSL Enabled
Configuring SSL for TIBCO® Order Management
HTTP Connection Pool Configuration
Configuring Authorization Server
Inter-service Communication
Configuration
Queue Management
Data Models
Model Loading Process
Online Model Loading
Catalog Web Service Model Loading
Offline Model Loading
WebClient Configuration
Order Management System Configuration
User Interface Configuration
URL to Access Order Management System UI Component
Side Navigation for Order Management System UI
Filtration of orders in Order Management System UI
Override Planfragment Destination
Managing Application Security
Managing Users and Roles
Authorization Service
Registering a Tenant
Update tenant information
Get tenant information
Delete tenant
Create User
Update User
Get User
Delete User
Generating an authorization token
Audit Trail
Enabling Internal Error Handler Support
Logging
How Logging Works
Contents of the Log Message
APIs for Changing log-level
Configuring Logging for Java Components
Configuring Redis
Configuring Microsoft SQL Server
Configuring an External Identity Provider
Administration Tasks
Swagger API Reference
Docker
Building a Docker Image Without an Internet Connection
Copying Files to Docker Context
Building Docker Images
Setting Up the .env File
Configuring for Order Management Server Docker Containers
Running the Docker Containers
Extend Docker-Compose Files
Modifying a Container Time-Zone
Reading Container Logs
Troubleshooting Error from Building Docker Images
Order Sequencing
Enabling or Disabling Order Sequencing
Bulk Order Actions
Bulk 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
Performing Bulk Actions On error Plans Items
Multitenancy
Creating and Configuring a Tenant
Authorizing a Tenant
Managing Health Check Endpoint
Implementation of LDAP
User Mapping from Directory Service to Order Management service
Types of retries
API Monitoring
Debugging tools for production
Scaling of Order Management microservices
orderPriority
Tuning Data Source
Catalog Caching
Integrate Inventory Information in AOPD Plan Generation
Integrate TIBCO OPE with Order Submission Process
Schema References
Plan Item
Product Model
Result Status
Message
Order Request
Order Request Header
Order Request Line
Process Component Model
Orchestrator
Architecture
Instance Registration
Process for Running Order-related Requests Using EMS
Submission of Order Assignment to Instance
Orchestrator Gateway Behavior
Message Routing On EMS
Instance Specific EMS Listeners
Internal Order Processor
Snapshot Saving Enhancement
Orchestrator and AOPD Communication
Database Updates
Division of State Machine
Order Content Caching
Cache Management via EMS
Southbound Replies On REST
XPath Evaluation Caching in AOPD
Processing Future-Dated Orders in the Orchestrator
Audit Trail and Recovery Notification Handling
Namespace Handling for Southbound Replies
Routing of REST Requests to EMS
Batch Notification
Synchronous Event Processing
Notification
Time Dependency
Non-Executing Plan Item
Process Component Destination
Order Types
Amend Order
Suspend and Activate Order
Order Submission
Execution Plan
Plan Tasks with Associated Process Components
Actions
Dependencies
Order Header
Order Line
Global Variables
Feasibility Providers
Feasibility Request
Feasibility Response
Feasibility Retry
OPD Error Handler
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
Broker Service
Feature Descriptions
Design and Implementation
Automated Order Plan Development
Overview
Model Deployment
Product Models Purging
Configuration
Main Configuration
Logs
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 the Fulfillment Catalog
Types of Amendment
OrderLine Action Change
RequiredbyDate Change
OrderLine user-defined field 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
Custom Action
Product Id and Product Id Ext.
Jeopardy Management System
Jeopardy Management
Jeopardy Events
Plan Item Jeopardy
Plan Jeopardy
Order Selection for 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
Predictive Jeopardy
Jeopardy Services
Design and Implementation
Jeopardy Detection Cycle
Adding Jeopardy Rules On OMS UI
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 planItem in ERROR State
Modifying the Plan Item State
Choosing the Error Resolution for the Plan Item in Error State
Details of Each Resolution Choice
Submit the Error Resolution
Order Management System User Interface
Navigation
Dashboard
Data Access Interfaces
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
Best Practices for TIBCO Order Management
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 Components for Technical Exception Handling
Schema References
Plan Item
ResultStatus
Message
Order Request
Samples
Sample Order XML
Sample Plan Item XML
Sample XPATHs
Architecture
Services and Operations
Integration Channels
SOAP Over HTTP
SOAP Over JMS
REST over HTTP/HTTPS
TIBCO Fulfillment Orchestration Suite Overview
TIBCO Fulfillment Orchestration Suite Components
Fulfillment Management Services
Security Header
Order Service
Activate Order
Amend Order
Cancel Order
Get Order Details
Get Order Execution Plan
Handle Plan Item In Error
Perform Bulk Order Action
Submit Order
Suspend Order
Synchronous Submit Order
Withdraw Order
Purge Order
Automated Order Plan Development Service
Generate Plan
Generate Partial Plan
Order Management Services
Data Service
Catalog Service
TM Forum Adapter Service
Common Data Format Specifications
ResultStatus
ResultFault
Notification
Order
OrderHeader
OrderLine
ProductModel
Execution Plan
PlanFragment models
Authorization Service API Samples
Register tenant
Update tenant information
Get tenant information
Delete tenant
Create User
Update User
Get User
Delete User
Configuration Service API Samples
Actuator APIs
Actuator web endpoint 'refresh'
Get loggers name
Post loggers name
Actuator root web endpoint
Actuator web endpoint 'loggers'
Actuator web endpoint 'health'
Actuator web endpoint 'health-path'
Application Metadata APIs
Application Properties APIs
Configuration File APIs
Configuration Notification APIs
Archival Services API samples
Operation Get Order Summary
Operation Get Plans By Criteria
Operation Get Orders By Criteria
Operation Get Plan Item By Criteria
Operation Get Pie Chart Details By Criteria
Operation Get Order Details
Operation Get Plan Details
Operation Get Bulk Action
Operation Get All Bulk Action
Operation Get Audit Trail
Operation Submit Audit Trail
Operation Purge Order
Operation Get Saved Searches
Operation Update Saved Searches
Operation Saved Searches
Operation Delete Saved Searches
Orchestrator API samples
Feasibility Reply
Get Order Details
Get Order Status
Submit Order
Withdraw Order Request
Activate Order
Cancel Order
Suspend Order
Bulk Action
Plan Item Bulk Error Handler
Plan Item Error Handler
PlanItem Execute Response
Plan Item Suspend Response
Milestone Notify Request
PreQualification Failed Reply
Get Order Messages
Operation Get Order State Machine XML
Operation Purge Order
Operation GetOrderExecutionPlan
Operation SubmitOrderExecutionPlan
Operation submitPlanErrorNotification
Data Services API samples
Set PlanItem Request
Get PlanItems Details
Set Plan Request
Get Plan Details
Catalog Services API samples
Submit Single Action Model
Get Bulk Action Model
Submit Bulk Action Model
Delete Bulk Action Model
Get All Action Model
Submit Single Product Model
Submit Bulk Product Models
Get Bulk Product Model
Delete Bulk Product Model
Get All Product Model
Submit Single PlanFragment Model
Get Bulk PlanFragment Model
Submit Bulk PlanFragment Models
Delete Bulk PlanFragment Model
Get All PlanFragment Model
Process Component API sample
Operation Feasibility
Operation Plan Item Activate Request
Operation Plan Item Error Handler
PlanItem Execute Request
Operation Milestone Release Request
Operation Plan Item Suspend Request
Operation PreQualification Failed
Operation OpdErrorHandler
Jeopardy Services API samples
Purge Plans
Get Plan in Jeopardy
Suspend Rule
Resume Rule
Update Rule
Rule Criteria
Add Rule
Get Jeopardy Alert Message
Get All Rules
Delete Rules
Migrate Plan Fragments
Plan Time Line
AOPD API Samples
Global Cache Interface
Product Hierarchy Interface
Configuration Service API Samples
Broker Service API Samples
Actuator APIs
Post loggers name
Actuator root web endpoint
Actuator web endpoint 'loggers'
Actuator web endpoint 'health'
Actuator web endpoint 'health-path'
Instance Management APIs
Recovery APIs
Response Codes and Messages
Error Codes
Introduction
Security Features
Security Vulnerabilities
Ensuring TIBCO Order Management Security
Authorization Service
Registering a Tenant
Update tenant information
Get tenant information
Delete tenant
Create User
Update User
Get User
Delete User
Generating an authorization token
Configuring SSL for TIBCO Order Management
Encrypt Password Utility
TIBCO Documentation and Support Services
Legal and Third-Party Notices