Setting Up Business Object Search and Quick Create

This chapter provides an overview of the business object (BO) search and quick create definition process and discusses how to define BO searches and quick create pages.

Understanding BO Search and Quick Create Setup

This section lists common elements and discusses:

BO search runtime process.
Quick create runtime process.
BO search and quick create setup process.

Common Elements Used in this Chapter

Field	Search fields are common objects that are used in BO search and quick create definitions. A field definition specifies the location of the field in the database, how the system searches for the field, the label of the field on the user interface, and how the field is updated by quick create. Fields are used in the following BO search and quick create elements: Search roles. Search definitions. Search criteria. Transaction adapter. Quick create templates.
Quick Create Template	A quick create template associates the fields that are entered with the business object roles that are updated when a user creates a business object using quick create. The criteria definition specifies the search criteria page on which quick create definitions that this template is associated with appear.
Quick Create Definition	A quick create definition is composed of one or more templates that appear to the user when the quick create definition is invoked. You can use the same quick create template in more than one definition.
Search Role	A search role definition associates field definitions to one or more role type. When user search for a field, only business objects that have a role that is associated with the field are returned in the search results. Search roles are used in search definitions.
Search Definition	A search definition is a collection of search roles and quick create definitions. Search definitions specify the roles and fields that are searched for data that a user enters. If you specify a quick create definition on the search definition, then the quick create definition is enabled on the search results page. You use search definitions in search criteria.
Search Criteria	Search criteria specify the search definitions that are invoked when the user enters data in certain fields on a component. You can specify a default search definition and up to four alternate definitions. You then select fields and associate each field with one or more search definitions. If you do not select a search definition for the field, then the default search definition is used. You associate criteria definitions with adapter sections.
Adapter	The adapter specifies the BO search definitions and quick create definitions that are enabled for a particular component or transaction. The adapter also defines the fields that appear in basic search mode, the search criteria to invoke for these fields, and the subpages of the component upon which these fields appear.

BO Search Runtime Processes

PeopleSoft Enterprise Customer Relationship Management (PeopleSoft Enterprise CRM) provides the capability for users to search for business objects that they need to reference on transactions or components. When users don't know the exact name of the business object to reference, they can initiate a BO search to find the business object based on any information that they might know. The system determines the information that it requires to locate the BO and presents a search page for the user to enter known information.

The customer identification framework also uses BO search technology without the user having to explicitly initiate a search.

When a user searches for an object that does not already exist in the system, some PeopleSoft Enterprise CRM transactions provide quick create functionality that enables the user to create that object with a minimum set of data. For example, when a contact calls for service on behalf of a company, the customer service representative (CSR) verifies the contact's information by doing a BO search for the contact. If the contact is not found in the database, the CSR can create a contact immediately and associate it to the company.

BO search and quick create functions are tightly integrated with each other, and they use much of the same system data.

Identifying Customers for Transactions

BO Search and Quick Create Setup

This is the BO search and quick create setup process:

Define search fields.
Define quick create templates.
Enter a quick create definition.
Define search roles.
Enter a search definition.
Define search criteria.
Define the BO search and quick create adapter.

Note. Setting up BO search and quick create definitions requires a good understanding of roles and relationships in the system.

See Also

Business Object Relationship Modelling

Delivered Definitions

PeopleSoft Enterprise CRM delivers a robust set of predefined system data that meets most business requirements. Search the delivered definitions before attempting to modify or add new business object search or quick create definitions. To search the delivered definitions, access the setup component for that definition and run a search without entering search criteria. A list of all defined items appears.

Important! PeopleSoft does not support changes made to the search definitions delivered with PeopleSoft Enterprise CRM. Implementation of any new search definitions that you create requires a coding effort, which is also not supported by PeopleSoft.

Adding and Modifying BO Search and Quick Create Definitions

This section discusses how to:

Define fields.
Define roles for a field.
Define quick create templates.
Define relationships for a template.
Set up quick create definitions.
Associate search fields with a role type.
Define BO searches.
Define search criteria fields.
Specify basic search criteria fields.
Define fields for transaction subpages.

Pages Used to Add or Modify Search Definitions

Page Name	Object Name	Navigation	Usage
Field	RBQ_FLDDFN	Set Up CRM, Common Definitions, Customer, BO Search, Field, Field	Define a field that is used in BO Search and quick create definitions.
Role	RBQ_FLDDFN_RL	Set Up CRM, Common Definitions, Customer, BO Search, Field, Role	View the roles that use the field definition. Each role that uses the field definition can override certain information that is defined for the field.
Template	RBQ_QCTMPL	Set Up CRM, Common Definitions, Customer, BO Search, Quick Create Template, Template	Define a quick create template. This defines the business object roles that appear on the Quick Create page when quick create is initiated from a specific component.
Relationships	RBQ_QCTMPL_REL	Access the Template page. Select the Relationships tab.	Define the relationships between the roles defined on the quick create template.
Quick Create	RBQ_QCDFN	Set Up CRM, Common Definitions, Customer, BO Search, Quick Create	Set up a quick create definition and associate one or more quick create templates to it.
Search Role	RBQ_SRCHRL	Set Up CRM, Common Definitions, Customer, BO Search, Search Role	Associate search fields with a role type.
Search	RBQ_SRCHDFN	Set Up CRM, Common Definitions, Customer, BO Search, Search	Define a BO search with one or more search roles, search fields, and related BOs.
Criteria	RBQ_CRITDFN	Set Up CRM, Common Definitions, Customer, BO Search, Criteria	Specify the advanced search criteria fields and advanced search definition.
Adapter	RBQ_ADPTR	Set Up CRM, Common Definitions, Customer, BO Search, Adapter, Adapter	Specify the basic search criteria fields.
Sections	RBQ_ADPTR_SECT	Set Up CRM, Common Definitions, Customer, BO Search, Adapter, Sections	Define the records and fields that appear on transaction subpages.

Defining Fields

Access the Field page.

General Options

Field Name/Label	Enter text that appears for the field on the user interface. The text appears both as a search criteria value that the user can select and as a column in the list of results returned by the search.
Mapping Reference	Enter the name that is used by the adapter to refer to the field in the component buffer.
Field and Secondary Field	Enter the names of the fields that the system searches for values that the user enters at runtime. The system searches the secondary field only if it doesn't find a match in the first field entered.
Field Upper and Secondary Field Upper	For fields of data type String, enter the names of the upper case fields that corresponds to the Field and Secondary field. This significantly improves performance when not using a case sensitive search.
Search Record	Enter the record where BO Search looks for the field to display.
Create Record	Enter the record where Quick Create looks for the field to update for a newly created business object.
Default	Select the values: Country, Currency, or SETID that are inserted into the record by default based on the user preferences.
Record Name 1 and Lookup Field	Enter the record and field that are used at runtime to populate a search field. Select Use Translate Values and Display as check box if appropriate for the field. Use Translate Values indicates that
Alternate Char Field	Select the alternate character field that is appears when the user ID is enabled for alternate character. See Implementing Alternate Character.

Search Operator

Select the default search operator and the search operators that are visible to the user when this field is searched.

Quick Create Keystrokes

Select the field name(s) that are used to map a BO search criteria value to a quick create field. This enables the system to pre-populate fields on a quick create page when the user creates a new business object after an unsuccessful search.

Viewing Roles that Use a Search Field

Access the Role page.

Use this page to indicate different role options for search fields. If the field is used by different role types, you can specify a different label to appear next to the field for each different role type. You can also specify a different search record, update record, and property for each role. The specifications you make on this page override the ones that you made on the Field page.

Property Name

Select a property name for this role. Quick create updates the property with the value that users enter in the corresponding field when they create a new business object using quick create functionality.

Defining Quick Create Templates

Access the Template page.

Market

Select the market for which this template is enabled.

Role Type

Select the role type for which you want to enable this quick create template.

Label

Enter the label that appears for this role type on the quick create page.

Criteria

Select the criteria definition for which this template is invoked.

Include Contact Info Entry

Select the contact info entry type that appears on the Quick Create page. This controls the address information that the user can enter for this business object.

Include Sold To/Ship To/Bill To

Select have the purchasing options appear on the Quick Create page.

Field Selection

Select one or more field definitions to include on the quick create template.

Defining Purchasing Options for Companies, Consumers, and Sites

Defining Fields

Defining Relationship Details for the Template

Access the Relationships page.

Note. Defining template relationships is optional. Define relationships between roles only if you include more than one role on a template.

Role and Relationship Selection

This page region enables you to specify the relationships that are built between the roles that are defined on a quick create template.

Role Type 1 and Role Type 2	Select the role types that are defined on the template.
Relationship Type	Select the relationship type between the two selected roles.

Setting Up Quick Create Definitions

Access the Quick Create page.

Quick Create Template

Select one or more templates to associate with the definition.

Primary Indicator

Select to indicate that the template is the primary, or controlling, template used by the quick create definitions.

Primary templates appear first on the runtime Quick Create page.

Associating Search Fields with a Role Type

Access the Search Role page.

General Options

Enter information that describes the role and how it appears.

Relationship Type and Relationship Type 2	Select a relationship type. All relationship types that apply to the role appear in these drop down lists. The one that you select is used to filter the search results.
Apply SetID Security	Select the options that determine how setID security is applied. If you do not specify a relationship for the role, this field is a check box that you either select or not. If you specify a relationship for the role, you have the options to apply SetID security to the primary, related, both, or neither business object in the relationship. See Setting Up PeopleSoft Customer Relationship Management Security and User Preferences.
Apply Application Security, Apply Controlling BO, and Apply Filter BO	Select the options that determine whether application security, controlling BO, and filter BO are applied to the primary or related business object in the relationship. If you do not specify a relationship, these options are not available.
Filter Record	Enter the name of a record that is used to filter the search results.

Used in Search Definitions

A list of all search definitions that use the role appears here.

Field Selection

Add fields that the role can search.

Related BO

Select if the field is a field of a related BO.

For example, for the Contact search role, you can check the Company Name field as a related BO because the field belongs to the company record and not the contact record.

Search

Select to use this field as a search criterion.

Search Result

Select for this field to appear in the search results.

Defining BO Searches

Access the Search page.

Enable Role Groups

Select to group the search results by role. For example, the Company, Site, and Alternate Capacity roles are grouped in the Organization group and the Consumer, Contact of Company, Contact of Consumer, Worker roles are grouped in the Individual group.

Note. The appearance of this page changes when you select this check box. Two additional page regions, Search Definition Group and Field Selection appear.

Search Definition Group

Control Type	Indicate if the role group is Controlling, Independent, or Dependent. Results appear with the controlling role first, followed by all dependent group records that are associated with the controlling group. For example, this enables users to display organizations first, then all the individuals that are associated with the organization. You can only have oneControlling group.
Result Display Type	Indicate whether the results appear in one column or two column format.
Select Multiple	Select to enable the user to choose multiple records from the result set.
Quick Create Definition	Select the quick create definition to associate with the role.

Role Definition

Select one or more roles for the search definition, define their appearance in results, and associate them with quick create definitions.

Role Definition

Select one or more search roles to associate with the search definition.

Result Field Selection

This page region appears when you select Enable Role Groups. If you associate more than one role definition to a search, then you must enter field definitions. This is necessary because two or more roles can use the same field definition. You must indicate to which role the field pertains.

Field Definition	Select the name of the field definition.
Role Type	Select the role type to associate with the field definition.
Related BO	Select to indicate that the field definition is associated with a BO that is related to the primary BO that is the target of the search definition.

Defining Search Criteria Fields

Access the Criteria page.

This page captures information about the search definitions to invoke when the user enters certain fields.

Description	Enter the name for the group of criteria that you specify. This name is used to link the criteria to an adapter section.
Search Definition	Enter the default search definition. The definition is used by default when the user searches for a field
Search Definition 1, Search Definition 2,Search Definition 3, Search Definition 4 and Search Definition 5	Enter alternate search definitions. These search definitions appear at runtime. The user can search by the default definition or select an alternate.
Enable Search Filter	Select to have only the search fields that are associated with the selected search definition appear at runtime.
Show Search Operators	Select to have the search operators appear on the BO Search page at runtime.
Criteria Required	Select to require the user to enter search criteria at runtime before searching.

Field Selection

Use this page region to select fields for a search criteria definition, specify the roles for which the field appears, and select the search definitions for which the field is enabled.

Role Type ID	Select the role to which the field applies, in the case where a field is shared by different roles. For example, if the Name field is shared between the Company and Site roles. To have it appear once as Company Name and once as Site Name, you need to select the Name field twice and associate one to the Company role and one to the Site role.
Enable Search 1, Enable Search 2,Enable Search 3,Enable Search 4 and Enable Search 5	Select to enable the corresponding search definition for the field. For example, if you enable Search 1 and Search 3 for a field, then these search definitions appear in a drop down list at runtime. The user can select a search definition or search by the default definition.

Note. If you select a field for multiple roles, at runtime the field appears once in the search criteria for each role selected. You can specify different field labels for each role to differentiate between multiple occurrences.

Specifying Basic Search Criteria Fields

Access the Adapter page.

Component Name

Specify the component to which this adapter definition pertains.

Market

Select the market to which this adapter definition pertains.

Application Class ID

Select the application class for the adapter.

Mapping Reference

Enter a reference that is used to switch adapters if more than one adapter is needed for a component.

Extension Selection

Extension Event Code

Select a method from the list that appears.

This list contains the methods of the selected application class. You can use these to write custom code.

Section Record Name

Enter the section to which this extension applies.

Defining Fields for Transaction Subpages

Access the Sections page.

Note. Before you configure the transaction adapter for fields, make sure that you have an extensive understanding of system data and transactions.

Section Record Name

This is the name of the record that is used as the subpage on the transaction.

Criteria

Select the criteria definition that is used by this section.

Adapter Section Test

Click to test the adapter section.

You cannot use this button to test sections that have a display type of Custom.

Field Selection

Field Definition	Add the fields that you want to appear on the transaction.
BO Assigned	Select to indicate that this field is associated to a primary BO on this section.
Section Identified	Select to change the display state of the section is from initialized mode to identified mode when the value for the field is retrieved.
Criteria	Select to use a value that is identified for the field as a criteria for additional searches. For example, when a company is identified at runtime, a prompt button with a search for contact appears. When the user clicks the prompt, the system invokes the search definition that you specify in this field.
Mapping Reference	Enter the logical name of the field on the transaction’s component buffer.

Display Options

Specify how the field appears in initialized mode and identified mode. Initialized mode refers to how the field appears when the page is first displayed and before any criteria are entered. Identified mode refers to how the field appears after the fields are populated with the search results.

Market	Select the market for which this template is enabled.
Role Type	Select the role type for which you want to enable this quick create template.
Label	Enter the label that appears for this role type on the quick create page.
Criteria	Select the criteria definition for which this template is invoked.
Include Contact Info Entry	Select the contact info entry type that appears on the Quick Create page. This controls the address information that the user can enter for this business object.
Include Sold To/Ship To/Bill To	Select have the purchasing options appear on the Quick Create page.

Component Name	Specify the component to which this adapter definition pertains.
Market	Select the market to which this adapter definition pertains.
Application Class ID	Select the application class for the adapter.
Mapping Reference	Enter a reference that is used to switch adapters if more than one adapter is needed for a component.