IBM Support

getCompleteOrderDetails API is not using Order/Extn/@Attribute for filtering

Troubleshooting


Problem

Attempts to run getCompleteOrderDetails API does not honor the extended attribute in IBM Sterling Order Management

Cause

This is working as per design.

Diagnosing The Problem

The behavior observed is as per product design. The getCompleteOrderDetails is a wrapper API which gives additional information in addition to information returned by the getOrderDetails API. These are detail APIs, which will fetch the Order details based on key (i.e. OrderHeaderKey) or by using the combination of attributes EnterpriseCode,DocumentType and OrderNo. Attributes which can uniquely identify the order are used to fetch the detail and not all the attributes.

As per API java docs of getOrderDetails :Order is associated With Table: YFS_ORDER_HEADER The OrderHeaderKey, or the EnterpriseCode, DocumentType and the OrderNo must be passed to identify the Order. The same input for getOrderDetails API will lead to the results based on above explanation.

Resolving The Problem

In order to fulfill the requirement, the following can be tried:

  1. Use list API, getOrderList which can filter based on extended attributes and also returns details of order.

  2. Write a custom API to decide on output of getCompleteOrderDetails API based on extn attribute passed in input.
    You can either perform validation in response of getCompleteOrderDetails or call getOrderList with filter and then call getCompleteOrderDetails based on result.

    NOTE: This requirement does not qualify for a enhancement request, because detail APIs will not perform filtering based on input attributes rather it will fetch details based on unique attributes. Filtering can be done with the help of list APIs. You can refer API java docs regarding those attribute.

[{"Product":{"code":"SS6PEW","label":"Sterling Order Management"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"Documentation","Platform":[{"code":"PF033","label":"Windows"}],"Version":"9.3","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Document Information

Modified date:
11 February 2020

UID

swg22015326