19Technical Reference for the Price Comparison Feature
Technical Reference for the Price Comparison Feature
This appendix provides detailed technical information about the Price Comparison feature in Siebel Energy. It includes the following topics:
Components of the Pricing Calculator
The components that make up the pricing calculator follow:
SmartScript to collect user inputs. For more information, see SmartScript for Price Comparison.
The following primary workflows:
SIS OM PC Comparison workflow. For more information, see SIS OM PC Comparison Workflow.
SIS OM PC Enrollment workflow. For more information, see SIS OM PC Enrollment Workflow.
The following primary methods called by the workflows:
Bill Decomposer. For more information, see Bill Decomposer Method.
Comparison Generator. For more information, see Comparison Generator Method.
Other Siebel workflows and methods.
SmartScript for Price Comparison
The SIS OM SmartScript functionality can be conceptually broken into the following parts:
Business component classes that invoke the SIS OM SmartScript
SIS OM SmartScripts (one standard and one high interactivity version)
SIS OM SmartScript engine classes
The EPC Admin VBC business component
SIS OM PC Workflows that use SmartScript answers collected by the SIS OM SmartScripts
This topic describes all these parts followed by user property descriptions and a graphic showing the SmartScript text.
Business Component Classes
These business component classes are used to invoke the SIS OM SmartScript. These classes contain the following methods:
Method SISOMCreateQuote in class CSSSIABCQuote
In Siebel eSales, this method is called using the Compare Price link on the Home page. Invoking this method from these standard interactivity applications invokes the standard interactivity SmartScript.
In Siebel Energy, this method is invoked from the PC Price Comparison view. Invoking this method from this high interactivity application causes the high interactivity SmartScript to run.
Note: In Siebel Energy, this class is used by the Quote business component. When this method is invoked from the PC Price Comparison view, the parent Opportunity business component is associated with the Quote business component. In this case, the current Opportunity row ID and Opportunity name are passed as input to the SmartScript when this method is called. The SmartScript then passes these values to the workflow that is invoked when the SmartScript Finish button is clicked.
Method SISOMRunPCReport in class CSSSISOMBCProductRelationship
This method can be used to run the SIS OM SmartScript in report mode. The method is invoked when the CP Report button from the Product Relationship view in Siebel Energy is clicked.
Note: Do not use this method when the application uses the standard-interactivity client.
SIS OM SmartScript
There are two versions of the SIS OM SmartScript.
SIS OM PC Comparison SmartScript - HI. This version is the high interactivity version used in Siebel Energy.
SIS OM PC Comparison SmartScript - LI. This version is the standard interactivity version used in Siebel eSales and Siebel Partner Relationship Management for Siebel Energy.
SIS OM SmartScript Engine Classes
The following classes make up the SIS OM SmartScript Engine:
CSSSWESISOMFrameWebCallScriptPlayer, used by the SIS OM SmartScript Player Applet
CSSSISOMBCVCallScriptPlayer, used by the business component SIS OM SmartScript Player
SIS OM PC Workflows
There are two preconfigured SIS OM PC workflows that are invoked by the SIS OM SmartScript. For more information about these workflows, see SIS OM PC Competitive Pricing Report Process Workflow and SIS OM PC Comparison Workflow.
SIS OM PC Competitive Pricing Report workflow. This workflow is invoked when the CP Report button is clicked in the Product Relationship view in Siebel Energy.
SIS OM PC Comparison Process workflow. This workflow is called inSiebel Energy when the CP Report button is clicked in the PC Price Comparison view. For Siebel eSales for Siebel Energy, this workflow is called from the Compare Price link on the Home page.
EPC Admin Virtual Business Component
The EPC Admin virtual business component is used to specify data sources (that is, LOVs and business components) in which SmartScript answers for a particular question can be found. For more information, see Siebel SmartScript Administration Guide.
SIS OM SmartScript Player User Properties
The following business component user properties, used by the SIS OM SmartScript Player business component, are used to enable the following SIS OM PC specific functionality.
Off Page Answer Branching
This set of user properties allows a SmartScript to branch to a different SmartScript page, using a SmartScript answer from another page.
SIS OM Branch Question. Specifies which SmartScript question contains the answer used for off page branching.
SIS OM Branch Answer. Specifies which SmartScript answer triggers branching. This value is in language independent code.
SIS OM Branch Answer LOV. Specifies the LOV used in conjunction with user property SIS OM Branch Answer to find the language dependent value.
SIS OM Branch Trigger Answer. The value of this user property is used to find the SmartScript question that contains the off answer branch. The SmartScript question must have this value specified as its default answer.
Dynamic Answers
This functionality allows the SmartScript to dynamically find, using a business service, the possible SmartScript answers for the Rate Plan and Supplier questions for both the electricity and gas questions.
SIS OM PC Service Name. Name of the business service that contains the methods used to get the Rate Plan (Get Area Rate Plan Names) and the Supplier (Get Area Supplier Names). Do not change the value of this user property.
SIS OM Question Service Type. Specifies which question is used to get the Service Type (Electricity or Gas). The Service Type is used as input to the Get Area Rate Plan Names and Get Area Supplier Names methods.
SIS OM Question Electric Service Area. Specifies which SmartScript question contains the electricity Service Area question. The Service Area is used as input to the Get Area Rate Plan Names and Get Area Supplier Names methods.
SIS OM Question Electric Supplier Name. Specifies which SmartScript question contains the electricity Supplier Name question. The answers that this SmartScript question displays come from calling the SIS OM PC Service business service’s method and Get Area Supplier Names.
SIS OM Question Electric Rate Plan. Specifies which SmartScript question contains the electricity Rate Plan question. The answers that this SmartScript question displays come from calling the SIS OM PC Service business service’s Get Area Rate Plan Names method.
SIS OM Question Gas Service Area. Specifies which SmartScript question contains the gas Service Area question. The Service Area is used as input to the Get Area Rate Plan Names and Get Area Supplier Names methods.
SIS OM Question Gas Supplier Name. Specifies which SmartScript question contains the gas Supplier Name question. The answers that this SmartScript question displays come from calling the SIS OM PC Service business service’s method and Get Area Supplier Names.
SIS OM Question Gas Rate Plan. Specifies which SmartScript question contains the gas Rate Plan question. The answers that this SmartScript question displays come from calling the SIS OM PC Service business service’s Get Area Rate Plan Names method.
Report Mode
These user properties are used when the SmartScript is in report mode. The SmartScript is in report mode when the SmartScript is invoked from the Relationship view New button (method invoked SISOMRunPCReport using class CSSSISOMBCProductRelationship).
SIS OM Report Mode: No Answer Validation #. Specifies which SmartScript questions do not have to be answered when in report mode. If a SmartScript question is empty (blank) and it uses this user property, then it is assumed that All SmartScript answers were selected for this question.
SIS OM Report Mode: On Finish View. Specifies which view appears after the report workflow is started.
SIS OM Report Mode: SIS OM Finish Workflow. Specifies which workflow is called to generate the report when the SmartScript Finish button is clicked.
General User Properties
SIS OM Finish Workflow. Specifies which workflow is called when the SmartScript Finish button is clicked.
SIS OM Pricing Calculator Business Service
This topic includes information about business properties for some methods in the SIS OM Pricing Calculator business service. For more information about this business service, see SIS OM Pricing Calculator Business Service.
CP Report Create Quotes Method
The following user properties are used by the CP Report Create Quotes method, which is used to create the data set used when generating a report.
Dual Fuel Service Type. Specifies the language independent code used to specify the dual fuel Service Type.
Service Type Question Name. Specifies which SmartScript question in the SmartScript answer table contains the Service Type.
Electric Region Question Name. Specifies which SmartScript question in the SmartScript answer table contains the electricity Region (Service Area).
Electric Service Type. Specifies the language independent code used to specify the electricity Service Type.
Electric Supplier Question Name. Specifies which SmartScript question in the SmartScript answer table contains the electricity Supplier.
Electric Tariff Question Name. Specifies which SmartScript question in the SmartScript answer table contains the electricity Tariff (Rate Plan).
Gas Region Question Name. Specifies which SmartScript question in the SmartScript answer table contains the electricity Region (Service Area).
Gas Service Type. Specifies the language independent code used to specify the gas Service Type.
Gas Supplier Question Name. Specifies which SmartScript question in the SmartScript answer table contains the gas Supplier.
Gas Tariff Question Name. Specifies which SmartScript question in the SmartScript answer table contains the gas Tariff (Rate Plan).
Run SmartScript Method
The following user properties are used by the Run SmartScript method as defaults if these values are not specified as input to this method.
SIS OM ScriptName - HI. Specifies the default SIS OM SmartScript to run if the application uses the high-interactivity client.
SIS OM ScriptName - LI. Specifies the default SIS OM SmartScript to run if the application uses the standard-interactivity client.
SIS OM ViewName. Specifies the default view that contains the SIS OM SmartScript Engine.
The following image shows the SmartScript text for the Price Comparison feature.
The transcript of the SmartScript text in the previous image follows:
You would like to see a price comarision for: - gas/electricity/both (if both, user will go through questions for gas AND electricity) Please select your Service Area: - (List of Areas) Who is your current supplier? - (Price lists where price list item has product category = "Electricity" AND product attribute Area = Service Area) What is your current tariff? - (Price list items where price list = current suspplier AND product category = "Electricity" AND product atribute Area = Service Area) Are you on a budget plan? If YES, AND you currently pay by monthly direct debit: - What is your monthly payment? - (Current amount) - What is the meter type? - (List of meter types) - STARTS PRICE COMPARISON WORKFLOW If NO, how do you currently pay? If you currently pay by monthly direct debit: - What is your monthly payment? - (Currency amount) - What is the meter type? - (List of meter types) - STARTS PRICE COMPARISON WORKFLOW If you pay by receipt of bill: - What bill information do you have? (Usage/bill) - For what period is the information? (Annual/Summer Quarter/Summer Month/Winter Quarter/Winter Month) - Please ener the amount (KWh or curency amount)
SIS OM Pricing Calculator Business Service
The SIS OM Pricing Calculator (PC) business service is a set of methods that implements the back-end calculation engine for the pricing calculator. Different workflows, which provide the business flow of this functionality, invoke the methods.
The two primary methods, Bill Decomposer and Comparison Generator, decompose a utility bill from a prospective customer into the usage breakdown and use that data to determine the comparable internal rate plans that best meet the customer's criteria.
More specifically, Bill Decomposer receives a PC Competitor quote that represents the utility bill from a competitor as input. Using the details of competitors' rate plans stored in the Siebel database, Bill Decomposer then reverse-engineers the utility bill information to deduce the usage breakdown of this prospective customer. It stores the result in the PC Competitor quote.
The quote is then passed to Comparison Generator, which looks up the internal rate plans to locate those that meet the customer's requirements. Comparison Generator then creates a PC Comparison quote for each of those matching rate plans and uses the Pricing Engine to calculate the potential savings available to prospective customers, if they switch to the rate plans.
User Properties for Pricing Calculator Methods
Pricing Calculator methods use the following user properties:
XA Name - Area. Name of the product attribute used to store the service area where the rate plan is being offered.
XA Name - Usage Type. Name of the product attribute used to store the usage breakdown category of the rate plan. The preconfigured value of this property is Usage Type.
Usage Type n. Valid values for the Usage Type attribute specified by the XA Name - Usage Type user property. For example:
| Name | Value |
|---|---|
Usage Type 1 |
Peak |
Usage Type 2 |
Off Peak |
Usage Type 3 |
Threshold |
Threshold Usage Type. Value of the Usage Type attribute that is handled as the threshold usage (that is, the number of units charged at a specified price before applying other pricing rules). The preconfigured value is Threshold.
Peak. Name of the field of the SIS OM PC Usage Profile business component that is used to store the Peak category of usage breakdown.
Off Peak. Name of the field of the SIS OM PC Usage Profile business component used to store the Off Peak category of usage breakdown.
Must Match XA n. Names of product attributes that an internal rate plan must possess to be qualified as a match to the current rate plan used by the prospective customer. For example:
| Name | Value |
|---|---|
Must Match XA 1 |
MeterType |
Must Match XA 2 |
Region |
PC Type n. Names of all the basic (non-dual) service types of products used in the Pricing Calculator functionality. For example:
| Name | Value |
|---|---|
PC Type 1 |
Electricity |
PC Type 2 |
Gas |
Dual Fuel Service Type. Name of the service type of products designated for dual fuel discount processing.
SIS OM ViewName. Default view to use when displaying the PC SmartScript. It is used by the Run SmartScript method.
SIS OM AppletName. Default applet to use when displaying the PC SmartScript. It is used by the Run SmartScript method.
SIS OM ScriptName - HI. Default SmartScript script to use for the high-interactivity client. It is used by the Run SmartScript method.
SIS OM ScriptName - LI. Default SmartScript script to use for the standard-interactivity client. It is used by the Run SmartScript method.
Adding a Usage Type for the Pricing Calculator
To add a new usage type for the pricing calculator, follow this procedure.
To add a usage type for the pricing calculator
Add the new value to the attribute specified by the user property XA Name - Usage Type.
Add a new user property Usage Type n to specify this new value.
Add both a new field to the SIS OM PC Usage Profile business component and a new column to its underlying table for the data storage.
Add a new user property with this new usage type as the name, and add the Business Component field name (previously added) as the value.
Bill Decomposer Method
This method decomposes a utility bill provided by a prospective customer into the usage breakdown. The calculation is based on a number of billing parameters derived from the information in the utility bill. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
PCMultiQuotes
[in/out] List of SIS OM Quote integration object instances that are used to store the utility bill information provided by a prospective customer. The usage breakdown is also written back into this quote structure as output. (Required)
Returns
List of SIS OM Quote integration object instances that contain the usage breakdown.
Remarks
The usage breakdown is represented in a quote integration object as the Quantity field of a usage sub-line item with the Usage Type attribute set to a specific value (for example, Threshold, Peak, Off Peak).
Related Topic
Comparison Generator Method
This method locates the comparable internal rate plans that match the rate plan currently provided to the prospective customer by a competitor. It creates a quote of type PC Comparison for each of the matching internal rate plans, setting the Quantity field to the usage breakdown obtained from the PCMultiQuotes input (which is usually generated from the Bill Decomposer Business Service method). This method is part of SIS OM Pricing Calculator Business Service.
Arguments
PCMultiQuotes
[in] List of SIS OM Quote integration object instances that are used to store the utility bill information provided by a prospective customer, along with the usage breakdown calculated by the Bill Decomposer method. (Required)
Opportunity
[in] Name of the opportunity object under which the generated PC Comparison quotes are stored. (Required)
PriceList
[in] Name of the Price List that contains the collection of internal products from which matching rate plans are located. (Required)
OpportunityRevenueAmt
[out] Summation of the total bill amount for each of the utility bills represented in the PCMulti Quotes input argument.
Returns
OpportunityRevenueAmt
Total bill amount the prospective customer is paying a competitor for.
Remarks
The usage breakdown is represented in a quote integration object as the Quantity field of a usage sub-line item with the Usage Type attribute set to a specific value (for example, Threshold, Peak, Off Peak).
Related Topics
Update Status Method
This method searches for all quotes with a certain type for a given opportunity and updates a user-specified field in those quotes. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
Opportunity Id
[in] ID of the opportunity for which the quotes are to be updated. (Required)
QuoteType
[in] Type of the quotes for which the user wants to query. (Required)
FieldName
[in] Name of the field in the quote business component that the user intends to update. (Required)
FieldValue
[in] Value to be set to the field in the quote business component that the user intends to update. (Required)
Returns
None.
Remarks
In the preconfigured use of this method, the value of Opportunity Id is passed through the Named Method that invokes the SIS OM PC Enrollment workflow, within which the other values of QuoteType, FieldName and FieldValue are set.
Related Topic
Get Area Rate Plan Names Method
This method locates available rate plans provided by any company (supplier) within a service area. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
Supplier Name
[in] Name of the company with the needed rate plans. (Optional)
Service Area
[in] Region within which the rate plans are needed. (Optional)
Service Type
[in] Type of service for search. Possible inputs are Gas, Electricity, or Dual Fuel. (Required)
Returns
List of rate plans that match the criteria.
Remarks
The list of rate plans is returned in a string in this structure: Plan 1, Plan 2, and so on.
Get Area Supplier Names Method
This method returns the list of supplier names for a given service type in a given service area. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
Service Area
[In] Region within which the rate plans are needed. (Optional)
Service Type
[In] Type of service for search. Possible inputs are Gas, Electricity, or Dual Fuel. (Required)
Returns
List of supplier names that match the criteria.
Remarks
The list of supplier names is returned in a string in this structure: Company 1, Company 2, and so on.
Run SmartScript Method
This method is used to run the pricing calculator's SmartScripts. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
Script Name
[in] Name of the SmartScript to run. (Optional)
If this parameter is not supplied, then the business service user property SIS OM ScriptName - HI is used to find the default SmartScript when running in the high-interactivity client. When running in the standard-interactivity client, the business service user property SIS OM ScriptName - LI is used to find the default SmartScript. For more information, see User Properties for Pricing Calculator Methods.
Applet Name
[in] Name of the applet used to display the SmartScript. (Optional)
If this parameter is not supplied, then the business service user property SIS OM AppletName is used to find the default applet. For more information, see User Properties for Pricing Calculator Methods.
View Name
[in] Name of the view used to display the SmartScript. (Optional)
If this parameter is not supplied, then the business service user property SIS OM ViewName is used to find the default view. For more information, see User Properties for Pricing Calculator Methods.
Currency Code
[in] Sets the current code used by the SmartScript. (Optional)
Language Code
[in] Sets the language code used by the SmartScript. (Optional)
Script Id
[in] Used to rerun a previous SmartScript session. (Optional)
Returns
None
Convert PC Quote to Quote Method
This method converts a Price Comparison (PC) Quote into a regular quote. The quantity for usage products is reset to 1, which is the number of items to be ordered. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
Account
[in] Name of the account for the PC Quote. (Optional)
QuoteId
[in] Quote Id of the PC Quote that is to be converted to a regular quote. (Required)
SiebelMessage
[out] Property set output that represents the regular quote. (Optional)
AutoSync
[in] True or false value used to synchronize the regular quote to the database. For performance reasons, this value is usually not specified and the regular quote is synchronized to the database after other operations that follow this step.
Returns
SiebelMessage
Property set output that represents the regular quote.
Related Topic
Convert PC Input to PC Quote Method
The answers from a SmartScript session are taken as the Pricing Calculator input and are converted into a Competitor Quote. Multiple quotes are created as appropriate by using the SmartScript answers. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
PCMultiQuotes
[out] List of SIS OM Quote integration object instances that are used to store the utility billing information provided by a prospective customer. (Required)
Opportunity
[in] Name of the opportunity object under which the generated PC Comparison quotes is stored. (Required)
OpportunityId
[in] ID of the opportunity object under which the generated PC Comparison quotes is stored. (Required)
RunId
[in] RunId of the SmartScript session in which the answers are stored. This value typically is a process property that is set internally when the SmartScript session is finished. (Required)
Returns
PCMultiQuotes
List of SIS OM Quote integration object instances that are used to store the utility billing information provided by a prospective customer.
Related Topic
Setup Question Field Map Method
This method determines the type of the question, the name of the business component, and the field in which the answer to a specific SmartScript question is stored. This step is required before the PC Input to PC Quote conversion method is called. This method is part of SIS OM Pricing Calculator Business Service.
The syntax for the arguments is: type-buscomp-field, where type is a value of PC Type n user properties.
Arguments
Electricity-Quote Item-Product
Electricity-Quote Item XA-Meter Type
Electricity-Quote Item XA-Payment Method
Electricity-Quote Item-Usage CxTotal
Electricity-Quote-Bill Period
Electricity-Quote-PC Bill Info
Electricity-Quote-PC Budget Plan
Electricity-Quote-Price List
Electricity-Quote-Region
Gas-Quote Item XA-Meter Type
Gas-Quote Item XA-Payment Method
Gas-Quote Item-Product
Gas-Quote Item-Usage CxTotal
Gas-Quote-Bill Period
Gas-Quote-PC Bill Info
Gas-Quote-PC Budget Plan
Gas-Quote-Price List
Gas-Quote-Region
[in] A list of mapping arguments that are mapped to a corresponding question name. The list is defined whether a customer chooses to answer all questions at runtime. The argument values are the question names. (Required)
Returns
None
Related Topic
Delete Existing PC Quotes Method
This method deletes existing PC Quotes for a given opportunity. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
Opportunity
[in] Name of the opportunity for which all the existing PC Quotes are deleted. (Required)
Returns
None
Remarks
The Delete PC Quotes Search Spec user property of the Quote business components specifies the search specification to be used by the method to determine which quotes to delete.
Related Topic
CP Report Create Quotes Method
This method is an intermediate step in the generation of the Competitive Pricing report. It takes input from a SmartScript session and reads the Pricing Calculator Relationship entries. It replaces some of the SmartScript answers and generates a quote for each In-House entry in the Relationship table and a matching quote for each like-for-like Competitor entry. This method is part of SIS OM Pricing Calculator Business Service.
Since this method invokes Convert PC Input to PC Quote internally, its arguments are formed as for that method, and passed through. CP Create Quotes directly uses only the RunId of the SmartScript session.
Arguments
PCMultiQuotes
[out] A list of SIS OM Quote integration object instances that are used to store the utility billing information provided by a prospective customer. (Required)
Opportunity
[in] The name of the opportunity object under which the generated PC Comparison quotes is stored. (Required)
OpportunityId
[in] The Id of the opportunity object under which the generated PC Comparison quotes is stored. (Required)
RunId
[in] The RunId of the SmartScript session in which the answers are stored. This value typically is a process property that is set internally when the SmartScript session is finished. (Required)
Returns
PCMultiQuotes
A list of SIS OM Quote integration object instances that are used to store the utility billing information provided by a prospective customer.
Get Next RowId Method
This method generates a unique RowId that can be used to populate required fields in business components. This method is part of SIS OM Pricing Calculator Business Service.
Arguments
RowId
[out] The automatically-generated RowId is returned.
SIS OM PC Comparison Workflow
The SIS OM PC Comparison Process is called by a SmartScript session. The SmartScript session is invoked by clicking the New button in the SIS OM PC Opportunity Price Comparison view or by clicking the Compare Prices link on Oracle’s Siebel eSales Home Page.
The following shows this workflow.
Workflow Description
This workflow performs the following actions:Opportunity Null? Delete Existing PC Quotes. These steps check to determine whether an opportunity exists for the Price Comparison. If an opportunity exists, then all existing quotes that meet the specified criteria are deleted. Preconfigured quotes of type PC Comparison, PC Like for Like, and PC Competitor are deleted.
Get New RowId. Create Opportunity. These steps create a new opportunity if an opportunity does not exist.
Setup Question-Field Mapping. This step maps the SmartScript session questions to fields of a quote.
PC Input to PC Quote. This step converts the answers from the SmartScript session into a competitor quote using the mapping created in the previous step.
Bill Decomposer. This step uses the Bill Decomposer method and the competitor quote information to calculate the user's annual usage.
Price Comparison. This step uses the Price Comparison method to generate a comparison quote for each product offered by the company that meets the criteria specified by the user. The usage amounts calculated by this step are used to calculate the projected annual bill given the pricing of the product.
Goto Price Comparison View. This step shows the comparison quotes in the Opportunity Price Comparison view. For more information, see SIS OM Goto Price Comparison View Workflow.
The following lists the SIS OM PC Comparison Workflow steps, methods, and business services.
| This Workflow Step | Calls This Method | In This Business Service |
|---|---|---|
Delete Existing PC Quotes |
Delete Existing PC Quotes |
SIS OM Pricing Calculator Service |
Get New RowId |
Get Next RowId |
SIS OM Pricing Calculator Service |
Setup Question-Field Mapping |
Setup Question Field Map |
SIS OM Pricing Calculator Service |
PC Input to PC Quote |
Convert PC Input to PC Quote |
SIS OM Pricing Calculator Service |
Bill Decomposer |
Bill Decomposer |
SIS OM Pricing Calculator Service |
Price Comparison |
Comparison Generator |
SIS OM Pricing Calculator Service |
SIS OM Goto Price Comparison View Workflow
The SIS OM Goto Price Comparison View workflow is invoked as a subprocess of the SIS OM PC Price Comparison workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following actions:Set Competitor Quote Total Bill. This step sets the Primary Revenue Amount of the Opportunity to the total bill amount, passed as an input to the workflow.
Application Type. This step checks the application that invokes the workflow.
Set Profile Attribute. CUT PC Comparison View. These steps store the Opportunity Id as a profile attribute and show the CUT Opportunity PC Price Comparison View (eSales) if the application is eSales.
SIS OM PC Comparison View. This step shows the SIS OM Opportunity PC Price Comparison View.
The following lists the Goto Price Comparison Workflow steps, methods, and business services.
| This Workflow Step | Calls This Method | In This Business Service |
|---|---|---|
Set Profile Attribute |
Set Profile Attribute |
SIS OM Product Manipulation Toolkit Service |
SIS OM PC Enrollment Workflow
The SIS OM PC Enrollment workflow is invoked by clicking the Enroll button in the SIS OM PC Opportunity Price Comparison View or the CUT Opportunity PC Price Comparison View (eSales).
The following shows this workflow.
Workflow Description
This workflow performs the following actions:Account Exist? This step checks to determine whether an account is associated with the opportunity.
Check Application Name. Create Account Subprocess. These steps show the SIS OM PC Account Entry view to allow the user to create a new account if an account does not exist and if the application that invoked the workflow is not eSales. For more information, see SIS OM PC Create Account Subprocess Workflow.
Yes or No. Go Back to Opportunity View. These steps check to see whether an account was created. If an account was not created, then the user is returned to the SIS OM PC Opportunity Price Comparison view. For more information, see SIS OM PC Go To Opportunity View Workflow.
Set Opportunity Account. This step associates the account with the opportunity if the user created a new account. For more information, see SIS OM PC Set Opportunity Account Workflow.
Convert PC Quote to Quote. This step converts the comparison quote i to a regular quote that can be progressed through the order life cycle.
Set Status for PC Comparison. Set Status for PC Competitor. These steps set the Status of the comparison and competitor quotes to Order Placed.
Application is eSales? CUT eSales PC Enrollment. These steps merge the comparison quote with the shopping cart if the application that invoked the workflow is eSales. For more information, see CUT eSales - PC Enrollment Workflow.
Quote to Order. SIS OM Sync. Get Order Id. Go To Order Line Items View. These steps convert the quote to an order and show the order in the Order Line Item view if the application is not eSales. For more information, see SIS OM PC Go to Order Entry - Line Items View (Sales) Workflow.
The following lists the SIS OM PC Enrollment Process steps, methods, and business services.
| This Workflow Step | Calls This Method | In This Business Service |
|---|---|---|
Convert PC Quote to Quote |
Convert PC Quote to Quote |
SIS OM Pricing Calculator Service |
Set Status for PC Competitor |
Update Status |
SIS OM Pricing Calculator Service |
Quote to Order |
Convert Product Instance |
SIS OM Product Manipulation Toolkit Service |
SIS OM Sync |
Synchronize |
SIS OM Product Manipulation Toolkit Service |
SIS OM PC Create Account Subprocess Workflow
The SIS OM PC Create Account Subprocess is invoked as a subprocess of the SIS OM PC Enrollment workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following actions:
Create New Account? This step shows the SIS OM PC Account Entry Selection View, and the user is asked whether to create a new account. If the user clicks No, then an account is not created and the subprocess terminates.
Create New Account. This step creates a new account if the user clicks Yes.
Get User Input. This step shows the SIS OM PC Account Entry View to allow the user to enter the details of the account. The user clicks Continue.
Get Account Name. This step retrieves the name of the account and returns it to the calling workflow.
SIS OM PC Go To Opportunity View Workflow
The SIS OM PC Go To Opportunity View workflow is invoked as a subprocess of the SIS OM PC Enrollment workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following action:
Opportunity PC View. This step displays the SIS OM PC Opportunity Price Comparison view.
SIS OM PC Set Opportunity Account Workflow
The SIS OM PC Set Opportunity Account workflow is invoked as a subprocess of the SIS OM PC Enrollment workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following action:
Set Opportunity Account Id. This step associates the Account Id specified by the process property with the Opportunity.
SIS OM PC Go to Order Entry - Line Items View (Sales) Workflow
The SIS OM PC Go to Order Entry - Line Items View (Sales) is invoked as a subprocess of the SIS OM PC Enrollment workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following action:Order Entry - Line Items View (Sales). This step navigates to the Order Entry - Line Items View (Sales).
CUT eSales - PC Enrollment Workflow
The CUT eSales - PC Enrollment workflow is invoked as a subprocess of the SIS OM PC Enrollment workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following actions:
Get Shopping Cart Status. This step checks the status of the shopping cart.
Is Cart Empty? New Cart. Set New Cart’s Price List Id. These steps create a new cart if the cart is empty, and set the cart's price list to the Price Comparison internal price list. For more information, see CUT eSales - Set Shopping Cart Price List Workflow.
Quote PL == Cart PL? Get Property: Explicit Login. These steps compare the cart's price list to the price list of the comparison quote selected by the user if the cart is not empty. If the price lists are different, then a check is made to see whether the user explicitly logged in.
Explicit Login? Prepare Shopping Cart. These steps show the Save Cart Confirmation view to allow the user to specify how to handle the existing cart if the user logged in. For more information, see CUT eSales - PC Prepare Cart Process Workflow.
Set Pending Request. Login View. These steps make a request to display the CUT Opportunity PC Price Comparison View (eSales) on login if the user is not logged in, and show the Login View.
Merge? This step terminates the workflow if the user chose not to save or discard the existing cart.
Merge PC Quote & Cart. This step adds the comparison quote line items to the cart if the comparison quote's price list and the cart's price list are the same, or if a new cart was created.
Goto Shopping Cart. This step shows the Shopping Cart view.
The following lists the CUT eSales - PC Enrollment Process steps, methods, and business services.
| This Workflow Step | Calls This Method | In This Business Service |
|---|---|---|
Get Shopping Cart Status |
GetShoppingCartStatus |
CUT OET Service |
Get Property: Explicit Login |
GetPropValue |
Shopping Service |
New Cart |
NewCartHeader |
CUT OET Service |
Set Pending Request |
Set Pending Request |
Shopping Service |
Merge PC Quote & Cart |
MergeCxObj |
CUT OET Service |
Goto Shopping Cart |
GotoView |
CUT OET Service |
CUT eSales - Set Shopping Cart Price List Workflow
The CUT eSales - Set Shopping Cart Price List process is invoked as a subprocess of the CUT eSales - PC Enrollment Process workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following action:
Set Cart Price List Id. This step updates the cart's price list to the specified value.
CUT eSales - PC Prepare Cart Process Workflow
The CUT eSales - PC Prepare Cart Process workflow is invoked as a subprocess of the CUT eSales - PC Enrollment Process workflow.
The following shows this workflow.
Workflow Description
This workflow performs the following actions:
Load Primary Buscomp. Save Cart Confirmation View. These steps load the current shopping cart and show the Save Cart Confirmation view.
Save Cart as Quote. This step saves the cart if the user chooses Save.
Discard Cart. This step discards the cart if the user chooses Discard.
Go back to PC Comparison View. This step shows the CUT Opportunity PC Price Comparison View (eSales) and terminates the calling workflow if the user chooses Cancel.
The following lists the CUT eSales - PC Prepare Cart Process Workflow steps, methods, and business services.
| This Workflow Step | Calls This Method | In This Business Service |
|---|---|---|
Save Cart as Quote |
SaveCartAsQuote |
Shopping Service |
Discard Cart |
DiscardCart |
Shopping Service |
Go Back to PC Comparison View |
GotoView |
CUT OET Service |
SIS OM PC Competitive Pricing Report Process Workflow
The workflow is called by a SmartScript session that is invoked by clicking the CP Report button in the Relationships view of the Product Comparison screen.
The following shows this workflow.
Workflow Description
This workflow performs the following actions:Opportunity Null? Delete Existing PC Quotes. These steps check to determine whether an opportunity exists for the Price Comparison. If there is an opportunity, then all existing price comparison quotes are deleted.
Get New RowId. Create Opportunity. These steps create a new opportunity if an opportunity does not exist.
Setup Question-Field Mapping. This step maps the SmartScript session questions to fields of a quote.
CP Report Create Quotes. This step converts the answers from the SmartScript session into a competitor quote by using the mapping created in the previous step. Using the answers from the SmartScript session, the data is generated for the report.
Execute Report. This step executes the report by using the data set generated by the previous step.
The following lists the SIS OM PC Competitive Pricing Report Process Workflow steps, methods, and business services.
| This Workflow Step | Calls This Method | In This Business Service |
|---|---|---|
Delete Existing PC Quotes |
Delete Existing PC Quotes |
SIS OM Pricing Calculator Service |
Get New RowId |
Get Next RowId |
SIS OM Pricing Calculator Service |
Setup Question-Field Mapping |
Setup Question Field Map |
SIS OM Pricing Calculator Service |
CP Report Create Quotes |
CP Report Create Quotes |
SIS OM Pricing Calculator Service |
Execute Report |
Execute Report |
Report Service |