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.

The two primary methods in this toolkit are:

• Delta. Creates a Quote or Order that defines the changes required to convert the initial state of an Asset into the final state of an Asset.

• Apply. Applies changes defined in Quotes and Orders to an Asset, putting the Asset into a new state.

The toolkit also provides a number of methods to support Delta and Apply.

This topic begins with a description of User Properties Used by PMT Methods. Then this topic describes all the methods that the PMT business service calls, which are summarized in the following table.

Method	Comment
Delta Method	Generates the actions necessary to change an existing product with components (asset) into a new product with components. The set of actions can be written to a quote or an order.
Apply Method	Applies changes defined by a Sales order line item to a customizable asset.
Trim Method	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 Method	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 Method	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 Method	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 Method	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 Siebel Message is based on the Order Entry business object.
Assign New Service IDs Method	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 Method	Converts a product instance of one type to another; for example, quote to order.
Get Instance Method	Gets a complex product instance from the Product Configurator.
Get Profile Attribute Method	Returns the value of the specified attribute of the user profile.
Is Fully Ex Method	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 Method	Determines whether or not the specified module is licensed.
Merge Method	Merges the components of one integration object (product instance) under the header of another integration object.
Quote To Revenue Method	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 Method	Displays the asset that was passed to the Product Configurator as input, in the Configurator UI.
Reset Method	Clears out all cached product instances.
Retrieve Next Object From List Method	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 Method	Sets the Action Code field of all items in the hierarchy of a given product instance to the specified value.
Set Exception Error Message Method	Called from the workflow to get the localized error message text that is associated with the input error code.
Set Field Value Method	Sets a specified field to the given values for all items in the product instance that meet an optional condition.
Set Multiple Field Values Method	Sets specified fields to the given values for all items in the product instance.
Set Output Header Method	Caches the output header that will be used by the Apply and Delta methods.
Set Product Instance Method	Caches a product instance that will be used as an input arguments for Apply and Delta methods.
Set Profile Attribute Method	Assigns values to attributes in a user profile.
Synchronize Method	Synchronizes product instance to the database. Optionally, this method also reprices the instance after it is synchronized by calling Pricing Manager Reprice or RepriceAll. This method calls the EAI Siebel Adapter Execute method to synchronize or upsert.
Update Multi Object List Method	After a root integration component is stripped from the integration object by the Retrieve Next Object From List method, this method returns the resulting integration object.
Update Order Line Item Completed Flag Method	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 Method	Identifies the button the user has clicked in the Complex Product view.
Refresh Business Component Method	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
Iterate Process For Selected Rows Method	Loops through all selected rows in the active business component and initiates the specified workflow process for each row.
Get Selected Row Count Method	Returns the number of rows selected in the active business component (for example, the business component that initiated the workflow).
Get First Selected Row Values Method	Queries the active business component for a given set of field values (specified by the Fields argument) to be assembled and returned in the output property set.
Ungroup Method	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.