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 an example for the web service request for generatePlan.
Generate Plan Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ord="http://www.tibco.com/aff/orderservice" xmlns:ord1="http://www.tibco.com/aff/order" xmlns:com="http://www.tibco.com/aff/commontypes">
<soapenv:Header/>
<soapenv:Body>
<ord:SubmitOrderRequest ExternalBusinessTransactionID="GG_AF1347_02">
<ord:orderRequest>
<ord1:orderRef>GG_AF1347_02</ord1:orderRef>
<ord1:header>
<ord1:description>ProductDependsOn</ord1:description>
<ord1:customerID>PDO_CUST</ord1:customerID>
<ord1:subscriberID>TIBCO</ord1:subscriberID>
<ord1:requiredByDate>2010-04-30T13:20:00-05:00</ord1:requiredByDate>
</ord1:header>
<ord1:line>
<ord1:lineNumber>1</ord1:lineNumber>
<ord1:subscriberID>TIBCO</ord1:subscriberID>
<ord1:productID>B </ord1:productID>
<ord1:productVersion>0.1</ord1:productVersion>
<ord1:quantity>1</ord1:quantity>
<ord1:uom>UOM</ord1:uom>
<ord1:action>PROVIDE</ord1:action>
<ord1:requiredByDate>2010-04-30T13:20:00-05:00</ord1:requiredByDate>
</ord1:line>
</ord:orderRequest>
</ord:SubmitOrderRequest>
</soapenv:Body>
</soapenv:Envelope>
Generate Plan Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns5:plan xmlns:ns9="http://www.tibco.com/aff/orderservice/result" xmlns:ns8="http://www.tibco.com/aff/aopd/service/soap" xmlns:ns7="http://www.tibco.com/aff/aopdservice/result" xmlns:ns6="http://www.tibco.com/aff/planfragments" xmlns:ns5="http://www.tibco.com/aff/plan" xmlns:ns4="http://www.tibco.com/aff/orderservice" xmlns:ns3="http://www.tibco.com/aff/commontypes" xmlns:ns2="http://www.tibco.com/aff/order">
<ns5:planID>967aba69-2bf5-422e-885c-3ae8903b4784</ns5:planID>
<ns5:orderID>1ef8ccef-0ecd-4687-81ac-6091ff926d9a</ns5:orderID>
<ns5:orderRef>GG_AF1347_02</ns5:orderRef>
<ns5:originator>AOPD</ns5:originator>
<ns5:planCreationDate>2013-09-17T11:46:01.228-07:00</ns5:planCreationDate>
<ns5:status>START</ns5:status>
<ns5:statusChanged>2013-09-17T11:46:01.228-07:00</ns5:statusChanged>
<ns5:planItem>
<ns5:planItemID>0c22aecf-5a11-4c00-9c43-80e507040000</ns5:planItemID>
<ns5:description>B1 PROVIDE</ns5:description>
<ns5:planFragmentUniqueID>EP_TEST</ns5:planFragmentUniqueID>
<ns5:orderLine>
<ns5:orderLineNumber>1</ns5:orderLineNumber>
<ns5:eol>true</ns5:eol>
</ns5:orderLine>
<ns5:action>PROVIDE</ns5:action>
<ns5:status>START</ns5:status>
<ns5:statusChanged>2013-09-17T11:46:01.228-07:00</ns5:statusChanged>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>RECORD_TYPE</ns5:name>
<ns5:value>PO</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>COMPENSATE_PROVIDE</ns5:name>
<ns5:value>DEFAULT</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>COMPENSATE_CEASE</ns5:name>
<ns5:value>DEFAULT</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>EOL</ns5:name>
<ns5:value>Y</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:evaluationPriority/>
<ns5:type>Shared</ns5:type>
<ns5:flavor>config</ns5:flavor>
<ns5:name>CONTRACTID-MV</ns5:name>
<ns5:value>CONTRACTID-MV value in B1 product model.</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>EPRM_ACTION_CEASE</ns5:name>
<ns5:value>COMPENSATE_RESTART</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>PRODUCTID</ns5:name>
<ns5:value>B1</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>EPMR_ACTION_WITHDRAW</ns5:name>
<ns5:value>COMPENSATE</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>Action</ns5:name>
<ns5:value>PROVIDE</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>M_EP_UDFS</ns5:name>
<ns5:value>0c22aecf-5a11-4c00-9c43-80e507040000</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>TASKID</ns5:name>
<ns5:value>0c22aecf-5a11-4c00-9c43-80e507040000</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>EPMR_ACTION_PROVIDE</ns5:name>
<ns5:value>COMPENSATE_RESTART</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>GLOBAL_PRODUCT_NAME</ns5:name>
<ns5:value>B1</ns5:value>
</ns5:udf>
<ns5:udf>
<ns5:flavor>config</ns5:flavor>
<ns5:name>ORDERLINE</ns5:name>
<ns5:value>1</ns5:value>
</ns5:udf>
</ns5:planItem>
</ns5:plan>
</soap:Body>
</soap:Envelope>
Generate Plan SOAP fault
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>INVALID_PRODUCT_IN_ORDER</faultstring>
<detail>
<ns7:resultFault xmlns:ns2="http://www.tibco.com/aff/commontypes" mlns:ns3="http://www.tibco.com/aff/orderservice"
mlns:ns4="http://www.tibco.com/aff/plan" xmlns:ns5="http://www.tibco.com/aff/planfragments" xmlns:ns6="http://www.tibco.com/aff/order" xmlns:ns7="http://www.tibco.com/aff/aopdservice/result" xmlns:ns8="http://www.tibco.com/aff/aopd/service/soap" xmlns:ns9="http://www.tibco.com/aff/orderservice/result">
<ns7:customErrors>
<ns7:customError>
<ns7:orderLine>1</ns7:orderLine>
<ns7:productId>BPO_PROD1</ns7:productId>
<ns7:message>TIBCO-AFF-AOPD-100006 : INVALID_PRODUCT_IN_ORDER</ns7:message>
<ns7:planGenerationPhase>VALIDATION</ns7:planGenerationPhase>
<ns7:ruleId>BasicOrderValidationAction</ns7:ruleId>
</ns7:customError>
</ns7:customErrors>
</ns7:resultFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Copyright © Cloud Software Group, Inc. All rights reserved.