1. Object Types Reference
  2. What's New in This Release

2Overview of Using Siebel Object Types Reference

Overview of Using Siebel Object Types Reference

This chapter describes an overview of Siebel Object Types Reference. It includes the following topics:

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.

    Differences That Exist Between the Properties Window and the Object List Editor

    In most situations, the properties and values that Siebel Tools displays for an object definition in the Properties Window and the Object List Editor are identical. There are some differences:

    • The Properties Window sometimes uses an abbreviated label for a property. For example, the Properties Window uses Workflow Component, and the Object List Editor uses Workflow Policy Component to describe the same property of the assignment attribute column object type.

    • The Properties Window might not include every property. For example, it does not include the Project property for some object types.

    • The Object List Editor might not include every property.

    If differences exist, then this book describes Object List Editor usage unless noted otherwise.

      Getting Help From Oracle

      If you require help from Oracle for using object types, you can create a service request (SR) on My Oracle Support. Alternatively, you can phone Global Customer Support directly to create a service request or get a status update on your current SR. Support phone numbers are listed on My Oracle Support. You can also contact your Oracle sales representative for Oracle Advanced Customer Services to request assistance from Oracle's Application Expert Services.

        Common Object Properties

        The following table describes object properties that are common for many different object types. Their meaning and usage is the same for these object types. If an object type includes a property, then, for brevity, the table describes the properties for this object type might not include this property.

        Table Common Object Properties

        Property Description

        Application Code

        Reserved for future use.

        Changed (S)

        If you edit a record, then Siebel Tools adds a check mark in the Changed property. This check mark indicates that you modified this object definition since the date and time that you specify in the General tab of the Development Options dialog box. If the Changed property does not include a check mark, then no modification has occurred. For more information, see Using Siebel Tools.

        Comments (O)

        Includes text that describes the object definition. This text helps the developer to understand how Siebel CRM uses this property. It does not affect Siebel CRM functionality in any way. It is for documentation purposes only.

        Description (S)

        Includes text that describes the object definition. This text helps the developer to understand how Siebel CRM uses this property. It does not affect Siebel CRM functionality in any way. It is for documentation purposes only.

        GParent, GGParent (S)

        Specifies the name of the grandparent or great-grandparent object definition. Siebel Tools creates the value that this property contains. It displays this property only in the Object List Editor and only if you click the Flat tab in the Object Explorer.

        ICL Upgrade Path (S)

        Identifies the releases that Siebel CRM sets for the Upgrade Behavior property to Preserve for ICL (Incorporate Custom Layout) user interface objects. For more information about ICL, see Siebel Database Upgrade Guide.

        Inactive (O)

        If this property includes a check mark, then Siebel Tools does not compile this object definition when you deploy your changes to the Siebel runtime repository and it does not allow other objects to reference it.

        Language Code (R)

        The abbreviation for the language that Siebel Tools uses for this object definition. For example, you can use the following value for U.S. English:

        ENU

        Module

        Reserved for future use.

        Object Language Locked

        The abbreviation for the language that Siebel Tools uses for this locked object. For example, ENU for U.S. English. For more information about object and project locking, see Using Siebel Tools.

        Object Locked

        If this property includes a check mark, then the object definition is locked.

        Object Locked by Name

        Contains the user name of the developer who locked the object definition.

        Object Locked Date

        Contains the date when the developer locked the object definition.

        Parent Name, Parent object_defn_name (S)

        Contains the parent name of the current object definition. Siebel Tools creates this value.

        The Parent Business Component property of the Link object type is different from the parent property for other object types. If you create a new link object, then you must enter a value in the Parent Business Component property.

        Project (R)

        Identifies the project that the object definition references.

        Redo (O)

        Describes a single-level redo of a field modification or a record modification. The Locale Management Utility uses this property to track locale-specific modifications.

        Repository Name (S)

        Identifies the repository that includes the object definition.

        String Override (O)

        A language-independent override of the String Reference property. If a value exists in the String Reference property, then Siebel Tools uses this value instead of the value that the String Reference property contains.

        Siebel Tools displays a string override as property_name-String Override. For example:

        Display Name - String Override

        String Reference (R)

        References a symbolic string.

        Siebel Tools displays a string reference as property_name-String Override. For example:

        Display Name - String Override

        For example, the Title - String Reference property contains SBL_ACCOUNTS-1004224727-0H5 for the Account List Applet. This string reference references a symbolic string locale. The ENU string value for this locale is Accounts.

        Tooltip Text

        Obsolete. You must not use this property.

        Translate (S)

        The Locale Management Utility uses this property to track modifications that occur to localization. This property is for Oracle use only.

        Upgrade Ancestor (S)

        You can use this property to make sure that the Application Upgrader upgrades an object that you copy in the same way that it upgrades the original object. For example, assume you make a copy of the Account business component, and then name it ESG Account. You set the Upgrade Ancestor property of the ESG Account business component to Account. This value configures the Application Upgrader to upgrade the ESG Account business component in the same way that it upgrades the Account business component.

        Upgrade Behavior (S)

        Determines if Siebel CRM preserves a user interface object for ICL (Incorporate Custom Layout) handling when it does a repository merge. You can use one of the following values:

        • Admin. The object is never eligible for ICL handling and Siebel CRM ignores it.

        • Non-Preservable. The object is not eligible for ICL handling for an upgrade for the current release. Siebel CRM might modify this value to Preserve in a subsequent release.

        • Preserve. The object is eligible for ICL handling.

        Oracle sets the value of the Upgrade Behavior property and the ICL Upgrade Path property for each release. You must not modify these values.

        For more information about ICL, see Siebel Database Upgrade Guide.

          About the Precision and Scale Properties

          The Precision property of an object type specifies the total number of digits that can exist to left and right of the decimal point for a numeric field:

          • A noninteger column can include a total of 22 digits.

          • An integer column can include a total of 10 digits.

          The Scale property of an object type specifies the maximum number of digits that can exist to the right of the decimal point for a numeric field:

          • A numeric column can include a total of 7 digits to the right of the decimal point.

          • An integer column cannot include any digits to the right of the decimal point.

          For example, if the precision for a number is 6, and the scale is 2, then this field can represent a number that uses the following format:

          9999.99

          Other examples follow:

          Precision 4, scale 2: 99.99
Precision 10, scale 0: 9999999999
Precision 8, scale 3: 99999.999
Precision 5, scale -3: 99999000

            Formats You Can Use With an Accelerator Object Type

            This topic describes the format that you can use with an Accelerator or Accelerator Locale. A menu or toolbar item might include a command field. If this command field includes a command that uses an accelerator that you define, then Siebel CRM uses this accelerator. You can use one of the following formats:

            • modifier + name

            • modifier_1 + modifier_n + name

            • accelerator

            where:

            • modifier is Ctrl, Alt, or Shift.

            • name is 0 through 9, A through Z, F 0 through 24, a key_code, or a constant.

            • key_code is a three-symbol decimal code, such as 128, or a four-symbol hex number, such as 0x10.

            • constant is INSERT, DEL, LEFT, RIGHT, UP, DOWN, HOME, END, PAGEUP, PGUP, PAGEDOWN, PGDN, SPACE, TAB, or ENTER.

            For example, you can use the following formats:

            • Ctrl+F10

            • Alt+A

            • Ctrl+ INSERT

            • Ctrl+Alt+0x221

            The syntax is not case-sensitive.

              Modifying Undocumented User Properties

              You can only modify a user property that is documented. For example, you can modify a user property for an applet that references the CSSFrameBrowser class. Only Oracle can create or delete a user property that is not documented. For more information, see Siebel Developer's Reference.

                Object Types That You Must Not Modify

                This topic lists object types that Siebel CRM uses to manage the repository or that are for internal Oracle use only. You must not modify or delete any of these objects. For help with using these object types, see the following.

                You must not modify any object type that this topic lists. Any modification can adversely affect Siebel CRM performance and operation.

                  Object Types That the Siebel Enterprise Integration Manager Uses

                  The Siebel Enterprise Integration Manager Wizard uses the following object types:

                    Object Types That Information Access Uses

                    Information access uses the following object types. Instead of modifying these objects, it is recommended that you use the Dock Object Wizard to create a new object:

                      Miscellaneous Object Types

                      You must not modify any of the following object types:

                        Alphabetic List of Object Types

                        The following list includes all object types that this book describes: