TIBCO® Fulfillment Provisioning Installation and Configuration Guide
Important Information
TIBCO Documentation and Support Services
Installation Overview
Operating System Requirements
Required Products
Required Software
Optional TIBCO Products
Third Party Products
Recommended Setup
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 Provisioning
Installing in GUI Mode
Installing in Console Mode
Installing in Silent Mode
Post Installation Task
Uninstalling TIBCO Fulfillment Provisioning
Fulfillment Provisioning OMS Installation and Setup
Installing Fulfillment Provisioning OMS
Starting and Stopping Fulfillment Provisioning
provadmin Overview
provadmin Commands
install fp
getallports fp
getadminport fp
display fp
stop fp
start fp
remove fp
Displaying provadmin help fp
Displaying a Sample Script for provadmin
Configuration Directory
Fulfillment Provisioning Deployment Specification
Log Files
trace.ini
config.ini
fwriter.ini
cfg_fileCount
cfg_flushFrequency
cfg_maxFileCount
cfg_maxFileSize
cfg_maxFileTime
cfg_outputDir
cartAdmin.xxxxxx.log
cartOrderTracing.xxxxx.log
journal.x.log
kpsaOrderTracing.xxxxx.log
kpsa.xxxxx.log
TIBCO® Fulfillment Provisioning User's Guide
Important Information
TIBCO Documentation and Support Services
Overview
General Description
Service Management Applications
Service Elements
Fulfillment Provisioning
Design Characteristics
Architectural Components
Provisioning Flow
Fulfillment Provisioning Catalog
Administrator
Cartridges
States of a Cartridge
Processing Asynchronous Orders
Service Order Handling
Creating Fulfillment Provisioning Application
Fulfillment Provisioning Flow Overview
Introduction
Provisioning Flow
Service Order Flow
Product Order Flow
Work Order Flow
Fulfillment Orchestration Overview
Fulfillment Orchestration Components
User Interface Integration
Environment Settings in Fulfillment Provisioning
User Environment Settings
Configuring and Managing Fulfillment Provisioning Nodes
Fulfillment Provisioning Commands
install fp
remove fp
start fp
stop fp
display fp
getadminport fp
getallports fp
Statistical Configuration Commands
load fpstats
unload fpstats
start fpstats
stop fpstats
display fpstats
Catalog Configuration Commands
install catalog
start catalog
stop catalog
remove catalog
save catalog
update catalog
Managing Catalog Versions
Stream Gate Commands
display gate
open gate
close gate
Checkpoint Commands
load checkpoints
migrate checkpoints
snapshot checkpoints
rollback checkpoints
listsnapshots checkpoints
Client Adapter Commands
enableall ca
disableall ca
enable ca
disable ca
lockall ca
unlockall ca
lock ca
unlock ca
display ca
displayall ca
configure ca
Flow Controller Commands
start fc
stop fc
getstatus fc
configure fc
Queue Commands
display queue
displaySuspendedCount queue
displaySuspended queue
flush queue
Order Processing Commands
cancel order
abort order
suspend order
resume order
Mapping Commands
load mapping
reset mapping
Dictionary Configuration Commands
load eventdictionary
setfilter eventdictionary
getfilter eventdictionary
Cartridge Maintenance Commands
configure cart
install cart
remove cart
start cart
stop cart
enable cart
disable cart
lock cart
unlock cart
display cart
loadNEConfig cart
displayNEConfig cart
startMaintenance cart
stopMaintenance cart
Password Commands
Important Files and Locations
Log Files Summary
trace.ini
config.ini
fwriter.ini
cartAdmin.xxxxxx.log
cartOrderTracing.xxxxx.log
journal.x.log
kpsaOrderTracing.xxxxx.log
kpsa.xxxxx.log
Fulfillment Provisioning Interfaces
The Fulfillment Provisioning Order Management System Web Interface
Logging into the Fulfillment Provisioning Order Management System
Adding a New Node
Connecting a Node
Disconnecting from a Node
Persisting the Parameters of a Service Order
Deleting a Node
Maintaining Cartridges
Tracking Orders
Starting and Stopping Fulfillment Provisioning
Running The Startup Script
Specifying A Configuration Directory
Deploying The Fulfillment Provisioning Application
Updating Catalog
Displaying provadmin Help
Recovering Provisioning Flow
Reloading Provisioning Flow
Displaying Sample Script for provadmin
Service Orders
Overview
Base Types
Activation Flows
Service Order Flows
Parallel Processing of Technical Product Orders
Order Parenting
Understanding Order Parenting
Viewing Affiliated Orders
Parent and Child Service Order Information
API Impact
Iterative Fulfillment
Creating Iterative Technical Product Order Instances
Multiple Iterative Orders
Iterative Technical Product Order Instances Sequencing
Fulfillment Provisioning Modules
Injecting Manual Service Orders
DirectoryScanner Streams Driver
Data Enrichment Through Fulfillment Provisioning Catalog
SOP
Service-order Level Rollback
Product Order Processing
POP Execution
Processing With onPOPError Set to stopAll
Processing With onPOPError Set to stopDependent
Disabling Parallel Processing
Re-submission of Service Orders
Processing With Asynchronous Cartridges
Holding Service Orders in Order Queues
Using Gates to Control the Flow
Sorting Service Orders
Sorter
Removing Service Orders
Terminator
Checkpointing Service Orders
Checkpoint
Commitpoint
Reinjecting Service Orders
Data Storage Back Ends
Using Checkpoints
Scheduling Service Orders
Controlling Request Flow
Reservoir and Queue Behavior
Sequencing Customers Service Orders
Sequencer
TokenRemover
Re-submitting Service Orders in Network Error
MessageStoreAndForward
Monitor
Usage of the Message Store and Forward
Controlling Administrative States of Orders
Cancel
Abort
Suspend
Resume
Flow Controller
Basic Principles
Flow Controller Setup
Flow Controllers and Order Queues
Controlling order queue or a reservoir
Making a POP Module Controlled
Flow Controllers and Memory Management
Flow Controllers and Priority on Order Queues
Flow Controller Configuration File
Priority and Driver
Applying a Flow Controller Configuration File
Impact of Setting Priority on Queue and Driver
Overview of The Fulfillment Provisioning Catalog
Functions of the Fulfillment Provisioning Catalog
Fulfillment Provisioning Catalog Components
Technical Product Configuration
Product catalog configuration
User Administration
Tools
Configuration
Example: Product Order Flows
Parameter Setting
Parameters
OSS/J Order Management Client Adapters
Componentization
Standard
OSS/J Model Data Mapping Concepts
User Interface Settings
Deploying Client Adapter
WS Profile through WS Routing
eTOM and SID
TIBCO® Fulfillment Provisioning Developer's Guide
Important Information
TIBCO Documentation and Support Services
Streams and Provisioning Flows
Streams and Streams Modules
Provisioning Flow Elements
Installing Provisioning Flow
Samples
Product Order Flows
Overview
Product Order Flows
Plugins and Nested Flows
Work Order Flows
Client Adapters
Framework Overview
Session Layer
Protocol Message Flows
Protocol Messages
Protocol Message Flows
Retrieving Protocol Message Flows
Marking Protocol Message Processing End
The NoOp Trick
Order Queues
Client Adapter
The ClientAdapter Module
The Client Adapter Interface
The Client Adapter Configuration
Use Case Client Adapter As Driver
Receiving Messages
Validating Incoming Messages
Acknowledging Reception
Creating Service Orders
Creating Service Order Message
Attaching Raw Order
Attaching Originator Data
Changing Failed Order Handling Mode
Binding Service Orders to the Session
Service Orders Flushing Policy
Dividing Transactions
Use Case Client Adapter As Responder
Client Adapter Lifecycle
Data Processing
Data Processing Framers
Data Processing Parsers
Populating the Service Order Data
Attaching and Populating Product Orders
Data Processing Composers, Formatters
Configuration
Developing New Modules
Developing New Queue Types
Developing Custom Pre-enrichment Modules
Creating Subscriber Context
Using a Service Module for Enrichment
Utility Packages
Frameworks Services
Executing Scripts
Script Evaluation Interface
Script Evaluation Module
Script Syntax
Aggregating Service Orders
Local Variable Support
Local Variable Enhancement
Samples
TIBCO Fulfillment Provisioning Catalog Details
TIBCO Fulfillment Provisioning Catalog Review
Object Model and Processing
Relationship Between Configuration Objects
Technical User
Catalog-level User
How TIBCO Fulfillment Provisioning Catalog Uses the Configuration Objects
Parameters and Patterns
Parameters
Patterns
Domains and Product Orders
Service Access Control
Authentication
Authorization
Rules
Example
Product Order Flows
Configuring TIBCO Fulfillment Provisioning
Functions of Configuration Data
Web or File-based Configuration
Object Names
Technical Configuration
Creating Parameters
Adding a New Parameter
Editing an Existing Parameter
Removing a Parameter
Adding a Capability to a Parameter Tree
Defining a Property
Adding a list of Valid Values
Defining Patterns
Creating a New Pattern
Editing an Existing Pattern
Removing a Pattern
Adding a Parameter to a Pattern
Removing a Parameter from a Pattern
Inheriting Parameters from Another Pattern
Removing an Inheritance Link
Defining Technical Products
Adding a New Technical Product
Exposing a Technical Product
Technical Product Order Mapping
Examples with Merging Datasets
Selecting a Fulfillment Provisioning Catalog for Editing
Removing a Technical Product
Associating a Pattern With a Product
Associating a Technical Product Rule With a Product
Flagging no matched condition As an Error
Defining Product Order Flows
Adding a New Product Order Flow
Viewing Product Order Usage
Removing a Product Order Flow
Defining Rules
Creating a New Technical Product Order Rule
Editing a Technical Product Order Rule
Removing a Technical Product Order Rule
Defining Verbs
Adding a New Verb
Removing a Verb
Defining Technical Product Orders
Creating a New Technical Product Order
Editing a Technical Product Order
Removing a Technical Product Order
Associating Rules With a Technical Product Order
Associating a Product Order Flow With a Product Order
Associating a Rollback Technical Product Order With a Product
Uploading Product Order Flows
Defining Associations
Conditional Associations
Specifying a Conditional Association
Order of Condition Evaluation for Rules
Order of Condition Evaluation for Product Order Flows
Order of Condition Evaluation for Product
Enriched Data Is Not Evaluated
Cascading Evaluation
Generic Product Orders
Complex Conditions
Operator Mapping for Configuration File
Dynamic Associations
Associations and Data Enrichment
Catalog Configuration
Creating Products
Adding a New Product
Editing an Existing Product
Removing a Product
Associating Technical Products With a Product
Defining Product Orders
Creating a New Product Order
Editing a Product Order
Removing a Product Order
Associating Technical Product Orders With a Product Order
Defining Verbs
Defining Domains
Editing a Domain
Enabling Generic Product Orders
Customizing Rule Order
Domain Configuration
Defining Versions
Editing a version
Editing Version Objects
Administration Features
Journal
Testing Service Orders
Testing Fulfillment Provisioning Catalog Configuration
Fulfillment Provisioning Catalog Test Flow
The Fulfillment Provisioning Catalog Test GUI
Creating a New Test File
Adding a New Test to a Test File
Configuring Tests
Running Tests
Removing Tests
User Administration
Groups
Defining a User
Defining Groups
Accessing Catalog from Models
Accessing Catalog Using Fulfillment Provisioning Catalog API
getProductOrders()
Web Pages
Subscriber Context Analysis
Subscriber Context Provided
Subscriber Context Retrieval
Implementing Subscriber Context Modules
Subscriber Context Requirements
Subscriber Context ID (scId)
Subscriber Context
Origin and Target Context
Subscriber Context Dataset
Delta Analyzing
Verb Classification
Delta Analyzing Rules
Hard Coded Rules
Disabling Delta Analyzing Process
Alternate Dataset Evaluation
Specifying a Dataset
Current Order Dataset
Foreign Datasets
Accessing Specific Datasets
Using extra dataset
The extra dataset
Enabling extra datasets
Accessing extra datasets
Multiple Service Order Iteration
Overview
Definition
Requirement
Samples
Ex02 - Subscriber Context
Ex03 - Delta Analyzing
Ex04 - Multiple Iteration
Ex15 - addPrefix
Ex16 - isMultiple TP
TIBCO Fulfillment Provisioning Order Management System
Fulfillment Provisioning Order Management System Review
Node Management
Dataload Parallelization for Performance
Order Tracking
List of Orders
Select Displayed Columns
Order Details
Configure Displayed Attributes
OrderLine Details
Technical Order Details
Resource Order Details
Interface List
Administrative Commands
Data Mapping
WorkOrder Data Mapping
WorkOrder translation
DataMapping
Packages
backcompdm Package
confdm Package
provdm Package
Samples
Product Order Data Mapping
Mapping configuration
PO Forward Mapping
PO Backward Mapping
Mapping Initiation
Extensibility
Configuration
Injecting ServiceOrders
Samples
Cartridge Network Element Configuration
Overview
Network Element Configuration File
Samples
Fulfillment Provisioning Utilities
Event Dictionary
Event Dictionary Files
Event Dictionary Loading
Event Dictionary Publishing
Event Dictionary Filtering
Static Filtering
Dynamic Filtering
Event Dictionary Subscribing
Sample ex10 - eventdictionary
Filewriter
Statistics
Definitions
Statistic Configuration Files Format
Using a Counter
Period Manager and Data Saver
Simple Counter With Threshold
Dynamic Counter
Provadmin Commands
Sample ex17 - Statistic Counters
Unique ID Generation
Component Documentation
Installation
Starting the Design Center
Accessing Component Documentation
Data Checkpointing Support
Checkpoints
Checkpoints Corruption Detection
File backend
Kinds of Fulfillment Provisioning Checkpoint
Adding New Checkpoint Kinds
Specializing a Checkpoint Kind
Instantiating the Specialized Checkpoint Kind
Setting Up the Application Version
Testing a New Checkpoint Kind
Configuring Checkpoints
Administrating Checkpoints
Recovering from Checkpoints
Migrating Checkpoints
Checkpoints Snapshots
Provtest
Configuration
Format
Validation
Defining Flows
Defining Tests
Automatic Computation of Some Attributes
Regular Expressions
Implicit and Explicit Scoping for Object References
Type Mapping
Special Characters
Provtest Scope
Testing Process
Provtest File Processing
Unit Test Processing
Completion Criteria
Transaction Management
Test Cases
Injecting a Service Order
Injecting a FileHandle
Validating a Service Order
Validating orderId
Validating Attributes
Validating the ServiceOrderData
Validating orderId
Validating Attributes
Validating the Dataset
Validating Error Messages
Validating ProductOrderData
Validating orderId, podId
Validating the Dataset
Validating Attributes
Validating Error Messages
Validating WorkOrderData
Validating orderId
Validating the Dataset
Validating Attributes
Validating Error Messages
Validating a FileHandle
Validating Filename
Validating the File Content
Validating Multiple Expects
Running Actions
Waiting for the Expected Result
Asynchronous Actions
Running Post-actions
Sleeping During a Test
Creating a ServiceOrder
Creating an Object
Selecting an Object
Setting Attributes
Invoking an Operation
Setting in Parameters
Checking Out Parameters
Checking Return Value
Checking for an Exception
Validating Object Attributes
Checking the Cardinality of an IDLOS Type
Checking Attributes
Referencing an Object's Attribute
Deleting a Referenced Object
Cleaning Objects
Loading a Flow
Executing a System Call
Deploying
Running the Tests
Good Practices
Provtest XML Schema
Fulfillment Provisioning Samples
Sample ex05 - Service Order Optimization (SOO) with Merger Instructions in the Config File
Sample ex05 - Service Order Optimization (SOO) with Merger Instructions in the soc/act File
Sample ex06 - Queue Priority
Sample ex08 - Context Routing
Sample ex08 - Basic Routing
Sample ex08 - Late Routing
Sample ex09 - Rollback Decision With Context
Sample ex09 - Rollback Decision Successful
Sample ex09 - Rollback Decision Fails
Sample ex14 - TimeoutSorter Module
Sample ex19 - Default POP behavior
Sample ex19 - POP replayableSOToRetryPort to false
Sample ex19 - POP skipFailedWO to false
Sample ex30 - Integration of FOS Products