6Business Component User Properties

Business Component User Properties

This chapter describes business component user properties. It includes the following topics:

• Alphabetic List of Business Component User Properties

• Viewing a Business Component User Property

• Controlling Siebel CRM Data

• Controlling Search and Sort

• Controlling Visibility Filters

• Controlling Records

• Controlling Fields

• Controlling Primaries

• Specifying Business Services

• Controlling Parent and Child Relationships

• Controlling Email

• Controlling Specific Siebel Business Applications

• Doing Other Work

For brevity, this chapter uses the term user property to represent the term business component user property, unless noted otherwise. A business component is the parent of a business component user property.

Alphabetic List of Business Component User Properties

The following table includes an alphabetic list of business component user properties.

Table Alphabetic List of Business Component User Properties

User Property	Topic
Active Field	Making Fields Active
Active Value
Activity SearchSpec	Specifying Search Specifications for the Action Business Component
Admin Mode Field	Allowing Administrators to Modify Records
Admin NoDelete	Preventing Administrators from Deleting Records
Admin NoUpdate	Preventing Administrators from Updating Records
All Mode Sort	Overriding Sort Specifications on Business Components
Always Enable Child: buscompname	Enabling Service Request Updates in Child Business Components
Always Enable Field n	Allowing Users to Update Closed Service Requests
Application Name	Specifying the Application Name
Aspect BC NoInsert: Aspect	Using Aspects to Control Read Only, Insert, and Other Behavior
Aspect BC ReadOnly: Aspect
Aspect Child BC ReadOnly: Aspect
Aspect Default Value: Aspect
Assignment Object	Specifying Assignment Objects
Associate: Completion Timeout	Specifying Server Timeouts for Forecasts
Associate: Completion Timeout (Client)	Specifying Client Timeouts for Forecasts
Associate: Sleep Time Between Attempts	Specifying Sleep Time Between Forecast Save Attempts
AutoPopulateResponsibility	Automatically Assigning Responsibilities to Users
BC eAuto Sales Step	Specifying Opportunity Sales Steps in Siebel Automotive
BC eAuto Sales Step Admin	Specifying the Sales Step Admin in Siebel Automotive
BC Opportunity	Specifying Reassignment in Siebel Automotive
BC Position	Specifying Positions in Siebel Automotive
BC Read Only Field	Making Records Read-Only According to a Field Value
BO eAuto Sales Step Admin	Specifying the Sales Step Admin in Siebel Automotive
Calc Actual OnWriteRecord	Calculating Values When Writing Records
ChargeBusinessService	Determining Charges for Service Activities
ChargeBusinessServiceMethodn	Determining Charges for Service Activities
CloseOutFlag	Setting the CloseOut Flg Field
Contact MVG PreDefault Expression	Adding Contacts to the Action Business Component
Contact-Activity BC Name	Specifying Reassignment in Siebel Automotive
Contact-Opportunity BC Name	Specifying Reassignment in Siebel Automotive
Copy Contact	Copying Contacts to Campaigns
Credit Card Expired Month	Specifying Credit Card User Properties
Credit Card Expired Year
Credit Card Number
Credit Card Type
Credit Check	Enabling Credit Check
Credit Check Workflow	Specifying the Workflow Process for Credit Check
Currency Field n	Modifying the Currency That a Field Uses
Day Number: Arrival Date Field	Specifying the Arrival Date Field for the Day Number Business Service
Day Number: Function BC Name	Specifying the Business Component for the Function Space
Day Number: Room Block BC Name	Specifying the Business Component for the Room Block
DB2 Optimization Level	Specifying the DB2 Optimization Level for SQL Statements
Deep Copy	Copying and Deleting Child and Grandchild Records
Deep Copy/Delete Link Buscomp
Deep Delete
Default Aspect	Using Aspects to Control Read Only, Insert, and Other Behavior
Default Bookmark View	Specifying the Default Bookmark View
DefaultPrefix	Specifying Field Name Prefixes for File Attachment Business Components
Disable Automatic Trailing Wildcard Field List	Disabling Automatic Trailing Wildcards in Queries
DisplayType	Overriding the Type for Fields That Users Read from Right-To-Left
Duplicate Elimination	Removing Duplicate Records From Queries
Dynamic Hierarchy Parent Field Id	Controlling Global Account Visibility
DynHierarchy Hierarchy Id Field
DynHierarchy Visibility Organization Id Field
DynHierarchy Visibility Position Id Field
eAuto Enable Create Sales Step	Specifying Opportunity Sales Steps in Siebel Automotive
Email Activity Accepted Status Code	Specifying Statuses for Outgoing Email
Email Activity New Status Code
Email Activity Rejected Status Code
Email Activity Sent Status Code
Email Manager Compatibility Mode	Specifying the Manager That Sends Email
Employee Link	Controlling My Visibility Filters
Enable Dispatch Board	Enabling the Dispatch Board
Extended Quantity Field	Extending Quote Quantities
Field Read Only Field: fieldname	Making Fields Read-Only
FileMustExist	Making Sure an Attachment File Exists
Forecast Analysis BC	Specifying Business Components for Forecast Analysis
Forecast Rollup	Specifying Search Specifications for Forecast Rollup
Group Visibility	Specifying Group Plus Team Visibility in Campaigns
Group Visibility Only	Specifying Group Only Visibility in Campaigns
Inner Join Extension Table n	Specifying Joins to the S_PARTY Table
Maintain Master Account	Maintaining the Master Account in Account Hierarchies
Manager List Mode	Controlling Manager Visibility Filters
Master Account Field	Specifying the Master Account Field
MVG Set Primary Restricted: visibility_mvlink_name	Specifying Who Can Modify Primary Team Members
Named Method n	Calling Business Service Methods from Business Components
Named Search: Forecast Series Date Range	Specifying Search Specifications for Forecasts
No Change Field n	Disabling Modifications to Saved Records
No Clear Field n	Disallowing Empty Fields
NoDelete Field	Disabling Field Deletion
Non-SalesRep View Mode SearchSpec	Specifying Search Specifications for Nonsales Rep Views
On Condition Set Field Value	Setting Field Values According to Conditions
On Field Update Invoke n	Calling Methods When Siebel CRM Updates Fields
On Field Update Set n	Updating Fields When Siebel CRM Updates Other Fields
OnAddAssocUpdateParent: buscompname	Updating the Parent Business Component if Siebel CRM Modifies Children
Opportunity Name	Specifying Opportunity Business Components in Siebel Automotive
Parent Account Field	Specifying the Field That Stores Parent Account IDs
Parent Read Only Field	Setting Business Components to Read-Only According to a Field Value
Parent Read Only Field: buscompname	Setting Business Components to Read-Only According to a Name
ParentBC Account Id Field	Specifying the Field That Stores Parent Account IDs for Contacts
Picklist Pre Default Field n	Setting Default Values for Fields That Use Drop-Down Lists
Position Join Fields	Specifying Position Join Fields for Siebel Life Sciences
Post Default Created Date To Date Saved	Setting the Field Created Date to the Saved Date
Primary Position Modification	Allowing Only the Primary to Modify Sales Methods for Opportunities
Private Activity Search Spec	Restricting How Siebel CRM Displays Private Activities for Primaries
Protect Seed Data	Protecting Seed Data
PSP: Active	Specifying Business Components for Product Selection and Pricing
PSP: Buscomp Name
PSP: Eligibility Fields
PSP: Eligibility Group
PSP: Eligibility Signal
PSP: Enabled BO: busobjname
PSP: Mode
PSP: Prepick Groups
PSP: Price Fields
PSP: Price Signal
QueryAssistantNumQueries	Adding Search Criteria to the Query Assistant
RBFields	Specifying Room Types for Siebel Hospitality
Recipient Email Address Field	Sending Email Packages to Recipients
Recipient Fax Address Field
Recipient First Name Field
Recipient Id Field n
Recipient Last Name Field
Recipient Preferred Medium Field
Recursive Link	Specifying Recursive Links Between Parent and Child Business Components
Remote Source	Specifying External Data Sources for Business Services
Required Position MVField	Making Sure the Current Employee Holds a Position
Response Type Call Back	Responding to Email or Web Offers
Response Type More Info
Response Type Unsubscribe
Revenue Aggregation Field n	Specifying Revenue Aggregation Fields
Revenue Associate List	Specifying Pop-up Revenues Lists
Revenue Field Map: fieldname	Specifying the Field That Siebel CRM Copies for New Revenue Forecasts
Revision Condition n	Enabling the Revise Button According to Conditions
Revision Copy Field n	Creating Numbered Revisions of Quotes, Orders, or Agreements
Sequence Field	Specifying Sequential Line Numbers for New Records
Sequence Use Max	Specifying Sequential Line Numbers for New Records According to Maximum Values
Service Name	Specifying Business Services for Virtual Business Components
Service Parameters	Specifying Business Service Parameters
Set Primary Sales Rep As Owner	Setting the Primary Sales Rep as the Owner
Set User As Contact	Setting the Current User as the Primary Contact
Skip Existing Forecast Series Date	Disallowing Users to Pick Dates in the Forecast Date Dialog Box
Sort Field Map n	Specifying How to Sort Predefined Queries for Opportunities
Sort Search Optimization	Optimizing Sort Searches
State Model	Specifying State Models
SubCompUpdate On Save	Allowing Users to Update Assets
TargetProp n	Saving Query Results in Target Lists
TypeRetailNew	Specifying Values for New Opportunities in Siebel Automotive
TypeRetailUsed	Specifying Values for Used Opportunities in Siebel Automotive
Update Parent BC	Specifying the Parent Business Component for Accounts
Update Planned Field On Set: StartDate	Updating the Planned Field if the Start Date Field Is Modified
Update Status To Synchronized	Updating the Synchronization Status for Activities
Update Status To Synchronized Types	Specifying Activities to Synchronize for Siebel Mobile
Use Literals For Merge: table_name	Using Literals Instead of Bind Variables When Merging Records
Validate Parent Account	Validating Parent Account IDs
View Aspect	Using Aspects to Control Read Only, Insert, and Other Behavior
View Aspect 1
View Aspect 2
View Aspect: View Name
ViewMode Sort: mode_num	Sorting According to the View Mode That the Business Component Uses
WorkFlow Behaviour	Identifying Business Components That Siebel Financial Services Uses

Viewing a Business Component User Property

This topic describes how to view a business component user property.

To view a business component user property

1. Open Siebel Tools.

2. Choose the View menu, and then click Options.

   Siebel Tools displays the Development Tools Options dialog box.

3. In the Object Explorer Hierarchy window, make sure the Business Component User Prop option contains a check mark, and then click OK.

4. In the Object Explorer, click Business Component.

5. In the Business Components list, locate the business component you must modify.

   For example, locate the Activity Plan business component.

6. In the Object Explorer, expand the Business Component tree, and then click Business Component User Prop.

   The Business Component User Properties list displays the user properties that exist for this business component.

Controlling Siebel CRM Data

This topic describes business component user properties that you can use to control Siebel CRM data. It includes the following topics:

• Controlling Accounts

• Controlling Activities

• Controlling Revenues

• Controlling Campaigns

• Controlling Forecasts

• Allowing Users to Update Closed Service Requests

• Allowing Users to Update Assets

• Adding Contacts to the Action Business Component

• Creating Numbered Revisions of Quotes, Orders, or Agreements

• Extending Quote Quantities

• Automatically Assigning Responsibilities to Users

• Making Sure the Current Employee Holds a Position

• Setting the CloseOut Flg Field

• Specifying State Models

• Specifying Assignment Objects

• Protecting Seed Data

Controlling Accounts

This topic describes business component user properties that you can use to control accounts.

Validating Parent Account IDs

The Validate Parent Account user property validates the parent account ID when Siebel CRM modifies an account hierarchy. It can contain one of the following values:

• Y. Validate the parent account ID.

• N. Do not validate the parent account ID.

It is recommended that you do not modify the default value of this user property. You cannot configure Siebel CRM to deactivate or create a new instance of this user property.

Specifying the Parent Business Component for Accounts

The Update Parent BC user property specifies the name of the parent business component that Siebel CRM updates when it updates an account hierarchy. The value of this user property must contain the name of an active business component.

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

Specifying the Field That Stores Parent Account IDs

The Parent Account Field user property specifies the name of the business component field that stores the parent account ID. The CSSBCAccountSIS class uses this value as the parent account ID for the record.

It is recommended that you do not modify the default value of this user property. You cannot deactivate or create a new instance of this user property.

Specifying the Field That Stores Parent Account IDs for Contacts

The ParentBC Account Id Field user property specifies the name of the field in the parent business component that stores the account ID that Siebel CRM uses to display affiliated contacts. For example:

Account ID

Siebel CRM uses this value in a Siebel Life Sciences application. If this user property does not exist, and if the user clicks the Affiliated Accounts button, then Siebel CRM creates an error.

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

Specifying the Master Account Field

The Master Account Field user property specifies the name of the field that stores the master account ID. The value for this user property must contain the name of a business component field. The CSSBCAccountSIS class uses this value as the master account ID for the record.

It is recommended that you do not modify the value of this user property. You cannot deactivate or create a new instance of this user property.

Maintaining the Master Account in Account Hierarchies

The Maintain Master Account user property maintains the master account ID in an account hierarchy. The value for this user property must contain one of the following values:

• Y. Maintain the master account ID.

• N. Do not maintain the master account ID.

You cannot deactivate or create a new instance of this user property.

Controlling Activities

This topic describes business component user properties that you can use to control activities.

Determining Charges for Service Activities

The ChargeBusinessService user property specifies the name of the business service that Siebel CRM uses to determine charges for a service activity. You must not enclose this name in quotes. For example:

FS Service Charge

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

Specifying the Business Service Method for Activity Charges

The ChargeBusinessServiceMethodn user property specifies the name of the business service method that Siebel CRM uses to determine charges for a service activity. You must not enclose this name in quotes and it must identify a business service method that resides on the business service that the ChargeBusinessService user property specifies. For example, ChargeBusinessServiceMethod1 can contain a value of CreateServiceCharges. This value identifies a method of the FS Service Charge business service.

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

Updating the Synchronization Status for Activities

The Update Status To Synchronized user property sets the status of some activities to Synchronized during a mobile synchronization. It can contain one of the following values:

• Y. Modify the activity status to Synchronized.

• N or this user property does not exist. Do not modify the activity status to Synchronized.

The Update Status To Synchronized Types user property determines the types of activities that Siebel CRM updates.

An activity that includes the Status field set to Synchronized in a Siebel Industry Application is read-only in the Activities view.

Siebel CRM supports this user property in the CSSBCFINSActivity class but not subclasses of this class.

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

Controlling Revenues

This topic describes business component user properties that you can use to control revenues.

Specifying Revenue Aggregation Fields

The Revenue Aggregation Field n user property specifies the business component field that Siebel CRM rolls up into the summary record from the detail records. Details and summaries reside in the same business component. A summary record sums the values from one or more fields that reside in the detail records for the summary date range. The value of this user property must contain the name of a field that resides in the Forecast 2000 -- Forecast Item Detail business component. For example, if you use the following value, then Siebel CRM sums the Amount Revenue field from the detail records, and then stores this sum in the summary record:

Amount Revenue

You can configure Siebel CRM to deactivate this user property.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

Specifying Pop-up Revenues Lists

The Revenue Associate List user property displays an association list if the user clicks New to create a new detail. The value for this user property is a Boolean value. If Y, and if the user clicks New to create a new detail, then Siebel CRM displays a pop-up list that lists revenues. The associated search specification for the current forecast series identifies the revenues that Siebel CRM displays. The user must associate one of these revenues with the forecast instead of adding free text data.

You define this user property on the Forecast 2000 -- Forecast Item business component.

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

Specifying the Field That Siebel CRM Copies for New Revenue Forecasts

The Revenue Field Map: fieldname user property specifies the field that Siebel CRM copies from the Revenue business component to one of the following business components. It copies this value if the user creates a detail in the Forecast Item business component:

• Forecast 2000 -- Forecast Item

• Forecast 2000 -- Forecast Item Detail

Note the following:

• The value of this user property must contain the name of a field that resides in the Revenue business component.

• The fieldname must identify the name of a field that resides in the Forecast 2000 -- Forecast Item business component.

For example, assume you define the user property that the following table describes. You define it on the Forecast 2000 -- Forecast Item business component. In this example, Siebel CRM copies the value of the Sales Rep Organization Id field of the Revenue business to the Organization Id field.

Table Example of the Revenue Field Map: fieldname User Property

User Property	Value
Revenue Field Map: Organization Id	Sales Rep Organization Id

You can configure Siebel CRM to modify the value for this user property, create a new instance of it for each field that Siebel CRM must copy, or deactivate it.

Controlling Campaigns

This topic describes business component user properties that you can use to control campaigns.

Copying Contacts to Campaigns

The Copy Contact user property copies contact associations to a campaign if the user modifies the status of the campaign from Planned to Active. Siebel CRM uses this user property with the DBM Campaign business component. The value for this user property must contain a Boolean value. If TRUE, and if a user modifies the status of a campaign from Planned to Active, then Siebel CRM copies all of the contact associations for the planned campaign to the active campaign.

Specifying Group Only Visibility in Campaigns

The Group Visibility Only user property specifies that Siebel CRM use only group visibility in the campaign. The value for this user property must contain a Boolean value. If TRUE, then Siebel CRM uses only group visibility and you must set the Group Visibility user property to FALSE. Setting the Group Visibility user property to FALSE makes sure Siebel CRM deactivates the Buscomp View Mode user property so that it does not cause an inner join to the S_SRC_POSTN table.

Specifying Group Plus Team Visibility in Campaigns

The Group Visibility user property uses group plus team visibility in a campaign. The value for this user property must contain a Boolean value. If TRUE, then Siebel CRM uses group plus team visibility.

Controlling Forecasts

This topic describes business component user properties that you can use to control accounts. It includes the following topics:

• Specifying Client Timeouts for Forecasts

• Specifying Server Timeouts for Forecasts

• Specifying Sleep Time Between Forecast Save Attempts

• Specifying Search Specifications for Forecasts

• Specifying Search Specifications for Forecast Rollup

• Specifying Business Components for Forecast Analysis

• Disallowing Users to Pick Dates in the Forecast Date Dialog Box

Specifying Client Timeouts for Forecasts

The Associate: Completion Timeout (Client) user property specifies the maximum number of seconds that Siebel CRM waits on the client for a subordinate forecast to finish before it skips the association and creates an error. If Siebel CRM does not create the association, then the user can manually associate the subordinate forecast. Siebel CRM uses this user property in synchronous mode. The value for this user property must contain an integer that is greater than 0.

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

Specifying Server Timeouts for Forecasts

The Associate: Completion Timeout user property for the server specifies the maximum number of seconds that Siebel CRM waits for the Siebel Server for a subordinate forecast to finish before it skips the association and creates an error. The description of the value that you use for this user property is the same as the description of the value that you use for the Associate: Completion Timeout user property for the client. For more information about this description, see Specifying Client Timeouts for Forecasts.

Specifying Sleep Time Between Forecast Save Attempts

The Associate: Sleep Time Between Attempts user property specifies the number of seconds that Siebel CRM waits after each attempt it makes to determine if a subordinate forecast is complete. The description for the value that you use is the same as the description for the Associate: Completion Timeout user property for the client. For more information, see Specifying Client Timeouts for Forecasts.

Specifying Search Specifications for Forecasts

The Named Search: Forecast Series Date Range user property specifies the search specification that Siebel CRM applies on the Revenue business component when it creates a forecast. It makes sure that the revenues that the search returns occur in the Forecast Date range, by default.

The value for this user property must contain a valid search specification. This search specification and the Auto and Assoc search specifications can use special variables that the Forecast Series and Forecast Series Date business components define. For example, consider the following default value of this user property:

[Date] >= '&FCST_DATE_LOWER_BOUND' and [Date] <= '&FCST_END_DATE'

This search specification returns the values that exist between the Date - Lower Bound field and the End Date field of the Forecast 2000 -- Forecast Series Date business component. In this situation, the &FCST_DATE_LOWER_BOUND variable represents the Date - Lower Bound field. If this field:

• Contains a value. Siebel CRM sets the value of the History View Date to the value that the Date - Lower Bound field contains.

• Does not contain a value. If the History Edit field:

  • Contains a value. Siebel CRM sets the Date - Lower Bound field to the value that the History Edit field contains.

  • Does not contain a value. Siebel CRM sets the Date - Lower Bound field to the value that the Start Date contains.

You can configure Siebel CRM to deactivate this user property or modify the value for it. If you deactivate it, then you must make sure that the Siebel CRM limits the revenues in the forecast according to date. To do this, you can modify the Auto and Assoc search specifications of the Forecast Series. You cannot configure Siebel CRM to create a new instance of this user property.

For more information, see How This Book Describes the User Property Format.

Specifying Search Specifications for Forecast Rollup

The Forecast Rollup user property contains a search specification that Siebel CRM applies to the Forecast Detail business component during a forecast rollup. Siebel CRM rolls up only the detail records that satisfy the search specification. It rolls up these records into the summary record. The value for this user property must contain a valid search specification.

For example, the following search specification returns forecast details that the current user owns. It also returns any subordinate records that exist that Siebel CRM rolls into this forecast:

[Link Type] = LookupValue('FCST_FCSTITEM_LINK_TYPE','Own Item')
OR [Link Type] = LookupValue('FCST_FCSTITEM_LINK_TYPE','Item') 

To restrict this search specification according to a series, you can use the Forecast 2000 -- Forecast Series business component.

It is recommended that you do not modify the value of this user property for a predefined business component that Siebel CRM uses for forecasting.

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

For more information, see How This Book Describes the User Property Format.

Specifying Business Components for Forecast Analysis

The Forecast Analysis BC user property specifies the name of the business component that provides the records that Siebel CRM displays in the lower applet of a forecast analysis view. This type of view allows the user to choose multiple forecasts, and then to view an aggregate summary of records in a lower applet. The value for this user property must contain the name of a business component. For example:

Forecast 2000 – Forecast Item Detail Flat

It is recommended that you do not modify the value of this user property for a predefined business component that Siebel CRM uses for forecasting.

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

Disallowing Users to Pick Dates in the Forecast Date Dialog Box

The Skip Existing Forecast Series Date user property configures Siebel CRM to not allow the user to pick a date in the Forecast Date dialog box in a Forecast view. It applies this restriction only if a forecast already exists for the current user for the current date. It can contain one of the following values:

• Y. Do not display the date. The user cannot pick another date.

• N. Display the date and allow the user to pick it.

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

Allowing Users to Update Closed Service Requests

The Always Enable Field n user property updates the fields that reside in a closed service request. It must contain the name of the field that Siebel CRM must update.

If a user sets the Status field on a service request to Closed, then Siebel CRM sets the Sub-Status field to Resolved and makes the record read-only except for the Status and Sub-Status fields. The CSSBCServiceRequest specialized business component class controls this behavior. For important caution information, see Using Specialized Classes.

If the business component includes:

• One instance of this user property. This instance must not include the numeric suffix.

• More than one instance of this user property:

  • The first instance must not include the numeric suffix.

  • Subsequent instances must include the numeric suffix, numbered sequentially.

    You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

You can configure Siebel CRM to deactivate this user property, modify the values for it, or to create a new instance of it.

Allowing Users to Update Assets

The SubCompUpdate On Save user property specifies whether the user can update an asset record. It can contain one of the following values:

• TRUE. The user can update an asset record.

• FALSE. The user cannot update an asset record and Siebel CRM disables any SubCompCanUpdate and SubCompUpdate field user properties that exist on fields that the business component contains. For more information, see Updating Assets and Cascading Asset Updates.

Adding Contacts to the Action Business Component

The Contact MVG PreDefault Expression user property identifies the predefault contact record that Siebel CRM adds to the Contact multivalue field of the Action business component. The value for this user property must use the following format:

Parent: 'Contact.Id', 'Service Request.Contact Id', 'Service Agreement.Contact Person Id'

For more information, see How This Book Describes the User Property Format.

Siebel CRM supports this user property for business components that reference a CSSBCActivity class, such as CSSBCFINSActivity. The business component where you add this user property must include a multivalue field named Contact Id or Contact Id (Thin).

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

Creating Numbered Revisions of Quotes, Orders, or Agreements

The Revision Copy Field n user property and Revision Field property creates a numbered revision of a quote, order, agreement, and so on. If the user clicks Revise to create a new record as a copy of the current record, then this user property copies the value that resides in a field of the current record to the new record. Note the following:

• This user property must contain the name of a business component field.

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

• You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

For more information, Revise Method.

In the following example, you use the Revision Copy Field and Revision Field user properties to create an updated revision of a quote.

To create numbered revisions of quotes, orders, or agreements

1. Open the Business Component User Properties list for the Quote business component.

   For more information, see Viewing a Business Component User Property.

2. Add a user property using values from the following table.

   Property	Value
   Revision Copy Field 1	Quote Number

3. Add a user property using values from the following table.

   Property	Value
   Revision Copy Field 2	Credit Card Number

4. Add a user property using values from the following table.

   Property	Value
   Revision Field	Revision

5. Compile your modifications.

6. Open the client, and then use the Revise button to create a new quote.

   The Revision field contains the next number that occurs in the revision sequence. This number is one more than the maximum number that the current record contains. The Quote Number and Credit Card Number fields contain the same values that the current record contains.

Extending Quote Quantities

The Extended Quantity Field user property defines the line item business component that Siebel CRM uses for a quote. For example, Quote Item. The value for this user property must contain the field name for the Extended Quantity in the line item. For example:

Extended Quantity Requested

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

Automatically Assigning Responsibilities to Users

The AutoPopulateResponsibility user property associates a responsibility with a new user when Siebel CRM creates a record. It must contain a Boolean value. If TRUE, then Siebel CRM associates a responsibility with a new user when it creates a record. The New Responsibility field for the current user identifies this responsibility. Note the following:

• This user property requires that the responsibility multivalue field is named Responsibility.

• If Siebel CRM uses the business component in the EAI or Siebel Adapter context, then it ignores this user property.

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

Making Sure the Current Employee Holds a Position

The Required Position MVField user property modifies the behavior of the WriteRecord method to require that the current employee must hold at least one position. The value for this user property must use the following format:

"[employee_flag]", "[position multivalue field]"

where:

• employee flag identifies the employee flag field that references the EMP_FLG column of the S_CONTACT table.

• position multivalue field identifies the multivalue field that contains the positions that the employee holds. You must make sure that the relationship that this multivalue field uses references the S_PARTY_PER table. You must not use the relationship that Siebel CRM uses with the positions that reference the employee or contact record that references the S_POSTN_CON table.

The code that Siebel CRM runs during a WriteRecord event determines whether it sets the value of the Employee Flag to Y:

• If it is Y, and if a position is associated with the current employee record, then no error occurs.

• If it is not Y, or if a position is not associated with the current employee record, then the WriteRecord event does not start and Siebel CRM creates an error.

If the EAI or Siebel Adapter context uses the business component, then Siebel CRM ignores this user property.

You can use this user property only with a business component that stores employee information.

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

For more information, see How This Book Describes the User Property Format.

Setting the CloseOut Flg Field

The CloseOutFlag user property specifies the value of the CloseOut Flg field for the parent business component. It must contain a Boolean value of Y or N. You can configure Siebel CRM to deactivate this user property or modify the value for it, but not to create a new instance of it.

Specifying State Models

The State Model user property adds a business component to the business components that a multi-value group applet displays. This applet resides in the State Model business component. The value for this user property must contain a Boolean value. If Y, then Siebel CRM adds the business component where you define this user property to the multi-value group applet. For more information about the State Model, see Siebel Applications Administration Guide.

Specifying Assignment Objects

The Assignment Object user property identifies the assignment object that Siebel CRM uses when it sets the Assignment Object Name (AsgnObjectName) parameter of the Assignment Manager server component when it runs an interactive assignment. The value for this user property must contain the name of an assignment object that is a child of a workflow policy object. You must enclose this assignment object in quotes.

For example, the Activity List View references the Action business component. If you set the Assignment Object user property on the Action business component to Activity, and if the user chooses Assign from the Tools menu while the user is in a child form applet in the Activity List View, then Siebel CRM adds the activity instead of some other object to the Assignment Manager queue for reassignment to a new owner.

You can configure Siebel CRM to deactivate this user property only if you disable interactive assignment, and only if you also remove any related controls from the client. You can configure Siebel CRM to modify the values for this user property, but not to create a new instance of it.

Protecting Seed Data

The Protect Seed Data user property prevents Siebel CRM from modifying seed data records of a business component. You can set it to one of the following values:

• Y. The user cannot modify or delete seed data records.

• N. The user can modify or delete seed data records.

For example, if you add this user property with a value of Y to the Responsibility business component, then the user cannot modify or delete any seed data responsibility record that starts with zero (0).

You can start the client in one of the following ways to override this user property:

• Append the following parameter to the command line that opens Siebel CRM, as defined in the properties dialog box for Siebel CRM shortcut in Windows:

  /editseeddata

• Append the following parameter to the UNIX command line that opens Siebel CRM:

  /editseeddata

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

Controlling Search and Sort

This topic describes business component user properties that you can use to control search and sort. It includes the following topics:

• Optimizing Sort Searches

• Removing Duplicate Records From Queries

• Overriding Sort Specifications on Business Components

• Sorting According to the View Mode That the Business Component Uses

• Disabling Automatic Trailing Wildcards in Queries

• Adding Search Criteria to the Query Assistant

• Saving Query Results in Target Lists

• Specifying How to Sort Predefined Queries for Opportunities

• Specifying Search Specifications for the Action Business Component

• Specifying Search Specifications for Nonsales Rep Views

Optimizing Sort Searches

The Sort Search Optimization user property helps a database work with a rules-based optimizer (RBO). You can set it to one of the following values:

• TRUE. Enable sort search optimization.

• FALSE. Disable sort search optimization.

The Sort Search Optimization user property chooses an index from multiple indexes. To do this, it adds a search term to the SQL statement that does not modify the search result but that provides the rules-based optimizer with more information to help it choose the correct index. The Sort Search Optimization user property sets the column in this search term to the first column of the sort specification. For example, assume a query includes the following sort:

ORDER BY

NAME, START_DT

In this example, the Sort Search Optimization user property adds the following search term to the SQL statement:

NAME >= '\1'

where:

• '\1'

  represents the ASCII 0 character.

Searching for values that are greater than ASCII 0 does not remove any information from the search result, but this search term helps the optimizer to choose the most effective index. This configuration improves the query performance when the business component specifies a sort specification and if the optimizer fails to choose the correct index. This access requires Sales Rep or Organization visibility, because All or All Across Organization visibility typically overrides sort specifications.

The Sort Search Optimization user property works only with Oracle 8 databases or with Oracle 9i databases that support a rules-based optimizer. It does not work with cost-based optimizers. Siebel CRM does not support it starting with Siebel CRM release 8.x. Siebel CRM disables Sort Search Optimization for DB2. For more information about rules-based optimizers, see Oracle9i Database Performance Tuning Guide and Reference.

Removing Duplicate Records From Queries

The Duplicate Elimination user property removes duplicate records from the result set of a query on a business component that runs in ForwardOnly mode. This result set might include multiple copies of the same record if one of the following situations exists:

• The intersection table includes duplicate rows. For example, Start Date is part of the association, and associations with different start dates are logically unique.

• The join references one or more destination columns that are not unique, and no join constraints or run-time search specifications exist.

You can use the Duplicate Elimination user property to determine how Siebel CRM handles these multiple copies. The value for this user property must contain a Boolean value. If:

• TRUE. Siebel CRM only aggregates the set of unique records that the memory currently contains. Do not do this aggregation as part of the SQL in the database layer.

• FALSE or this user property does not exist on the business component. Siebel CRM aggregates the set of unique records as part of the SQL that runs in the database layer. This aggregation provides superior performance. However, if any of the following conditions apply, then the Siebel Object Manager does this aggregation after Siebel CRM reads all rows from the database:

  • The Database Aggregation Flag parameter in the Server Datasource section of the configuration file is FALSE. This configuration sets Siebel CRM to server mode.

  • The DBAggregation parameter in the application .cfg file on the Mobile Web Client is FALSE.

  • A search specification includes a clause that the database cannot evaluate. Siebel CRM must evaluate this specification in memory.

  • Aggregation in the database fails for some reason.

This user property determines how Siebel CRM does aggregation. You must first make multiple settings in Siebel Tools to enable aggregation on a list column or for a multivalue link.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

For more information about:

• Setting parameters in the configuration file, see Siebel System Administration Guide.

• Account hierarchies, see Siebel Applications Administration Guide.

• Configuring a list applet to display totals or to display totals in a separate applet for a multivalue link, see Configuring Siebel Business Applications.

• ForwardOnly mode, see Siebel Object Interfaces Reference.

Using Duplicate Elimination with a Denormalized Relationship

A situation might exist where Siebel CRM might denormalize the relationship and view that it uses for associations that exist in the context of the parent record. It might repeat the same parent row in the result set as an association to different child records that reside in the intersection table even if no duplicate associations exist. In this situation, it might be preferable to configure Siebel CRM to not reject duplicates.

Overriding Sort Specifications on Business Components

The All Mode Sort user property overrides the default sort specification that a business component contains. It can contain one of the following values:

• Normal. Use the Sort Specification property of the business component. This value allows the user to run a predefined query that incorporates a SORT. Any query that Siebel CRM does in a workflow process uses this Sort Specification property even if no visibility is set for the view.

• TRUE. Override the Sort Specification property of the business component. Use the U1 index. This index is the predefined user key. If Siebel CRM defines this user key on the primary extension table, especially for a business component that references the S_PARTY table, then this behavior reverts to Normal.

• FALSE. Remove all sorting.

Guidelines for Overriding Sort Specifications on Business Components

Siebel CRM overrides the sort specification on the business component for some visibility types to force the view to use an ORDER BY sort with the predefined user key. The All Mode Sort user property determines whether Siebel CRM overrides this sort specification. If it does do this override, then this user property determines the sort that Siebel CRM applies, if any, to the business component for the affected views.

If you set the Visibility Applet Type property of the view to one of the following values, then the All Mode Sort user property affects this view:

• All

• Catalog

• Group

• Manager

• Organization

• Sub-Organization

Note the following:

• If you set this user property to Personal or Sales Rep, then the All Mode Sort user property does not affect the view.

• If you configure the default sort order so that it sorts one of these views, then this configuration might display a large amount of data that Siebel CRM typically sorts only according to a user key.

• If you use All Mode Sort to override the default sort behavior, then it is recommended that you contact your database administrator to get guidance on how the database indexes the sort-by fields.

• It is recommended that you performance test the view and any reports that use the view.

Sorting According to the View Mode That the Business Component Uses

The ViewMode Sort: mode_num user property specifies a sort specification on a business component that is in view mode. The value for this user property must use the following format:

field name1, field nameN

where:

• field name identifies the name of a business component field.

The order that you use in this value determines the priority that Siebel CRM uses for each field that the sort uses.

Caution: To avoid a performance problem, any sort that you define must reference an indexed column. The items in this sort sorts must occur in the same sequential order that this index uses. This configuration includes any sort that you define with the ViewMode Sort user property.

mode_num contains an integer that identifies a view mode. The following table describes the integers that you can use. For information about these integers, see Siebel Object Interfaces Reference.

Table View Modes That You Can Use with the ViewMode Sort User Property

Integer	View Mode
1	ManagerView
3	AllView
5	OrganizationView
7	GroupView
8	CatalogView
9	SubOrganizationView

You can use the ViewMode Sort user property to sort items in a view that uses visibility other than the Personal or Sales Rep visibility. You can use it with the following views:

• All

• Catalog

• Group

• Manager

• Organization

• Sub-Organization

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

Example of Configuring the ViewMode Sort User Property

If you set the All Mode Sort user property to FALSE for a business component, and if Siebel CRM displays this business component in a view mode that the ViewMode Sort user property supports, then Siebel CRM ignores all other sort specifications. For example, assume Siebel CRM must sort the records in a business component according to the Last Name field, and then by First Name, and that it must do this sort only if it displays this business component in an All view mode. The following table describes the user properties that you can add to the business component to support this example. For more information, see Overriding Sort Specifications on Business Components.

Table Example of Configuring the ViewMode Sort User Property

User Property	Value
All Mode Sort	FALSE
ViewMode Sort:3	Last Name, First Name

Disabling Automatic Trailing Wildcards in Queries

The Disable Automatic Trailing Wildcard Field List user property disables the automatic trailing wildcards that Siebel CRM uses in a query on a field. You cannot disable this user property for a DTYPE_PHONE field.

The value for this user property must contain a list of fields separated by commas. You can add this user property to a business component to disable automatic trailing wildcards for individual fields. For example:

• Name. Disable Automatic Trailing Wildcard Field List.

• Value. First Name, Last Name.

To disable automatic trailing wildcards

1. In the Siebel Web Client, navigate to the Administration - Server Configuration screen, Enterprises, and then the Component Definitions view.

2. In the Component Definitions list, locate the relevant component.

   For example, to disable automatic trailing wildcards for Siebel Sales, locate the following component:

   Sales Object Manager (ENU)

3. Click Menu, and then click Start Reconfiguration.

4. In the Component Parameters list, locate Automatic Trailing Wildcard, and then set the Value field to FALSE.

5. In the Component Parameters list, click Menu, and then click Commit Reconfiguration.

6. Restart the server component.

   For more information about starting and stopping server components, see Siebel System Administration Guide.

Adding Search Criteria to the Query Assistant

The QueryAssistantNumQueries user property adds a search criterion to the Query Assistant. The predefined Query Assistant uses four search criteria in a query. Siebel CRM displays them as four rows that the user can choose. It also includes an operator for the query and the value that Siebel CRM must query.

The following information lists the predefined fields in the Query Assistant business component that correspond to each other for each criteria.

Table Fields That Correspond to Each Other for Each Criteria

Query Field	Operator Field	Value Field
Field1	Operator1	Value1
Field2	Operator2	Value2
Field3	Operator3	Value3
Field4	Operator4	Value4

To add search criteria to the Query Assistant

1. In the Business Component User Properties list, locate the QueryAssistantNumQueries user property, and then set the Value property to 5.

   For more information, see Viewing a Business Component User Property.

2. In the Object Explorer, click Field.

3. In the Fields list, click the Field4 field, choose the Edit menu, and then click Copy Record.

4. Set the Name property to Field5.

5. In the Fields list, click the Operator4 field, choose the Edit menu, and then click Copy Record.

6. Set the Name property to Operator5.

7. In the Fields list, click the Value4 field, choose the Edit menu, and then click Copy Record.

8. Set the Name property to Value5.

9. Add a control for each field that maps to the Query Assistant applet.

10. Display the controls in the Web layout.

Saving Query Results in Target Lists

The TargetProp n user property specifies a target list for a business component. It uses the following format:

"EntityDisplayName", "MVFName", "ListCategory"

where:

• EntityDisplayName identifies a language-independent code value that the SLM_FIELD_DISPLAY list of values contains.

• MVFName identifies the name of the multivalue field that stores the target list.

• ListCategory identifies one of the display values that the SLM_LST_CATEGORY list of values contains. These values are Account, Contact, Employee, Position, or Prospect.

For example:

"Accounts", "List Mgmt List Id", "Accounts"

Targeting is a type of query that allows the user to save query results in a target list, and then apply this list to other views.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it for each target list, or deactivate it.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

For more information, see How This Book Describes the User Property Format.

For more information about how to configure a target list, see the topic about global target list management in the Siebel Applications Administration Guide.

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 the following table describes in the Opportunity business component.

Table Example of Configuring the Sort Field Map User Property

User Property	Value
Sort Field Map 1	"Revenue","Primary Revenue Amount"
Sort Field Map 2	"Close Date","Primary Revenue Close Date"

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"

Specifying Search Specifications for the Action Business Component

The Activity SearchSpec user property specifies a search specification for the Action business component. The value for this user property must contain a valid search specification. For example:

[Status]= LookupValue('EVENT_STATUS', 'Open') AND [Class] = LookupValue('FS_ACTIVITY_CLASS',
'Sales Activity')

You can configure Siebel CRM to deactivate this user property or modify the value for it, but not to create a new instance of it. For more information, see How This Book Describes the User Property Format.

Specifying Search Specifications for Nonsales Rep Views

The Non-SalesRep View Mode SearchSpec user property specifies the search specification that Siebel CRM uses on a business component if it is not in Sales Rep mode. The value for this user property must contain a valid search specification for the business component.

The fields that you include in this search specification must exist in the business component and the values for the fields must be valid. For example, the following search specification is valid:

"[Secure Flag] = 'N' OR [Secure Opty Id] IS NOT NULL"

This specification references the Secure Flag field and the Secure Opty Id field. It configures Siebel CRM to display business component records that are not secure. It also displays records that include a value in the Secure Opty Id field. This configuration indicates that the current record is not secure.

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

For more information, see How This Book Describes the User Property Format.

Controlling Visibility Filters

This topic describes business component user properties that you can use to control visibility filters. It includes the following topics:

• Controlling Global Account Visibility

• Controlling My Visibility Filters

• Controlling Manager Visibility Filters

Controlling Global Account Visibility

The dynamic hierarchy user properties define relationships that control visibility in Global Accounts views that the Accounts screen contains. The value for these user properties must contain the name of a field that resides in the current business component, not enclosed in quotes.

Siebel CRM provides default values for this user property for the business components that the following items in Global Account views reference:

• Subaccounts

• Contacts

• Activities

• Opportunities

• Sales teams

If your Siebel CRM implementation does not use global accounts, then you can deactivate this user property. It is recommended that you seek technical assistance because inactivating this user property might affect the account reporting hierarchy relationship. For more information, see Getting Help From Oracle.

You must not configure Siebel CRM to create a new instance of this user property.

Dynamic Hierarchy Id Field

The DynHierarchy Hierarchy Id Field user property specifies a business component field that defines a join to an account hierarchy. This relationship determines the business component records that Siebel CRM displays in the flat list that it associates with an account hierarchy in Global Accounts views.

For example, the value of this user property in the Global Account Action business component is Dynamic Hierarchy Id. The content of the Dynamic Hierarchy Id field on the Global Account Action business component is the ID of a record that resides in the table that defines account hierarchies. Siebel CRM associates a Global Account Action record with the account hierarchy where the activity account resides. Siebel CRM displays this record in the flat list of activities for the parent account and for any other account that exists in the hierarchy.

Dynamic Hierarchy Parent Field Id

The Dynamic Hierarchy Parent Field Id user property specifies a business component field that stores the ROW_ID of the parent account for the account hierarchy. For example, Account. This field must be active or the Force Active property of the field must be TRUE.

Dynamic Hierarchy Visibility Organization Id Field

The DynHierarchy Visibility Organization Id Field user property specifies a business component field that defines the join between accounts and organizations. This relationship identifies the records that Siebel CRM displays in the flat list of the business component if the user clicks All Global Accounts or All Global Accounts Across Organizations.

For example, the value of this user property on the Global Account Contact business component is DynHierarchy Visibility Organization Id. The default value of the DynHierarchy Visibility Organization Id field is the alias of the join that joins accounts and organizations. Siebel CRM associates a Global Account Contact record to the same organization that it associates with the account.

If the user sets visibility to All Global Accounts, then the hierarchy only displays accounts that reference the same organization that the user position references. This organization includes only the contact records that the account contains that Siebel CRM displays in the flat list of contacts for a hierarchy.

Dynamic Hierarchy Visibility Position Id Field

The DynHierarchy Visibility Position Id Field user property specifies the business component field that specifies the join to positions. This relationship defines the records that Siebel CRM displays in the flat list of the business component if the user clicks My Global Accounts.

For example, the value of this user property on the Global Account Opportunity business component is DynHierarchy Visibility Position Id. The default value of the DynHierarchy Visibility Position Id field is the alias of the join that joins positions or team members and accounts. Siebel CRM associates a Global Account Opportunity record with the team members that exist on the account. If the user clicks My Global Accounts, then the hierarchy displays only the accounts that include the user position on the account team. It displays the opportunity records in the flat list of opportunities for an account hierarchy. It displays an opportunity only if the current user is on the account team that includes this opportunity.

Controlling My Visibility Filters

The Employee Link user property restricts data visibility to the data that Siebel CRM associates with the user login. The value for this user property must contain the name, not enclosed in quotes, of a link that includes the following items:

• Parent business component is Employee.

• Child business component is the current business component.

For example:

Employee/My Competitor

Siebel CRM uses the business component where you set this user property to configure the My view that restricts data according to the user name that the user enters during the login instead of the position.

For example, the My Competitor business component provides data for the SI Com Tracked Competitors View in Siebel Briefings. Siebel CRM labels this view as My Tracked Competitors in the client. It sets the Employee Link user property that resides on the My Competitor business component to Employee/My Competitor. This view only lists competitor records that the Employee/My Competitor link associates with the user. These are the competitors that the user enters.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

Controlling Manager Visibility Filters

The Manager List Mode user property specifies the records that Siebel CRM displays in a manager view. The value for this user property must contain one of the following values:

• Primary. Display only the records that are related to the primary team members who report to this manager.

• Team. Display the records for all people who report to the manager. Siebel CRM does a subquery for the My Team's view so that it can get and display the accounts, opportunities, and so on for all members that the team contains, and not only for the primary team members. Performance is slower but this query yields more data.

Controlling Records

This topic describes business component user properties that you can use to control records. It includes the following topics:

• Making Records Read-Only According to a Field Value

• Disabling Modifications to Saved Records

• Allowing Administrators to Modify Records

• Preventing Administrators from Deleting Records

• Preventing Administrators from Updating Records

• Calculating Values When Writing Records

• Specifying Sequential Line Numbers for New Records

• Specifying Sequential Line Numbers for New Records According to Maximum Values

• Setting Business Components to Read-Only According to a Field Value

• Setting Business Components to Read-Only According to a Name

• Using Literals Instead of Bind Variables When Merging Records

Making Records Read-Only According to a Field Value

The BC Read Only Field user property specifies the business component field that determines whether a record is read-only. If the value that this field contains is TRUE, then the current record is read-only.

If you set the Admin Mode Flag property to TRUE, then this setting overrides the BC Read Only Field user property. For information, see Allowing Administrators to Modify Records.

Disabling Modifications to Saved Records

The No Change Field n user property disallows modifying a field value after Siebel CRM saves the record. It must specify the name of a business component field, not enclosed in quotes.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

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

Allowing Administrators to Modify Records

The Admin Mode Field user property determines whether a business component is currently in Admin mode. It allows an administrator to delete, insert, merge, or update records regardless of how you set the following business component properties:

• No Delete

• No Insert

• No Merge

• No Update

Siebel CRM typically sets the Admin Mode Flag property of an administrative view to TRUE to allow an administrator to configure Siebel CRM to do these operations regardless of how you set these properties.

Requirements for Using Admin Mode

If you set the Admin NoDelete user property on a business component, then Siebel CRM cannot delete records in any view that references this business component. This situation also applies for the Admin NoUpdate user property. For more information about Admin Mode, see Siebel Security Guide and Configuring Siebel Business Applications.

The value for this user property must contain the name of a field, not enclosed in quotes. This field must possess the following characteristics:

• Reside in the current business component

• Active

• Calculated

• Of type DTYPE_BOOL

• Contain a value of ""

Siebel CRM uses the value of the Admin Mode Flag property of the current view to determine the business component behavior at runtime. For example, assume you create a calculated business component field and name it IsAdminMode. It is recommended that you use this naming format, but it is not required. You add the Admin Mode Field user property with a value of IsAdminMode to the business component.

Caution: All views and drilldowns that a screen contains that are enabled for Admin Mode also work in Admin Mode because of their subordinate relationship to the screen. This behavior applies even if you set the Admin Mode Flag property of a view to False.

You can configure Siebel CRM to modify the value for this user property, deactivate it, or create a new instance of it, but no more than one instance for each business component.

Using a Script to Set the Admin Mode

You can use the Admin Mode Field user property in a script to determine if a business component is currently in Admin mode. The following example displays Y only if the business component is currently in Admin mode:

function BusComp_NewRecord ()
{
var isAdmin = this.GetFieldValue("IsAdminMode");
var WshShell = COMCreateObject("WScript.Shell");
WshShell.Popup(isAdmin);
}

Preventing Administrators from Deleting Records

The Admin NoDelete user property prevents Siebel CRM from deleting business component records if a view is Admin mode. It must contain a Boolean value of Y or N. If a business component does not include this user property, then Siebel CRM defaults this value to N.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

For more information, see Allowing Administrators to Modify Records.

Preventing Administrators from Updating Records

The Admin NoUpdate user property prevents Siebel CRM from updating business component records if a view is in Admin mode. It must contain a Boolean value of Y or N. If a business component does not include this user property, then Siebel CRM defaults this value to N.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

For more information, see Allowing Administrators to Modify Records.

Calculating Values When Writing Records

The Calc Actual OnWriteRecord user property calculates a number when Siebel CRM writes a record. It can contain one of the following values:

• Y. Calculate the Actual Number.

• N. Do not calculate the Actual Number.

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

Specifying Sequential Line Numbers for New Records

The Sequence Field user property configures a sequence field to create a sequential line number when Siebel CRM creates a new record or copies a record. This user property must contain the name of the business component field that corresponds to the sequence number column that resides in the table that this business component references. This field is typically Line Number or Sequence Number. Note the following:

• The business object must reference a sequence business component.

• You must set the Insert Position property to LAST for each applet that displays a record from the numbered detail business component. If this user property is empty, then unexpected behavior might result in the line numbers that Siebel CRM creates in the applet.

• You must do other configuration work. For more information, see the topics that describe creating a sequence field in Configuring Siebel Business Applications.

For information about how Siebel CRM uses a sequenced field to number a new record, see Specifying Sequential Line Numbers for New Records According to Maximum Values.

Specifying Sequential Line Numbers for New Records According to Maximum Values

The Sequence Use Max user property creates a sequence number for a new or copied record. It must specify one of the following values:

• Y. Set the sequence number to the maximum existing sequence number plus 1.

• N or this user property does not exist. Set the sequence number to the sequence number of the current record plus 1. Renumber other records, if necessary.

For example, the following table describes a configuration that defines the Line Number field as the sequence field and sets the sequence for any new or copied record to the value of the maximum existing sequence plus 1. For more information, see Specifying Sequential Line Numbers for New Records.

Table Example of the Sequence User Properties

User Property	Value
Sequence Field	Line Number
Sequence Use Max	Y

Setting Business Components to Read-Only According to a Field Value

The Parent Read Only Field user property sets a business component to read-only according to the value that a field contains. It restricts the detail records that Siebel CRM displays in a multivalue group. The value for this user property must use the following format:

buscompname.fieldname

where:

• buscompname specifies the name of the parent business component.

• fieldname specifies the name of a field that resides in the parent business component. If Siebel CRM evaluates the value of this field to TRUE or Y, then it sets the current business component to read-only. Note the following:

  • The business component that contains this field must be a parent or grandparent of the business component that Siebel CRM sets to read-only. A link or a series of links must create this relationship.

  • The Link Specification property of this field must be set to TRUE. If it is FALSE, then this user property does not work correctly. The exception is if Siebel CRM displays the child record in the multivalue field in the parent business component, then you can set this Link Specification property to FALSE.

To restrict the detail records that Siebel CRM displays in a master and detail view, you must make sure that some other business object does not use the business component that Siebel CRM sets to read-only.

You add this user property to the business component that Siebel CRM must set to read-only.

For more information, see How This Book Describes the User Property Format.

For more information about the Parent Read Only Field user property, see Configuring Siebel Business Applications.

Setting Business Components to Read-Only According to a Name

The Parent Read Only Field: buscompname user property specifies the name of a field that resides in a parent business component. This business component contains a calculated field that Siebel CRM evaluates to TRUE or FALSE or Y or N. This behavior is similar to Setting Business Components to Read-Only According to a Field Value, except that the name instead of the value specifies the name of the parent business component. If the calculated field evaluates to TRUE or Y, then Siebel CRM sets the child business component to read-only.

The value for this user property must contain a field name.

This user property uses multiple fields as part of the decision to make the current record read only. For example, the following table describes a configuration that makes a contact read-only in a parent service request, account, or opportunity according to different fields that reside in these parents. If the current record that resides in the Contact business component includes a parent of Service Request, Account, or Opportunity, and if Siebel CRM evaluates the field that the Value property identifies to TRUE, then it sets the record to read-only.

Table Example of Using the Parent Read Only Field: buscompname User Property

User Property Name	Value
Parent Read Only Field: Service Request	field name
Parent Read Only Field: Account	field name
Parent Read Only Field: Opportunity	field name

Using Literals Instead of Bind Variables When Merging Records

The Use Literals For Merge: table_name user property creates a literal in an SQL statement for predicates that reside on a column that possesses low cardinality. It can contain one of the following values:

• TRUE. Use a literal value instead of a bind variable as criteria in an SQL statement where the predicate resides on a column that is a foreign key to table_name.

• FALSE or the user property does not exist. Use a bind variable instead of a literal value.

table_name identifies the name of a table. The current business component includes a field that is a foreign key column to this table.

For example, assume you add the following user property and set the value for it to TRUE:

Use Literals For Merge:S_BU

In this example, Siebel CRM uses literals instead of bind variables in SQL statements whose predicates reside on a column that is a foreign key to S_BU.

Siebel CRM uses a bind variable for all predicates when it merges records. In some situations, if the cardinality of the column is low, and if using an index is more efficient, then DB2 does table scans.

You add this user property to the business component where Siebel CRM merges records.

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

Controlling Fields

This topic describes business component user properties that you can use to control fields. It includes the following topics:

• Making Fields Active

• Making Fields Read-Only

• Disallowing Empty Fields

• Disabling Field Deletion

• Setting Field Values According to Conditions

• Updating Fields When Siebel CRM Updates Other Fields

• Calling Methods When Siebel CRM Updates Fields

• Setting the Field Created Date to the Saved Date

• Updating the Planned Field if the Start Date Field Is Modified

• Overriding the Type for Fields That Users Read from Right-To-Left

• Setting Default Values for Fields That Use Drop-Down Lists

• Modifying the Currency That a Field Uses

• Specifying Field Name Prefixes for File Attachment Business Components

For information about using field user properties to control fields, see Field User Properties.

Making Fields Active

The following user properties together determine if a record is active:

• Active Field. Specifies the business component field that Siebel CRM uses as the active flag for this business component.

• Active Value. Specifies how to interpret the value of this flag.

The value for the Active Field user property must contain the name of a field that resides in the current business component and that Siebel CRM uses as the active flag for this business component. You must enclose this value in quotes.

If the value of the active flag for a record is:

• Y. This record is active in any of the following situations:

  • The value of the Active Value user property is Y.

  • The Active Value user property does not exist for a business component.

• N. If the value of the Active Value user property is N, then this record is active.

Consider the following example:

• The value of the Active Field user property on the Quote business component is Active.

• The Active Value user property does not exist on the Quote business component.

In this situation, if the value of the Active field on a record is Y, then this record is active.

Consider the following example:

• The value of the Active Field user property of the Fund business component is Locked Flag.

• The value of the Active Value user property of the Fund business component is N.

In this situation, if the value of the Locked Flag field on a record is N, then this record is not locked.

Siebel CRM can update an active record. It cannot update a record that is not active.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

Making Fields Read-Only

The Field Read Only Field: fieldname user property sets a business component field to read-only. The fieldname value for this user property must contain the name of a business component field. This field must contain a Boolean value.

If Siebel CRM evaluates the field that this user property references to TRUE at runtime, then it sets the field that fieldname specifies to read-only.

For example, if Field Read Only Field: Sales Rep contains a value of Calculated Primary Flag, and if the Calculated Primary Flag field is TRUE, then Siebel CRM sets the Sales Rep field to read-only.

Caution: You must not use this user property with the Abstract field of the Service Request business component. If you do this, then Siebel CRM examines the Abstract field to determine if it is read-only. If it is read-only, then the entire Service Request business component becomes read-only and the user cannot add an activity or attachment to a service request.

This user property does not work correctly on the Fund Request business component because of the specialized business component code that the parent CSSBCFundReq class contains. For important caution information, see Using Specialized Classes.

Disallowing Empty Fields

The No Clear Field n user property disallows setting a field value to an empty value. It must specify the name of a business component field, not enclosed in quotes.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

Disabling Field Deletion

The NoDelete Field user property restricts the records that Siebel CRM deletes. It must specify the name of a business component field.

Siebel CRM does not delete records that contain a value of Y in the business component field that you specify. For example, assume the following configuration exists on the Contact business component:

• The NoDelete Field user property contains a value of Protect Internal Employee Flag.

• The Protect Internal Employee Flag field of a record is Y.

In this example, Siebel CRM cannot delete this record.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

Setting Field Values According to Conditions

The On Condition Set Field Value user property specifies the value for a field according to a condition. The value for this user property must use the following format:

"Condition", "FieldName", "FieldValue"

where:

• Condition specifies the condition that Siebel CRM evaluates.

• FieldName specifies the name of a business component field.

• FieldValue specifies the value.

If Siebel CRM evaluates Condition to TRUE, then it sets the FieldName to the FieldValue.

If the condition is TRUE in the following example, then Siebel CRM sets the Employee Flag field to Y:

"[Primary Held Position Id] is not null and [Primary Held Position Id] 
<> ""No Match Row Id""", "Employee Flag", "Y"

Double quotes (") must enclose each parameter. A comma and a space must separate each parameter.

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

For more information, see How This Book Describes the User Property Format.

Updating Fields When Siebel CRM Updates Other Fields

The On Field Update Set n user property sets the value of a business component field when Siebel CRM updates another field. The value for this user property must use the following format:

"FieldToCheck", "FieldToSet", "Value", "Condition"

where:

• Value and Condition are optional parameters.

Note the following:

• If Siebel CRM updates FieldToCheck, then it sets FieldToSet to Value.

• If you do not include the Value parameter, then it sets FieldToSet to the value that FieldToCheck contains.

• If you include Condition, then it updates FieldToSet only if Condition evaluates to TRUE.

• Double quotes (") must enclose each parameter. A comma and a space must separate each parameter.

For more information, see How This Book Describes the User Property Format.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

Setting the Value Parameter of On Field Update Set

The Value parameter can contain an expression. If Siebel CRM updates the Done Flag in the following example, then it uses an IIF expression to set the Done field:

"Done Flag", "Done", "IIF ([Done Flag] = "Y", Today (), "")"

Any expression you use must evaluate to the same data type that the target field uses. In the following example, Siebel CRM uses the ToChar function to convert the date to a string before it concatenates it with another string and sets the field value:

"Agreement Start Date", "Name", "ToChar([Agreement Start Date])+ [Agreement Type]"

Setting the Condition Parameter of On Field Update Set

In the following example, if Siebel CRM updates the Primary Revenue Amount field, then it sets the Revenue field of the Opportunity business component, but only if the IsParentBCRevn field contains a value of N:

"Primary Revenue Amount", "Revenue", "[Primary Revenue Amount]","[IsParentBCRevn] = 'N'"

Using On Field Update Set with An Address Business Component

Siebel CRM concatenates street address, city, and state so that it can populate the Address Name field of an address business component, such as Business Address. If the user updates the street address, city, or state, then Siebel CRM uses multiple instances of the On Update Field Set user property to set the value of a calculated field. In the following example, if the user updates a city, then Siebel CRM uses an On Update Field Set user property that contains the following value:

"City", "Address Name",  "IIF( [Address Name Locked Flag] = ""N"",
[Calculated Address Name], [Address Name])"

If the user updates the street address or the state, then Siebel CRM uses similar user property instances to update the Address Name field.

Guidelines for Updating Fields When Siebel CRM Updates Other Fields

If you configure the On Field Update Set n user property, then use the following guidelines:

• Do not use this user property to set a multivalue or calculated field. If FieldToSet is a multivalue or calculated field, then Siebel CRM does not update it when it examines FieldToCheck.

• Do not define FieldToCheck as a field on a multivalue group. This user property does not recognize modifications that Siebel CRM makes in a multivalue group field, including modifying the primary field by modifying the primary record of a multivalue group. For example, assume you use the following value for the On Field Update Set user property on the Contact business component:

"Primary Address Id", "Email Address", "[e-mail]"

If the user modifies the primary of the Street Address multivalue group, then Siebel CRM does not update the Email Address field.

Calling Methods When Siebel CRM Updates Fields

The On Field Update Invoke n user property calls a business component method when Siebel CRM updates a field. The value for this user property must use the following format:

"[FieldToCheck]", "[BusCompName]", "[MethodName]","[Condition]"

If Siebel CRM updates FieldToCheck, then it calls the MethodName that the BusCompName contains. If you do not include FieldToCheck, then it calls this method when the user saves the record.

You can optionally include a condition. If you define a condition, then Siebel CRM calls this method only if the condition evaluates to TRUE.

For more information, see How This Book Describes the User Property Format.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

Setting the Field Created Date to the Saved Date

The Post Default Created Date To Date Saved user property sets the Created Date of a field to the Saved Date when Siebel CRM saves a record. You can set this user property to one of the following values:

• TRUE. Set the Created Date to the Saved Date.

• FALSE. Do not modify the Created Date.

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

Updating the Planned Field if the Start Date Field Is Modified

The Update Planned Field On Set: StartDate, StartTime user property automatically updates the Planned field when Siebel CRM updates the Start Date field. It can include one of the following values:

• Y. Update the Planned field.

• N or this user property does not exist. Do not update the Planned field.

Siebel CRM uses this user property with the CSSBCPharmaSpecializedAct class. For important caution information, see Using Specialized Classes.

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

Overriding the Type for Fields That Users Read from Right-To-Left

The DisplayType user property overrides the Type property of a field that Siebel CRM configures for right-to-left (RTL) display. It is applicable only if Siebel CRM uses this right-to-left configuration. It displays text fields as data types. For example, DTYPE_ID, DTYPE_PHONE, and so on.

The value for this user property must contain one of the following values:

• DTYPE_CURRENCY

• DTYPE_DATE

• DTYPE_ID

• DTYPE_INTEGER

• DTYPE_NUMBER

• DTYPE_PHONE

Displaying data from right to left for some fields does not make sense. For example, a service request number must always display from left to right. Siebel CRM sets the Type property for the SR Number field to DTYPE_TEXT. It sets the DisplayType user property for this field to DTYPE_ID to make sure the service request number displays left to right.

Setting Default Values for Fields That Use Drop-Down Lists

The Picklist Pre Default Field n user property sets default values for fields in a new record of the child business component. To set these values, CRM gets values from the parent business component record. The value for this user property must use the following format:

"field", "'buscomp1.field1','buscomp2.field2',' . . .'"

where:

• field is a field that resides in the current business component.

• buscompn.fieldn is the name of a field that resides in the parent business component.

For example, assume a view references a parent Action business component. The user can use a drop-down list that references the child Opportunity business component to create a new record.

Note the following format requirements:

• You must include a space after the first comma.

• You must use double quotes (") to enclose the list of buscompn.fieldn entries.

• You must use single quotes to enclose each buscompn.fieldn entry.

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

For more information, see How This Book Describes the User Property Format.

Using Multiple Instances of Picklist Pre Default Field

You can configure Siebel CRM to use multiple instances of the Picklist Pre Default Field n user property. For example, to create a new opportunity, the user can use an Opportunity drop-down list in each of the following applets:

• Activity Form Applet that references the Action business component

• Comm Outbound Item Form Applet that references the Comm Outbound Email business component

If the user creates a new opportunity from the drop-down list in each of these applets, then Siebel CRM sets a default value for the Account for the opportunity and the Account Id field. It uses the corresponding field value from the parent record to get these default values.

The following table describes user properties that this example uses on the Opportunity business component. For more information, see Numbering Instances of a User Property.

Table Example of Using the Picklist Pre Default Field n User Property

User Property Name	Value
Picklist Pre Default Field 1	"Account", "'Action.Account Name', 'Comm Outbound Email.Account Name'"
Picklist Pre Default Field 2	"Account Id", "'Action.Account Id', 'Comm Outbound Email.Account Id'"

Modifying the Currency That a Field Uses

The Currency Field n user property specifies the name of a field that stores currency data. If the user modifies the currency code, then Siebel CRM does a currency exchange operation on the data that this field contains, and then updates the field value.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

Specifying Field Name Prefixes for File Attachment Business Components

The DefaultPrefix user property specifies the unique field name prefix for each business component that Siebel CRM uses for file attachments. It must specify a string that Siebel CRM uses for the prefix in the names of the required fields that these business components contain. You do not enclose this value with quotes.

Each business component that Siebel CRM uses for file attachments includes a unique field name prefix. For example, the value of the DefaultPrefix user property for the Account Attachment business component is Accnt because the required fields for this business component are named AccntDockStatus, AccntFileDate, AccntFileName, and so on. For more information, see the table in Dependencies and Limitations for the CSSBCFile Class.

To create the entire field name for the required fields in any file attachment business component, a method uses the default prefix that this user property specifies. A method can use this prefix to access the required fields without using the literal name of each field.

You can modify the value for this user property. You cannot create more than one instance of this user property, and you cannot deactivate this user property.

Controlling Primaries

This topic describes business component user properties that you can use to control primaries. It includes the following topics:

• Specifying Who Can Modify Primary Team Members

• Setting the Primary Sales Rep as the Owner

• Setting the Current User as the Primary Contact

• Allowing Only the Primary to Modify Sales Methods for Opportunities

• Restricting How Siebel CRM Displays Private Activities for Primaries

Specifying Who Can Modify Primary Team Members

The MVG Set Primary Restricted: visibility_mvlink_name user property determines who can modify the primary team member of an opportunity, account, or contact. The value for this user property must contain one of the following values:

• TRUE or this user property does not exist. Only a Siebel Administrator in Admin view mode or a Manager in Manager view mode can modify the primary team member.

• FALSE. Someone other than the Manager or Siebel Administrator can modify the primary team member.

visibility_mvlink_name identifies the name of a multivalue link that resides in the BusComp View Mode child object of the business component where you must configure this visibility.

The following example describes how to control who can modify the primary sales team members for contacts.

To specify who can modify primary team members

• Create the following user property on the Contact business component:

User Property Name	Value
MVG Set Primary Restricted: Position where: Position is the value of the Visibility MVLink property of the Sales Rep business component view mode that resides on the Contact business component.	FALSE

Setting the Primary Sales Rep as the Owner

The Set Primary Sales Rep As Owner user property identifies the Primary Sales Rep that Siebel CRM assigns to the user who is currently logged in, and then assigns all new activities to this Primary Sales Rep. It can contain one of the following values:

• Y. Assign the current user as the Primary Sales Rep for all new activities.

• N or this user property does not exist.  Do not assign all new activities.

This user property is applicable only if the business component name is Action (Web), and only if Siebel CRM uses it for the Professional Portal LS application.

Siebel CRM supports this user property with the CSSBCFINSActivity class but not for any subclass of CSSBCFINSActivity.

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

Setting the Current User as the Primary Contact

The Set User As Contact user property assigns the current user as the Primary Contact for all new activities. It can contain one of the following values:

• Y. Assign the current user as the Primary Contact for all new activities.

• N or this user property does not exist.  Do not assign all new activities.

This user property is applicable only if the business component name is Action (Web), and only if Siebel CRM uses it for the Professional Portal LS application.

Siebel CRM supports this user property with the CSSBCFINSActivity class but not for any subclass of CSSBCFINSActivity.

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

Allowing Only the Primary to Modify Sales Methods for Opportunities

The Primary Position Modification user property specifies who can modify the Sales Method of an opportunity. You can set this user property to one of the following values:

• Y. Only the primary position can modify the Sales Method.

• N. Anyone can modify the Sales Method.

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

Restricting How Siebel CRM Displays Private Activities for Primaries

The Private Activity Search Spec user property includes a search specification that restricts the activities that Siebel CRM displays to activities that include one of the following:

• The Private flag is not set.

• The user who is currently logged in is the primary owner.

You can define other restrictions, as necessary.

The value for this user property must include a valid search specification. For example:

[Private] = 'N' OR [Private] IS NULL OR [Primary Owner Id] = LoginId ()

This value supports typical search specification functionality, such as the following:

IIf(condition, search spec 1, search spec 2)

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

For more information, see How This Book Describes the User Property Format.

Specifying Business Services

This topic describes business component user properties that you can use to specify business services. It includes the following topics:

• Calling Business Service Methods from Business Components

• Specifying Business Service Parameters

• Specifying External Data Sources for Business Services

• Specifying Business Services for Virtual Business Components

For information about using business service user properties, see Business Service User Properties.

Calling Business Service Methods from Business Components

The Named Method n business component user property calls a business component or business service method, or sets a field value. You can use it instead of scripting. The value that this user property can contain and the usage for it is similar to the value and usage that you can use for the Named Method n applet user property. For more information, see Calling Methods from Applets.

Specifying Business Service Parameters

The Service Parameters user property specifies parameters for a business service. The value for this user property must use the following format:

ParamName1=ParamValue2;ParamName2=ParamValue2;ParamNameN=ParamValueN

where:

• ParamName specifies the name of a parameter.

• ParamValue specifies the value for the parameter that Siebel CRM sends to the business service. For example:

DLLName=VirtualBusCompODBC.dll

The Pre_Invoke method typically parses these parameters. A virtual business component typically uses these values in a workflow process. For more information about configuring a business service in a workflow process, see the Siebel Business Process Framework: Workflow Guide.

For more information, see How This Book Describes the User Property Format.

Specifying External Data Sources for Business Services

The Remote Source user property specifies an external data source that a business service uses. The value for this user property identifies the name of this external data source. For example:

DSN=EXCELABCCust

You can configure Siebel CRM to deactivate this user property or modify the value for it.

Specifying Business Services for Virtual Business Components

The Service Name user property specifies a business service that a virtual business component uses. The value for this user property must contain the name of a business service.

Controlling Parent and Child Relationships

This topic describes business component user properties that you can use to control parent and child relationships. It includes the following topics:

• Copying and Deleting Child and Grandchild Records

• Updating the Parent Business Component if Siebel CRM Modifies Children

• Specifying Recursive Links Between Parent and Child Business Components

• Enabling Service Request Updates in Child Business Components

Copying and Deleting Child and Grandchild Records

The Deep Copy and Deep Delete user properties copy or delete a record. For example, a deep copy user property can copy the detail records that a child business component contains from the original record to a new record that the parent business component contains. If Siebel CRM uses one of these user properties, then it examines sources according to the following order to determine the parent and child link that it must use:

1. The parent and child reside in the same business component. The Recursive Link user property that resides in the business component must define the relationship. Siebel CRM uses this link to identify child records. For more information, see Specifying Recursive Links Between Parent and Child Business Components.

2. The Deep Copy/Delete Link user property is set on the parent business component. Siebel CRM uses the link that the Deep Copy/Delete Link user property specifies. For more information, see Specifying the Link for Deep Copy and Delete.

3. The parent and child business components are of the same Siebel object, and the parent is the primary business component in the business object. Siebel CRM determines whether a link from the parent to the child exists. If it exists, then Siebel Tools displays it in the Link property in the Business Object Component list.

4. These steps do not provide a link between the parent component and the child business component. Siebel CRM determines whether a link named parent business component/child business component exists. For example, Opportunity/Revenue. If this link exists, then Siebel CRM uses it.

Each business component that Siebel CRM modifies during a deep copy uses the configuration that resides on each of these business components. The parent business component includes deep copy properties for each child, and each child business component includes deep copy properties for each grandchild. This configuration is the same for deep delete.

Siebel CRM supports deep copy only for a business component that references the CSSBCBase class and that gets data from this class. The CSSBusComp class resides in the parent of the CSSBCBase class. Siebel CRM does not support deep copy for the CSSBusComp class. You can write a script or a workflow process that uses deep copy with the CSSBusComp class.

You must not use Deep Copy or Deep Copy/Delete Link with the Quote business components or the Order Entry – Orders business component. The copy functionality for these business components uses the Data Transfer Utilities business service. For more information, see Siebel Order Management Infrastructure Guide.

Using Deep Copy to Copy Records in Child Business Components

The Deep Copy n user property specifies a child business component. If a user chooses the Copy option, then Siebel CRM copies the records that this child business component contains. This option typically copies only one level. The Deep Copy n user property copies records in multiple levels, similar to a cascade copy. You typically use Deep Copy and Deep Delete together.

The value for this user property must contain the name of a child business component if you define the parent and child link in one of the ways that the Copying and Deleting Child and Grandchild Records topic describes.

You must not use Deep Copy if the parent-child relationship is a many-to-many (M:M) relationship. Instead, you can set the No Copy property to FALSE in the link that Siebel CRM uses for this parent-child relationship.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property and Specifying the Link for Deep Copy and Delete.

To use deep copy to copy records in child business components

1. In the parent business component, create the user properties for each child business component that Siebel CRM must include in the deep copy. Use values from the following table.

   User Property Name	Value
   Deep Copy 1	child business component name
   Deep Copy 2	child business component name

2. Add a multivalue link in the parent business component for each child business component.

3. Set the No Copy property of the multivalue link to TRUE.

   This configuration prevents an error that is similar to the following from occurring:

   A Duplicate Record Exists SQL

4. Create a multivalue field in the parent business component from each child business component.

Using Deep Delete to Delete Records in Child Business Components

The Deep Delete n user property specifies a child business component. The value for this user property must contain the name of a child business component if you define a parent and child link in one of the ways that the Copying and Deleting Child and Grandchild Records topic describes.

If a user chooses the Delete option, then Siebel CRM deletes the records that this child business component contains. This option typically deletes records in only one level. The Deep Delete n user property deletes records in multiple levels, which is similar to a cascade delete. You typically use Deep Copy and Deep Delete together.

To use deep delete, do Using Deep Copy to Copy Records in Child Business Components with the following differences:

• In Using Deep Copy to Copy Records in Child Business Components, use Deep Delete 1 and Deep Delete 2 for the names.

• In Using Deep Copy to Copy Records in Child Business Components, set the No Delete property of the multivalue link to TRUE.

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property and Specifying the Link for Deep Copy and Delete.

Specifying the Link for Deep Copy and Delete

The Deep Copy/Delete Link Buscomp user property specifies the link that Siebel CRM uses for a deep copy or deep delete of the child business component. It resides in the parent business component. The value for this user property must contain the name of a link that exists between the parent business component and the child business component.

The Link object defines a one-to-many parent and child relationship that exists between these business components. For information about links, see Configuring Siebel Business Applications.

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

If you deactivate a predefined instance of this user property in a production environment, then thoroughly plan and test this configuration to confirm that Siebel CRM no longer copies or deletes child records, and that your configuration does not affect records from other business components that are related to these child records.

Specifying Links for More Than One Business Component

Buscomp is an optional parameter. You use it if you must specify the link for more than one business component. It must identify the business component that Siebel CRM uses as the child in a link where the current business component is the parent. You set the deep copy or deep delete user properties in the parent business component. For example, to configure Siebel CRM to do a deep copy or deep delete of the revenues that Siebel CRM associates with an opportunity, you add the Deep Copy/Delete Link: Revenue user property with a value of Opportunity/Revenue. You add this user property to the Opportunity business component. Opportunity is the parent business component and Revenue is the child business component of the Opportunity/Revenue link.

Updating the Parent Business Component if Siebel CRM Modifies Children

The OnAddAssocUpdateParent: buscompname user property updates a parent business component with the value that Siebel CRM sets in a child business component if it associates an account or contact with this child business component. The value for this user property must use the following format:

"Condition1", "ParentBCField1", "[ChildBCField1]"
or "Expression1", "ParentBCField2", "[ChildBCField2]"
or "Expression2", ...

where:

• ParentBCFieldn identifies a field that resides in the parent business component that Siebel CRM updates if it evaluates Conditionn to TRUE.

• ChildBCFieldn identifies the business component field where you set this user property. Siebel CRM uses the value of this field to update the parent business component field.

• Expressionn contains an expression that determines the value that Siebel CRM uses to update the parent business component field. An IIf statement is an example of this expression.

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

For more information, see How This Book Describes the User Property Format.

Example of Updating the Parent Business Component if Siebel CRM Modifies Children

For example, the

OnAddAssocUpdateParent: Action

user property on the Contact business component contains the following value:

"[Account Id] IS NULL", "Account Id", "IIf([Account Id] IS NULL
OR [Account Id] = 'No Match Row Id','',[Account Id])"

If a user chooses a contact for an activity, and if Siebel CRM does not already associate an account with the parent activity, then Siebel CRM also chooses the account from the contact for the activity. If an account is associated with the contact, then Siebel CRM does not set an account for the activity.

In this example, the

OnAddAssocUpdateParent: Contact

user property that resides in the Account business component contains the following value:

"[Account Id] IS NULL OR [Account Id] = 'No Match Row Id'", "Account
Id", "[Id]", "Primary Address Id", "[Primary Address Id]"

If Siebel CRM associates an account with a contact, then it sets the primary address of this account as the primary address for the contact.

Specifying Recursive Links Between Parent and Child Business Components

The Recursive Link user property specifies a parent and child relationship between a business component and itself.

If Siebel CRM copies or deletes a record that resides in a parent business component, then the Deep Copy, Deep Delete, or Update Foreign Key Field user properties can copy or delete records that reside in child business components. If the parent and child are the same business component, then the Recursive Link user property must specify the link that defines this parent and child relationship.

The value for this user property must contain the name of a link that resides between the parent business component and itself. For example, to delete catalog subcategories if Siebel CRM deletes a category, you can use Deep Delete with the Recursive Link user property set to the following value:

Catalog Category/Catalog Category

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

For more information, see Copying and Deleting Child and Grandchild Records and Specifying the Parent Business Component for Accounts.

Naming a Link

A link name uses the following format:

parent business component/child business component

This format is optional. The value that the Recursive Link user property contains might include different names on each side of the slash. For example, Action/Action - Deep. However, the parent and child business components of this link must be the same business component.

For more information about the Link object type, see Configuring Siebel Business Applications.

Enabling Service Request Updates in Child Business Components

The Always Enable Child: buscompname user property determines whether Siebel CRM can update a child business component of a service request after it closes this service request. It must contain a Boolean value. If TRUE, then Siebel CRM can update the child business components of a service request even if this service request is closed.

You can also modify the service request status to Open to modify a closed service request and child business component.

Enabling Service Request Updates in Child Business Components with Customer Surveys

The Always Enable Child: Customer Survey user property of the Service Request business component enables or disables customer surveys. Closing a service request does not prevent Siebel CRM from updating the child Customer Satisfaction business component. You can survey your customers even if the service request is resolved.

To allow Siebel CRM to update other business components, you can add user properties to the Service Request business component, and then substitute the appropriate business component name for Customer Survey.

Controlling Email

This topic describes business component user properties that you can use to control email. It includes the following topics:

• Specifying Statuses for Outgoing Email

• Specifying the Manager That Sends Email

• Sending Email Packages to Recipients

• Responding to Email or Web Offers

Specifying Statuses for Outgoing Email

The email activity user properties handle the status for outbound email messages.

Specifying the Status for In Progress Emails

The Email Activity Sent Status Code user property specifies the code that Siebel CRM uses in the EVENT_STATUS_LOV list of values that correspond to an outbound email that is in progress. The eMail Response client uses it to set the status of an outbound email that is in process or that is waiting for the Communications Outbound Manager or Email Manager to send this email. The value for this user property must contain a language-independent value that the EVENT_STATUS_LOV list of values contains. For example:

Queued

You must not deactivate this user property. You can modify the values for this user property. You cannot create a new instance of this user property.

Specifying the Status for Sent Emails

The Email Activity Accepted Status Code user property specifies the code that Siebel CRM uses in the EVENT_STATUS_LOV list of values that corresponds to sent outbound email. The eMail Response client uses it to set the status of an outbound email that Siebel CRM finished processing. The value for this user property must contain a language-independent value that the EVENT_STATUS_LOV list of values contains. For example:

Done &&

You must not deactivate this user property. You can modify the values for this user property. You cannot create a new instance of this user property.

Specifying the Status for Unsent Outbound Emails

The Email Activity New Status Code user property specifies the code that Siebel CRM uses in the EVENT_STATUS_LOV list of values that corresponds to an outbound email that Siebel CRM has not sent or has not processed. The eMail Response client uses it to set the status of an outbound email that Siebel CRM has not yet sent. The value for this user property must contain a language-independent value that the EVENT_STATUS_LOV list of values contains. For example:

Not Started

You must not deactivate this user property. You can modify the values for this user property. You cannot create a new instance of this user property.

Specifying the Status for Rejected Emails

The Email Activity Rejected Status Code user property specifies the code that Siebel CRM uses in the EVENT_STATUS_LOV list of values that corresponds to an unsuccessful outbound email. The eMail Response client uses it to set the status of an outbound email that Siebel CRM rejects because it cannot send this email for some reason. The value for this user property must contain a language-independent code that the EVENT_STATUS_LOV list of values lists. For example:

Cancelled

You must not deactivate this user property. You can modify the values for this user property. You cannot create a new instance of this user property.

Specifying the Manager That Sends Email

The Email Manager Compatibility Mode user property specifies how to send email messages. It must specify one of the following values:

• Y. The business component uses Mail Manager to send email messages.

• N. The Outbound Communications Manager sends email messages.

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

Sending Email Packages to Recipients

The recipient communications user properties send email packages. A generic recipient is a generic name for a person instead of the actual name, email address, or fax number. Service Request Owner is an examples of a generic recipient. Contact Name is another example. Siebel CRM gets values for these generic recipients from user properties, and then displays them as a list of recipients in the Pick Recipient applet.

You can configure this list of generic recipients. This configuration is similar to the set of templates that Siebel CRM lists in the Body drop-down list in the Send Email or Send Fax dialog boxes except that Siebel CRM adds recipients through child user properties.

For example, the user can choose Service Request Owner or Service Request Contact for recipients when this user creates an email or fax for a service request. For a contact record, the user might choose only Contact Name. Siebel CRM does not list the actual name in the Pick Recipient applet. Instead, it gets the name and corresponding fax number or email address from fields that reside in the current business component record. For example, a contact can include a name, email address, and a fax number.

Siebel CRM can also use a join to get the recipient information from a record that resides in another business component. For example, Siebel CRM gets recipient information for the Service Request Owner in a service request from an employee record and recipient information for the Service Request Contact from a contact record. These fields reference joins from the service request record.

Recipient First Name Field

The Recipient First Name Field user property identifies the first name of the recipient of an email, fax, or page. It specifies the name of the business component field that contains this first name.

Recipient Last Name Field

The Recipient Last Name Field user property identifies the last name of the recipient of an email, fax, or page. It specifies the name of the business component field that contains this last name.

Recipient Email Address Field

The Recipient Email Address Field user property identifies the email address of the recipient. It specifies the name of the business component field that contains this email address.

Recipient Fax Address Field

The Recipient Fax Address Field user property identifies the fax address of the recipient. It specifies the name of the business component field that contains this fax address. This address must use a format that your fax server can understand. For more information about driver parameters for the Internet SMTP/POP3 Server, see Siebel CTI Administration Guide.

Recipient Preferred Medium Field

The Recipient Preferred Medium Field user property identifies the communications channel that the recipient prefers for email or fax. It specifies the name of the business component field that contains the name of this channel.

If Siebel CRM uses the Only Send Preference setting for a communication request, and if the template channel type:

• Corresponds to the value that exists in the field that this user property specifies, then it sends a communications template to the recipient.

• Does not correspond to the value that exists in the field that this user property specifies, or if this user property does not exist, and if the business component includes the Preferred Communications field, then it gets the preference from this Preferred Communications field.

Recipient Id Field

The Recipient Id Field n user property specifies properties for email recipients when Siebel CRM sends an email or fax. The value for this user property contains the following items:

• ID field name. Identifies the foreign key field that resides in the parent business component that references records that reside in the joined business component.

• Business component. Identifies the joined business component.

• Label. Specifies the text for the label that Siebel CRM displays in the Pick Recipient dialog box for this generic recipient. For example:

  Service Request Owner

• Field in the target business component. You can include this optional item if the field name is not an ID field.

A comma must separate each item. For more information, see Numbering Instances of a User Property.

Responding to Email or Web Offers

The response type user properties specify how Siebel CRM creates new email or Web offers. You can use them with offer, email offer, and Web offer business components.

Response Type Call Back

The Response Type Call Back user property creates a Call Back response type if the user creates a new email or Web offer. If you set this user property to Y, then it creates a Call Back response.

Response Type More Info

The Response Type More Info user property creates a More Info response type if the user creates a new email or Web offer. If you set this user property to Y, then it creates a More Info response.

Response Type Unsubscribe

The Response Type Unsubscribe user property creates an Unsubscribe response type if the user creates a new email or Web offer. If you set this user property to Y, then it creates an Unsubscribe response.

Controlling Specific Siebel Business Applications

This topic describes business component user properties that you can use to control specific Siebel Business Applications. It includes the following topics:

• Controlling Siebel Automotive

• Specifying Activities to Synchronize for Siebel Mobile

• Specifying Position Join Fields for Siebel Life Sciences

• Specifying Business Components for Product Selection and Pricing

• Identifying Business Components That Siebel Financial Services Uses

• Specifying Room Types for Siebel Hospitality

• Specifying Arrival Dates, Room Blocks, and Function Spaces for Siebel Hospitality

• Enabling Credit Check

• Specifying the Workflow Process for Credit Check

• Specifying Credit Card User Properties

Controlling Siebel Automotive

This topic describes business component user properties that you can use to control Siebel Automotive. It includes the following topics:

• Specifying Opportunity Business Components in Siebel Automotive

• Specifying Values for New Opportunities in Siebel Automotive

• Specifying Values for Used Opportunities in Siebel Automotive

• Specifying Opportunity Sales Steps in Siebel Automotive

• Specifying the Sales Step Admin in Siebel Automotive

• Specifying Reassignment in Siebel Automotive

• Specifying Positions in Siebel Automotive

Specifying Opportunity Business Components in Siebel Automotive

The Opportunity Name user property specifies the name of the business component that Siebel CRM uses to create opportunities in a Siebel Automotive application. The value for this user property must contain the name of a business component. For example:

Opportunity

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

Specifying Values for New Opportunities in Siebel Automotive

The TypeRetailNew user property specifies the value that Siebel CRM uses in the Opportunity Type field that indicates that an opportunity is a new retail opportunity.

The CSSBCFINOppty business component class uses this user property when it calculates the Actual Number for new retail opportunities. For example, if you add the TypeRetailNew user property with a value of Retail New, then the CSSBCFINOppty class includes only the opportunities that include an Opportunity Type of Retail New.

If the TypeRetailNew user property does not exist, then Siebel CRM uses a value of New.

Siebel CRM uses this user property with Siebel Automotive.

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

Specifying Values for Used Opportunities in Siebel Automotive

The TypeRetailUsed user property specifies the value that Siebel CRM uses in the Opportunity Type field that indicates that an opportunity is a used retail opportunity. The description for this user property is the same as the description for the TypeRetailNew user property except that it applies only to used opportunities. For more information, see Specifying Values for New Opportunities in Siebel Automotive.

Specifying Opportunity Sales Steps in Siebel Automotive

This topic describes the user properties that Siebel CRM uses to specify opportunity sales steps in Siebel Automotive.

Specifying Business Components for the Opportunity Sales Step in Siebel Automotive

The BC eAuto Sales Step user property specifies the name of the business component for eAuto Opportunity Sales Step. This business component must reference the Opportunity business object. You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it.

Specifying How to Populate Opportunity Sales Steps in Siebel Automotive

The eAuto Enable Create Sales Step user property specifies how to populate opportunity sales steps for a Siebel Automotive application. The value for this user property must use the following format:

"ApplicationName", "bPopulate"

where:

• ApplicationName specifies the name of a Siebel Business Application.

• bPopulate is Y or N. If Y, then Siebel CRM populates the opportunity sales steps.

For example, the following code configures Siebel CRM to populate the Opportunity Sales Step for the Siebel Dealer application:

"Siebel Dealer", "Y"

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

Specifying the Sales Step Admin in Siebel Automotive

This topic describes the user properties that Siebel CRM uses to specify the Sales Step Admin in Siebel Automotive.

Specifying Business Objects for the Sales Step Admin in Siebel Automotive

The BO eAuto Sales Step Admin user property specifies the name of the business object that Siebel CRM uses for eAuto Sales Step Admin. It defines the view to set for Sales Steps. You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it.

Specifying Business Components for the Sales Step Admin in Siebel Automotive

The BC eAuto Sales Step Admin user property specifies the name of the business component that Siebel CRM uses for eAuto Sales Step Admin. This business component must reference the eAuto Sales Step Admin business object. You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it.

Specifying Reassignment in Siebel Automotive

This topic describes the user properties that Siebel CRM uses to specify reassignment in Siebel Automotive.

Specifying the Business Component for Reassignment in Siebel Automotive

The BC Opportunity user property specifies the name of the Opportunity business component that Siebel CRM uses during reassignment in a Siebel Automotive application. This business component must reference the Opportunity business object. You can configure Siebel CRM to deactivate this user property or modify the value for it, but not to create a new instance of it.

Reassigning Opportunities in Siebel Automotive

The Contact-Opportunity BC Name user property specifies the name of the business component that Siebel CRM uses to reassign an opportunity in a Siebel Automotive application. For example:

Opportunity

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

Reassigning Contacts in Siebel Automotive

The Contact-Activity BC Name user property specifies the name of the business component that Siebel CRM uses when it reassigns an activity to another contact in a Siebel Automotive application. For example:

Action

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

Specifying Positions in Siebel Automotive

The BC Position user property specifies the name of a business component that stores Position data. Siebel CRM uses this business component when it creates an opportunity in a Siebel Automotive application. You can configure Siebel CRM to deactivate this user property or modify the value for it, but not to create a new instance of it.

Specifying Activities to Synchronize for Siebel Mobile

The Update Status To Synchronized Types user property determines the types of activities that Siebel CRM updates during mobile synchronization. It uses the following format:

,type1,type2,typeN,

where:

• type identifies an activity type.

For example, assume you set the Update Status To Synchronized user property to Y and the Update Status To Synchronized Types to the following value:

,Account Call,Professional Call,Attendee Call,

In this example, Siebel CRM updates the Status fields to Synchronized for activities of type Account Call, Professional Call, and Attendee Call.

A comma must prefix and suffix each activity type. For more information, see How This Book Describes the User Property Format.

You must also set the Update Status To Synchronized user property to Y. For more information, see Updating the Synchronization Status for Activities.

An activity with the Status field set to Synchronized in a Siebel Industry Application is read-only in the Activities view.

Siebel CRM supports this user property in the CSSBCFINSActivity class but not in subclasses of this class.

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

Specifying Position Join Fields for Siebel Life Sciences

The Position Join Fields user property specifies the position join fields that Siebel CRM uses for an update in a Siebel Life Sciences application. The value for this user property includes one or more field names. For example:

"Rep Specialty", "Rep TOP", "Primary Address Id"

There is no limit to the number of field names you can specify.

Double quotes (") must enclose each parameter. A comma and a space must separate each parameter.

If you add a new field to this user property, then you must also create a field that includes the same name in the Pharma Professional Position business component and that references the same column that resides in the S_POST_CON table.

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

For more information, see How This Book Describes the User Property Format.

Specifying Business Components for Product Selection and Pricing

The product selection and pricing user properties control how Siebel CRM integrates product business components with the Production Selection and Pricing (PSP) engine. The following table describes these user properties. For more information, see Siebel Order Management Infrastructure Guide.

Table Production Selection and Pricing User Properties

User Property	Value	Description
PSP: Active	Y or N	Turns PSP integration on or off.
PSP: Buscomp Name	Business component name	Specifies the business component that instructs Siebel CRM to call the PSP engine. For example: Internal Product PSP Integration It is recommended that you do not modify the value for this user property.
PSP: Eligibility Fields	Business component field	Specifies the fields that the PSP Eligibility group contains. For example, you can use one of the following values: Eligibility Reason Eligibility Status A PSP group is a group of fields that the PSP engine populates if the same signals call these fields.
PSP: Eligibility Group	PSP group name	Specifies the name of the PSP group that calls eligibility. This value is typically Eligibility.
PSP: Eligibility Signal	Signal name	Specifies the signal name that Siebel CRM calls to populate all field values that the PSP Eligibility group contains. For example: GetUserProdEligibility
PSP: Enabled BO: busobjname	Y or N	Determines whether PSP is active in the business object. Siebel CRM enables PSP integration only if the following is true: PSP: Active is Y. PSP: Enabled BO: busobjname is Y. This configuration allows Siebel CRM to use the same product business component with multiple business objects or in a Siebel Business Application that does not use PSP.
PSP: Mode	PSP mode	Specifies the PSP Mode that Siebel CRM uses to create a PSP signal. For example: Product Siebel CRM uses this value as an input to the context service that determines the variable map mode.
PSP: Prepick Groups	PSP group name or names	Specifies the prepick group. You can use one of the following values: Price Eligibility
PSP: Price Fields	Business component field	Specifies the fields that the PSP Price group contains. For example: Deals, List Price, and Net Price
PSP: Price Signal	Signal name	Specifies the signal name that Siebel CRM calls to populate all field values that the PSP Price group contains. For example: GetUserProdPrice

Using the Product Selection and Pricing User Properties

You can use the product selection and pricing user properties with a product business component that references the CSSBCPecBase class or subclass, such as CSSBCProdBuyNow. For example, assume Siebel CRM must use the GetProdEligibility signal to populate the Eligibility Status and Eligibility Reason fields, but only in the Order Entry business object. The following table describes the user properties that you can add that configures this example. You add them to the following business component:

Internal Product by Price List Optional 2

Table Example of Using the Product Selection and Pricing User Properties

User Property	Value
PSP: Active	Y
PSP: Buscomp Name	Internal Product PSP Integration
PSP: Eligibility Fields	Eligibility Reason, Eligibility Status
PSP: Eligibility Group	Eligibility
PSP: Eligibility Signal	GetProdEligibility
PSP: Enabled BO: Order Entry	Y
PSP: Mode	Product
PSP: Prepick Groups	Eligibility

Identifying Business Components That Siebel Financial Services Uses

The WorkFlow Behaviour user property identifies a business component that the Siebel Financial Services application uses. It can include one of the following values:

• Y. Use this business component in a Siebel Financial Services application.

• Empty or this user property does not exist. Do not use this business component in a Siebel Financial Services application.

This user property helps the Workflow Process Object Manager to identify a Siebel Financial Service application from other types of Siebel Industry Applications.

Siebel CRM supports this user property for use in the CSSBCFINSActivity class, but not in the subclasses of this class. It does support this user property for custom configuration.

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

Specifying Room Types for Siebel Hospitality

The RBFields user property specifies fields that reside in the Room Block business component that represent types of rooms. The value for this user property includes the names of fields that exist in the Room Block business component. For example:

RB Single, RB Double, RB Triple, RB Quad, 100

A comma must separate each field. An integer must terminate the value. It indicates the sum of the values for the specified fields. The integer is typically 100.

You can modify the value for this user property and create a new instance of it. You cannot deactivate this user property. For more information, see How This Book Describes the User Property Format.

Specifying Arrival Dates, Room Blocks, and Function Spaces for Siebel Hospitality

The day and number user properties define day and number values.

Specifying the Arrival Date Field for the Day Number Business Service

The Day Number: Arrival Date Field user property specifies the name of the Arrival Date field that Siebel CRM uses in the Day Number business service. If the user modifies the value of this field, then this business service sends this modification to the date fields that reside in the Function Space and Room Block business components.

You can modify the value for this user property. You cannot deactivate or create a new instance this user property.

Specifying the Business Component for the Function Space

The Day Number: Function BC Name user property specifies the name of the business component that Siebel CRM uses for the Function Space. Siebel CRM uses it with the Day Number: Arrival Date Field user property. For more information, see Specifying the Arrival Date Field for the Day Number Business Service.

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

Specifying the Business Component for the Room Block

The Day Number: Room Block BC Name user property specifies the name of the business component that Siebel CRM uses for the Room Block. Siebel CRM uses it with the Day Number: Arrival Date Field user property. For more information, see Specifying the Arrival Date Field for the Day Number Business Service.

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

Enabling Credit Check

The Credit Check user property enables or disables Credit Check during verification. It must contain one of the following values:

• Y. Do credit check.

• N. Do not do credit check.

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

Specifying the Workflow Process for Credit Check

The Credit Check Workflow user property specifies the name of the workflow process that Siebel CRM uses if Credit Check is enabled. For example, Credit Check – Quotes. If you set the Credit Check user property to Y, then the Credit Check Workflow user property is required.

You can configure Siebel CRM to deactivate this user property only if you set the Credit Check user property to N. You can modify the value for this user property. You cannot create a new instance of it.

Specifying Credit Card User Properties

The following credit card user properties store information in the Mod 10 (LUHN) algorithm for credit card validation:

• Credit Card Expired Month

• Credit Card Expired Year

• Credit Card Number

• Credit Card Type

These user properties are valid only:

• For a business component that references the CSSBCBase class or that gets data from a class that references the CSSBCBase class, such as CSSBCQuote.

• With the Validate method of the Credit Card Transaction Service business service. This is an exception to the typical user property behavior of the specialized business component class. For important caution information, see Using Specialized Classes. For more information about payment validation, see Siebel Order Management Guide.

All four of the fields that these user properties reference must contain data to allow validation.

Credit Card Expired Month

The Credit Card Expired Month user property stores the expiration month of the credit card.

Credit Card Expired Year

The Credit Card Expired Year user property stores the expiration year of the credit card.

Credit Card Number

The Credit Card Number user property stores the credit card number.

Credit Card Type

The Credit Card Type user property stores the credit card type.

Doing Other Work

This topic describes business component user properties that you can use to do other work. It includes the following topics:

• Specifying the Application Name

• Using Aspects to Control Read Only, Insert, and Other Behavior

• Specifying the Default Bookmark View

• Enabling the Dispatch Board

• Making Sure an Attachment File Exists

• Enabling the Revise Button According to Conditions

• Specifying Joins to the S_PARTY Table

• Specifying the DB2 Optimization Level for SQL Statements

• Capturing User Drilldown Behavior

Specifying the Application Name

The Application Name user property specifies the name of the application. It must reference a valid application name.You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it.

Using Aspects to Control Read Only, Insert, and Other Behavior

An aspect determines how Siebel CRM displays data from a business component. You can use one of the aspect user properties to configure business component behavior according to the applet that Siebel CRM uses to display data from this business component. For example, the applets that reference the Action business component might contain different predefault values for the Type field. An aspect user property is optional.

Aspect User Properties for the CSSBCBase Class

If Siebel CRM sets an aspect for an applet that references the CSSBCBase class, then it modifies the behavior of this class according to the following user property setting. These settings assume the current aspect is Aspect and the value of Field Name is Y:

• Aspect BC ReadOnly: Aspect. The current record becomes read-only.

• Aspect Child BC ReadOnly: Aspect. The child business components of the current record become read-only.

• Aspect BC NoInsert: Aspect. The user cannot insert a new record. You must make sure that Siebel CRM does not modify the

  [Field Name]

  value if the user steps off the record. If it does modify this value, then the behavior in the client might confuse the user. An incorrect configuration makes an insert that depends on the state of the current record. This configuration is probably not what your implementation requires.

• Aspect Default Value: Aspect. If you define Aspect Default Value: Aspect for a business component field, and if the current aspect is Aspect, then the predefault value for this field becomes the expression that the value of the user property defines. For example, the Action business component handles activities. If it includes a Planned field, and if you define the Aspect Default Value: Planned field user property for this field, and if the value of this user property is Timestamp(), then the predefault value for the planned start date and time of the activity becomes Timestamp().

You cannot use Aspect Default Value with a multivalue field because a multivalue field does not use a predefault value.

The following table lists the aspect user properties that you can use with a business component.

Table Aspect User Properties That You Can Use With a Business Component

User Property Name	Value
Default Aspect	Aspect
Aspect BC ReadOnly: Aspect	Field Name
Aspect Child BC ReadOnly: Aspect	Field Name
Aspect BC NoInsert: Aspect	Field Name

The following table lists the aspect user properties that you can use with a field.

Table Aspect User Properties That You Can Use With a Field

User Property Name	Value
Aspect Default Value: Aspect	Expression

Aspect User Properties for the CSSSWEFrame Base or CSSSWEFrameListBase Class

You must configure Siebel CRM to set and send the aspect name to the business component that the view references in the following situations. This business component uses the CSSSWEFrameBase or CSSSWEFrameListBase class:

• You define a View Aspect* user property for the current view.

• You do not define View Aspect* for the current view but you do define the Default Aspect.

The following table lists the aspect user properties that you can use with a view.

Table Aspect User Properties That You Can Use With a View

User Property Name	Value
View Aspect: View Name	Aspect Name
View Aspect	"View Name", "Aspect Name"
View Aspect 1	"View Name", "Aspect Name"
View Aspect 2	"View Name", "Aspect Name"
Default Aspect	Aspect Name

Specifying the Default Bookmark View

The Default Bookmark View user property specifies the default view that Siebel CRM uses to access a business component when it creates a bookmark for this business component. The value for this user property must contain the name of a view, not enclosed in quotes.

The Communications Server uses this user property to create a bookmark when it sends a package, and if the Attach Bookmark field of this package contains a check mark. For example, this user property exists on the predefined Opportunity business component that the Opportunity List View references. Assume the Communications Server creates an email message, and that a bookmark that references an opportunity record is attached to this message. If the user clicks this bookmark, and if the responsibility that this user uses includes this view, then Siebel CRM displays the linked record in the Opportunity List View. For more information about bookmarks, see Siebel CTI Administration Guide.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. No more than one instance can exist for each business component.

Enabling the Dispatch Board

The Enable Dispatch Board user property enables the Dispatch Board views that reference the business component that contains this user property. The value for this user property must contain one of the following values:

• TRUE. Enable the Dispatch Board views that reference this business component.

• FALSE or this user property does not exist. Disable the Dispatch Board views that reference this business component.

You can modify this user property. You cannot deactivate or create a new instance of this user property.

For more information, see Siebel Field Service Guide.

Making Sure an Attachment File Exists

The FileMustExist user property determines whether a file must already exist before the user can add it as an attachment. The value for this user property must contain a Boolean value. If TRUE, then the file must already exist before the user can add it as an attachment.

Enabling the Revise Button According to Conditions

The Revision Condition n user property enables the Revise button that Siebel CRM displays in a list applet.

The following table describes typical values for this user property. In this example, if the Active flag is Y and the Order Status is Open, then Siebel CRM enables the Revise button.

Table Example of the Revision Condition n User Property

User Property	Value
Revision Condition 1	"Active", "Y"
Revision Condition 2	"Status", LookupValue("FS_ORDER_STATUS","Open")

Using the Revision Condition User Property

In this example, you configure Siebel to enable the Revise button if the status is Open or Failed.

To use the Revision Condition user property

1. Add a new calculated field using values from the following table.

   Property	Value
   Name	Status Rev
   Calculated Value	IIf([Status]=LookupValue("FS_ORDER_STATUS","Open") OR [Status]=LookupValue("FS_ORDER_STATUS","Failed"), "Y", "N")

2. Modify the Value property of the Revision Condition 2 user property to the following value:

   "Status Rev", "Y"

Specifying Joins to the S_PARTY Table

The Inner Join Extension Table n user property specifies a table. The value for this user property must contain the name of a table, not enclosed in quotes. This table must be an extension table of the S_PARTY table. Siebel CRM uses an inner-join to join this table to the S_PARTY table. Some business components use the Siebel Party Model to control access and visibility. For example, organization, account, and position. These business components use one or more inner joins to the base S_PARTY table.

If you create a new business component that references the Siebel Party Model, then you must use the Inner Join Extension Table n user property to define one or more tables that Siebel CRM implicitly joins to the S_PARTY base table. For example, to configure visibility for a group that does not fit any of the predefined Siebel Party Model business components, you might need to create a new business component.

You must not deactivate this user property or modify the value. You can create a new instance of this user property, if necessary. You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property.

Caution: You must be careful if you use the S_PARTY table in a custom configuration. For more information, see Configuring Siebel Business Applications.

Numbering Instances of the Inner Join Extension Table User Property

If you add multiple Inner Join Extension Table n user properties to a business component, then you can append a value to this user property. The lowest value indicates the primary extension table. For example, the predefined Employee business component includes the following user properties:

• Inner Join Extension Table 1 includes a value of S_CONTACT.

• Inner Join Extension Table 2 includes a value of S_USER.

• Inner Join Extension Table 3 includes a value of S_EMP_PER.

In this example, S_CONTACT is the primary extension table. For more information, see Numbering Instances of a User Property.

Specifying the DB2 Optimization Level for SQL Statements

The DB2 Optimization Level user property modifies the optimization level that Siebel CRM uses for the SQL statements that a business component creates. The value for this user property must contain an integer that indicates the level of optimization that Siebel CRM uses. The DB2 connector uses an optimization level of 3 for each client SQL statement.

Caution: The value that you use for the DB2 Optimization Level user property affects the entire business component. Modifying it can adversely affect the performance of other SQL statements that this business component creates. It is extremely important that you analyze SQL statements that Siebel CRM performs slowly, and that you use other tuning options before you modify the DB2 Optimization Level user property.

To specify the DB2 optimization level for SQL statements

1. Use other tuning options:

   • Make sure an index exists that addresses the needs of the WHERE conditions and the ORDER BY clause on the tables that Siebel CRM uses in the query.

   • Remove one or more columns from the ORDER BY clause.

   • If the business component is customized, then simplify this customization.

2. Analyze performance.

   You can use the

   /s <filename>

   option when you start the client. This option causes Siebel CRM to log all SQL statements. This log file includes the time that Siebel CRM spends to run each SQL statement. You can use it to identify the statements that run slowly. Note that the DB2 SQL generator adds the following clause to the end of the SQL statement. This clause does not display in the SQL log:

   optimize for 1 row

3. If a DB2 Optimization Level user property already exists on the business component that creates the SQL statement, then examine this optimization level to determine if it causes the slow SQL query.

4. Paste the suspected slow query into one of the explain utilities, add the following clause, and then set the optimization level to the appropriate value:

   optimize for 1 row

5. Create a query plan for the statement, and then analyze it. If you conclude that modifying the optimization level is the best way to improve query performance, then use a different optimization level.

6. If the new optimization level fixes the slow query, then add the user property to the business component.

Capturing User Drilldown Behavior

You can use the business component user properties that this topic describes to capture user drilldown behavior so that Siebel CRM can store values for the business component fields where the drilldown occurs. It can store these values in an attribute in a user profile, which is a type of attribute that Siebel CRM creates at run time to allow it to modify the Siebel application behavior in reply to a user action. It can store one business component field for each of these attributes. For more information about these attributes, see the topic about the SetProfileAttr method for an application in Siebel Object Interfaces Reference, and the topic about dynamic user profile attributes in Siebel Personalization Administration Guide.

Example of Capturing User Drilldown Behavior

In this example, the Com Invoice Profile comes predefined with Siebel CRM starting with Siebel CRM release 8.1.1.10. It tracks the parent Account Id when the user navigates away from the Account Summary View. This view displays the following information:

• Account details in a form applet that references the CMU Com Invoice Profile business component

• Invoice profiles in a list applet that references the Com Invoice Profile business component

These business components reference the same database table, but no link exists that Siebel CRM can use that allows the CMU Com Invoice Profile business component to access the Account business component. Assume your implementation must get billing details from an external system when the user drills down on a billing profile. To support this requirement, Siebel CRM must send an integration object message that includes the following data:

• Data from the CMU Com Invoice Profile business component, including values for the Invoice Profile Name field and the Account Id field that Siebel CRM uses as key fields to get billing information for the SOAP and HTTP Web service call. This billing information includes invoices, payment adjustments, balance, and so on.

• The Account Id of the account that Siebel CRM displays in the Account Summary View when the user drills down on the Profile Name field of the business component record that Siebel CRM displays in the Com Invoice Profile list applet.

Siebel CRM includes the following predefined objects to capture this Account Id:

1. Adds the Profile Name drilldown object to the CMU Com Invoice Profile List Applet. The View property of this drilldown object references the CMU Billing Invoice View. The business component property of this applet references the Com Invoice Profile business component.

2. Adds the following user properties to the Com Invoice Profile business component.

   Name	Value
   DrilldownObject0	Profile Name
   Profile Name:ProfileAttributeName1	Service Account Id
   Profile Name:ProfileAttributeName2	Service Account
   Profile Name:ProfileAttributeValue1	Account Id
   Profile Name:ProfileAttributeValue2	Account Name

   ProfileAttributeValue1 and ProfileAttributeValue2 each provide the name of a business component field. In this example, ProfileAttributeValue must contain the name of a business component field that currently exists. ProfileAttributeName can contain a text string.

3. Adds the following fields to the CMU Com Invoice Profile business component:

   Name	Calculated Value
   Service Account	GetProfileAttr("Service Account") Siebel CRM uses the value of the ProfileAttributeName2 profile defined in step 2 to calculate the Service Account.
   Service Account Id	GetProfileAttr("Service Account Id") Siebel CRM uses the value of the ProfileAttributeName1 profile defined in step 2 to calculate the Service Account Id.

Drilldown Object User Property

The DrilldownObject n user property identifies the name of a drilldown object. This drilldown object resides in an applet. It references a business component.

The following table describes typical values for this user property.

Table Example of the Drilldown Object n User Property

User Property	Value
DrilldownObject0	Name of the drilldown object. For example: Profile Name

Profile Name: attributename User Property

The Profile Name: attributename user property identifies the name of the profile attribute that Siebel CRM sets when the user clicks a drilldown object.

The following table describes typical values for this user property.

Table Example of the Profile attributename User Property

User Property	Value
Profile Name:ProfileAttributeName1	Name of the profile attribute. For example: Service Account Id

Profile Name: attributevalue User Property

The Profile Name: attributevalue user property identifies the name of a business component field. Siebel CRM sets the value for this field according to the results of the drilldown.

The following table describes typical values for this user property.

Table Example of the Profile attributevalue User Property

User Property	Value
Profile Name:ProfileAttributeValue1	Value of the profile attribute. For example: Account Id