ApplyPromotionDefaults Method

This method is automatically triggered by the Siebel Business Application when you apply a promotion, provided the Promotion Automatch system preference is set to Y. This method is not triggered if the Promotion Automatch system preference is set to N, or if the Promotion Automatch system preference is not defined.

This method configures customizable product line items in the current product as follows:

  1. It loads the product line item.

  2. Runs batch validation on the product line item.

  3. Changes the product line item according to the Promotion Automatch argument value.

    The following table describesSiebel CRM behavior when the Promotion Automatch argument value is set to Default Cardinality, and when the Promotion Automatch argument value is set to Min Max Cardinality. For more information about cardinality, see the table in the following section.

  4. It writes the line item back to the document

This method does not require a user interface context to be called, and contains the method arguments listed in the following table.

In asset-based ordering (ABO) mode, ApplyPromotionDefaults calls the SIS OM Get Future Asset subprocess workflow, which computes the action codes.

About Cardinality

Cardinality refers to the quantity of the component that a user can select. Minimum cardinality governs whether or not selecting items from a relationship is optional or required. Maximum cardinality sets the maximum number of items that a user can select from a relationship. Default cardinality specifies what quantity of the default product is automatically added to the initial solution that the user sees. For more information about cardinality, see Siebel Product Administration Guide.

Argument Name Data Type Input or Output Comments

Promotion Automatch

String

Input

If set to Default Cardinality, then Siebel CRM behavior is as follows:

  • Non-existing items change to the default quantity.

  • Existing ports lower than the minimum quantity change to the default quantity.

  • Existing ports higher than the maximum quantity change to the default quantity.

  • Existing product ports not violating the cardinality remain the same.

  • Existing class ports lower than the default quantity change to the default quantity.

If set to Min Max Cardinality, then Siebel CRM behavior is as follows:

  • Non-existing items change to the default quantity.

  • Existing ports lower than the minimum quantity change to the min quantity.

  • Existing ports higher than the maximum quantity change to the max quantity.

  • Existing product ports not violating the cardinality remain the same.

    Note: This behavior can occur if neither Min nor Max cardinality on the promotion is specified.
  • Existing class ports lower than the default quantity change to the default quantity.

If set to blank (if no value is set), then Siebel CRM behavior reverts to the existing behavior (that is, the behavior in previous versions of Siebel Order Management). The default setting is blank.

Log Error

String

Input

If set to Y, then logs error messages.

The default is Y.

Display Error

String

Input

If set to Y, then displays Unified Messaging Framework (UMF) messages; a user interface context is required.

If, depending on application of the promotion, the customizable product structure changes, then the UMF message displays the recommendations applet in the dynamic catalog view; or, the user can open the recommendations applet using the recommendation icon.

The default is N.

Document Id

String

Input

The Header Id of the quote or order.

Document Type

String

Input

This value must be either Quote or Order.

Integration Object

String

Input

Depending on document type and ABO mode, this argument defaults to either one of the following:

  • SIS OM Order, or SIS OM Quote

  • When ABO is turned off: 7.7 Order Entry Integration Object, or 7.7 Quote Integration Object

Search Spec

String

Input

The Search Spec is applied to the business component line item. By default, this argument is empty. However when ApplyPromotionDefaults is called automatically on applying a promotion (by setting the Promotion Automatch system preference to Y), this argument is set by the application to retain only those line items that are associated with that promotion instance.

See also the following related Search Spec user properties in the third table in this topic:

  • Order Default Search Spec

  • Quote Default Search Spec

Sync

String

Input

If set to Y, then the result is synchronized to the database.

The default is N.