User Properties

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

For information about business component user properties, see Business Component User Properties.

Overview of User Properties

This topic describes an overview of user properties. It includes the following topics:

A user property is an object definition that Siebel CRM adds as a child to an applet, business component, control, field, or list column. It configures specialized behavior that the properties of the parent object cannot provide. The following object types include user properties:

Applet
Application
Assignment
Business Component
Business Service
Business Service Method Argument
Control
Field
Integration Component
Integration Component Field
Integration Object
List Column
View
Virtual Business Component

Oracle only supports user properties that this book describes. For information about a user property that is specific to a Siebel Business Application, see the guide for this application. For example, for a user property that is specific to Siebel Hospitality, see Siebel Hospitality Guide.

For important caution information, see Using Specialized Classes.

How This Book Describes the User Property Format

You can enter a text string in the Value property to define the value of a user property. Unless noted otherwise, this book describes the format that you must use in this user property. For example, to define the value for the following Activity SearchSpec user property, you must use parantheses to enclose every field name that you include in this search specification, and you must use quotes and parentheses:

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

In the following example, to list multiple pairs of fields, you must enclose each pair in single quotes and use a comma to separate each pair:

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

Note the following example:

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

This example requires the following format:

Square brackets ([]) must enclose each parameter.
Double quotes (") must enclose each set of square brackets.
A comma and a space must separate each parameter.

Many user properties can contain a value of TRUE or FALSE. In most situations, if a user property does not exist for an object, then Siebel CRM assumes a value of FALSE. For information about locating an object, and then examining the user property list to determine if a user property exists for an object, see Viewing a Business Component User Property.

Numbering Instances of a User Property

Siebel CRM can use some user properties on multiple instances of a single business component or applet. If more than one instance of this user property exists, then Siebel CRM runs each instance sequentially. It uses Name n, such as On Field Update Invoke 1, On Field Update Invoke 2, and so on to identify multiple instances of a user property. In most situations, if the business component or applet includes only one instance of the user property, then Siebel CRM does not require this number.

Example of Numbering Instances of a User Property

For example, the Asset Mgmt - Asset (Order Mgmt) business component includes the following user properties:

On Field Update Invoke   "Product Name", "Asset Mgmt - Asset", "CopyXA"
On Field Update Invoke 1   "Product Name", "Asset Mgmt - Asset", "GeneratePartNumber"
On Field Update Invoke 2   "Product Name", "Asset Mgmt - Asset", "SaveCxProd"
On Field Update Invoke 3   "Quantity", "Asset Mgmt - Asset", "SetExtendedQuantity"

If Siebel CRM updates the Product Name field in the Asset Mgmt - Asset (Order Mgmt) business component, then it calls the following methods that the Asset Mgmt - Asset business component uses:

CopyXA
GeneratePartNumber
SaveCxProd

If Siebel CRM updates the Quantity field in the Asset Mgmt - Asset (Order Mgmt) business component, then it calls the SetExtendedQuantity method that resides in the Asset Mgmt - Asset business component.

If you do not specify FieldToCheck, then Siebel CRM calls the CopyXA method in the Asset Mgmt - Asset business component when the user saves the record. For example:

On Field Update Invoke "", "Asset Mgmt - Asset", "CopyXA"

Guidelines for Numbering Instances of a User Property

If you configure Siebel CRM to create multiple instances of a user property, then it is recommended that you use the following guidelines:

Number each instance.
Use consecutive numbers. For example, use Deep Copy 8, and then Deep Copy 9.
Do not include a gap between a number that is greater than 9.
Do not append a number that includes more than two digits.

The following examples create unwanted results:

You use On Field Update Invoke 10 but no instances exist that use numbers less than 10.
You use Deep Copy 9 and Deep Copy 19 but no instances exist that are numbered sequentially between 9 and 19.
You use Named Method 100.

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

Alphabetic List of User Properties

The following table includes an alphabetic list of the user properties that this chapter describes. For a list of business component user properties, see Alphabetic List of Business Component User Properties.

Table Alphabetic List of User Properties

User Property	Topic
Affiliated Account Id Field	Specifying the Field That Stores the Account Id of a Contact
ApplicationContextType	Specifying the Application That Creates Proposals
AssocFieldName [Field Name]	Specifying the Field Name for an MVG
Association	Specifying Association Business Components
BAPIAdapterService	Specifying the BAPIAdapterService
BatchSize	Specifying the BatchSize for SAP IDOCs
CanInvokeMethod: MethodName	Enabling Methods for Applets
ClientBusinessServicen	Calling Business Services from the Client
Contact Relationship Type	Specifying Relationships in Organization Charts
DataSourceBuscompName	Specifying the Parent Business Component
Default Applet Method	Specifying the Method That the Enter Key Calls
DefaultAppletFocus	Specifying the DefaultAppletFocus
DefaultFocus	Specifying the Default Applet Focus
DefaultFocus_Edit	Specifying the Default Applet Focus for Base, Edit,or Edit List Mode
DefaultFocus_New	Specifying the Default Applet Focus for New Mode
DefaultFocus_Query	Specifying the Default Applet Focus for Query Mode
Disable Buscomp Hierarchy	Disabling Hierarchies in List Applets
DisableNewRecord	Disabling New Record Creation
DisableSearch	Disabling Search on Text Fields or Unindexed Fields
DisableSort	Disabling Sort on Business Component Fields
DisableSort	Disabling Sort on List Columns
Display Mask Char	Masking Credit Card, Account, and Other Secure Data
DocumentContextType	Specifying Template Values for Proposals
Drilldown Visibility	Specifying Drilldown Visibility
EnableStandardMethods	Enabling Record Manipulation in Field Service and Task Views
Encrypt Key Field	Specifying the Field That Contains the Encryption Key
Encrypt ReadOnly Field	Setting an Encrypted Field to Read Only if Encryption Fails
Encrypt Service Name	Specifying the RC2 or AES Encryption Service
Encrypt Source Field	Specifying the Field That Contains Secure Data
Encrypted	Enabling Encryption on a Field
FINS Query Mode Disabled Method n	Disabling Methods for FINS Applets in Query Mode
ForceActive	Forcing Controls to Be Active
ForceActive	Forcing Fields That a List Column References to be Active
Logical Message Type	Specifying the IDOC Message Type for SAP
Major Time Unit	Specifying Gantt Chart Behavior
Minor Time Unit	Specifying Gantt Chart Behavior
MVG	Specifying MVG Business Components
Named Method n	Calling Methods from Applets
NoDataHide	Hiding Applets That Contain No Data
NoDelete	Preventing Siebel EAI From Deleting Records
NoInsert	Preventing Siebel EAI From Inserting Records
NoUpdate	Preventing Siebel EAI From Updating Fields
OverrideViewCachen	Disabling the View Cache
Page	Specifying the Goto Web Page
Parent Id Field	Specifying Field Names According to Parent Id
PDQDisabledViewn	Disabling Predefined Queries in Views
Political Analysis Field	Specifying Political Influence in Organization Charts
PostInvokeMethod n	Specifying the PostInvokeMethod
PostMainViewData	Saving Unsaved Data
Required	Making a Field Required
Show Required n	Making an Applet Control Required
SleepTime	Specifying the Time Out Interval for Receive Requests
SubCompCanUpdate	Updating Assets
SubCompUpdate	Cascading Asset Updates
Text Length Override	Setting the Field Text Length
Url	Specifying the Goto URL
Use Literals For Like	Using Literals Instead of Bind Variables
UseExistsForSubQuery	Specifying the SQL for EXISTS Search Specifications
View	Specifying the Goto View
Visibility Type	Specifying the Calendar Visibility Filter
WebGotoPlayerErrorPage	Specifying the Error Web Page for Smart Script
WebGotoView	Specifying the Finish or Cancel Web Page for Smart Script
X-BC	Specifying Gantt Chart Behavior
X-Color Field
X-Color LOV Name
X-Color Map
X-Date InvokeMethod
X-Display Constraint Map
X-Display Duration
X-DrillDown Field
X-End DateTime Field
X-Join Field
X-Join InvokeMethod	Specifying Gantt Chart Behavior
X-LOV Map
X-Num Slots
X-Num Tool Tips
X-Sort Spec
X-Start DateTime Field
X-Tooltips 1
X-Tooltips 2
X-Tooltips n
Y-BC
Y-BC ViewSet Size
Y-Constraint
Y-DrillDown Field
Y-DrillDown View
Y-Join Field
Y-Label
Y-Legend
Y-SortSpec
Z-BC
Z-Date InvokeMethod
Z-End DateTime Field
Z-Join Field
Z-Join InvokeMethod
Z-Start DateTime Field

Application User Properties

This topic describes application user properties. It includes the following topics:

Siebel CRM sets some of the parameters that it set in the application configuration (.cfg) file prior to Siebel CRM version 8.0 differently. It now sets them as application user properties in Siebel Tools.

Calling Business Services from the Client

The ClientBusinessServicen user property calls a business service from a browser script. It must specify the name of the business service that a browser script calls. This value uses the following format:

ClientBusinessServicen

where:

n is a sequential number. If you skip a number, then Siebel CRM cannot call this service from a browser script. For more information, see Numbering Instances of a User Property.

You can use this user property only with Siebel Browser Script.

If a browser script attempts to use this user property to call a business service that is not listed, then an error that is similar to the following error might occur at runtime:

Cannot get service: <name of service>.(SBL-UIF-00275)

Starting with Siebel CRM version 8.0, you no longer set this user property in the application .cfg file. You now set it as an application user property in Siebel Tools.

Disabling Predefined Queries in Views

The PDQDisabledViewn user property disables the Predefined Query (PDQ) dropdown list for a view. The value for this user property must include the name of the view where you must disable the Predefined Query (PDQ) dropdown list.

If you add this user property to a view, then Siebel CRM does not apply the PDQs in the dropdown list when it loads this view. The user can still choose the PDQs in the dropdown list, and then Siebel CRM applies these PDQs.

Starting with Siebel CRM version 8.0, you no longer set this user property in the application .cfg file. You now set it as an application user property in Siebel Tools.

Disabling the View Cache

The OverrideViewCachen user property disables caching for a view. The value for this user property must use the following format:

OverrideViewCachen

where:

n is a sequential number between 0 and 99. For more information, see Numbering Instances of a User Property.

For example, to disable caching if Siebel CRM makes a dynamic modification to a view. For example, if it modifies a parameter or calls a toggle applet. Starting with Siebel CRM version 8.0, you no longer set this user property in the application .cfg file. You now set it as an application user property in Siebel Tools.

To disable the view cache

Open Siebel Tools.
In the Object Explorer, click Application.
In the Applications list, query the Name property for the Siebel Business Application that contains the view where you must disable the cache.
In the Object Explorer, click Application User Prop.

In the Application User Props list, create a new application user property using values from the following table.

Property	Value
Name	OverrideViewCache0 You can use OverrideViewCache1, OverrideViewCache2, and so on to disable the cache for more views.
Value	The name of the view where you must disable the cache.

Property

Value

Name

OverrideViewCache0

You can use OverrideViewCache1, OverrideViewCache2, and so on to disable the cache for more views.

Value

The name of the view where you must disable the cache.

Compile and test your modifications.

Applet User Properties

This topic describes applet user properties. It includes the following topics:

Calling Methods from Applets

The Named Method n applet user property calls a business component or business service method, or sets a field value. You can use it instead of scripting. The value for this user property must include a value that depends on the following action that Siebel CRM must perform:

You can use the following format to set a field value:
```
"Name", "SET", "Field", "Expression"
```
If Siebel CRM calls Name, then it uses Expression to set the value of Field.
You can use the following format to call a business component method:
```
"Name", "Action", "BusComp", "Method"
```
If Siebel CRM calls Name, then it calls Method of the BusComp according to the Action. For a list of actions, see the table in Actions That You Can Use with the Named Method n User Property for Applets.
You can use the following format to call a business service method:
```
"Name", "Action", "BusComp", "Service", "Method"
```
If Siebel CRM calls Name, then it calls Method from the Service business service of the BusComp business component according to Action. For a list of actions, see Actions That You Can Use with the Named Method n User Property for Applets.

It might be necessary for you to configure Siebel CRM to start an action in reply to a data modification. For example, if Siebel CRM creates, deletes, or updates a record. You can configure Siebel CRM to start the reply before or after it applies the date modification. You can use a user property to create this automated reply without creating a custom script.

You can use this applet user property with the following classes:

CSSFrameBase
CSSFrameListBase

You can specify this user property with or without the numeric suffix. For more information, see Numbering Instances of a User Property and Calling Business Service Methods from Business Components.

Format You Must Use with the Named Method n Applet User Property

You must enclose each item that you include in the value of this user property in double quotation marks. You must use a comma and a space to separate each item. If a value includes a hyphen or parenthesis, then you must enclose this value in another set of single quotation marks or two more sets of double quotation marks. For example, if Siebel CRM must send the O2 Repair - Create Notification workflow process as a value for a parameter, then you use the following format:

"'O2 Repair - Create Notification'"

or

"""O2
Repair - Create Notification"""

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

You can append more parameters to an expression. If you use a business service action, then Siebel CRM sends this expression as a property set. You must use a name and value pair instead of an array of strings. For example:

"NameExpr", "ValueExpr"

Calling Methods in a Specific Order

You can use the Named Method n applet user property to call methods in a specific order. For example, you can use it to update a legacy system with new account records after Siebel CRM creates a new account record. The following code saves the record in Siebel CRM, and then calls a workflow process that updates the legacy system:

Named Method 2: WriteRecord 'INVOKE', 'WriteRecord','INVOKESVC', 'Workflow Process Manager', 'Run Process', '"ProcessName"','"Account - New Order"', '"RowId"','[Id]'

Actions That You Can Use with the Named Method n User Property for Applets

The following table describes the actions that you can use with the Named Method n user property.

Table Actions You Can Use with the Named Method n User Property

Action	Description	Method Type
INVOKE	Calls the method.	Business component
INVOKESEL	Saves the state and calls the method one time for each chosen record.
INVOKEALL	Saves the state, requeries, and then calls the method one time for each record.
INVOKESAVE	Saves the state, requeries, and then calls the method.
INVOKESVC	Calls the method.	Business service
INVOKESVCSEL	Saves the state and calls the method one time for each chosen record.
INVOKESVCALL	Saves the state, requeries, and then calls the method one time for each record.
INVOKESVCSAVE	Saves the state, requeries, and then calls the method.

Disabling Hierarchies in List Applets

The Disable Buscomp Hierarchy applet user property prevents Siebel CRM from displaying a hierarchical relationship in a list applet. The value for this user property must include a Boolean value. If TRUE, then Siebel CRM disables the business component hierarchy.

Siebel CRM uses a hierarchical list applet to display records that include a hierarchical relationship. To display this hierarchy in the client, it uses icons in the first column of this list applet. You can set the Hierarchy Parent Field property of the parent business component to use this hierarchy.

To disable this hierarchy, you can add this applet user property to the applet with the following values:

Name. Disable Buscomp Hierarchy.
Value: TRUE.

Siebel CRM uses this applet user property on predefined list applets, such as Asset Mgmt - Asset List Applet.

For more information, see the topic about specialized behavior that Web templates support in Configuring Siebel Business Applications.

Disabling Methods for FINS Applets in Query Mode

The FINS Query Mode Disabled Method n applet user property disables a method if the applet is in query mode. The value for this user property must include the name of a method.

You can use this applet user property with the CSSSWEFrameFINApplication class.

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

Disabling New Record Creation

The DisableNewRecord applet user property prevents Siebel CRM from calling NewRecord in the current applet. The value for this user property must match the application name exactly.

If the application name is the same as the name of the Siebel Business Application that Siebel CRM is currently running, then Siebel CRM disables NewRecord on this applet. For example, if the Siebel Sales Enterprise application is currently running, then the following value disables NewRecord on this applet for this application:

Siebel Sales Enterprise

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.

Enabling Methods for Applets

The CanInvokeMethod: MethodName applet user property enables or disable a method or a button. It must include a value or an expression that returns one of the following values:

TRUE. Siebel CRM enables the method.
FALSE. Siebel CRM disables the method.

MethodName identifies the name of the method that this user property enables or disables.

For example, Siebel CRM uses the following values to disable the Copy Record method that resides in the Partner Product List Applet:

Name. CanInvokeMethod: CopyRecord.
Value. FALSE.

The following example uses an expression for the value in the SIS Account List Applet. It enables the copy record feature for accounts that include a status but disables it for all other accounts:

Name. CanInvokeMethod: CopyRecord.
Value. [Account Status] IS NOT NULL.

Siebel CRM disables the method that the button calls. You can do this declaratively at the applet level. It is easier to use than scripting PreCanInvokeMethod.

Siebel CRM uses this user property in the CSSFrame class, CSSFrameList class, and the subclasses of these classes.

You can configure Siebel CRM to deactivate this user property, modify the value for it, or if an instance of it is not already defined, then to create a new instance of it.

Enabling Record Manipulation in Field Service and Task Views

The EnableStandardMethods applet user property enables record manipulation operations in a field service or task view. The value for this user property must include one of the following values:

Y. Enable record manipulation operations.
N. Call this method only if the user does one of the following:
- Right-clicks and opens an applet menu
- Uses a shortcut

If you specify the EnableStandardMethods user property on an applet, then the user can use this applet to do record manipulation operations. For example, the user can run a query, advance the record pointer, edit multiple records, and so on.

You can use this applet user property with the following classes:

CSSFrame
CSSFrameList
CSSSWEFrameShuttleBaseAssoc
CSSSWEFrameShuttleBaseMvg

Hiding Applets That Contain No Data

The NoDataHide applet user property hides the applet if it contains no data. The value for this user property must include one of the following values:

Y. If the applet contains no data, then hide it.
N. If the applet contains no data, then do not hide it.

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

Making an Applet Control Required

The Show Required n applet user property requires a control on an applet. Siebel CRM makes sure that the field that this control references is required and resides on an applet. The value for this user property must specify the name of an applet control.

If you specify this user property, then the business component that the applet references must use the CSSBCUser class.

If the control that you specify does not reside in the applet, then the user cannot enter a value for the required control. For example, if you create an applet user property named Show Required 1 with a value of EmailAddress, then Siebel CRM requires the user to use the EmailAddress control in the applet.

You can configure Siebel CRM to deactivate this user property. If more than one instance of this user property exists, then Siebel CRM runs each instance sequentially. For more information, see Numbering Instances of a User Property.

Specifying Gantt Chart Behavior

The following table describes the applet user properties that Siebel CRM uses for the eGanttChart Busy Free Time Applet. To view the values that you can use for each of these user properties, locate the predefined eGanttChart Busy Free Time Applet in the Applets list in Siebel Tools, and then examine the Value property in the Applet User Properties list.

Table User Properties for the eGanttChart Busy Free Time Applet

Applet User Property	Description
Major Time Unit	Specifies the major time unit in the X-axis of the Gantt chart. You can use one of the following values: Day Week Month Year
Minor Time Unit	Specifies the minor time unit in the X-axis of the Gantt chart. You can use one of the following values: Hour Day Week Month You can use the following combinations of major and minor time units: Day, Hour Week, Day Month, Day Month, Week Year, Month
X-BC	Specifies the business component for the X-axis of the Gantt chart.
X-Color Field	Specifies the cells of the Gantt chart that Siebel CRM can color differently. This applet user property specifies the field in the X business component that determines the coloring. For the field that you choose, make sure a corresponding list of values exists. For more information, see the description for the X-Color LOV Name applet user property.
X-Color LOV Name	Specifies the list of values that defines the values of the field that you choose for the X-Color Field applet user property. From this list of values, you can specify the Language Independent Code (LIC) that Siebel CRM uses for the field value.
X-LOV Map	Specifies the Language Independent Code of the list of values that Siebel CRM can map to colors.
X-Color Map	Specifies the colors of the different values of the Language Independent Code. These values must use the same order that the values in the X-LOV Map applet user property uses. For example, 2-High maps to GanttChartBlue. The values of the X-Color Map applet user property are the style sheet classes that the Gantt.css defines.
X-Date InvokeMethod	Specifies to map to an internal X-business component method that determines the date-time range for the X-business component data. You must not modify this applet user property.
X-Display Constraint Map	Specifies the lower and upper bounds of the time that Siebel CRM displays in the Gantt chart instead of displaying a 24-hour interval. It applies only if the minor time unit is Hour.
X-Display Duration	Specifies the number of minutes to increment each cell in the Gantt chart.
X-DrillDown Field	Specifies the field in the X business component that Siebel CRM uses as the drill down field. A corresponding Drilldown Object must exist for the applet in Siebel Tools.
X-End DateTime Field	Specifies the field in the X business component that specifies the end of the date and time range.
X-Join Field	Specifies the field in the X business component that links it to the Y business component. If you do not specify the X-Join InvokeMethod applet user property, then Siebel CRM uses the value in the X-Join Field applet user property in a search specification.
X-Join InvokeMethod	Specifies how to map to an internal X business component method to link the Y and X business components. You must not modify this applet user property.
X-Num Slots	Specifies the number of slots for a cell. For example, assume multiple activities include the same start and end times. If X-Num Slots is 3, then Siebel CRM splits the cell that contains the time range into a maximum of three slots. These cells contain the conflicting activities.
X-Num Tool Tips	Specifies the number of tooltips that the applet contains. For example, assume that the following tooltip is the last tooltip that the applet defines: X-Tooltip 12 In this example, you set the value of the X-Num Tool Tips applet user property to 12. If the applet does not contain an X-Tooltip n applet user property, then you set the value of the X-Num Tool Tips applet user property to 0 (zero).
X-Sort Spec	Specifies the sort specification for the X business component.
X-Start DateTime Field	Specifies the field in the X business component that contains the start for the date and time range.
X-Tooltips 1	Specifies the First control that Siebel CRM displays in the tooltip.
X-Tooltips 2	Specifies the Second control that Siebel CRM displays in the tooltip.
X-Tooltips n	You can define more applet user properties for more tooltip controls.
Y-BC	Specifies the business component that Siebel CRM uses for the Y-axis of the Gantt chart.
Y-BC ViewSet Size	Specifies the maximum number of records that the Y-axis can include.
Y-Constraint	Specifies the search specification for the Y business component in the base Gantt chart. Siebel CRM does not include any value for this user property, by default. If this user property does not include a value, then it uses a link in a parent and child relationship to constrain the Y business component.
Y-DrillDown Field	Specifies the source field that Siebel CRM uses for the Y drilldown.
Y-DrillDown View	Specifies the destination view of the Y drilldown. You can modify this user property.
Y-Join Field	Specifies the field in the Y business component that Siebel CRM uses to link this field to the X and Z business components.
Y-Label	Specifies the label for the Y-axis.
Y-Legend	Specifies a field in the Y business component that Siebel CRM displays in the Gantt chart.
Y-SortSpec	Specifies the sort specification for the Y business component.
Z-BC	Specifies the business component that determines the background that Siebel CRM draws for the Z-axis of the Gantt chart. For example, assume the working schedule of each employee is Monday through Friday, 8:00 AM to 5:00 PM. In this example, Siebel CRM uses a plain background where it displays the schedule and a colored background where it does not display the schedule. One of the following Z business components determines the display: GanttStateNone. No schedule. GanttStateOff. A schedule exists. GanttStateOn. Color of the cell that the X-Color Map controls.
Z-Date InvokeMethod	Specifies how to map the internal Z business component method that determines the date and time range for the Z business component data. You must not modify this user property.
Z-End DateTime Field	Specifies the field in the Z business component that specifies the end of the date and time range.
Z-Join Field	Specifies the field in the Z business component that links to the Y business component. If the Z-Join InvokeMethod property does not include a value, then Siebel CRM uses the Z-Join Field property as a search specification.
Z-Join InvokeMethod	Specifies how to map an internal Z business component method to link the Y and Z business components with each other. You must not modify this user property.
Z-Start DateTime Field	Specifies the field in the Z business component that determines the start of the date and time range.

Specifying Template Values for Proposals

The DocumentContextType applet user property specifies the context of a proposal. The value for this user property must include a string that defines a proposal template category. This value must match exactly a value that the PROPOSAL_TEMPLATE_TYPE list of values contains.

If the value you specify matches a value in the PROPOSAL_TEMPLATE_TYPE list of values, then Siebel CRM uses the templates that include the same category value in this applet. It displays these values in the Template drop-down list. For example, the following value filters proposal templates so that Siebel CRM displays only some proposal templates in the Template drop-down list in this applet in the client:

Account Proposal

The Account Proposal that Siebel CRM defines for the Category field determines the templates that Siebel CRM displays.

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 Drilldown Visibility

The Drilldown Visibility applet user property determines the visibility that Siebel CRM uses for a new view during a single record drill down. Earlier versions of Siebel CRM use this applet user property. The Visibility Type property of the drilldown object replaces this applet user property in later versions. For more information, see Specifying the Calendar Visibility Filter.

Specifying Field Names According to Parent Id

The Parent Id Field applet user property specifies the name of a field that resides in the current business component. For example, the PS Project Team OrgChart Applet specifies the Parent Team Member Id field that resides in the PS Project Team business component. If the user relocates one box next to another box in an organization chart to create a parent and child relationship, then Siebel CRM populates this field with the parent row ID.

If you do not specify a field, then Siebel CRM uses the default value from the Manager Id field that resides in the Contact business component.

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

Specifying Political Influence in Organization Charts

The Political Analysis Field applet user property specifies the name of a field that resides in the current business component. Siebel CRM uses it in the organization chart to display the level of influence for each contact. It shades the box of the contact with the appropriate level of color.

If you do not specify a field, then Siebel CRM uses Political Analysis as the default value.

You can map this field only to a list of values that includes the following values:

Low. No Color.
Political Structure (Medium). Light Grey.
Inner Circle (High). Dark Grey.

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

Specifying the PostInvokeMethod

The PostInvokeMethod n user property sets a value in some predefined applets. For example, the FINS FSW Service Request List Applet references the Service Request business component. It includes the following user property:

Name. PostInvokeMethod 1
Value. NewRecord:SetFieldValue:INS Product:[INS Product Predefault Calc]

If the user creates a new record in this applet, then this user property sets the INS Product field to the value that the INS Product Predefault Calc calculated field returns. In this example, it overrides the predefault value that Siebel CRM sets in the business component field.

Specifying Relationships in Organization Charts

The Contact Relationship Type applet user property specifies a list of relationship types that indicate the contact possesses a line of influence. The value for this user property must specify one or more relationship types. You can use a comma and a space to separate multiple relationship types. For example:

Influencer, TAS Influencer

The CONTACT_RELATIONSHIP_TYPE list of values typically provides these types.

If the user presses and holds down the CTRL key, and then moves one box in an organization chart and drops it on another box, then the value of this applet user property populates the RELATION_TYPE_CD column of the S_CONTACT_REL table. This table is the intersection table that resides between the Contact and Contact Relationship business components. For example, if the user relocates Box A in an organization chart onto Box B, then:

The CONTACT_ID column identifies the row ID of Box A.
The REL_CONTACT_ID column identifies the row ID of Box B.

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.

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

Specifying the Application That Creates Proposals

The ApplicationContextType applet user property specifies the Microsoft application that Siebel CRM uses to create proposal and presentation documents. It must include one of the following values:

MSWord. Use Microsoft Word for a proposal.
MSPpt. Use Microsoft PowerPoint for a presentation.

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

Specifying the Calendar Visibility Filter

The Visibility Type applet user property sets the visibility filter in a calendar applet. The value for this user property must include one of the following values:

My. The Owner static drop-down list displays the name of the user who is logged in. This user can view only their personal calendar.
My Direct Reports. The Owner static drop-down list displays the direct reports of the user who is logged in. This user can view the calendars for all people who report directly to this user. Siebel CRM typically uses this value in the eCalendar my direct reports applets.
All. The user who is logged in can view the calendars of other people that Siebel CRM allows this user to access even if these other people are not direct reports.

Specifying the Default Applet Focus

The DefaultFocus applet user properties set the focus for a field or control that resides in an applet before a user interacts with this field or control. It can override this focus behavior as determined by the applet mode. An applet web template determines the modes that an applet can use.

You can configure Siebel CRM to deactivate each of these user properties, to modify the value for each them, or to create a new instance of each of them, but you must not configure Siebel CRM to create more than one instance of each them for an applet.

Setting the Default Focus for an Object That Siebel CRM Does Not Display

If you set the default focus to a field or control that Siebel CRM does not display in the visible portion of the client, then one of the following situations might occur. This behavior might confuse the user:

The user might not be able to identify the object that is in focus.
Siebel CRM might attempt to adjust the vertical position of the view so that it can display the field or control that is in focus.

Specifying the Default Applet Focus for Base, Edit,or Edit List Mode

The DefaultFocus_Edit applet user property sets the focus for a field or control in an applet if the applet is in Base, Edit, or Edit List mode. The value for this user property must include the name of a field or control that resides in the applet. You must not enclose this value with quotes. For example, you can use the following value to set the default focus for the Last Name field on an applet that is in Edit mode:

Last Name

If you do not add the DefaultFocus_Edit user property to an applet, and if the applet is in Base, Edit, or Edit List mode, then Siebel CRM does not set the focus on any field or control.

Specifying the Default Applet Focus for New Mode

The DefaultFocus_New applet user property sets the focus for a field or control that resides in an applet if the applet is in New mode. The value for this user property must include the name of a field or control that resides in the applet. You must not enclose this value with quotes. For example, you can use the following value to set the default focus to the New button on an applet that the user uses to add a new record:

NewRecord

If you do not add the DefaultFocus_New user property to an applet, and if the applet is in New mode, then Siebel CRM sets the focus on the first field in the applet.

Specifying the Default Applet Focus for Query Mode

The DefaultFocus_Query applet user property sets the focus for a field or control that resides in an applet if the applet is in Query mode. The value for this user property must include the name of a field or control that resides in the applet. You must not enclose this value with quotes. For example, you can use the following value to set the default focus for the First Name field on an applet that is in Query mode:

First Name

If you do not add the DefaultFocus_Query user property to an applet, and if this applet is in Query mode, then Siebel CRM sets the focus to the first field that it displays in this applet.

Specifying the Error Web Page for Smart Script

The WebGotoPlayerErrorPage applet user property specifies the name of the Web page that Siebel CRM displays if an error occurs while it runs a SmartScript in Siebel Consumer Marketing. This error page includes a control that returns navigation to the eSmartScript page that caused the error.

Specifying the Finish or Cancel Web Page for Smart Script

The WebGotoView applet user property specifies the name of the view that Siebel CRM displays if it calls the FINISH event or the CANCEL event in the Siebel SmartScript player applet.

Specifying the Method That the Enter Key Calls

The Default Applet Method user property specifies the method that Siebel CRM runs if the user presses the Enter key in an applet. The value for this user property must include the name of a method that Siebel CRM accesses from the applet.

You can configure Siebel CRM to modify the value for this user property, create a new instance of it, or deactivate it. Only one instance can exist on each applet.

Specifying the Parent Business Component

The DataSourceBuscompName applet user property specifies the name of the business component that the business object references as the parent business component. It must specify the name of a business component that the current business object references.

If the Document Server receives a request to create a proposal or presentation, then it tries to restore the request context before it processes this request. It does this so that Siebel CRM positions the business component on the correct record set. The Proposal business component gets data from this business component according to the link specification. The first record is the record that the user used to submit the proposal request.

Note the following:

It is typically not necessary to specify this applet user property because Siebel CRM defaults to the parent business component of the Proposal business component. This is typically the parent business component.
You can specify this applet user property only if the parent business component that the current business object references is not the same as the parent business component of the Proposal business component.
If you use this applet user property, then the link to the business component that the user property defines restricts the data that Siebel CRM gets from the business components instead of the default value of the parent of the proposal.
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

Business Service User Properties

This topic describes business service user properties. It includes the following topics:

For information about using business component user properties to specify business services, see Specifying Business Services.

Specifying the BAPIAdapterService

The BAPIAdapterService business service user property specifies the name of the BAPI (Business Application Programming Interface) adapter business services. It must specify one of the following values:

BAPI Adapter
EAI
SAP

Specifying the BatchSize for SAP IDOCs

The BatchSize business service user property specifies the number of IDOCs (Intermediate Documents) that Siebel CRM reads from SAP in a single call. The value for this user property must include an integer. The value you use depends on the resources that are available in your environment. A high value might degrade performance. The default value is 3000.

Specifying the Time Out Interval for Receive Requests

The SleepTime business service user property specifies the time out interval, in seconds, that Siebel CRM uses for a receive request. The value for this user property must include an integer. The default value is 20 seconds.

Caution: If you set the SleepTime user property to a low value or zero, then a serious negative impact on performance might result. It can cause SAP to flood the SAP system buffers and to retry sending IDOCs to Siebel CRM because the connector does not "receive" them.

Control User Properties

This topic describes control user properties. It includes the following topics:

Forcing Controls to Be Active

The ForceActive control user property that resides on a control in a form applet forces the field that the control references to be active even if Siebel CRM does not display this field in the client. The value for this user property must include a Boolean value. If Y, then this field is active even if Siebel CRM does not display it in the client.

A field is typically active only if Siebel CRM displays it in the client. For more information, see Forcing Fields That a List Column References to be Active.

Saving Unsaved Data

The PostMainViewData control user property prevents Siebel CRM from losing unsaved data if a control calls a method that modifies the main view before Siebel CRM saves any new data that resides in the current record. The value for this user property must include one of the following values:

TRUE. If the current record contains modified data, Siebel CRM saves the current record before the control modifies the focus.
FALSE or this user property does not exist. Siebel CRM calls the control method and does not write unsaved data to the current record.

It is recommended that you set the PostMainViewData user property on each control that affects how Siebel CRM saves data, such as the Attach button. For example, if the All Service Requests view is the main view, then the user can click the Search button before Siebel CRM saves the current record. If the user runs a search, and then clicks the Attach button for a record, then Siebel CRM drills down on the Results list into the active record. This configuration modifies the applet that resides in the main view and Siebel CRM might lose the new data that resides in the unsaved service request.

You can configure Siebel CRM to deactivate this user property, modify the value for it, or if an instance of it is not already defined, then to create a new instance of it.

Specifying the Goto URL

The Url control user property specifies the URL that Siebel CRM uses when it calls the GotoUrl method for an applet control. If the value of the Method Invoked property on a control is GotoUrl, then you must use the Url control user property to specify the URL.

Siebel CRM typically uses the GotoUrl method with the CancelQuery control. It uses the following value for the Url:

JavaScript:history.back()

Specifying the Goto View

The View control user property specifies the name of the view that Siebel CRM displays when it calls the GotoView method for an applet control. For example:

Account List View

If the value of the Method Invoked property on a control is GotoView, then you must use the View control user property to specify the view.

Specifying the Goto Web Page

The Page control user property specifies the Web page that Siebel CRM displays when it calls the GotoPage method for an applet control.

If you set the Method Invoked property of a control to GotoPage, then you must use the Page control user property to specify the Web page.

Siebel CRM typically uses the GotoPage method with the Main Menu control, where the value of Page is SLWS Start Page.

Field User Properties

This topic describes field user properties. It includes the following topics:

For information about using business component user properties to control fields, see Controlling Fields.

Disabling Search on Text Fields or Unindexed Fields

The DisableSearch field user property prevents the user or the Siebel query engine from running a query on a field that is not indexed or that is a text field. The value for this user property must include one of the following values:

TRUE. Disable wildcard search on the field. For example, if the user enters the following value, then Siebel CRM displays an error message:
```
[Name] LIKE 'S*'
```
Siebel CRM does allow an exact search. For example, it allows the following search:
```
[Name] = 'Siebel'
```
FALSE or this user property does not exist. Allow wildcard or exact match search.

Siebel CRM enforces this user property in the following situations:

Query by example
Query Assistant
Search Center
Query started in a programmatic or message interface
Predefined query

You can configure Siebel CRM to deactivate this user property, modify the value for it, or if an instance of it is not already defined, then to create a new instance of it.

Disabling Sort on Business Component Fields

The DisableSort field user property specifies whether a user can sort a result set on a business component field. It must include one of the following values:

TRUE. Disable all sorting on any field in any applet that references the business component. Siebel CRM does the following:
- Does not display the sort icons or tool tips in the list column header.
- Does not display the field in the Advanced Sort window.
- If a user attempts to sort on the Name field in any applet that references this business component, then Siebel CRM displays an error message.
FALSE or this user property does not exist. Enable sort on the field.

You can configure Siebel CRM to deactivate this user property, modify the value for it, or if an instance of it is not already defined, then to create a new instance of it.

For more information, see Disabling Sort on List Columns.

Making a Field Required

The Required field user property makes the parent field a required field in some situations. The value for this user property must include a calculated expression. If Siebel CRM evaluates this expression to Y, then the field is required.

You can use this applet user property only with a business component that references the CSSBCBase class.

Setting the Field Text Length

The Text Length Override field user property configures Siebel CRM to use the text length of a field instead of the database column to determine the maximum field length. You can use this field user property only for a text field. The value for this user property must include text. If this user property:

Exists. The Text Length property of this field determines the maximum field length regardless of the value that the user property contains. This situation is true even if the value is empty.
Does not exist. The size of the database column determines the maximum field length.

Specifying Encryption for Fields

This topic describes user properties that handle encryption. It includes the following topics:

Overview of Encryption User Properties

Siebel CRM comes predefined with the following business services that it uses to encrypt data fields according to RSA (Rivest Shamir Adleman) encryption:

Advanced Encryption Standard (AES) Encryptor
RC2 Encryptor

To encrypt a field, you set the encryption flag, identify the encryption service, and specify the encryption key. To disable encryption on a field, you set the Encrypted user property of the field to N.

If encryption is enabled, then Siebel CRM writes data to the field in the encrypted format and reads decrypted data from the field. Encryption must be enabled for each business component field that Siebel CRM maps to the same database column, and the user property specifications for these objects must be consistent.

Siebel CRM typically encrypts credit card number fields. However, it might be necessary for you to disable encryption in these fields in the following screens so that the user can view this information:

Order Entry -- Orders
Quote
Agreements

For more information about setting up or upgrading encryption, see Siebel Security Guide. For more information about encryption keys and how to manage them, see Siebel System Administration Guide.

Upgrading Encryption

To do one of the following, you must run an upgrade script that modifies the encryption for the field:

Use the RSA or AES encryptor service on a field that Siebel CRM previously did not encrypt or that the Standard Encryptor encrypted. Siebel CRM no longer supports Standard Encryptor.
Use a stronger version of RC2 encryption than Siebel CRM previously used on the field.

For more information, see the upgrade guide for the operating system you are using.

Enabling Encryption on a Field

The Encrypted field user property specifies whether Siebel CRM encrypts a field. The value for this user property must include a Boolean value. If Y, then Siebel CRM enables encryption. To enable encryption on a field, you must set this field user property to Y and you must configure the Encrypt Service Name and Encrypt Key Field user properties. For more information, see Siebel Security Guide.

Specifying the Field That Contains the Encryption Key

The Encrypt Key Field field user property specifies the name of the business component field that contains the encryption key index. The keyfile.bin file in the following directory contains indexed encryption keys:

\Siebel_Root\Admin

The Encrypt Key Field user property specifies the business component field that contains the numbered encryption key index that Siebel CRM uses to decrypt the parent field.

For example, the Credit Card Number field that resides in the Quote business component is an encrypted field that contains credit card numbers. The Credit Card Number Key Index field contains the index of the encryption key that Siebel CRM uses to decrypt the Credit Card Number field. Siebel CRM sets the Credit Card Number field in the Encrypt Key Field user property to a value that the Credit Card Number Key Index contains.

Specifying the RC2 or AES Encryption Service

The Encrypt Service Name field user property specifies the encryption service name. It must specify one of the following values:

RC2 Encryptor
AES Encryptor

You can set this field user property on an encrypted field to specify the embedded encryption service that Siebel CRM applies.

Setting an Encrypted Field to Read Only if Encryption Fails

If decryption fails, then the Encrypt ReadOnly Field field user property sets an encrypted field to read-only. It must specify the name of a calculated business component field whose Calculated Value property is empty.

The calculated field that this field user property specifies determines whether Siebel CRM sets the data in the encrypted field to read-only. Preserving the data in read-only form allows someone to recover it later without modifying this data. This calculated field can use one of the following values:

Y. Decryption fails on the encrypted field. Siebel CRM sets this encrypted field to read-only.
N. Decryption succeeds on the encrypted field. Siebel CRM sets this encrypted field to readable.

For example, the Quote business component includes the encrypted Credit Card Number field. Siebel CRM sets the Encrypt ReadOnly Field user property for this field to the value that the Credit Card Number - Read Only calculated field contains.

Masking Credit Card, Account, and Other Secure Data

The Display Mask Char field user property displays a masked version of secure data, typically a credit card number or account number. The value for this user property must include a character that Siebel CRM uses to mask characters. Siebel CRM sets this value to x, by default.

Siebel CRM uses this field user property with the Encrypt Source Field user property to display only the last 4 digits of a credit card number or account number. For example, xxxxxxxxxxxx9999. You set this field user property on a separate calculated field that Siebel CRM displays in the client instead of on the field that contains the entire credit card number or account number.

For example, Siebel CRM uses the Credit Card Number field in the Quote business component as the encrypted field that stores the credit card number. The properties of the Credit Card Number - Display calculated field include the following values:

Display Mask Char. This user property contains x.
Encrypt Source Field. This user property contains the following value. The applet field that displays the masked credit card number must reference the Credit Card Number - Display field:
```
Credit Card Number
```

The field that the Encrypt Source Field property identifies must be encrypted. If it is not encrypted, then the masking functionality does not work.

For more information, see Specifying the Field That Contains the Encryption Key.

Specifying the Field That Contains Secure Data

The Encrypt Source Field field user property specifies the name of the business component field that contains an encrypted credit card number or account number. For more information, see Masking Credit Card, Account, and Other Secure Data.

Updating Assets

The SubCompCanUpdate field user property updates asset records. The value for this user property must include one of the following values:

TRUE. Update any nonroot asset record.
FALSE. Set asset records to read only.

For more information, see Allowing Users to Update Assets and Cascading Asset Updates.

Cascading Asset Updates

The SubCompUpdate field user property cascades modifications that occur to an asset record. It cascades these modifications to child asset records. The value for this user property must include one of the following values:

TRUE. Cascade modifications to child asset records.
FALSE. Do not cascade modifications.

Configuring Siebel CRM to Cascade Asset Updates

This topic describes how to configure Siebel CRM to cascade modifications that it makes to an asset record. The example in this topic describes how to configure Siebel CRM to cascade modifications that it makes to the Ship Date field that resides in the Asset Mgmt - Asset business component. It cascades these modifications to the Ship Date field that resides in the Asset Mgmt - Asset - SubCompUpdate Processing business component.

To configure Siebel CRM to cascade asset updates

Log in to Siebel Tools.
In the Object Explorer, click Business Component.
In the Business Components list, query the Name property for the following value:
```
Asset Mgmt - Asset
```
In the Object Explorer, expand the Business Component tree, and then click Field.
In the Fields list, query the Name property for the following value:
```
Ship Date
```
In the Object Explorer, expand the Field tree, and then click Field User Prop.

In the Field User Props list, create a new field user property using values from the following table.

Property	Value
Name	SubCompCanUpdate
Value	FALSE

In the Field User Props list, create a new field user property using values from the following table.

Property	Value
Name	SubCompUpdate
Value	TRUE

In the Object Explorer, click Business Component.
In the Business Components list, query the Name property for the following value:
```
Asset Mgmt - Asset - SubCompUpdate Processing
```
In the Object Explorer, click Field.
In the Fields list, query the Name property for the following value:
```
Ship Date
```

Set the following property using values from the following table.

Property	Value
Force Active	TRUE

Specifying the Field That Stores the Account Id of a Contact

The Affiliated Account Id Field user property specifies the name of the business component field that stores the account ID of affiliated contacts. Siebel Life Sciences applications use it to display affiliated contacts. If you do not define this field user property, then Siebel CRM searches for the Account Id field in the parent business component.

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 Specifying the Field That Stores Parent Account IDs for Contacts.

Specifying the SQL for EXISTS Search Specifications

The UseExistsForSubQuery field user property determines the type of SQL clause that Siebel CRM uses if it encounters an EXISTS search specification in a business component. If it encounters an EXISTS search specification, and if the value for this user property is:

TRUE. Siebel CRM uses the SQL EXISTS clause.
FALSE or this user property does not exist. Siebel CRM uses the SQL IN clause.

In some situations, using the SQL EXISTS clause instead of the IN clause can improve query performance, particularly for IBM DB2 390.

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

Using Literals Instead of Bind Variables

The Use Literals For Like field user property uses a literal instead of a bind variable as the criteria for a LIKE predicate in the SQL code that Siebel CRM uses to query a field. The value for this user property must include one of the following values:

TRUE. Siebel CRM uses a literal instead of a bind variable. For example:
```
LIKE "ABC%" 
```
where:
- The % (percentage symbol) specifies the exact location of the wildcard.
- FALSE or this field user property does not exist. Siebel CRM uses a bind variable. If a search string includes a wildcard, such as * or ?, then Siebel CRM creates the following predicate to represent this wildcard:
```
LIKE ?
```

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

Guidelines for Using Literals Instead of Bind Variables

Caution: Avoid or minimize using the Use Literals For Like field user property. It can use resources because it requires more SQL code parsing that can cause a package cache overflow. It is recommended that you use it only after testing indicates that a significant performance improvement will result.

Using the Use Literals For Like user property can impact performance when compared to using a bind variable for some searches. For example:

A search string that includes a wildcard in a trailing position, such as "ABC*", can improve performance because Siebel CRM can choose a more appropriate index.
A search string that includes a wildcard in a leading position, such as "*ABC", can degrade performance. The Use Literals For Like field user property does not improve performance for this search because it does not significantly reduce the number of rows that Siebel CRM must scan.

If you configure the Use Literals For Like field user property, then use the following guidelines:

If poor performance exists, or if a DB2 UDB utility indicates that the optimizer does not choose indexes efficiently, then it is recommended that you use the Use Literals For Like field user property. If performance improves significantly, then deploy this configuration to your production environment.
Do not use the Use Literals For Like field user property to improve performance with a case-insensitive query.
Use a literal in a query that includes a LIKE predicate. This configuration can improve query performance on DB2 UDB. It provides information that the database optimizer can use to choose indexes for the query.

Integration Component User Properties

This topic describes integration component user properties. It includes the following topics:

Specifying Association Business Components

The Association integration component user property indicates that the integration component is an association business component. The value for this user property must include a Boolean value. If Y, then the integration component is an association integration component.

Specifying MVG Business Components

The MVG integration component user property specifies that the integration component is a multivalue group business component. The value for this user property must include a Boolean value. If Y, then the integration component is a multivalue group business component.

Preventing Siebel EAI From Deleting Records

The NoDelete integration component user property restricts the Siebel EAI connector from performing a delete on the corresponding business component. The value for this user property must include a Boolean value. If Y, then the Siebel EAI connector does not perform deletes in the business component that the integration component references.

Preventing Siebel EAI From Inserting Records

The NoInsert integration component user property restricts the Siebel EAI connector from inserting on the corresponding business component. The value for this user property must include a Boolean value. If Y, then the Siebel EAI connector does not perform inserts in the business component that the integration component references.

Integration Component Field User Properties

This topic describes integration component field user properties. It includes the following topics:

Specifying the Field Name for an MVG

The AssocFieldName [Field Name] integration component field user property specifies the name of the business component field that Siebel CRM displays on the multivalue group business component.

Preventing Siebel EAI From Updating Fields

The NoUpdate integration component field user property restricts the Siebel EAI connector from updating the corresponding field. The value for this user property must include a Boolean value. If Y, then the Siebel EAI connector updates the field that the integration component field references.

Integration Object User Properties

This topic describes integration object user property. It includes the following topics:

Specifying the IDOC Message Type for SAP

Specifying the IDOC Message Type for SAP

The Logical Message Type integration object user property specifies the logical message type that corresponds to the IDOC (Intermediate Document). The value for this user property must include a logical message type that corresponds to the IDOC. For example, DEBMAS or MATMAS. If you use this integration object user property with an SAP product, then the SAP Connector:

Ignores it when it receives each IDOC from SAP.
Uses the value that it contains to populate the control segment MESTYP field before it sends each IDOC to SAP.

List Column User Properties

This topic describes list column user properties. It includes the following topics:

Disabling Sort on List Columns

The DisableSort list column user property specifies whether a user can sort a result set on a list column. It prevents the user and the Siebel query engine from sorting data that is not indexed. The value for this user property must include a Boolean value. If TRUE, then Siebel CRM does the following:

Disables sort on the list column.
Does not display the sort icons or tool tips in the list column header.
Does not display the field in the Advanced Sort window.

For example, if you set the DisableSort user property of the Name list column to TRUE, then Siebel CRM does the following:

Does not display the sort icons or Sortable tool tip in the Name list column.
Does not display the Name field in the Advanced Sort window.
If a user attempts to sort on the Name field, then it displays an error message. For more information, see Disabling Sort on Business Component Fields.

You can configure Siebel CRM to deactivate this user property, modify the value for it, or if an instance of it is not already defined, then to create a new instance of it.

Forcing Fields That a List Column References to be Active

The ForceActive list column user property forces the field that the list column references to be active even if Siebel CRM does not display it. A field is typically active only if Siebel CRM displays it in the client. The value for this user property must include a Boolean value. If Y, then the field is active even if Siebel CRM does not display it in the client. For more information, see Forcing Controls to Be Active.

View User Properties

This topic describes view user properties.It includes the following topics:

Specifying the DefaultAppletFocus

Specifying the DefaultAppletFocus

The DefaultAppletFocus view user property identifies an applet in a view. Siebel CRM sets the focus to this applet before the user interacts with the view. This user property overrides the applet that receives the default focus.

The value for this user property must include the name of an applet that the view displays. You must not enclose this value in quotes. For example, Siebel CRM sets the value of the DefaultAppletFocus user property of the Account Screen Homepage View to the following value:

Account Home Search Virtual Form Applet

It sets the focus for this view to the Account Home Search Virtual Form Applet the first time the user accesses this view.

If the DefaultAppletFocus user property does not exist on a view, then the screen view determines the default focus. If the Type property of the screen view is:

Detail View, and if the view includes more than one applet, then Siebel CRM places the focus on the second applet.
Not Detail View, or if the view includes only one applet, then Siebel CRM places the focus on the first applet.

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

For more information, see Setting the Default Focus for an Object That Siebel CRM Does Not Display.