Bookshelf v7.5: Product Manipulation Toolkit Business Service Methods

The Product Manipulation Toolkit (PMT) business service is a set of methods that can be linked to implement order processing workflows. These workflows maintain the service profile as orders are provisioned.

Then this section describes all the methods that the PMT business service calls, which are summarized in Table 8.

Table 8. PMT Methods
Method	Comment
Delta	Generates the actions necessary to change an existing customizable product (asset) into a new customizable product. The set of actions can be written to a quote or an order.
Apply	Applies changes defined by a Sales order line item to a customizable asset.
Trim	Eliminates line items from a delta quote or delta order if they do not meet the requirements specified in the input arguments. This action produces a new trimmed quote or order. The method determines which changes in a customizable order item to apply to the service profile stored in Assets.
Explode	Creates multiple instances of a product. The number of instances is determined by the value of the field defined by the ExplodeOnField argument. For each new instance, the value of ExplodeOnField is set to 1. An existing instance is considered for explosion only if it meets the conditions specified by ConditionFieldNames and ConditionValues.
Explode Siebel Object	Functions like Explode except that it also loads the SiebelMessage integration object from the Siebel database with a specified business component and synchronizes it back to the database after the explosion.
Find Orders	Given the asset integration Id of a root line item, this method finds all instances of order items that have the same asset integration Id. The order header, matching line item, its child items and attributes are returned as part of the output. Other lines item in the same order header with a different integration Ids are not returned.
Logical Delete	Converts any item of a product instance that has a Deleted action code to an Update action code and an Inactive status. Logical Delete only works with a product instance of the Order type. In other words, the Integration Object passed in the SiebelMessage is based on the Order Entry business object.
Assign New Service IDs	Assigns a service point Id, associated with a specified premise, to each item of the input complex object where the service point type matches the service type of the product.
Convert Product Instance	Converts a product instance of one type to another; for example, quote to order.
Get Instance	Gets a complex product instance from the Product Configurator.
Get Profile Attribute	Returns the value of the specified attribute of the user profile.
Is Fully Exploded	Checks a product instance to determine if an explode operation is required, based upon the value specified by ExplodeOnField. If the field value is greater than 1 for any component of the product instance, the method returns N. Otherwise, the method returns Y.
Is Module Licensed	Determines whether or not the specified module is licensed.
Merge	Merges the components of one integration object (product instance) under the header of another integration object.
Quote To Revenue	Generates revenue line items for each line item in a quote that matches the criteria specified by the input conditions. The line items are associated with the opportunity from which the quote was created.
Reconfigure Product Instance	Displays the asset that was passed to the Product Configurator as input, in the Configurator UI.
Reset	Clears out all cached product instances.
Retrieve Next Object From List	Given a hierarchical integration object with multiple root components at the second level, this method returns an integration object that contains the header, one root component, its children and their attributes.
Set Action	Sets the Action Code field of all items in the hierarchy of a given product instance to the specified value.
Set Exception Error Message	Called from the workflow to get the localized error message text that is associated with the input error code.
Set Field Value	Sets a specified field to the given values for all items in the product instance that meet an optional condition.
Set Multiple Field Values	Sets specified fields to the given values for all items in the product instance.
Set Output Header	Caches the output header that will be used by the Apply and Delta methods.
Set Product Instance	Caches a product instance that will be used as an input arguments for Apply and Delta methods.
Set Profile Attribute	Assigns values to attributes in a user profile.
Synchronize	Synchronizes product instance to the database. Optionally, this method also reprices the instance after it is synchronized by calling the Pricing Manager Reprice/RepriceAll. This method calls the EAI Siebel Adapter Execute method to synchronize or upsert.
Update Multi Object List	After a root integration component is stripped from the integration object, this method (in conjunction with Retrieve Next Object From List) returns the resulting integration object.
Update Order Line Item Completed Flag	Sets the Order Item Processed Flag of the root order line item to Y, if its status and that of all its child items is Complete, Rejected, or `-`.
Get Cfg Button Click Information	Notifies when a user has clicked Cancel or Done in the Complex Product view.
Refresh Business Component	Reexecutes all instances of the specific buscomp to get data from the database.
Invoke BC Method	Allows a business component-based method to be invoked from a workflow. Acts as a bridge to pass the business component name and method name, along with the parameters, and returns the value required from the workflow to the specified business component