Siebel Developer's Reference > Business Component User Properties > Controlling Search and Sort >

Specifying How to Sort Predefined Queries for Opportunities

The Sort Field Map n user property determines how Siebel CRM sorts a predefined query on a business component that stores opportunity data. It uses the following format:

"field", "redirect field"

where:

• field is the name of a multivalue field that resides in the current business component. This field stores opportunity data that Siebel CRM maps to a field that resides in the Revenue business component. The Revenue field and the Close Date field are examples of this field.
• redirect field is the name of a single-value field that resides in the current business component. This field stores opportunity data. Siebel CRM maps it to the same revenue field that resides in the primary revenue record for the opportunity. The Primary Revenue Amount field and the Primary Revenue Close Date field are examples of a redirect field.

A one-to-many relationship exists between a business component that handles opportunity data and the Revenue business component. This relationship enables the master and detail view that displays the revenue records that Siebel CRM associates with an opportunity. The Opportunity business component and the Global Account Opportunity business component are examples of business components that handle opportunity data.

Opportunities typically include multivalue fields that reference fields that reside in the Revenue business component. For example, the Revenue field that resides in the Opportunity business component references the Revenue field that resides in the Revenue business component. An existing predefined query on opportunities might include a sort specification that references one or more of these multivalue revenue fields. The Sort Field Map user property redirects this sort to the corresponding single-value field in the opportunity at runtime. For example, it redirects a sort specification that resides on the Revenue multivalue field in the Opportunity business component to the Primary Revenue Amount field. This field contains the revenue amount for the primary revenue record of the opportunity. You can use the Sort Field Map n user property to specify how Siebel CRM does this redirect.

You can specify this user property with or without the numeric suffix. However, you typically add multiple instances to redirect multiple revenue fields. The numeric suffix differentiates these instances. For more information, see Numbering Instances of a User Property.

You must not configure Siebel CRM to deactivate this user property or modify the value for it, but you can configure Siebel CRM to create a new instance of it.

For information about configuring a sort specification in a predefined query, see Configuring Siebel Business Applications. For information about the primary revenue record for an opportunity, see Siebel Applications Administration Guide.

Example of Configuring the Sort Field Map User Property

For an example of configuring the Sort Field Map user property, assume you define the user properties that Table 24 describes in the Opportunity business component.

In this example, the following sort specification in a predefined query provides a result set that Siebel CRM sorts in descending order according to the revenue amounts that exist in the primary revenue records of the opportunities:

'Opportunity'.Sort = "Revenue (Descending)"

The following sort specification in a predefined query provides a result set that Siebel CRM sorts according to the revenue close dates that exist in the primary revenue records:

'Opportunity'.Sort = "Close Date "

Alternative to Configuring the Sort Field Map User Property

For a new predefined query, it is recommended that you do not configure the sort specification to reference a multivalue field. You can configure the sort specification to reference a single-value field instead of using the Sort Field Map user property to do a redirect. For example, you can use the corresponding Primary Revenue field. You can use the following instead of using 'Opportunity'.Sort = "Close Date ":

'Opportunity'.Sort = "Primary Revenue Close Date"