Conventions This Book Uses to Describe Object Types

This book uses the following conventions:

  • Each object type includes a table that describes the properties that the object type includes. The Property column in these tables includes one of the following values:

  • (R) Required. You must include a value for this property.

  • (O) Optional. You are not required to include a value for this property.

  • (S) System. Siebel CRM creates a value that you cannot modify.

  • (H) Hidden. Identifies object types and properties that the Siebel Web Client does not use. Siebel CRM hides these items in the client and does not display them in the Object Explorer in Siebel Tools. If Siebel CRM hides an object type, then it also hides the properties of this object type. To display these hidden items and other object types in the Object Explorer, see the topic about displaying object types in Using Siebel Tools.

  • If you spell an object name, then you must use the same spelling that this book uses for this object name.

  • A constant is case-sensitive. You typically use all uppercase characters to spell it. For example, TRUE or FALSE for a Boolean field.

A user is a person who uses the client of a Siebel CRM application to use Siebel CRM data.

The client is the client of a Siebel CRM application.

The server is the Siebel Server, unless noted otherwise.

An administrator is anyone who uses the administrative views in the client to configure Siebel CRM.

Computer font indicates a value you enter or text that Siebel CRM displays. For example:

This is computer font

A predefined object is an object that comes defined with Siebel CRM. The objects that Siebel Tools displays in the Object List Editor immediately after you install Siebel Tools and the Siebel runtime repository but before you make any customizations are predefined objects.

Siebel Tools can display the value for the property of an object type in one of the following ways:

  • Statically in a dropdown list or dialog box.

  • Dynamically in a dropdown list or dialog box.

  • Text entry.

  • With a check mark.

  • As a link.

To view the full list of values that you can use for most properties, you can click the dropdown list that Siebel Tools displays if you click anywhere in the value field of the property. This book does not describe every property value you can choose. It describes only the property values that require elaboration.

This book describes only reference information about object types. For information about how to use object types to configure Siebel CRM, see Configuring Siebel Business Applications.

Your Siebel CRM application might not include all the features that this documentation describes, depending on the software modules that your company purchases.