BC User Properties

BC User Properties

Deep Copy Generate Sequence

Deep Copy/Delete Link: Activity Plan Action

Field Invisible Field:Score

Field Invisible Parent Field:Emp Review Comments

Field:Base Price

Item Total Field 5                  "Current Quote Total Item Tax", "Tax Amt"

MVG Set Primary Mode

MVG Set Primary Restricted: Position

No Change Field

NoDelete Field

On Condition Set Field Value

On Field Update Invoke

On Field Update Invoke n

This user property allows you to invoke the specified business component method when a field is updated.

Value

The value of the On Field Update Invoke user property consists of three quoted parameters separated by a comma and a space, as follows:

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

[MethodName] is invoked on the [BusCompName] business component when [FieldToCheck] is updated. If [FieldToCheck] is not defined, the method is invoked when the user saves the record.

You can optionally use a fourth parameter that defines a condition. If you define a condition, the method is only invoked if the condition evaluates to TRUE.

Usage

You can create additional instances of this user property as needed. If you have more than one instance of this user property for a business component, they are executed sequentially by number (for example, On Field Update Invoke 1, then On Field Update Invoke 2, and so on). If there is only one such user property, then no number is required.

See also About Setting Numbered Instances of a User Property.

For example, the Asset Mgmt - Asset (Order Mgmt) business component has four such 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"

When the Product Name field in the Asset Mgmt - Asset (Order Mgmt) business component is updated, the CopyXA, GeneratePartNumber, and SaveCxProd methods are invoked on the Asset Mgmt - Asset business component.

When the Quantity field in the Asset Mgmt - Asset (Order Mgmt) business component is updated, the SetExtendedQuantity method is invoked on the Asset Mgmt - Asset business component.

In this example, where no [FieldToCheck] is specified, the CopyXA method is invoked on the Asset Mgmt - Asset business component when the user saves the record:

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

NOTE:  The empty quotes followed by the comma are necessary.

Parent Object Type

Business Component

NoDelete Field

---

This user property allows you to restrict the deletion of records based on the value of the specified field.

Value	The value of this user property must be the name of a field in the business component.
Usage	When you specify a field in this user property, the business component does not allow records to be deleted that have a value of Y in the specified field. For example, a record on the Contact business component cannot be deleted if NoDelete Field has a value of Protect Internal Employee Flag and the value of the Protect Internal Employee Flag field in the record is Y. You can inactivate or modify the values for this user property. You can also create new instances of this user property as needed, but you cannot create more than one instance for a business component.
Parent Object Type	Business Component
Functional Area	CSSBCBase

Always Enable Field n

---

This user property allows fields in a closed service request to be updated.

Value	The name of the field you wish to keep updatable.
Usage	In standard Siebel applications, when a user sets the Status field on a service request to Closed, the Sub-Status field is updated to Resolved. The record becomes read-only except for the Status and Sub-Status fields. This behavior is controlled by the specialized business component class CSSBCServiceRequest. To allow fields to be updated after the service request is closed, use the Always Enable Field n user property. You can inactivate and modify values for this user property. You can also create new instances of this user property as needed. For more information, see About Setting Numbered Instances of a User Property.
Parent Object Type	Business Component
Functional Area	Service Request

On Condition Set Field Value

---

This user property allows you to specify the value of a field to be set under a specified condition.

Value	The value for the On Condition Set Field Value user property consists of three quoted parameters, separated by a comma and a space, as follows: "Condition", "FieldName", "FieldValue" Condition specifies the condition to be evaluated. FieldName specifies the name of the field on the business component. FieldValue specifies the value.
Usage	When the specified condition evaluates to TRUE, the specified field (FieldName) is set to the specified value (FieldValue). For example: "[Primary Held Position Id] is not null and [Primary Held Position Id] <> ""No Match Row Id""", "Employee Flag", "Y" In this example, the Employee Flag field is set to Y when the condition is TRUE. You can modify the value for this user property and create new instances of it. You can also inactivate this user property.
Parent Object Type	Business Component
Functional Area	CSSBCUser

No Clear Field n

---

This user property disallows setting a field's value to NULL.

Value	The value of this user property must be the name of a field in the business component, not enclosed in quotes.
Usage	This property can be specified with or without the numeric suffix. You should append the numeric suffix to differentiate between multiple instances on a business component. For example, add No Clear Field 1 and No Clear Field 2 user properties to a business component to specify two different fields whose values cannot be set to NULL. You can inactivate or modify the values for this user property. You can also create new instances of this user property as needed. See also About Setting Numbered Instances of a User Property.
Parent Object Type	Business Component
Functional Area	Various

No Change Field n

---

This user property disallows changing a field's value after the record is committed.

Value	The value of this user property must be the name of a field in the business component, not enclosed in quotes.
Usage	This property can be specified with or without the numeric suffix. You should append the numeric suffix to differentiate between multiple instances on a business component. For example, add No Change Field 1 and No Change Field 2 user properties to a business component to specify two different fields which cannot be changed after a record is committed. You can inactivate or modify the values for this user property. You can also create new instances of this user property as needed. See also About Setting Numbered Instances of a User Property.
Parent Object Type	Business Component
Functional Area	Various

NoDelete Field

---

This user property allows you to restrict the deletion of records based on the value of the specified field.

Value	The value of this user property must be the name of a field in the business component.
Usage	When you specify a field in this user property, the business component does not allow records to be deleted that have a value of Y in the specified field. For example, a record on the Contact business component cannot be deleted if NoDelete Field has a value of Protect Internal Employee Flag and the value of the Protect Internal Employee Flag field in the record is Y. You can inactivate or modify the values for this user property. You can also create new instances of this user property as needed, but you cannot create more than one instance for a business component.
Parent Object Type	Business Component
Functional Area	CSSBCBase

MVG Set Primary Restricted: visibility_mvlink_name

---

This user property allows you to disable the restriction that only Siebel Administrators and Managers have the ability to change the Primary team member on opportunities, accounts, and contacts.

Value	The value for the MVG Set Primary Restricted: visibility_mvlink_name user property is FALSE.
Usage	The visibility_mvlink_name specified in the name of the user property indicates the name of the multivalue link in the BusComp View Mode child object of the business component for which you want to allow or restrict setting the primary. If this user property is not set, only Siebel Administrators (in Admin mode) and Managers (in Manager view mode) have the ability to change the Primary team member on opportunities, accounts, and contacts. Setting this user property to FALSE allows the Primary team member to be altered by someone other than the Manager or Siebel Administrator. For example, if you want to allow sales representatives to set the primary sales team members for contacts: Create a user property for the Contact business component called MVG Set Primary Restricted: Position Position is the value of Visibility MVLink for the Sales Rep view mode for Contact. Set the value of MVG Set Primary Restricted: Position to FALSE.
Parent Object Type	Business Component
Functional Area	Access control

Deep Copying and Deletion User Properties

---

When you copy or delete a record, you can use the Deep user properties to propagate the change to child business components. For example, you can arrange to copy the detail records of a child business component from the original record to the new copied record of the parent business component.

For purposes of these user properties, the application checks the following sources in the order given to determine the parent/child link to use:

• If the parent and child are the same business component, then the relationship must be defined by the Recursive Link user property set on the business component. The link that the Recursive Link user property specifies is used to determine child records.

See also Recursive Link.

• If the Deep Copy/Delete Link user property is set on the current (parent) business component, then the link that the Deep Copy/Delete Link user property specifies to the child business component is used.

See also Deep Copy/Delete Link.

• If the parent and child business components are of the same Siebel object, and the parent is the primary business component in the business object, then the application looks up the link listed for the parent to the child, if one exists. If the link exists, then it is listed by choosing Object Explorer > Business Object > Business Object Component in Siebel Tools. Under the applicable business object, the link displays in the Link column for the child business component in the Business Object Components list.
• If none of the sources mentioned in this list provides a link between the parent and child business components, then the application determines whether a link named parent business component/child business component exists (for example, Opportunity/Revenue). If such a link exists, then the application uses that link.

Deep Copy n

This user property allows you to specify a child business component that should be copied when a user selects the Copy option.

See also Deep Copy/Delete Link.

Value	The value for the Deep Copy n user property must be the name of a child business component for which a parent/child link is defined in one of the ways described in Deep Copying and Deletion User Properties.
Usage	The Deep Copy n user property allows child business components and their respective child business components to be copied automatically when selecting the Copy option. Normally, the Copy option only copies one level. This feature allows multiple levels to be copied like a cascade copy. To use Deep Copy, do the following: In the parent business component, create a user property for each child business component to be included in the deep copy. The child business component user properties are: Name: Deep Copy 1 Value: [Child BusComp Name] Name: Deep Copy 2 Value: [Child BusComp Name] Add a multivalue link in the parent business component for each child business component. Create a multivalue field in the parent business component from each child business component. Set the No Copy attribute in the multivalue link to TRUE to avoid the SQL error "A Duplicate Record Exists" occurring. NOTE:  Do not use Deep Copy when the parent-child relationship is many-to-many (M:M). For M:M relationships, set the No Copy attribute to FALSE in the link used for this parent-child relationship. Each business component in the Deep Copy chain takes care of its own children. The parent business component has Deep Copy properties for each of its direct children, and each child business component has Deep Copy properties for each of the relevant grandchildren. There is an analogous Deep Delete user property to do a deep cascade delete. Typically, use Deep Copy and Deep Delete together. See also About Setting Numbered Instances of a User Property.
Parent Object Type	Business Component
Functional Area	Copying records

Deep Copy/Delete Link

The Link object defines a one-to-many parent/child relationship between two business components. The Deep Copy/Delete Link user property is set on the parent business component to specify the link to use for deep copies and deep deletes of the child business component named in Deep Copy/Delete Link.

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

See Also

• Deep Copying and Deletion User Properties
• Deep Copy n
• Deep Delete n

Syntax

Deep Copy/Delete Link: Buscomp

Argument	Description
Buscomp	This parameter is the name of a business component for which: The business component is the child in a link for which the current business component is the parent, and Deep Copy or Deep Delete user properties are set on the current (parent) business component. This is an optional parameter. Use it when links must be specified for more than one business component.

Value	The value of this business component user property must be the name of a link between the current (parent) business component and the child business component specified by the Buscomp parameter.
Usage	For example, to specify a link to apply to deep copying or deep deleting of the revenues associated with an opportunity, add the user property Deep Copy/Delete Link: Revenue with value Opportunity/Revenue to the Opportunity business component. Opportunity is the parent and Revenue is the child business component of the Opportunity/Revenue link. You can inactivate or modify the values for this user property. You can also create new instances of this user property. CAUTION:  Before you inactivate any predefined instances of this user property in a production environment, do thorough planning and testing to confirm that the child records that are to be no longer copied or deleted are those you intended, and that records of other business components related to those child records are not adversely affected.
Parent Object Type	Business Component
Functional Area	Copying and deleting records

Deep Delete n

This user property allows you to specify a child business component that should be deleted when a user selects the Delete option.

See also Deep Copy/Delete Link.

Value	The value for the Deep Delete n user property must be the name of a child business component for which a parent/child link is defined in one of the ways described in Deep Copying and Deletion User Properties.
Usage	Normally, the Delete option only deletes one level. Deep Delete allows child business components and their respective child business components to be deleted automatically when selecting the Delete option. This feature allows multiple levels to be deleted like a cascade delete. To use this feature, do the following: Create a user property for each child business component to be included in the deep delete. The child business component user properties are: Name: Deep Delete 1 Value: [Child BusComp Name] Name: Deep Delete 2 Value: [Child BusComp Name] Add a multivalue link for each child business component. Set the No Delete user property value to: FALSE: allows deep delete for the child business component TRUE: does not allow deep delete for the child business component Create a multivalue field in the parent business component, using the multivalue link. This field is usually not displayed on the screen but needs to be present on the business component. This is analogous to the Deep Copy user property. Use Deep Delete to do a deep cascade delete. Typically, Deep Copy and Deep Delete are used together. See also About Setting Numbered Instances of a User Property.
Parent Object Type	Business Component
Functional Area	Deleting records

Always Enable Child: buscompname

---

This user property allows you to specify whether a child business component of a service request can be updated after the service request is closed.

Value	TRUE   Specifies that child business components of service requests can be updated when the service request is closed.
Usage	Closing a service request does not prevent updates to the child Customer Satisfaction business component, so you can survey your customers even if a service request has been resolved. The user property for the Service Request business component, named Always Enable Child: Customer Survey, allows you to enable and disable customer surveys. You can allow updates to other business components by adding user properties to the Service Request business component and substituting the appropriate business component name for Customer Survey. NOTE:  Another way to make a closed service request and its child business components accessible for additions and edits is to change its status to Open.
Parent Object Type	Business Component
Functional Area	Service Request

All Mode Sort

---

This user property allows you to specify whether the Siebel application overrides the default sort specification.

Value	The value for the All Mode Sort user property must be one of the following: Normal. Uses the business component-defined sort specification. This setting also allows the user to run a predefined query (that incorporates a SORT). TRUE. Overrides the business component sort specification and uses the U1 index (the standard user key). If the standard user key is defined on the primary extension table, especially for S_PARTY-based business components, the behavior reverts to Normal. FALSE. Removes all sorting.
Usage	Standard Siebel application behavior is to override the sort specification on views with certain visibility types to force the view to ORDER BY the standard user key. The All Mode Sort user property determines whether the Siebel application overrides the sort specification and, if so, determines the sort (if any) that is applied to the business component for the affected views. This user property affects views with visibility other than Personal or Sales Rep visibility, including Manager, All, Organization, Sub-Organization, Group, and Catalog views. NOTE:  If you set up the default sort order so that it sorts on one of these views, be aware that this might expose large quantities of data that in general should be sorted only by user keys. When All Mode Sort is set to Normal, queries performed in workflows also use the business component sort specification, even when no visibility has been set. If you choose to override the default sort behavior using All Mode Sort, first consult your database administrator for guidance on how the sort-by fields are indexed. You should also conduct careful performance testing on the view itself and on reports run against the view.
Parent Object Type	Business Component
Functional Area	SSE Service Request, Action, and Activity Plan Action

Always Enable Field n

---

This user property allows fields in a closed service request to be updated.

Value	The name of the field you wish to keep updatable.
Usage	In standard Siebel applications, when a user sets the Status field on a service request to Closed, the Sub-Status field is updated to Resolved. The record becomes read-only except for the Status and Sub-Status fields. This behavior is controlled by the specialized business component class CSSBCServiceRequest. To allow fields to be updated after the service request is closed, use the Always Enable Field n user property. You can inactivate and modify values for this user property. You can also create new instances of this user property as needed. For more information, see About Setting Numbered Instances of a User Property.
Parent Object Type	Business Component
Functional Area	Service Request

Set Primary Sales Rep As Owner

---

This user property finds the Primary Sales Rep assigned to the logged-in user, and specifies that all newly created Activities be assigned to this Primary Sales Rep.

Value	Y   Causes all new Activities to be assigned to the Primary Sales Rep of the current user. N (or blank)   Feature is disabled.
Usage	The Set Primary Sales Rep As Owner user property is applicable only when the business component name is Action (Web) and it is used for the Professional Portal LS application. You can inactivate and modify the values for this user property. However, you cannot create new instances of this user property. This user property is supported for use in CSSBCFINSActivity, but not in its subclasses.
Parent Object Type	Business Component
Functional Area	CSSBCFINSActivity