tibco fulfillment order management web services …...tibco® fulfillment order management web...

TIBCO® Fulfillment Order Management WebServices Guide Software Release 4.0.2 August 2018Document Updated: March 2019

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Runtime Agent, TIBCOAdministrator, and TIBCO Enterprise Message Service are either registered trademarks or trademarksof TIBCO Software Inc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

2

TIBCO® Fulfillment Order Management Web Services Guide

Copyright © 2010-2018 TIBCO Software Inc. All rights reserved.

3


Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Services and Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Integration Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

SOAP Over HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

SOAP Over JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

TIBCO Fulfillment Orchestration Suite Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

TIBCO Fulfillment Orchestration Suite Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Fulfillment Management Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Security Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Order Management Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Order Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Cancel Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Get Order Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Get Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Get Order Execution Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

Submit Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Synchronous Submit Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Amend Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

Perform Bulk Order Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Withdraw Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Handle Plan Item In Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Activate Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

Suspend Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Fetch Authentication Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Get Enriched Execution Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Enriched Execution Plan Request Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Enriched Execution Plan Response Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

AOPD Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Generate Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

Generate Partial Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Product Model Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Price and Discount Model Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Offline Catalog Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Rule Model Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4


Offer and Price Engine Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Get Offer Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Validate Offer Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Get Price Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Get Product Information Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

Get Price Information Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Order Capture System Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

CRM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Subscriber Inventory Pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Subscriber Inventory Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Common Data Format Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

ResultStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

ResultFault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Order Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

Plan Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

OrderHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

OrderLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Characteristic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Execution Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

PlanFragment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Pagination Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

SubscriberListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

AddressType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Response Codes and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Orchestrator Pre-processors and Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102

5


Figures

SOAP over HTTP Integration Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

SOAP over JMS Synchronous Integration Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

SOAP over JMS Asynchronous Integration Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Provisioning in the Orchestration Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Synchronous Submit Order Request Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Synchronous Submit Order Response Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

PaginationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

SubscriberListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94

AddressType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

6


TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Product-Specific Documentation

Documentation for Fulfillment Order Management is available on the Fulfillment Order ManagementDocumentation page.

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO Fulfillment Order Management Installation and Configuration Guide

● TIBCO Fulfillment Order Management User's Guide

● TIBCO Fulfillment Order Management Administration Guide

● TIBCO Fulfillment Orchestration Suite Getting Started Guide

● TIBCO Fulfillment Orchestration Suite Best Practices Guide

● TIBCO Fulfillment Order Management Concepts and Architecture Guide

● TIBCO Fulfillment Order Management Web Services Guide

● TIBCO Fulfillment Order Management Release Notes

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

7


https://docs.tibco.comhttps://docs.tibco.comhttps://docs.tibco.com/products/tibco-fulfillment-order-managementhttp://www.tibco.com/services/supporthttps://support.tibco.comhttps://support.tibco.comhttps://ideas.tibco.com/https://community.tibco.com

Architecture

TIBCO® Fulfillment Order Management is a meta data driven order management and fulfillmentsystem which allows development of fulfillment plans based on meta-data specified in productcatalogs. Order fulfillment and service provisioning is no longer a simple single-service or productworkflow. The dynamic bundled offerings along with the explosion of devices, applications, real timeinventory management, and third-party content providers require a complex order fulfillment systemwhich can adapt to the changes in processes, meta data, and inventory. Traditional OSS/BSS 1 approachwith the data silos fail to provide a dynamic and agile solution. An end-to-end order managementsystem based on product and service catalogs is a key differentiator of TIBCO® Fulfillment OrderManagement.

TIBCO Fulfillment Order Management is a comprehensive software solution which designs, deploys,and maintains high-performance scalable enterprise-level business processes for advanced anddynamic order fulfillment. TIBCO Fulfillment Order Management enables companies to quicklyintroduce new product offerings and in most cases requires little or no change to fulfillment processes.The product bundles are decomposed into existing products to automatically generate a plan specific tothe order.

TIBCO Fulfillment Order Management also enables companies to efficiently manage changes to theexisting business process to meet a rapidly changing business environment.

The product model can be defined following SID 9 guidelines using TIBCO® Fulfillment Catalog or anyother catalog management system and imported into TIBCO Fulfillment Order Management.

Services and OperationsThe interfaces are organized into services that include related operations. The following interfaces areexposed for any client to invoke the services related to the framework. These services can be invokedover two different channels: SOAP over HTTP and SOAP over JMS.

Supported encoding style in the web service request is UTF-8.

All Web Services support HTTP and JMS. Web Services endpoint URL has the following format:

http://:/api/ServiceHTTP.

For example, http://localhost:9091/api/aopdService.

The naming convention for SOAP action is /api/.

The naming convention for JMS destination istibco.aff..services..

For example, tibco.aff.oms.ordersService.

If AOPD is running in colocated mode, the host name is omsServer. If AOPD is running in standalonemode, the host name is aopd.

The operations specified in the table follow the naming conventions.

Services and Operations Summary

Module Service JMS Destination Operation

Order Management(OM)

Order tibco.aff.oms.ordersService

CancelOrder

1 Operational/Operations Support System (OSS) Software applications support back-office activities operating a company network,provision and maintain customer services. OSS is traditionally used by network planners, service designers, operations, architects,support, and engineering teams in the service provider.

8


Module Service JMS Destination Operation

GetOrderDetails

GetOrders

GetOrderExecutionPlan

GetEnrichedExecutionPlan

SubmitOrder

AmendOrder

SyncSubmitOrder

WithdrawOrder

FetchAuthenticationToken

PerformBulkOrderAction

ActivateOrder

SuspendOrder

HandlePlanItemInError

Purge N/A purgeOrders

getPurgeStatus

getPurgeEstimate

Offline Catalog N/A RequestOfflineCatalog

Purge

Automatic Order PlanDevelopment (AOPD)

AOPD tibco.aff.aopd.aopdService

generatePartialPlan

generatePlan

For all the web services to work correctly, the data models should be available to Orchestrator andAutomatic Order Plan Development (AOPD) components.

Integration ChannelsTo provide maximum flexibility for exposing services to the enterprise, service implementation isseparated from the interface. This allows services to be invoked from different transport mechanisms.The following transports are supported:

9


● SOAP over HTTP● SOAP over JMS

SOAP Over HTTPSOAP over HTTP service calls use the standard synchronous web services message format. Theintegration pattern is as follows:

SOAP over HTTP Integration Pattern

In the SOAP over HTTP pattern, a service client makes a synchronous service call to the OrderManagement Services component. The service calls the appropriate operation and performs therequired operation before sending a reply back to the calling application.

Since TIBCO Fulfillment Order Management is deployed as part of the OMS Server, the endpoint URLsfor SOAP over HTTP have changed. The new endpoint URLs for respective components are as follows:

● AOPDService in standalone and collocated mode http://:/api/aopdService● Offer and Price Engine in standalone and collocated mode: http://:/api/

opeService

● Offline Catalog Request: http://:/api/offlineCatalogueWS● Order Capture System: http://:/ocs-appThe Offline Catalog request service can be used to send the request to the TIBCO Fulfillment OrderMangement interface to load the offline models.

SOAP Over JMSSOAP works over a variety of transports and is not restricted to HTTP web services. JMS provides ahighly available transport mechanism that delivers messages over and above what HTTP provides.SOAP over JMS service calls use the TIBCO proposed specification extension for sending SOAPmessages over JMS. TIBCO ActiveMatrix BusinessWorks supports calling SOAP over JMSsynchronously using the standard SOAP Request/Reply activity. The non-TIBCO ActiveMatrixBusinessWorks application should be able to call SOAP over JMS services both synchronously andasynchronously using standard JMS messaging techniques that implement the required elements of thespecification extension.

The synchronous integration pattern is as follows:

10


SOAP over JMS Synchronous Integration Pattern

The asynchronous integration pattern is as follows:

SOAP over JMS Asynchronous Integration Pattern

In the SOAP over JMS pattern, a service client makes a synchronous or asynchronous service call to theOrder Management Services component. The service calls the appropriate operation and performs therequired operation before sending a reply back to the calling application.

The JMS destinations where the SOAP message should be sent is specified in the respective webservices WSDL document.

11


TIBCO Fulfillment Orchestration Suite Overview

New technologies and network architectures enable communications service providers (CSP) to createinnovative converged products and services offerings which are introduced faster and have shorter lifecycles than previous service offerings to address a very changing and competitive market.

In view of the rapid pace of change in the technology, the industry is evolving to become a contributorand not remain a mere consumer of technology. In this environment, communications service providersface the challenge of defining, managing, and delivering numerous complex products and variations tothe market in a most effective way to differentiate themselves. TIBCO has concentrated and structuredits services around the following points:

● New product offerings are designed and rolled out in a few weeks including implementation in allof the fulfillment chain.

● Customer orders are instantly fulfilled and provisioned in the network to maximize customerexperience.

● Customer orders come from a large variety of order entries such as customer self-care portals,customer sales representative desks, or even network elements detecting service access to leveragefulfillment chain investment and support hardware rationalization.

TIBCO provides CSPs with a comprehensive and integrated solution ready for complete end-to-endfulfillment automation. The TIBCO® Fulfillment Orchestration Suite defines new product and serviceofferings, associated fulfillment rules and processes, and automates the delivery from order capturedown to the service activation in the network.

TIBCO Fulfillment Orchestration Suite ComponentsThe TIBCO Fulfillment Orchestration Suite solution is capable of supporting end-to-end orderfulfillment with order management, provisioning, and catalog capabilities.

The following are the constituents of the TIBCO Fulfillment Orchestration Suite:

● TIBCO® Fulfillment Catalog: TIBCO Fulfillment Catalog is a catalog function that defines andmanages life cycles of commercial and technical offerings.

● TIBCO® Fulfillment Order Management: TIBCO Fulfillment Order Management is a meta datadriven order management and fulfillment system which allows development of fulfillment plansbased on meta-data specified in product catalogs. Order fulfillment and service provisioning is nolonger a simple single-service or product workflow. The dynamic bundled offerings along with theexplosion of devices, applications, real-time inventory management, and third-party contentproviders require a complex order fulfillment system which can adapt to the changes in processes,meta data, and inventory. Traditional OSS/BSS approach with the data silos fail to provide adynamic and agile solution.

● TIBCO® Fulfillment Provisioning: TIBCO Fulfillment Provisioning is a provisioning componentthat automates the activation of the underlying network services and allocation of all the networkresources. This provisioning element implements service order management and resource ordermanagement TAM applications, aligns to service and resource activator OSS/J order managementcomponents, uses eTOM service configuration and activation, and implements resourceprovisioning processes and functions.

● TIBCO® Fulfillment Subscriber Inventory: TIBCO Fulfillment Subscriber Inventory maintains acurrent image of customer products at any given point in time that is capable of supporting fastconcurrent read or write access while ensuring data consistency. TIBCO Fulfillment SubscriberInventory also provides a rich, user-friendly web interface that can be used to explore and modifythe contents of the system in a safe and secure manner.

12


Provisioning in the Orchestration Suite

To enable TIBCO® Fulfillment Orchestration Suite to provide a truly unified and cohesive solution suite,different components of the suite have been integrated. For instance, the suite provides pre-definedinter-connectivity between TIBCO Fulfillment Provisioning, TIBCO Fulfillment Subscriber Inventory,TIBCO Fulfillment Order Management, and TIBCO Fulfillment Catalog, a catalog concept alignmentbetween TIBCO Fulfillment Catalog and TIBCO Fulfillment Provisioning through data synchronizationprocess, and a GUI integration for a similar look-and-feel. .

13


Fulfillment Management Services

The fulfillment management services are the set of services which are related to entities associated withorder. These services allow you to get information about these entities and perform other operations.

Security HeaderTIBCO® Fulfillment Order Management supports both HTTP and JMS as transport protocols forinvoking SOAP based Web services.

● TIBCO Fulfillment Order Management supports various web services, and each web service requestrequires the WS-Security UserName Token mechanism. It uses TIBCO Administrator credentials ina standards-compliant manner.

● By default, OMS provides a set of user IDs and passwords for the operations on OMS through webservice requests. Order services in OMS can be secured by enabling user name token-based security.OMS supports the WS-Security UserName Token mechanism which allows for the sending andreceiving of user credentials in a standards-compliant manner. For more details, refer to TIBCOFulfillment Order Management Administration Guide.

Order Management ServicesThe location of all OMS web service WSDLs is $AF_HOME/schemas/wsdl.

Order ServiceThis service contains operations regarding submitting and retrieving orders.

Cancel Order

This operation cancels the specified order in the orchestration engine. The order must be previouslysubmitted successfully and exist in the orchestration engine database. This function extracts the originalorder and resubmits it as an amendment with all order line actions set to CANCEL.

The request message format is:

Cancel Order Request Data Model

Element Name Element Type Description

ExternalBusinessTransactionID String Transaction ID sent by client.

14



orderID String

(Mandatory, Choice)

The ID of the Order generatedby OMS. This must be an exactmatch.

orderRef String

(Mandatory, Choice)

The client order reference ID.This must be an exact match.

rollback Boolean

(Optional)

Flag to indicate if the order isto be rolled back.

The reply message format is:

Cancel Order Response Data Model



BusinessTransactionID String Transaction ID generated byOMS, and used internally byOMS and Orchestrator.

orderID String

(Mandatory, Choice)

The ID of the Order generatedby OMS. This must be an exactmatch.

orderRef String

(Mandatory, Choice)


message String Interactive message sent toclient confirming requestprocessing.

Get Order Details

This operation retrieves the order details for a given order ID or order reference and returns to thecalling application.


15


GetOrderDetailsRequest Data Model


OrderID String

(Mandatory, Choice)

The ID of the order generatedby OMS. This must be an exactmatch.

OrderRef String

(Mandatory, Choice)



includeOrderRequest boolean This flag determines whetheror not to include the originalrequest in the response.

includeAmendments boolean This flag determines whetheror not to include all theamendments for the order inthe response.


GetOrderDetailsResponse Data Model

Element Name Element Type Description Example

orderType orderType

(Optional)

Order data structure.Data model for theorder is defined inXSD (refer section Common Data FormatSpecifications on page73). If the order is notfound this element isomitted.

Get Orders

This operation retrieves the orders for the specified subscriber or customer and returns to the callingapplication.


16


The request criteria is used to filter the resulting list of orders returned. Criteria are additive using theAND operator. The request criteria is not required, but it is recommended to pass in a request afterapplying the filtering criteria. Otherwise, a very large result set may be generated and returned. Theresults are limited to a maximum of 1000 orders.

By default, the returned orders are sorted by submission date in descending order.

The user can also customize the sorting by passing information in the SortCriteria element. TheSortCriteria element can be passed single field or combination of fields, the order for sorting (ascendingor descending) and sequence. The sequence defines in what order should the sorting field be applied.By using these combination the user can get the sorted result in desired way.

Get Orders Request Data Model



sortCriteria sortCriteria

Optional

Complex type whichencapsulates the sortFieldsequence.

sortField Sequence

Optional

Sequence of complex typewhich encompasses sortField/udfField and their sequencenumber and sorting order.

sortCriteria/sortField/sortBy Attribute, String This element is used to definewhat order the records shouldbe sorted. This element takesvalues ASC (Ascending) orDESC(Descending).

sortCriteria/sortField/sortSequence

Attribute, String This attribute defines sequenceof the given field for which thesorting is applied to. It takesnumerical number.

17



orderUDFField String

Optional

Defined the order header UDFfield name by which the resultis sorted. More than one udffield can be given but cannot berepeated.

field sortFieldValues

Optional

List of fields which can be usedto sort the result.

orderID String

(Optional)

The ID for the order to retrieveorders. This field supportswildcard searches using * or %at the start or end of the string.This is a case-insensitive searchparameter.

orderRef String

(Optional)

The order reference to retrieveorders. This field supportswildcard searches using * or %at the start or end of the string.This is a case-insensitive searchparameter.

customerID String

(Optional)

The ID for the customer toretrieve orders. This fieldsupports wildcard searchesusing * or % at the start or endof the string. This is a case-insensitive search parameter.

subscriberID String

(Optional)

The ID of the subscriber toretrieve orders. This fieldsupports wildcard searchesusing * or % at the start or endof the string.

Specifying subscriberID returnsall orders that include thesubscriber, including multiple-subscriber orders.

dateRange/startDate Date (YYYY-MM-DD) The earliest order date toreturn orders. This date isinclusive. This is based on theOrderSubmission Date on theorder. Order submission datesbefore this date are excluded.

18



dateRange/endDate Date (YYYY-MM-DD) The latest date to return orders.This date is inclusive. This isbased on the Order SubmissionDate on the order. Ordersubmission dates after this dateare excluded.

status String Order status.

headerUDF/name String Name of UDF.

headerUDF/value String Value of UDF.

orderLineUDF/name String Name of UDF.

orderLineUDF/value String Value of UDF.

pagination/startRecord long Inclusive start record index.

pagination/endRecord long Inclusive end record index.

orderSummary boolean Flag to indicate if the operationshould only return orderheader information.


Get Orders Response Data Model


Orders Type

(Optional)

List of Orders. If no orders arefound this element is omitted.

pagination/startRecord long

(Mandatory)

Start record index of returnedorders. This index is inclusive.

pagination/endRecord long

(Mandatory)

End record index of returnedorders. This index is inclusive.


19


Get Order Execution Plan

This operation retrieves the order execution plans for a given order and returns to the callingapplication.


Get Order Execution Plan Request Data Model


ExternalBusinessTransactionID

String Transaction ID sent by client.

orderID String

(Mandatory, Choice)

The ID of the Order. This must be an exactmatch.

orderRef String

(Mandatory, Choice)

The order reference ID. This must be an exactmatch.


Get Order Execution Plan Reply Data Model




20



Plan Type

(Optional)

Execution Plan data structure. Data model forExecution Plan is defined in XSD (refer section Common Data Format Specifications on page 73).If no Execution Plan was found this element isomitted.

Submit Order

This operation accepts an order for submission to the order management system and returns the orderID and order reference to the calling application.

● If the order is being submitted for the first time, do not specify the Order ID in the input. A value isgenerated internally.

● If the order is an amendment to a previously submitted order, orderRef must be specified.

● If orderRef is not specified, a value is generated and returned to the calling application. This value isalways generated whether the order passed validation or not.

● For SOAP over JMS Web services, the length of orderRef should be less than or equal to 100characters.

● If the router configuration is selected as filteringRouter, then submitOrder must have a UDFwith UDF Name as "Orchestrator" in the order header. This information is required to evaluate theOrchestrator engine type in the filteringRouter. For example: CUSTOMERID Orchestrator IPC

Optionally, the orders submitted into the system can be validated before being sent for furtherprocessing. This validation can be enabled by setting the flagcom.tibco.af.oms.enableOfferValidation to true.


Submit Order Request Data Model


orderRequest orderRequestType

(Mandatory)

Order data structure. Datamodel for Order is defined inXSD (refer section CommonData Format Specifications onpage 73).

21





Submit Order Response Data Model




orderID String

(Optional)

Order ID generated by theorder manager (OMS). If theorder fails validation, this isomitted.

orderRef String

(Optional)

Client order reference.

If the submitOrder request does not contain either orderID or orderRef element, then OMS generatesthe orderRef and returns the same in the submitOrder response.

Synchronous Submit Order

This operation accepts an order for submission to the order management system and returns the orderID, order reference, and the plan to the calling application after the order has been completed throughthe Orchestrator engine.

● If the order is being submitted for the first time, do not specify the Order ID in the input. A value isgenerated internally.

● If orderRef is not specified, a value is generated and returned to the calling application. This value isalways generated whether the order passed validation or not.

22


● For SOAP over JMS Web services, the length of orderRef should be less than or equal to 100characters.

● If the Router Configuration is selected as filteringRouter, then submitOrder must have a UDFwith UDF Name as "Orchestrator" in the order header. This information is required to evaluate theOrchestrator engine type in the filteringRouter. For example: CUSTOMERID Orchestrator IPC

An optional validate on submit function is available. If this function is enabled, prior to handing theorder to the Order Management component, this service performs a validation on the order todetermine if it is valid. The results of this validation are returned. If the order fails validation, it is notsubmitted to Order Management.

If the function is enabled by a flag, a copy of the order is saved in the offer cache to indicate it has beensubmitted.


Synchronous Submit Order Request Data Model

Synchronous Submit Order Request Data Model



(Mandatory)




23


Synchronous Submit Order Response Data Model

Synchronous Submit Order Response Data Model Table

Element NameElementType Description

resultStatus ResultStatus The result status of the operation.

OrderId String OrderID generated by OMS.

OrderRef String Client order reference.

planID String Plan ID of the plan generated for the order.

status String Status of the order. For example, completed, or failure.



BusinessTransactionID String Transaction ID generated by OMS, and used internallyby OMS and Orchestrator.

If the synchronous submitOrder request does not contain either orderID or orderRef element, thenOMS generates the orderRef and returns the same in the submitOrder response.

Amend Order

An existing order can be modified using the amend order web service. If the order reference alreadyexists in OMS, then it accepts the amend order request.


24


The following table explains elements defined in request schema.

Amend Order Request Data Model



(Mandatory)



The response message format is:

The following table explains the elements defined in the response schema.

Amend Order Response Data Model



BusinessTransactionID String Transaction ID generated byOMS and used internally byOMS and Orchestrator.

orderID String

(Optional)

Order ID generated by theorder manager (OMS). If theorder fails validation, this isomitted.

orderRef String

(Optional)

Client order reference.

25


Perform Bulk Order Action

This service can be used to perform the following operations on multiple orders (Order IDs, orderRef):

● CANCEL● SUSPEND● RESUME● WITHDRAWOnly one type of bulk action can be performed on multiple orders in a single request.


Perform Bulk Order Action Request Data Model


businessTransactionID String Transaction ID sent by client.

action String Name of the bulk actions toperform:

● CANCEL

● SUSPEND

● RESUME

● WITHDRAW

orderID String

(Optional)

List of order IDs on which bulkoperations are to be performed.

orderRef String

(Optional)

List of order references onwhich bulk operations are to beperformed.

A response in the form of an acknowledgment is returned asynchronously indicating the successfulsubmission of request. The status of the bulk process can be tracked through OMS UI, OMS server, andOrchestrator logs.


26


Perform Bulk Order Action Response Data Model


businessTransactionID String Transaction ID sent by client.

timestamp dateTime Date and time when OMSreceives a bulk order request.

message String

(Optional)request

Message indicating successfulrequest submission.

noOfOrders Integer

(Optional)

Number of orders in therequest.

Withdraw Order

This operation withdraws all the submitted orders. As an input, this operation accepts the OrderID orOrderRef to withdraw an order and returns the message while sending the order for withdrawal in theOrchestrator component. After receiving an order removal notification from Orchestrator, it removesthe requested order from the Order Management System component.

1. You cannot withdraw an order when it is in the COMPLETE or CANCELLED state.

2. The only way you can trace withdrawn orders from the Order Management System component isby OrderRef on the Activity Log page.

3. You can submit an order with the same OrderRef that is already withdrawn. Currently, since thesystem does not keep record of the withdrawn orders, the Orders Summary section under theDashboard tab does not show any statistics for withdrawn orders.


Withdraw Order Request Data Model



orderID String

(Mandatory, Choice)


27



orderRef String

(Mandatory, Choice)



Withdraw Order Response Data Model




orderID String

(Mandatory, Choice)


orderRef String

(Mandatory, Choice)



Handle Plan Item In Error

The Handle Plan Item In Error marks failed plan-items with an ERROR state and allows the user toselect an appropriate action for the failed plan-item.


28


Handle Plan Item In Error Request Data Modell

Element Name Element Type description

orderID String (Mandatory) The ID of the order generated byOMS. This must be an exact match.

planID String (optional) Plan ID of the plan generated for theorder.

orderRef String (optional) The client order reference ID.

planItemID String Unique Id identifying the plan Item.

errorResolution String RETRY

RESUME

COMPLETE

MOPD

errorResolutionComment

String (optional) Any String based user input.


29


Handle Plan Item In Error Response Data Model


orderID String The ID of the order generated byOMS.

planID String Plan ID of the plan generated for theorder.

orderRef String The client order reference ID.

message String Internal error handler serviceinitiated.

Activate Order

The Activate Order operation is used to activate or resume a suspended order. This operation takesorderId or orderRef and attempts to activate or resume the order for the given orderId or orderRef. Thisoperation is asynchronous. Only valid orders and orders which are in SUSPEND state can be activated.

Element name: os:ActivateOrderRequest


Activate Order Request Data Model


ExternalBusinessTransactionID String

(Optional)

This is an attribute which canbe used by external systems tokeep track of requests. Notethat the value of this attribute isnot stored anywhere in TIBCOFulfillment OrderManagement, and it is justmeant for use by externalsystems.

orderID String

(Mandatory, Choice)


orderRef String

(Mandatory, Choice)


Element name: os:ActivateOrderResponse


30


Activate Order Response Data Model



(Optional)


orderID String

(Mandatory, Choice)

Required

orderRef String

(Mandatory, Choice)

Required

message String

(Mandatory, Choice)

Interactive message sent toclient confirming requestprocessing. Required.

Suspend Order

The Suspend Order operation suspends an existing order. This operation takes orderRef or orderId andsends a message to Fulfillment Order Management to suspend an order. This operation isasynchronous.

Element name: os:SuspendOrderRequest


31


Suspend Order Request Data Model



(Optional)


orderID String

(Mandatory, Choice)


orderRef String

(Mandatory, Choice)


Element name: os:SuspendOrderResponse


Suspend Order Response Data Model



(Optional)


orderID String

(Mandatory, Choice)


orderRef String

(Mandatory, Choice)


32




Fetch Authentication Token

A token based authentication has been introduced for the OMS order soap web service using JSONWeb Token (JWT). The operation FetchAuthenticationToken has been added to fetch the token based onthe existing username and password. This token can be used to invoke other operations of the orderservice.

In order to use this form of authentication, the client can keep the password empty and send thefetched token as the username in the SOAP request.


admin admin

Fetch Authentication Token Request Data Model


Username String Existing username.

Password String Existing password.


soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJhZG1pbiIsImlzcyI6Ik9NUyIsInJscyI6W3siYXV0aG9yaXR5IjoiUk9MRV9BRE1JTiJ9XSwidG50IjoiVElCQ08iLCJleHAiOjE0OTk3MTM5NzYsImlhdCI6MTQ5OTcxMzc5Nn0.NmLbv2yT5at1lE_DUyWfvjYdxvgv7TJk1utdv-YX-Fo

33


Sample Security Header with JWT

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJhZG1pbiIsImlzcyI6Ik9NUyIsInJscyI6W3siYXV0aG9yaXR5IjoiUk9MRV9BRE1JTiJ9XSwidG50IjoiVDEiLCJleHAiOjE0OTQyMTcyNjAsImlhdCI6MTQ5NDIxMzY2MH0.sW6zyVrPOV4g8hE-dItzriShWiT9XCVcDk0PMopm89g

Get Enriched Execution Plan

The getEnrichedExecutionPlan operation calls an existing APIgetEnrichedExecutionPlanByPlanId to generate an enriched plan for a given order ID or orderreference ID. The response includes details about the plan and the generated jeopardy header for theplan.

The user has two optional parameters in the input:

1. Include Plan Fragment (Default is true)

2. Include Jeopardy Header (Default is true)

By default, the jeopardy header is included as part of a completed response..

Jeopardy Header includes Plan Item information along with risk region and duration information.Jeopardy Header also contains information about the SLA level calculation and predictabilitycalculations done for the plan. Based on the SLA and predictability calculation, the risk region isupdated with appropriate flag.

The getEnrichedExecutionPlan operation returns the following error codes in case an exception isthrown:

● MISSING_ORDER_ID_AND_REF(TIBCO-AFF-OMS-100007)

● ORDER_NOT_FOUND(TIBCO-AFF-OMS-100020)

34


● ORDER_INPUT_INVALID((TIBCO-AFF-OMS-100001)

● UNEXPECTED_ERROR(TIBCO-AFF-OMS-100000)

Enriched Execution Plan Request Operation

Test_1 true true

Enriched Execution Plan Response Operation

2a85486d-4f1d-4e28-aa8d-ab832efe9f84 06deb39b-0372-47ec-82c8-0d7dc2c01a61 AF-4173AF-4178_01 AFO 2014-05-10T13:45:13.913+05:30 COMPLETE 2014-05-10T14:06:44.528+05:30 ProductDependsOn 2014-05-10T13:45:14.057+05:30 1399709714057 false .... .... ... JM_MESSAGE:20140510-134901.412 AFF_JM_PLAN_0200:Plan is predicted to exceed typical duration and is increasing JM_MESSAGE:20140510-135101.848 AFF_JM_PLAN_0230:Plan is predicted to exceed maximum duration and is increasing JM_MESSAGE:20140510-140401.512 AFF_JM_PLAN_0120:Plan has exceeded out of scope threshold output

35


headerUDF headerUDF Value; set by defaultPC for planItem 02946078-1252-4db5-8036-4dfce7d64561 at time 2014-05-10T14:00:28.582+05:30 headerUDF Value; set by defaultPC for planItem 1fee1d6e-5c7c-46a4-a080-381c527b0b90 at time 2014-05-10T14:00:15.832+05:30 String JM_RISK_REGION OUT_OF_SCOPE HAZARD ServerTimeZone 19800000 19800000 1399711004558 OUT_OF_SCOPE 1fee1d6e-5c7c-46a4-a080-381c527b0b90 START END 1f1f2daa-9219-47ea-9ee0-47e9a73d7f84 START END 02946078-1252-4db5-8036-4dfce7d64561 START END 10009443 10009443 1fee1d6e-5c7c-46a4-a080-381c527b0b90 START END 1f1f2daa-9219-47ea-9ee0-47e9a73d7f84 START END 02946078-1252-4db5-8036-4dfce7d64561 START END 10009443 10009443 1399709714057 1399710254057 1399710614057 25 25

36


1399719723500 1399711004528 .... .... ....

AOPD ServiceThe following web services are provided in AOPD:

Generate Plan

The generate plan web service makes it possible to get a copy of a plan for a particular order prototype,and existing catalogue, without submitting the order in system. The following code sample is anexample for the web service request for generatePlan.

Generate Plan Request

GG_AF1347_02 ProductDependsOn PDO_CUST TIBCO 2010-04-30T13:20:00-05:00 1 TIBCO B 0.1 1 UOM PROVIDE 2010-04-30T13:20:00-05:00

37


Generate Plan Response

967aba69-2bf5-422e-885c-3ae8903b4784 1ef8ccef-0ecd-4687-81ac-6091ff926d9a GG_AF1347_02 AOPD 2013-09-17T11:46:01.228-07:00 START 2013-09-17T11:46:01.228-07:00 0c22aecf-5a11-4c00-9c43-80e507040000 B1 PROVIDE EP_TEST 1 true PROVIDE START 2013-09-17T11:46:01.228-07:00 config RECORD_TYPE PO config COMPENSATE_PROVIDE DEFAULT config COMPENSATE_CEASE DEFAULT config EOL Y Shared config CONTRACTID-MV CONTRACTID-MV value in B1 product model. config EPRM_ACTION_CEASE COMPENSATE_RESTART config PRODUCTID B1 config

38


EPMR_ACTION_WITHDRAW COMPENSATE config Action PROVIDE config M_EP_UDFS 0c22aecf-5a11-4c00-9c43-80e507040000 config TASKID 0c22aecf-5a11-4c00-9c43-80e507040000 config EPMR_ACTION_PROVIDE COMPENSATE_RESTART config GLOBAL_PRODUCT_NAME B1 config ORDERLINE 1

Generate Plan SOAP fault

soap:Server INVALID_PRODUCT_IN_ORDER 1 BPO_PROD1 TIBCO-AFF-AOPD-100006 : INVALID_PRODUCT_IN_ORDER VALIDATION BasicOrderValidationAction

39


Generate Partial Plan

The SOAP web service only provides a preview for order decomposition. the valid plan generationphases are VALIDATION, DECOMPOSING, OPTIMIZING, and PUBLISHING. In all other cases thisweb service returns a preview of the complete generated plan.

Generate Partial Plan Request

GG_SU_Local7 GG_JM JM TIBCO 2012-03-12T13:20:00-05:00 test123 test123 test123 IN 411057 test123 test123 test123 test123 IN 411057 test123 TEST 1 B1 1.0 1 UOM PROVIDE MOVE 1 DECOMPOSING

Generate Partial Plan Response

5cbb306d-2806-4830-845e-46eaf72927fd dc8dc9b8-87be-40fa-8600-b621a420ed65 GG_SU_Local7

40


AOPD 2013-09-17T11:47:22.456-07:00 START 2013-09-17T11:47:22.456-07:00 c705350b-5ae1-462c-989e-2a224d10a7c1 B1 PROVIDE EP_TEST 1 true PROVIDE START 2013-09-17T11:47:22.456-07:00 config RECORD_TYPE PO config COMPENSATE_PROVIDE DEFAULT config COMPENSATE_CEASE DEFAULT config EOL Y Shared config CONTRACTID-MV CONTRACTID-MV value in B1 product model. config EPRM_ACTION_CEASE COMPENSATE_RESTART config PRODUCTID B1 config EPMR_ACTION_WITHDRAW COMPENSATE config Action PROVIDE config M_EP_UDFS c705350b-5ae1-462c-989e-2a224d10a7c1 config TASKID c705350b-5ae1-462c-989e-2a224d10a7c1

41


config EPMR_ACTION_PROVIDE COMPENSATE_RESTART config GLOBAL_PRODUCT_NAME B1 config ORDERLINE 1

Product Model PurgeThe purge web service makes it possible to remove existing products from the model repository inAOPD and models persisted in OMS database. For more details see "Product Model Purge" in theFulfillment Order Management Administration Guide.

Price and Discount Model PurgeThe purge web service also makes it possible to remove all prices and discounts from the modelrepository in AOPD, OPE, and models persisted in OMS database. For more details see "Product ModelPurge" in the Fulfillment Order Management Administration Guide.

Offline Catalog LoadingThe offline catalog feature enables TIBCO Fulfillment Order Management to have no dependency onTIBCO Fulfillment Catalog to be online all the time for the data models. For more details see "OfflineCatalog" in the Fulfillment Order Management Administration Guide.

Rule Model Purge

The purge web service also makes it possible to remove all rule models from the model repository inAOPD, OPE, and models persisted in OMS database. For more details see "Product Model Purge" in theFulfillment Order Management Administration Guide.

Offer and Price Engine ServicesThe Offering and Pricing Engine (OPE) provides support for generating and validating the productoffering for the customer and provides pricing for the offers. The engine integrates with the productcatalog provided by TIBCO Fulfillment Catalog for product definition at design time.

OPE exposes the following services to generate and validate the offer, get the price for the generatedoffer, and get the product and price information:

● Get Offer Service● Validate Offer Service● Get Price Service● Get Product Information Service● Get Price Information ServiceThe following samples have been added for the OPE web services:

42


● Offer and price engine services model samples located in TIBCO_HOME/af/4.0/samples/Models

● Web service requests and responses, including the Offer ID functionality, located inTIBCO_HOME/af/4.0/samples/WebService

Get Offer ServiceThis service validates the incoming offer with the existing basket of the customer.

The validation considers product integrity, product compatibility with the products in the offer,segment compatibility with basket items, and group requirements. In case of ceased products, it checksif the item is present in TIBCO Fulfillment Subscriber Inventory in a blocked status. Depending uponthe migrations created in the product model, the offer includes the products to be migrated forotherwise incompatible products. Eligibility is evaluated for all products including the autoprovisioned products. In case any auto provisioned child is invalid, the product is ineligible.

The services utilize the following relationships:

● CompatibleSegment

● IncompatibleSegment

● Category

● CompatibleProduct

● IncompatibleProduct

● Migration including the existing ProductComposedOf and ProductRequiredFor

The offer is generated on a particular set of inputs and returns the list of products which can be offeredto the subscriber. The inputs in the request can include any of the following filters:

● Segments

● Categories

● Promotions

● Record Types and Record Subtypes

● Focus (focuses on products in the subscriber's basket or inventory)

● Characteristics

● Product Status

In case these filters are present, the products satisfying only these criteria are considered for the offer. Incase no filters are present, all product offerings are considered for generating offer and the validationrules are applied.

You can utilize the following request flags for this web service:

Get Offer Request Flags

Request Flag Name Default

ReturnIneligibleProducts True

ReturnBundleOfferings False

ReturnPrices False

ReturnProductInformation True

43



validateData True

validateProductRequiredForGroups True

validateProductComprisedOfGroups True

validateProductCompatibility True

validateSegmentCompatibility True

decomposeProducts False

basicValidationOnExistingOffer True

ValidateProdDate False

enforceCompatibleSegment False

skipChildFilterValidation False

Get Offer Request

Get Offer Request Body Details


BusinessTransactionID String

(Optional)

Used for the upstream web serviceto correlate a response with theappropriate request.

ReturnIneligibleProducts Boolean

(Optional)

Toggles whether products, whichare found to be ineligible as aresult of a specific reason, arereturned in the response. Theproducts that are present in theEligible Products Holder and areremoved as being incompatiblewith a product, or child of aproduct, in the order or inventoryare identified as ineligibleproducts once detected. Thedefault is value false.

ReturnBundleOfferings Boolean

(Optional)

Bundle support, which is forgetting eligible bundles for thecurrent basket and inventory. Onlythose products which haveoptional children in the orderrequest are eligible. The defaultvalue is false.

44



ReturnPrices Boolean

(Optional)

If set, prices for the generated offerare returned. The default value isfalse.

ReturnProductInformation Boolean

(Optional)

If set to true, it returns theproduct information for theeligible product. The default valueis false.

RequestControl/validateData Boolean

(Optional)

Not used in this service.

RequestControl/validateProductRequiredForGroups

Boolean

(Optional)

Toggles if ProductRequiredForgroups are evaluated in eligibility.The default value is true.

RequestControl/validateProductComprisedOfGroups

Boolean

(Optional)

Toggles if ProductComprisedOfgroups are evaluated in eligibility.The default value is true.

RequestControl/validateProductCompatibility

Boolean

(Optional)

Toggles if ProductCompatibility isevaluated in eligibility. The defaultvalue is true.

RequestControl/validateSegmentCompatibility

Boolean

(Optional)

Toggles if SegmentCompatibility isevaluated in eligibility. The defaultvalue is true.

RequestControl/validateProdDate Boolean

(Optional)

Toggles if the engine checks thatthe products are valid based on theconfigured start dates and enddates.

RequestControl/decomposeProducts Boolean

(Optional)

Toggles if products aredecomposed into autoprovisionedchildren or requiredForchildren.The default value is true.

RequestControl/ReturnProductInformation

Boolean

(Optional)

If existent, ProductInformation isadded directly to eligible andvisible ineligible products.

RequestControl/basicValidationOnExistingOffer

Boolean

(Optional)

Toggles if the existing basket andinventory is validated beforeselecting eligible products. Thedefault value is false.

45



RequestControl/ReturnProductInformationData

String

(Optional)

With this element, you canconfigure characteristic filters forreturning product information.There is an "or" relationshipbetween characteristic name(ReturnCharacteristicsName),characteristic description(ReturnCharacteristicsDescription) and characteristic value type(ReturnCharacteristicsValueType).

SubscriberID String

(Optional)

Eligible products are presented forthe subscriber specified in thesefields. This information is used inthe context of the order andinventory to perform compatibilityand integrity checks.

CustomerID String

(Optional)

Eligible products are presented forthe subscriber specified in thesefields. This information is used inthe context of the order andinventory to perform compatibilityand integrity checks.

Segment Boolean

(Optional)Information used to derive theinitial list of eligible products. Persegment type, a segment elementand all related segments should bemapped as name.

If multiple segments are providedfor a SegmentType, the union of allassociated products is returned.Multiple SegmentTypes return anintersection of all productscompatible with all SegmentTypes.

OrderDate dateTime

(Optional)

If OrderDate is entered, productsin the eligible product list arefiltered based on configured startand end dates of each product forthat date, otherwise the systemtime is taken.

46



RecordTypes String

(Optional)

If one or more RecordTypes valuesare included in the request,products in the eligible product listare filtered after the expansion toinclude AutoProvision and NonMandatory children. This meansthat all the products in the eligibleproduct list that meet the filteringcriteria are returned. RecordTypeis compared to the configuredclass of the product.

Multiple RecordTypesresults in a union of allproducts having one ofthe providedRecordTypes.

Promotions String

(Optional)

Promotion products is a reducedlist of products that is evaluated bythis request. Promotion productsare filtered according to the othercriteria specified in the request andtested for compatibility withproducts in the inventory or order.

RecordSubType String

(Optional)

If one or more RecordSubTypesare included in the request,products in the eligible product listare filtered while the expansionincludes AutoProvision and NonMandatory children. This meansthat all of the products in theeligible product list that meet thefiltering criteria, plus any childrenor children of children, arereturned. RecordSubType iscompared to the configuredSubclass of the Product.

Multiple RecordTypesresult in a union of allproducts having one ofthe providedRecordSubTypes.

47



Categories String

(Optional)If one or more categories areincluded in the request, productsin the eligible product list arefiltered for these categories. If youprovide multiple categories, anintersection of the results for eachcategory are presented.

If one auto provisioned child is notcompatible to a category, theparent is not either.

Focus Focus

(Optional)

With this field, you can set abasket or inventorying item intofocus. The focused item's childproducts are evaluated andattached as eligible products.

InputField Field

(Optional)

With this field, you can set linkingto relevant fields and returns toevaluate eligible products usingthose fields.

orderRequest orderRequest

(Optional)

Products in the basket can bepassed into the eligibility enginethrough the order to maintaincompatibility between productsthat are already ordered.

Status String This element is not being used.

Get Offer Response

Get Offer Response Details


BusinessTransactionID String

(Optional)

If provided, it is passed fromthe request and can be used tocorrelate service calls acrossdisparate services to trackactual business process flows inthe system.

Get Offer Result Status Element Details


operation String

(Optional)

The operation's name is"getEligibleProducts"

48



component String

(Optional)

The service's name is"ExtEligibilityAndValidation"

severity String

(Optional)

INFO, ERROR

code String

(Optional)

The error code is a string thatidentifies the error and theTIBCO FulfillmentOrchestration Suite componentthat produced the error. Anerror code of 0 indicates asuccessful invocation of theservice.

message String

(Optional)

A descriptive text stringassociated with code.

Eligible or Ineligible Product Element Details


ProductID String

(Mandatory)

The ID of the eligible product.

InternalID String

(Optional)

The internal ID of the productinstance that is used forcorrelation withParentInternalID of a childproduct.

ParentInternalID String

(Optional)

The internal ID of the product'sparent instance that is used forcorrelation with InternalID of aparent product.

SubscriberID String

(Optional)

The subscriber ID for which theeligibility request was made.

CustomerID String

(Optional)

The customer ID for which theeligibility request was made.

49



UDFs UDFType

(Optional)

Each UDF contains a namefield and a value field.Eligibility tries to enrichproducts with UDFs as muchas possible by mapping UDFsfrom related (compatible,parent, child) products. Iflinking relevant UDFs couldnot be mapped from inventoryor basket items, they arecreated with a default value ${new}.

Messages String

(Optional)

Attached ValidationMessageelements which displayvalidation results.

Price ChildPriceBaseType

(Optional)

If set from request, it returnsthe price for this product.

Validation Message Details

ElementName Element Type Description

Code String

(Mandatory)

The code of the validation message.

Type String

(Optional)

The type of the validation message. It is mostly an errormessage because validation messages are only created incase of errors. The only exception is in case of a migration,because the possibility of a migration is indicated using amessage of type info.

Details String

(Optional)The corresponding textual message, configurable in the GVslocated in:

AFF/OfferConfigurationValidation/Constants/

Errors/OfferValidation

CausingItem String

(Optional)

The CausingItem field indicates which type of item causedthe validation error or message, such as TrolleyItem or UDF.

CausingItemID

String

(Optional)

The CausingItemID field displays the ID of the item causingthe validation error or message, such as the ProductID orthe UDF Name.

CausingItemPosition

String

(Optional)

The CausingItemPosition indicates the position type of theitem causing the validation error or message, such as"LineNumber" for TrolleyItemor "InventoryID" forInventoryItems.

50


ElementName Element Type Description

CausingItemPositionID

String

(Optional)

The CausingItemPositionID indicates the position of theitem causing the validation error or message, such as aLineNumber for TrolleyItemor an "InventoryID" forInventoryItems.

RuleViolation String

(Optional)

The RuleViolation displays the concrete violation of theparticular rule which created this message, forexample,violation of a maximum constraint ofProductComprised group would be "Group.Max: 2.0 /ActualCount: 3.0".

Validate Offer ServiceThis service validates the request based on the number of inputs including segments, order, and offer.When you submit an order request, that order is submitted to OPE. Based on the product model andgroup constraints, it returns a message stating if the products are valid or not.

The validation considers product integrity, product compatibility with the products in offer, segmentcompatibility, category compatibility, and group requirements of basket items. In the case an inventoryis supplied, the service validates inventory with the items in the basket and checks for single use,product compatibility with basket items, and group requirements. In the case of cease products, theservice checks if the item is present in inventory in a blocked status. In case any of these checks fail, thisservice invalidates the offer and returns an appropriate error response.

You can apply IncompatibleSegment to a LinkID for the ValidateOffer web service. To implement this,add a UDF with the name SegmentLinkID under the seg:Segment element and under the orderlineUDF where you want to map the LinkID under the validateOffer request.


validateData True

validateProductRequiredForGroups True

validateProductComprisedOfGroups True

validateProductCompatibility True

validateSegmentCompatibili

tibco fulfillment order management web services …...tibco® fulfillment order management web...

Documents