Siebel Advisor API Reference > Siebel-Specific Functions for Siebel Advisor >

GetPrice


Usage

Use the GetPrice function to return and display the final price of the selected product for the user. When the call is made, a pop-up window will display showing the current product price. The price will include any pricing adjustments if configured within the Siebel pricing engine.

GetPrice can be called from any frame within the application and can be executed anywhere a JavaScript function can be used. It is commonly called from the onClick event handler of a link, but can also be referred to from an image map, set as the SUBMIT method of an embedded frame, or called from another user-defined JavaScript function.

Refer to the Runtime Access to Your Pricing Information topic in Siebel Advisor Administration Guide for more information.

Syntax

GetPrice(productDescriptionString)

Argument
Description

productDescriptionString

Optional argument used as the description for the customizable product to be added. If productDescriptionString is not specified, the model and state are examined to automatically build a customizable product description before adding the product to, and displaying, the quote or order.

You can define ProductDescriptionString in the following ways:

  • As <product ID>
  • As a fully formed string, built by hand or using helper APIs (see BuildProductStr). Use the form:

    relationship=<relationship name>&*prodID=<prodID>&*qty=<quantity>&*attributes=
    {<key1>=<value1>&*<key2>=<value2>&*...}&*children=
    {<child1>|*<child2>|*...}

  • As null to specify not to extract a string
Example

ISS.GetPrice(ISS.GetBusCompID("CAR.COLOR"));

ISS.GetPrice();

ISS.GetPrice(ISS.GetResultsValue("CONSTRUCTED_PRODUCT"));

Additional Pricing Functions

You can modify the behavior of GetPrice by using the following functions. Call these functions from the customCode.js file if they are application specific. Call them from the _i file if they are page-level specific.

  • ORP_DisplayPrice

    Allows you to write custom code to bypass the entire code. The user is passed the same information, including the price object, that is returned from the server and all the configuration variables.

  • ORP_DisplayPriceString

    Allows you to write custom code to bypass the entire code. This function allows you to override the final display of the data. This function is useful if you want to override the default behavior of opening a pop-up window for displaying the price.

  • COP_BeforeDisplayPriceString

    Allows you to manipulate the HTML string before it appears in the window.

For more information on these functions, see Callout Point Functions for Siebel Advisor.

Accessing the Additional Pricing Functions

Use the following accessories to the price object to access the additional pricing functions:

  • GetField (fieldName)

    Retrieves the value specified by fieldName.

  • GetChildren ( )

    Returns an array of price objects or an empty array if there are no children.

Siebel Advisor API Reference Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.