1. Object Types Reference
  2. Field

Field

A field defines a business component field. The fields in a business component record include entries from a single value field or a multi value field. Siebel CRM evaluates required fields in alphabetical order according to the parent business component. For example, assume two required fields named Alpha and Omega exist on an applet and that these fields reference a business component field. Siebel CRM processes Alpha first and then Omega.

This object type occurs in the following location in the object hierarchy:

The following table describes properties that Siebel CRM uses with a field.

Property Description

Calculated (O)

If TRUE, then Siebel CRM gets values from the business component to calculate the field value rather than getting values from the server database.

Calculated Value (O)

Specifies the expression Siebel CRM uses to calculate the field value if the Calculated property is TRUE.

Column (R)

Specifies the table column name. Other objects that reference this field can reference it through the column name.

This property is not used or required for the following items:

  • Calculated fields

  • Multi-value fields

  • Fields in a virtual business component

The column name is name is case-sensitive. It must use the same format that it uses in the Siebel database.

Currency Code Field (O)

Specifies the name of the currency code field that Siebel CRM uses with a DTYPE_CURRENCY data type.

The default field name is Currency Code.

Dest Field (O)

Specifies a field in the destination business component that is defined in the Multi Value Link field.

Siebel CRM uses the Dest Field property only if the Multi Valued property is TRUE

If the Multi Valued property is FALSE, the Siebel CRM ignores the Dest Field property.

Disable Search

You can use one of the following values:

  • TRUE. Users cannot use this field to search in any way: in the client user interface, predefined queries (PDQ), search specifications on a business component, or in scripting, workflows, tasks, and so on.

  • FALSE. Users can use this field to search without restrictions.

Disable Sort

You can use one of the following values:

  • TRUE. The user cannot use this field to sort in the client.

  • FALSE. The user can use this field to sort in the client.

Exchange Date Field (O)

Specifies the name of the exchange date field that Siebel CRM uses with a DTYPE_CURRENCY data type. The default field name is Exchange Date.

Force Active (O)

If TRUE, then to get the field value, Siebel CRM queries the Siebel database each time it instantiates the parent business component. It does this even if it does not display this field in the client. You must set the Force Active property to TRUE only if you must script a field in the active business component, and only if Siebel CRM does not display this field in the active applet. Setting this property to TRUE might reduce performance.

Force Case (O)

Specifies the case for the field value. You can use one of the following values:

  • UPPER

  • LOWER

  • FIRSTUPPER

Hidden (O)

If TRUE, then the field is not visible to a dynamically created list view, such as the view that the forecasting module uses. Siebel CRM uses this property to support only specialized functionality. It does not support general configuration.

The default value of the Hidden property is one of the following:

  • TRUE for a business component that uses the DTYPE_ID data type.

  • FALSE for business components that do not use the DTYPE_ID data type.

Immediate Post Changes (O)

For more information, see Configuring the Immediate Post Changes Property of a Field.

Internal Pick Applet (O)

Specifies a pick applet that Siebel Tools displays for a workflow process. You can set the conditions for the Decision Point step in a workflow process to use values from business component fields. You can use the Internal Pick Applet property to specify the applet that this user interface displays.

Join (O)

Specifies the name of the join object definition that this field uses. Siebel CRM uses this join to get data from the table that the join defines. The value in the Join property corresponds to the Name property of this join. For more information, see Join.

Link Specification (O)

If TRUE, then Siebel CRM sends the field value as a default value to a field in the child business component.

Message Display Mode

Specifies the data to display if a validation failure occurs. You can use one of the following values:

  • User Msg. Display only the validation message.

  • User Msg with Error Code Only. Display the validation message and a Siebel error code in the following format:

SBL-xxx-yyy

  • User Msg with Error Code/Msg. Display the validation message, Siebel error code, and the default error message.

Multi Value Link (O)

Depends on the following value of the Multi Valued property of this field:

  • TRUE. The Multi Value Link property specifies the multivalue link for this field.

  • FALSE. Siebel CRM ignores the Multi Value Link property.

Multi Valued (O)

You can use one of the following values:

  • TRUE. This field is a multivalue field.

  • FALSE. This field is a single value field.

Name (R)

Specifies the name for this field. Other objects reference this field through this Name property.

You must not modify the name of a predefined field. Doing this can create upgrade problems and might affect intended configuration.

The name can include spaces. It must be unique in the business component.

No Copy (O)

You can use one of the following values:

  • TRUE. Siebel CRM does not copy the field value to the newly created record during a Based On Last operation.

  • FALSE. Siebel CRM copies the field value to the newly created record during a Based On Last operation. If you set the No Copy property to false for a field that Siebel CRM derives from a joined table, then you must make sure that No Copy in the join field is also set to FALSE. The Source Field property in the join specification identifies this join field. If you do not do this, then Siebel CRM displays the new record. It does this to copy the fields from the joined table. If the record is required, then it does not populate the fields. This situation occurs only in a Based On Last operation.

Oracle Sequence Object (O)

Specifies the name of an Oracle sequence object. If Siebel CRM creates a new record, then it uses this sequence for this field.

You must manually create the Oracle sequence object in the Oracle Database. This is an exception to the normal way that you configure an Oracle sequence object.

Siebel Remote does not support an Oracle sequence object.

PickList (O)

Specifies the name of a picklist object definition that Siebel CRM uses to display a list of valid values that the user can choose.

Post Default Value (O)

Specifies the field value that Siebel CRM inserts in this field if it is empty the first time Siebel CRM writes it to the Siebel database. Note the following:

  • Siebel CRM inserts the post default value even if it does not display this field in the client.

  • If this field is empty during a subsequent update of this field, then Siebel CRM does not insert this post default value.

  • Siebel CRM does not validate the value that the Post Default Value property contains for a calculated field.

  • Siebel CRM limits the value in the Post Default Value property to 255 characters.

  • To make sure the configuration in the linked field of a child business component works correctly, the Link Specification property must be TRUE on the parent business component.

Pre Default Value (O)

Specifies the field value that Siebel CRM inserts in this field when it creates a new record through an Add New Record or Copy Record operation. Note the following:

  • The user can modify this value before Siebel CRM writes the record to the Siebel database.

  • Siebel CRM inserts the predefault value even if it does not display this field in the client.

  • Siebel CRM does not validate the value that the Pre Default Value property contains for a calculated field.

  • Siebel CRM limits the value in the Pre Default Value property to 255 characters.

  • If a predefault value expression depends on other fields, then these fields must be populated when Siebel CRM evaluates this expression. For example, the following predefault value works because Siebel CRM populates the Row Id or Id field when it initializes the record:

Expr: Field 'ID'

The following predefault value does not work because Siebel CRM populates the Picklist Field after it initializes the record:

Expr: Field: 'picklist_field_name'

This situation is true for a Copy Record operation only if the NoCopy property is TRUE.

Precision (O)

For more information, see About the Precision and Scale Properties.

Read Only (O)

If TRUE, then the user cannot modify the field value for this field. A field that references a joined table is typically read-only with the following exceptions:

  • A join to an extension table

  • A join to an active intersection table

Some fields are read-only even if the Read Only property is FALSE. The Effective Start Date field for the following business components is read-only:

  • Account Product

  • Promotion

  • Promotion Account

  • Promotion Account Product

  • Promotion Administration

  • Promotion Product

For more information, see Join.

Required (O)

If TRUE, then Siebel CRM writes the field value to the Siebel database only if this field contains a value.

Scale (O)

For more information, see About the Precision and Scale Properties.

Text Length (O)

Specifies the maximum length of text that the field can contain.

Siebel CRM typically ignores this property. It typically gets the length from the table column that this field references.

If a Text field includes a user property named Text Length Override, then Siebel CRM does not ignore the Text Length property.

Type (R)

Specifies the field data type. For more information, see Configuring the Type Property of a Field.

Validation (O)

Specifies the expression that Siebel CRM uses to validate the data that the user enters in this field. Note the following:

  • You can use the Validation property only with a single value field. You cannot use it with a multivalue field.

  • Siebel CRM limits the value in the Validation property to 255 characters.

Validation Message (O)

Specifies to override the default validation message that the Application Object Manager provides. For example, if a user enters 250 in a field, and if this value must not exceed 200, then the Application Object Manager displays the following validation message: 

Incorrect fields values:  field_name <= 200.

The user might not understand this message. To improve it, you can use the Validation Message property to configure Siebel CRM to display the following message:

Please enter a value under 200 for the field_name field.

For more information about validation messages, see the description for the Message Display Mode property.