Generic InstallShipment business object

The Generic InstallShipment business object contains sufficient information to create Installed Products in a destination application. This information includes, but is not limited to, the shipment date, ship-to customer, shipped items, quantity shipped, carrier, and the bill-of-lading. Generic InstallShipment is based on a typical ERP delivery or shipping document.

In addition to providing the generic InstallShipment business object, IBM also provides generic InstalledProduct. Generic InstalledProduct contains information about products that have been installed at customer sites.

The generic InstalledProduct business object is used by both the InstalledProductSync and ProductInstallation collaboration templates. The generic InstallShipment business object is used only by the ProductInstallation collaboration template.

For more information on when and how to use the InstalledProductSync and ProductInstallation collaboration templates, see their reference pages.

Business object structure

InstallShipment is a hierarchical business object. Figure 1 illustrates its relationship to its child business objects.

Figure 1. Generic InstallShipment business object structure

InstallShipment contains unique identifiers for the site to which an item is shipped, contacts for the shipment, location from where the product is being shipped, product being shipped, and waybill or FedEx tracking number.

InstallShipment also contains such information about the shipped item as its description, type and category, status, plant, revision number, warranty number, quantity, sales order number purchase order number, serial number, lot number, total weight, and unit of measure.

InstallShipment contains the dates for the product, such as its planned ship date, actual ship date, and arrival date.

InstallShipment contains the following child business objects:

Business object attributes
Child business object Description Cardinality
InstallShipmentLine Contains information relevant for an InstallShipmentLine item, such as the item and quantity shipped. n
ContactRef Contains the reference to the contacts for the header business object for the InstallShipmentLine line item; for example, the name of the contact at the customer site that purchased and is expecting a shipped item. n
RelatedCustomerRef Contains the reference to the customers or customer partners for the InstallShipment; for example, the person to whom the installed items are shipped. n
CharacteristicRef Contains any special configuration for the InstallShipmentLine item. This business object is used if an item has configurable options such as size and color that are configurable. n

Supported verbs

IBM uses InstallShipment with the create verb for Event Notification (receiving from the source application).

For request processing, (sending to the destination application) the ProductInstallation collaboration template uses the generic InstalledProduct business object instead of InstallShipment.

Examining the object

For a listing of InstallShipment's attributes, use System Manager or Process Designer Express.

Related Reference

Copyright IBM Corp. 1997, 2004