This chapter provides an overview of the recommendation experience and discusses how to:
Define display templates.
Use PeopleSoft Real-Time Advisor.
Note. This chapter is written to give the dialog creator a sense of the runtime recommendation experience. The focus of this chapter is to provide a better understanding of how the display templates, as well as the decisions made while using the Advisor Workbench tool, translate into the runtime experience.
PeopleSoft Real-Time Advisor integrates directly with several other PeopleSoft applications when users want to buy or configure a recommended object. PeopleSoft Real-Time Advisor can be invoked directly from PeopleSoft Order Capture, PeopleSoft Order Capture Self Service, PeopleSoft Mobile Order Capture, PeopleSoft CRM Catalog, PeopleSoft CRM industry-specific solutions that rely upon order-entry functionality, or the CRM catalog.
With the addition of the (AAF) active analytic framework , PeopleSoft Real-Time Advisor can also be indirectly invoked from PeopleSoft Support and HelpDesk cases, the 360-degree view, and PeopleSoft Marketing waves through AAF Actions.
The PeopleSoft Real-Time Advisor recommendation experience connects dialog creation with user presentation. It can be a quiet session that uses information already known about a user to generate recommendations, or it can be an interactive session where the user is asked a series of questions in order to gather information. Each page that is presented to a user contains elements such as questions and answers, explanations, recommendations, and actions. Depending on the action type, either the action itself or transition rules determine the subsequent page. PeopleSoft Real-Time Advisor segments users based on their responses to questions and conditions, and places them in target groups which determine what aspects of the recommended product they are most likely to favor. If a user is not part of a target group and a recommendation is requested, the default target group is passed into the recommendation engine. Display controls enable a dialog creator to successfully define a varied and relevant set of display templates to influence the user experience.
Style classes enable you to change the appearance of HTML objects. They can control the colors, font, and display size of HTML objects. PeopleSoft Real-Time Advisor leverages style class definitions to control how dialog pages look. You create style classes in PeopleSoft Application Designer. The more style classes that you create prior to creating PeopleSoft Real-Time Advisor display templates the better, as this provides a plentiful array of materials to use when designing runtime pages.
The Advisor Workbench Test Dialog functionality (using Interactive mode) can be used to test the style classes and display templates to ensure you are getting the desired display appearance.
Several actions are available at runtime. Actions appear on the page at runtime. These action types are defined while preparing the PeopleSoft Real-Time Advisor environment:
Next: Uses transition rules to determine the next page.
Back: Sets up the next page to be the one that was previous to the current page.
All user answers to the questions on that page are represented. The current page is removed from the path guide.
Exit: Returns users to the application that called the PeopleSoft Advisor dialog.
Save: Saves the current PeopleSoft Real-Time Advisor session.
If you have saved during the session, PeopleSoft Real-Time Advisor provides the calling application with a session identifier that is used to restore the session information at a later time.
Start Over: Restarts the dialog session, completely erasing the current session, including all of the user's answers, and restarts the session.
Recommend: Sets up the next page to be the Recommendation page and requests a set of recommendations from the engine based on the user's answers and conditions.
View Answers: Lists all of the dialog pages with questions and answers.
Users can go back to a page and change their answers. If a user selects one of the pages to edit, the path guide is updated. The recommendation process continues from this page, using the transitions of the page and the action designated by the user.
See Also
Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Application Designer
This section provides an overview of display templates and discusses how to:
Define display templates.
Define page controls.
Define recommendation controls.
Define compare controls.
Define view answer controls.
Associate display characteristics to the template.
Clone the current template.
Display templates control the look of the runtime pages. Templates also dictate the information that appears for the recommended objects. Even quiet dialogs need display templates, since this is where several key controls are defined, such as the recommendation thresholds and the display characteristics. Presentation according to templates enables the interface to change by dialog or by page, depending on the dialog and page settings, and requires no coding by the user setting up the dialog. Templates can control these five areas of the interactive experience:
Overall user interface.
Questions and answer pages.
Recommendation page.
Comparison page.
View the Answers page.
Page controls are derived based on how the questions and explanations are presented to users during the runtime of the dialog. These pages are the majority of what users will view; therefore, page controls are important, because you can use them to create a custom look for either the dialog or the page depending on the dialog setup.
By adding a display template to the page with the Advisor Workbench tool, you can override the dialog template with a page template. You may want to take advantage of this functionality if you want a specific question and answer page to differ from the general look of the dialog.
See Creating Pages.
Display characteristics determine the aspects of the recommended object that are shown to the user. Because templates can be used across multiple advisor types, and each advisor type has a different set of characteristics associated with it, you can select the characteristics to show per advisor type. Therefore, you can create a look through the template and use that template for many different dialog types.
The recommendation engine only works with characteristic keys of an object. The template determines the information regarding the object that is valuable to show users. For example, when the dialog recommends products, the dialog uses the setID and product ID to indicate which product to recommend. However, you may want to show the product description as well. You can map the description as a display characteristic and add it to the recommendation grid; the description is then shown to the user as relevant information about the product. This same functionality can be applied to any display-type characteristic. You can also determine what characteristic to show as a link. Links can transfer users to the product details in an application such as the CRM catalog.
Note. The characteristic mappings for display characteristics and what happens when a link is selected must be defined while preparing the PeopleSoft Real-Time Advisor environment.
See Defining Characteristic Mapping.
Page Name |
Object Name |
Navigation |
Usage |
RAD_TEMPLATE |
Marketing, Advisor Dialogs, Define Display Template |
Define display templates that control the look of the dialog presentation. |
|
RAD_TMPL_PAGE |
Click the Page Controls link on the Define Display Template page. |
Define page control options to change the look of the individual question and answer pages at runtime. |
|
RAD_TMPL_RECOM |
Click the Recommendation Controls link on the Define Display Template page. |
Define recommendation controls to configure the way in which the system presents recommendations and the thresholds used to generate the recommendations. |
|
RAD_TMPL_COMP |
Click the Compare Controls link on the Define Display Template page. |
Define compare controls to change the look and feel of the comparison page. At runtime, you can use this page to view compared recommendations. |
|
RAD_TMPL_VIEWANS |
Click the View Answer Controls link on the Define Display Template page. |
Define the view answer controls to change the look of the View Answers page. At runtime, you can view or edit previous answers to questions on this page. |
|
RAD_TMPL_CHARA |
Click the Choose Display Characteristics link on the Define Display Template page. |
Choose the display characteristics for the recommendation and comparison pages. |
|
RAD_TMPL_CLONE |
Click the Clone Current Template link on the Define Display Template page. |
Clone the current template so a new template can be created without having to reenter options. |
Access the Define Display Template page.
Select either Active or Inactive. Only active templates are available to be used in the Advisor Workbench tool when creating a dialog. |
Click to set up page controls for question and answer pages, including page control preferences, path guide options, and style classes. |
|
Click to access the Define Recommendation Controls page and define recommendation control options, recommendation options, style classes, and score display details. At runtime, this information is used to display recommendations. This step must be done even for dialogs that will only run in quiet mode, since this step determines the recommendation thresholds. |
|
Click to access the Define Compare Controls page and change the look of the Compare Selected page. At runtime, users use the Compare Selected page to compare recommendations returned by PeopleSoft Real-Time Advisor. |
|
Click to access the Define View Answer Controls page and change the look of the View Answers page. At runtime, users can view or edit previous answers on the View Answers page. |
|
Click to control what display characteristics are shown to users with regard to recommendations and comparisons. This step must be done even for dialogs that will only run in quiet mode, since this step determines the characteristics returned with the recommendation. |
Click to clone the current template to create a new template without reentering options. |
Access the Define Page Controls page.
Page Title |
If the page does not have navigation text (as defined in the Advisor Workbench tool), the text entered here will be shown by default. There is a 30-character limit. |
Default Explanation |
Enter a default explanation to use if none is associated for a given page. |
Number Questions |
Select to number the questions sequentially for this page only. |
Show Dialog Title |
Select to display the dialog title on the page. The dialog title is the navigation text defined for the dialog. |
Show Page Title |
Select to display the Page Title field for this page. If selected, either the page navigation text or the page title appears on the page. |
Select to display the path guide on the upper right-hand corner of this page. You can view the names of all of the completed pages, as well as all of the questions and answers from the previous page. |
|
Select to provide a break row between each page listed in the path guide, using style classes. |
|
Select the type of edit link that enables users to go back and edit answers on specific pages.
|
|
Page Name |
Enter a style class for the page name in the path guide. The page name that appears is either the navigation text of the page or the page title. |
Question Text |
Enter a style class for the question text in the path guide. The question text that appears is the navigation text for the question. |
Answer Text |
Enter a style class for the answer text in the path guide. The answer text that appears is the navigation text for the answer. |
Page Edit Link |
Enter a style class for the edit link of a page in the path guide. |
Page Row |
Enter a style class for a page row in the path guide. |
Question Row |
Enter a style class for the question row in the path guide. |
Break Row |
Enter a style class for a break row in the path guide. Use this row if you select Include Break Line After Page. |
Dialog Title |
Enter a style class for the title of the dialog, if used. |
Page Title |
Enter a style class for the page title, if used. |
Question Box |
Enter a style class for the question box. This is the framed box that surrounds the question and answers on the page. |
Question |
Enter a style class for the questions. |
Explanation |
Enter a style class for the explanation text. |
Action Buttons |
Enter a style class for action buttons. |
Action Button Box |
Enter a style class for the framed box that surrounds actions in the runtime. |
Question Explanation |
Enter a style class for text explanations for questions. |
Even Row Answer |
Enter a style class for even row answers for both single-type or multiple-type answers. |
Odd Row Answer |
Select a style class for odd row answers for both single-type or multiple-type answers. |
Error Text |
Select a style class for the error text. |
Flagged Question |
Select a style class for the color of the text when a question is flagged because it is required. |
Upload Image |
Select an image to use on a page. |
Delete Image |
Delete the image that is being used on the page. |
Access the Define Recommendation Controls page.
Page Title |
Enter the page title to use for recommendation pages. There is a 75-character limit. |
Default Explanation |
Enter a default explanation to use for the Recommendation page. |
Image Location |
Select where to place the image. Values are: Right of Explanation and Left of Explanation. |
Characteristic Default |
Enter a value to specify what an empty characteristic shows, if the characteristic value for the recommended object is empty. Use something apparent like NA or -. |
Allow Compare |
Select to enable users to compare recommended objects. |
Show Passed Information |
At runtime, the calling application may provide PeopleSoft Real-Time Advisor additional display information about the recommended objects that does not appear in the database. Select this check box to allow this information to appear in PeopleSoft Real-Time Advisor when the object is recommended. For instance, the calculated price may be the passed information. |
Show Dialog Title |
Select to display the dialog title on the page. The dialog title that appears is the navigation text of the dialog. |
Show Page Title |
Select to display the Page Title field. |
Select a score presentation. Values are: Image Range, Normalized List(out of 100), Ranking, or Raw Score. Note. A normalized list takes the highest score to 100 and the lowest score to zero. All of the other scores are then adjusted accordingly. A ranking ranks the score, and the raw score is the score as it is calculated by the recommendation engine. |
|
Enter a score to determine the raw score range for this image. |
|
Displays the image if a recommended objects score falls within the designated range. |
|
Browse |
Click to obtain the image for the range. |
Note. If there are recommendations whose raw scores do not fall within any of the defined image ranges, the score image for that
recommend object is empty.
Score Range information is only used if the Score Presentation is set to Image Range.
Enter the number of recommendations to present on the Recommendation page. This entry is required for dialogs run in Quiet mode too. |
|
Enter a number to filter recommendations under a certain raw score. For instance, you may only want recommendations with at least a 50 score. This entry is required for dialogs run in Quiet mode too. |
Select to use both the number of recommendations and the minimum score to determine the number of recommendations that appear on the Recommendation page. |
|
Select to use only the score as the limiting factor to determine the number of recommendations shown on the Recommendation page. |
|
Select to use only the number of recommendations as the limiting factor to determine the number of recommendations shown on the Recommendation page. |
Note. Control results, Number to Return, and Minimum Score are used by quiet dialogs.
Dialog Title |
Enter a style class for the dialog title, if used. |
Page Title |
Enter a style class for the page title, if used. |
Score |
Enter a style class for the score display column in the recommendation control. This style class is not used when the Image Range option is selected. |
Recommendation Box |
Enter a style class to use for the framed box around the list of recommendations. |
Even Row |
Enter a style class for even row recommendations in the recommendations control. |
Odd Row |
Enter a style class for odd row recommendations in the recommendations control. |
Detail Link |
Enter a style class for the details link column in the recommendation control. |
Details Label |
Enter a style class for the details label column in the recommendation control. |
Compare Button |
Enter a style class for the Compare button. |
Explanation |
Enter a style class for the explanation text. |
Action Buttons |
Enter a style class for the action buttons. |
Action Buttons Box |
Enter a style class for the framed box that surrounds actions in the runtime. |
Upload Image |
Click to select the default image to use on the Recommendation page. |
Delete Image |
Click to delete the default image that is being used on the Recommendation page. |
Access the Define Compare Controls page.
Enter the page title that is to be used for comparison pages. There is a 75-character limit. |
|
Enter a default explanation to use for the comparison page. |
|
Select where to place the image. Values are: Right of Explanation and Left of Explanation. |
|
Enter a value to specify what an empty characteristic shows, if the characteristic value for the recommended object is empty. Use something apparent like NA or -. |
|
Select to display the dialog title on the page. The dialog title that appears is the navigation text of the dialog. |
|
Select to display the Page Title field. |
|
At runtime, the calling application may provide PeopleSoft Real-Time Advisor additional display information about the recommended objects that does not appear in the database. Select this check box to allow this information to appear in PeopleSoft Real-Time Advisor when the object is recommended. For instance, the calculated price may be the passed information. |
Dialog Title |
Enter a style class for the dialog title, if used. |
Page Title |
Enter a style class for the page title, if used. |
Comparison Box |
Enter the style class that applies to the box surrounding the compared objects grid. |
Detail Link |
Enter a style class for the details link column in the compare control. |
Even Row |
Enter a style class to use for even row comparisons in the compare control. |
Odd Row |
Enter a style class to use for odd row comparisons in the compare control. |
Criteria |
Enter the style class that applies to the first column of the comparison grid where the various aspects of the object are listed. The criterion might be the price of a product. |
Explanation |
Enter a style class for the Explanation button. |
Action Buttons |
Enter a style class for the action buttons. |
Action Button Box |
Enter a style class for the framed box that surrounds actions in the runtime. |
Upload Image |
Click to select the default image to use on the Comparison page. |
Delete Image |
Click to delete the default image that is being used on the Comparison page. |
See Also
Defining Recommendation Controls
Access the Define View Answer Controls page.
Page Title |
Enter the page title that is to be used for the View Answers page. There is a 75-character limit. |
Enter a default explanation to use if none are available for a page. |
|
Image Location |
Select where to place the image. Values are: Right of Explanation and Left of Explanation. |
Show Page Title |
Select to display a page title when the Page Title field is empty. |
Show Dialog Title |
Select to display the dialog title on the page. |
Dialog Title |
Enter a style class for the dialog title, if used. |
Page Title |
Enter a style class for the page title, if used. |
Page Box |
Enter the style class that applies to the box surrounding the grid. |
Page Navigator Text |
Enter the style class for the page navigator text. |
Question |
Enter the style class for the question text. |
Answer |
Enter the style class for the answer text. |
Action Buttons |
Enter a style class for the action buttons. |
Action Button Box |
Enter a style class for the framed box that surrounds actions in the runtime. |
Explanation |
Enter a style class for the Explanation button. |
Upload Image |
Click to select the default image to use on the View Answers page. |
Delete Image |
Click to delete the default image that is being used on the View Answers page. |
Access the Choose Display Characteristics page.
Display Characteristics for Advisor Types
This scroll area may have multiple advisor types listed. Set up the display characteristics for each advisor type that may use this template. Display characteristics defined here are used by quiet dialogs. The first 10 Advisor Types will show, use the scroll area controls to move to others. The information set up here is also needed for dialogs run in quiet mode as these determine the information returned with the recommendation set.
Characteristic Mapping |
Select display characteristics for the advisor type. |
Recommendation |
Select to use this characteristic for recommendations. This characteristic appears in the Details column on the Recommendation page or is returned with recommendations when the dialog is run in quiet mode. |
Comparison |
Select to use this characteristic for comparisons. This characteristic appears on the comparison page or is returned with recommendations when the dialog is run in quiet mode. |
Detail Link |
Select to use this characteristic as the detail link. At runtime, detail links are used by the system to determine which characteristic to enable as a drillable link. This is usually the title or description characteristic of the recommended object. This characteristic is also returned with recommendations when the dialog is run in quiet mode Note. Only one display characteristic can be identified as the detail link on the comparison or recommendation pages. |
Show Label |
Select to display the label for the characteristic in the details column of the recommendation page. |
Access the Clone Current Template page.
Template Name |
Enter a new template name for the template. There is a 30-character limit. |
Status |
Displays either active or inactive status. |
Clone Template |
Click to clone the current template. |
Select the following check boxes to copy specified items: Page Controls, Recommendation Controls, Compare Controls, View Answer Controls, and Display Characteristics.
This section provides an overview of PeopleSoft Real-Time Advisor runtime, how decisions in the dialog creation and template settings affect the presentation of the dialog, and discusses how to:
Run PeopleSoft Real-Time Advisor.
Navigate question and answer pages.
View and edit answers.
View recommendations.
Compare recommended products, services, or solutions.
Save dialogs.
Exit PeopleSoft Real-Time Advisor.
You can run PeopleSoft Real-Time Advisor from a variety of PeopleSoft CRM applications, such as PeopleSoft Order Capture, PeopleSoft Order Capture Self Service, industry-specific CRM applications, and from catalogs. You can also run PeopleSoft Real-Time Advisor in debugging mode from the Advisor Workbench tool.
In debugging mode, an additional group box appears beneath the runtime page to identify the activity that has occurred. The information that appears is useful in correcting unforeseen problems that may arise in the return of data or the flow of the dialog itself. It appears on every runtime page. This group box may also appear in other calling applications depending on the mode in which PeopleSoft Real-Time Advisor was called.
Note. PeopleSoft Order Capture enables the CSR (Customer Service Representative) to turn on Real-Time Advisor session information. This feature allows the CSR to see session (debugging) information when running a dialog for a customer. By default, session information is turned off. This option is available on the Order Capture Business Unit Definition page.
See Defining PeopleSoft Order Capture Business Units.
When you run PeopleSoft Real-Time Advisor, a start page containing questions appears. Users answer questions and have several options available; these are determined by the dialog creator, who added actions to the page during dialog creation. Users can view or edit previous answers, ask for a recommendation, go to the next page, go back a page, or compare objects that are recommended. They can save the dialog interaction at any point or can continue to access information on the object by viewing the details of the recommended object. Behind the scenes, the PeopleSoft Real-Time Advisor runtime engine determines the next page depending on the user action and possibly the transitions and may perform calculations relevant to the recommendation model as determined while using the Advisor Workbench tool during setup.
Four key runtime page types rely on template information. Each page has its own set of template controls to control the appearance of each independently:
Question and Answer.
Recommendation.
Compare.
View Question and Answer.
See Defining Display Templates.
When you first initialize the runtime engine, PeopleSoft Real-Time Advisor checks several characteristics of the dialog before allowing the dialog to run. First, it verifies that there is a deployed version of the dialog and the dialog is active. Next, the system checks to make sure that the current date is within the start date and end date for the dialog. If either of these are invalid, the dialog does not run, and the system returns an error. If you are running PeopleSoft Real-Time Advisor from the Test Dialog link in the Advisor Workbench tool, the system verifies that the dialog status is Testing or Deployed before running the dialog.
In quiet mode the dialog is run immediately using information about the user from the system or from AAF and delivers recommendations to the calling application. In interactive mode the dialog is run and the user is presented with the Real-time Advisor runtime as determined by the dialog settings and the display templates.
Page Name |
Object Name |
Navigation |
Usage |
Question and Answer |
RAD_ADVISOR_RUN |
|
Answer questions and move through a dialog. Depending on the dialog, you may be able to access a recommendation or view debugging information. |
RAD_ADVISOR_RUN |
|
View previous responses to questions and change the answers. |
|
RAD_ADVISOR_RUN |
|
View recommendations returned by the PeopleSoft Real-Time Advisor recommendation engine. |
|
RAD_ADVISOR_RUN |
|
Compare two or more recommended products, services, or solutions. |
Depending on the template controls for the dialog and the page contents, this information may appear:
Dialog name.
Page name.
An explanation for the page.
Questions and answers for the page.
Applicable actions for the page.
You determine the content of the page when you create it. The look of the page is based on the template that you used for the page or dialog.
Note. There may be session information shown at the bottom of the page, depending on how Advisor was called. The session information will appear if the session is run from the Advisor Workbench tool or if the calling application requests session information be shown when it started Advisor.
See Understanding the Recommendation Experience.
Access a <Question and Answer> page.
Users can navigate through the entire collection of pages, answering the questions that appear.
Note. The page title is not static. It is determined while working with the Advisor Workbench tool in the Layout Pages and Transitions step, or if not set there, it is defined in the template.
Click to access the Recommendations page. You can compare two or more selected products, or you can drill into a selected product, service, or solution. |
|
Click to save the current session information to the database. Enter a name for the saved session. |
|
Click to return to the start of the dialog. This clears the question and answer lists, as well as the path guide. |
|
Click to exit the runtime process and return to the calling application. If there has been a save during the session, the calling application is given a session ID to return to the session at a later time. For example, suppose that users run PeopleSoft Real-Time Advisor from PeopleSoft Order Capture; they would return to the order-entry form within that application. If the user was a dialog creator who was testing the runtime activity, that person would return to the main Advisor Workbench page. |
|
Click to go back and modify question answers in the path. If you make modifications, the system updates the path guide to the selected page, and it updates the recommendation and question and answer list. The dialog then restarts from selected page using the transitions of the page, as well as the action designated by the users. Any answers to questions further into the dialog are saved and used if the question appears again. However, these answers do not influence a recommendation; they are for viewing purposes only and are not used to determine user target groups. |
|
Click to return to the page that appeared prior to the current page. Note. This automatically updates the path and the question and answer lists. |
Click the page link that appears beneath the question that you want to change to edit answers. Click Back to return to the previous page.
Access the Recommendations page.
Select the check boxes for each recommended object that you want PeopleSoft Real-Time Advisor to compare against one another. |
|
Displays the Detail Link characteristic as set up in the display template, such as a product ID or short description. |
|
Displays object details. The characteristics that display in this column are determined by the selected Recommendation characteristics selected in the dialog template. |
|
Displays a score based on the settings in the recommendation controls for display templates. |
Click this button after you have selected two or more recommended objects, and the PeopleSoft Real-Time Advisor engine compares the recommended products using a variety of data. |
Access the Compare Selected Products page.
The Compare Selected Products page displays a side-by-side comparison of the recommended products that were selected on the Recommendations page. The characteristics shown and how they are shown are determined by the display template for the dialog.
Enter a name for the dialog session, and then click the Save button to save the dialog in its current state. Later, you can resume the session where you left off. This functionality is not available while running from the Advisor Workbench tool with the Test Dialog functionality.
Click the Exit button at any point in the dialog session to exit and return to the calling application, or to the Advisor Workbench tool if you are in Test mode.