Siebel Hospitality Guide > User Properties Reference for Siebel Hospitality > User Properties for Menus and Packages >

Business Component User Properties for Menus and Packages


This topic describes the following business component user properties:

AddToCart Proxy Buscomp2

Use this user property to get the business component instance in C++ code to evaluate defined search criteria and search for items.

Value

Internal Product Popup

Parent Object Type

Quick Add business component

Usage

The value of this user property is business component. This user property gets the business component instance in C++ code to evaluate defined search criteria, search items, and add the selected items to the function line items.

Aspect Default Value: Menu

Use this user property to set the default Menu Per Person value for the Type field, if the TNT Product - ISS Admin business component is driven by the TNT Menu Administration List Applet applet.

Value

LookupValue ("PRODUCT_TYPE", "Menu Per Person")

Parent Object Type

Type Field in TNT Product - ISS Admin business component

Usage

The TNT Menu Administration List Applet applet has the Default Aspect user property and a value of Menu. If the TNT Product - ISS Admin business component is driven by the TNT Property Product Admin List Applet applet, the lookup value of Menu Per Person is set to the Type field as the default value.

Aspect Default Value: Menu

Use this user property to set the default value of Person to the Unit of Measure field, if the TNT Product - ISS Admin business component is driven by the TNT Menu Administration List Applet applet.

Value

LookupValue ("UNIT_OF_MEASURE", "Person")

Parent Object Type

Unit of Measure Field in TNT Product - ISS Admin business component

Usage

The applet TNT Menu Administration List Applet has the Default Aspect user property and a value of Menu. If the TNT Product - ISS Admin business component is driven by the TNT Menu Administration List Applet applet, the lookup value of the Unit of Measure field is set to Person as the default value.

Aspect Default Value: MenuEventItem

Use this user property to set the default current date C value for the Start Date field, if the TNT Product - ISS Admin business component is driven by the TNT Property Product Admin List Applet applet.

Value

Today()

Parent Object Type

Start Date Field in TNT Product - ISS Admin business component

Usage

The TNT Property Product Admin List Applet applet has the Default Aspect user property and a value of MenuEventItem. If the TNT Product - ISS Admin business component is driven by the TNT Property Product Admin List Applet applet, the current date is set to Type as the default value.

Aspect Default Value: Package

Use this user property to set the default value of the Start Date field to the current date, if the TNT Product - ISS Admin business component is driven by the TNT Package Administration List Applet applet.

Value

Today()

Parent Object Type

Start Date Field in TNT Product - ISS Admin business component

Usage

The TNT Package Administration List Applet applet has the Default Aspect user property and a value of Package. If the TNT Product - ISS Admin business component is driven by the TNT Property Product Admin List Applet applet, the default value of Type is set to the current date.

Aspect Default Value: Package

Use this user property to set the default value of the Unit of Measure field to Person, if the TNT Product - ISS Admin business component is driven by the TNT Package Administration List Applet applet.

Value

LookupValue ("UNIT_OF_MEASURE", "Person")

Parent Object Type

Unit of Measure Field in TNT Product - ISS Admin business component

Usage

The TNT Package Administration List Applet applet has the user property Default Aspect and a value of Package. If the TNT Product - ISS Admin business component is driven by the TNT Menu Administration List Applet applet, the default value of the Unit of Measure field is set to Person.

CanInvokeCustomMethod 1

Use this user property to enable or disable the Validate Allocation method.

Value

"ValidateAlloc", "IsIdNotNull"

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Enables or disables the Validate Allocation method. The first part of the value indicates the method name, and the second part of the value indicates a condition for enabling or disabling. By default, the condition indicates that a record must exist.

This user property is applicable only for those business components that are based on the CSSBCSHMQuoteItem class.

CanInvokeCustomMethod 2

Use this user property to enable or disable the UseSysAlloc method.

Value

"UseSysAlloc", "TNT Use Sys Alloc Call Flag"

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Enables or disables the UseSysAlloc method. The first part of the value indicates the method name, and the second part of the value indicates a condition for enabling or disabling. The value of the TNT Use Sys Alloc Call Flag field determines if the UseSysAlloc method is enabled or disabled for users.

This user property is applicable only for those business components that are based on the CSSBCSHMQuoteItem class; and the condition part must return either Y, y, N, or n.

Deep Copy

Use this user property to copy the child items in the menu or package when the parent menu or package is copied.

Value

TNT SHM Order Item

Parent Object Type

TNT SHM Order Item business component

Usage

Copies the child items in the menu or package when the parent menu or package is copied.

Deep Copy

Use this user property to copy the child items in the menu or package when the parent menu or package is copied.

Value

TNT SHM Quote Item

Parent Object Type

TNT SHM Quote Item business component

Usage

Copies the child items in the menu or package when the parent menu or package is copied.

Deep Copy

Use this user property to copy the child items in the menu or package when the parent menu or package is copied.

Value

TNT SHM Invoice Order Item

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Copies the child items in the menu or package when the parent menu or package is copied.

Field Name: IsExtendedQuantity

Use this user property to pass the field name to the C++ code.

Value

IsExtendedQuantity

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Passes the field name to the C++ code.

Field Name: IsMenuPackageType

Use this user property to pass the field name to the C++ code.

Value

TNT Extended Revenue Estimate Line Total - Display

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Passes the field name to the C++ code.

Field Name: TNT TaxRequired Flag

Use this user property to pass the field name to the C++ code.

Value

TNT TaxRequired Flag

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

Field Name: TNT TopLevelParentFlag

Use this user property to pass the field name to the C++ code.

Value

TNT TopLevelParentFlag

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

Field Name: TNT TopLevelParentPIP

Use this user property to pass the field name to the C++ code.

Value

TNT TopLevelParentPIP

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

Field Read Only Field: Product

Use this user property to evaluate some conditions to make the Product field read only.

Value

TNT Product Read Only Flag

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

For a description of the usage of this user property, see the chapter on user properties in Siebel Developer's Reference.

This user property is in the Oracle's Siebel CRM base application and is modified with more conditions for the Menus and Packages feature.

IsParentMPTypeField

Use this user property to specify the field name to determine if the parent line item is a Menu or Package Type.

Value

IsParentOrderItemMPType

Parent Object Type

TNT SHM Order Item, TNT SHM Invoice Order Item business components

Usage

A field name of the business component is passed as the value of this user property. This user property is used in C++ code to verify whether or not the function line item is a child item of a parent menu or package.

Line Items BC Name: Quote

Use this user property to get the appropriate business component instance in C++ code to create custom menus or packages in quote line items.

Value

TNT SHM Quote Item

Parent Object Type

TNT Custom Menu, Package VBC business component

Usage

Creating custom menus and packages is handled through C++ code, and it requires the appropriate business component to be retrieved. This user property is created with the business object. If the active business object is TNT SHM Quote, then the TNT SHM Quote Item business component instance is created in C++ code to create custom menus and packages.

Line Items BC Name: TNT Function Line Item Quick Entry View

Use this user property to retrieve the business component instance in C++ code while adding items to the function line items, using the Quick Add applet.

Value

TNT SHM Quote Item

Parent Object Type

Internal Product Popup, Quick Add business components

Usage

Retrieves the business component instance in C++ code while adding items to the function line items, using the Quick Add applet. The second part of the user property name designates the view context. If the active view is the TNT Function Line Item Quick Entry View view, then the TNT SHM Quote Item business component instance adds the items to the function line items.

Line Items BC Name: TNT SHM Function

Use this user property to get the appropriate business component instance in C++ code to create custom menus or packages in function line items.

Value

TNT SHM Function Item

Parent Object Type

TNT Custom Menu/Package VBC business component

Usage

Creating custom menus and packages is handled through C++ code, and it requires the appropriate business component to be retrieved. This user property is created with the business object. If the active business object is TNT SHM Function, then the TNT SHM Function Item business component instance is created in C++ code to create custom menus and packages.

Line Items BC Name: TNT SHM Order Entry

Use this user property to get the appropriate business component instance in VBC code.

Value

TNT SHM Order Item

Parent Object Type

TNT Custom Menu/Package VBC business component

Usage

Creating custom menus and packages is handled through C++ code, and it requires the appropriate business component to be retrieved. This user property is created with the business object. If the active business object is TNT SHM Order Entry, then the TNT SHM Order Entry Item business component instance is created in C++ code to create custom menus and packages.

Line Items BC Name: TNT SHM Order Function Line Items View

Use this user property to retrieve the business component instance in C++ code while adding items to the function line items, using the Quick Add applet.

Value

TNT SHM Order Item

Parent Object Type

Internal Product Popup, Quick Add business components

Usage

Retrieves the business component instance in C++ code while adding items to the function line items, using the Quick Add applet. The second part of the user property name designates the view context. If the active view is the TNT SHM Order Function Line Items view, then the TNT SHM Order Item business component instance adds the items to the function line items.

Line Items BC Name: TNT SHM Quote Function Line Items View

Use this user property to retrieve the business component instance in C++ code while adding items to the function line items, using the Quick Add applet.

Value

TNT SHM Quote Item

Parent Object Type

Internal Product Popup, Quick Add business components

Usage

Retrieves the business component instance in C++ code while adding items to the function line items, using the Quick Add applet. The second part of the user property name designates the view context. If the active view is the TNT SHM Quote Function Line Items view, then the TNT SHM Quote Item business component instance adds the items to the function line items.

Line Items BO Name: Quote

Use this user property to define a business object name to make technical decisions in C++ code.

Value

Quote

Parent Object Type

TNT SHM Quote Item business component

Usage

Defines the business object name to make technical decisions in C++ code. This user property is active only if the business component is associated with the defined business object.

Line Items BO Name: SHM Invoice

Use this user property to define the business object name to make technical decisions in C++ code.

Value

SHM Invoice

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Defines the business object name to make technical decisions in C++ code. This user property is active only if the business component is associated with the defined business object.

Line Items BO Name: TNT SHM Function

Use this user property to define a business object name to make technical decisions in C++ code.

Value

TNT SHM Function

Parent Object Type

TNT SHM Quote Item business component

Usage

Defines the business object name to make technical decisions in C++ code. This user property is active only if the business component is associated with the defined business object.

Line Items BO Name: TNT SHM Order Entry

Use this user property to define the business object name to make technical decisions in C++ code.

Value

TNT SHM Order Entry

Parent Object Type

TNT SHM Order Item business component

Usage

Defines the business object name to make technical decisions in C++ code. This user property is active only if the business component is associated with the defined business object.

Line Items BO Name: TNT SHM Templates

Use this user property to define a business object name to make technical decisions in C++ code.

Value

TNT SHM Templates

Parent Object Type

TNT SHM Quote Item business component

Usage

Defines the business object name to make technical decisions in C++ code. This user property is active only if the business component is associated with the defined business object.

Menu Item Field Map 1

Use this user property to carry over the value from Menu Item administration to the function line item when a menu is added to the function line items.

Value

"TNT Split Qty Flag", "Split Price Flag"

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Carries over the value from Menu Item administration to the function line item when a menu is added to the function line items. In this case, TNT Split Qty Flag is a field in the parent object and Split Price Flag is a field in the TNT Menu Item business component.

When a menu is added to the function line items, the child menu items are added along with the parent menu. The value of the Split Price Flag field of the TNT Menu Item business component is copied into the TNT Split Qty Flag field of the parent business component.

NOTE:  For examples, refer to the Menu Item Field Map x (where x is equal to 1,2,3...) user properties in the same parent object.

Named Method

Use this user property to call a business service method when a user clicks the Add button to add line items through the Search Add applet.

Value

"AddToList", "INVOKESVC", "Internal Product Popup", "TNT Utility Service", "ListAdd"

Parent Object Type

Internal Product Popup business component

Usage

Calls a business service method when a user clicks the Add button to add line items through the Search Add applet.

Named Method 1

Use this user property to set the Per Person Allocation field to an empty string when the UpdateItemsPPA custom method is called.

Value

"UpdateItemsPPA", "SET", "Per Person Allocation", """"

Parent Object Type

TNT Package Item business component

Usage

For a package item, the Per Person Allocation field must be empty if the parent package is of the Package Item Price type. If the parent package type is modified to Package Item Price, the UpdateItemsPPA custom method is called by the UpdatePPA method from the TNT Product - ISS Admin parent business component.

Named Method 4

Use this user property to set an empty value to the Per Person Allocation parent business component in package items.

Value

"UpdatePPA", "INVOKEALL", "TNT Package Item", "UpdateItemsPPA"

Parent Object Type

TNT Product - ISS Admin business component

Usage

For a package item, Per Person Allocation must be empty if the parent Package is of the Package Item Price type. This user property works with the On Field Update Invoke user property. If the Package type is modified to Package Item Price, the UpdatePPA custom method is called, and the call delegates to the UpdateItemsPPA method of the TNT Package Item business component.

Named Method 7

Use this user property to refresh the business component when the SetParentSplitFlag method is called.

Value

"SetParentSplitFlag", "INVOKE", "TNT SHM Invoice Order Item", "RefreshBusComp"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Refreshes the business component when the TNT Split Qty Flag field is updated for a child menu item, so as to set the appropriate value of Split Menu Flag for the parent menu. This user property works with the On Field Update Invoke user property.

Named Method 8

Use this user property to call an internal service method to set the split flag value for the parent menu when the TNT Split Qty Flag field is updated for a child menu item.

Value

"SetParentSplitFlag", "INVOKEALL", "TNT SHM Invoice Order Item", "SetSplitValue"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Calls an internal service method to set the appropriate value to the Split Menu Flag field for the parent menu when the TNT Split Qty Flag field is updated for a child menu item. This user property works with the On Field Update Invoke user property.

Named Method 8

Use this user property with the On Field Update Invoke 10, On Field Update Invoke 11, and On Field Update Invoke 12 user properties to update the value of the Quantity Requested field in the child business components.

Value

"UQItemQty", "INVOKEALL", "TNT SHM Quote Item", "UpdateFields"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity Requested field in the child business components. This user property works with the On Field Update Invoke 10, On Field Update Invoke 11, and On Field Update Invoke 12 user properties.

Named Method 9

Use this user property to set the split flag value for a parent menu when the TNT Split Qty Flag field is updated for a child menu item.

Value

"SetSplitValue", "INVOKESVC", "TNT SHM Invoice Order Item", "TNT Utility Service", "SetSplitPriceFlag"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Sets the value of the TNT Split Qty Flag field for the parent menu. This user property works with the Named Method 8 user property.

Named Method 10

Use this user property with the On Field Update Invoke 13, On Field Update Invoke 14, and On Field Update Invoke 15 user properties to update the value of the Quantity Requested field in the child business components.

Value

"UOItemQty", "INVOKEALL", "TNT SHM Order Item", "UpdateField"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity Requested field in the child business components. This user property works with the On Field Update Invoke 13, On Field Update Invoke 14, and On Field Update Invoke 15 user properties.

Named Method 11

Use this user property to call the service method to validate the package price with the cumulative allocation of the child line items of the package.

Value

"ValidateAlloc", "INVOKESVC", "TNT SHM Quote Item", "TNT Utility Service", "Validate Allocation Price"

Parent Object Type

TNT SHM Quote Item business component

Usage

Calls the service method to validate the package price with the cumulative allocation of the child line items of the package.

  • If the cumulative sum of the child item allocations is equal to the price of the parent package, then the following message is displayed.

    Allocations equal the package net price.

  • If the cumulative sum of the child item allocations is not equal to the price of the parent package, then the following message is displayed.

    Allocations do not equal the package net price.

Named Method 13

Use this user property to call the service method to set the system allocation to the child line items of the appropriate package.

Value

"UseSysAlloc", "INVOKESVC", "TNT SHM Quote Item", "TNT Utility Service", "Set System Allocation"

Parent Object Type

TNT SHM Quote Item business component

Usage

Calls the service method to set the system allocation to the child line items of the appropriate package.

Named Method 14

Use this user property to call a service method to set the system allocation for the child line items of the appropriate package.

Value

"UseSysAlloc", "INVOKESVC", "TNT SHM Invoice Order Item", "TNT Utility Service", "Set System Allocation"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Calls a service method to set the system allocation for the child line items of the appropriate package. This user property works with the On Field Update Invoke 1 user property and the Applet menu method item.

Named Method 15

Use this user property to update the Quantity if Guaranteed/Projected/Expected Num changes in the Parent BC TNT SHM Function.

Value

"UpdateFields", "SET", "Quantity Requested", [QuantityCalc]

Parent Object Type

TNT SHM Quote Item business component

Usage

Updates the Quantity of TNT SHM Quote Item if Guaranteed/Projected/Expected Num changes in the parent business component TNT SHM Function.

Named Method 15

Use this user property to call the service method to validate the package price with the cumulative allocation of the child line items of the package.

Value

"ValidateAlloc", "INVOKESVC", "TNT SHM Invoice Order Item", "TNT Utility Service", "Validate Allocation Price"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Calls the service method to validate the package price with the cumulative allocation of the child line items of the package.

  • If the cumulative sum of the child item allocations is equal to the price of the parent package, then the following message is displayed.

    Allocations equal the package net price.

  • If the cumulative sum of the child item allocations is not equal to the price of the parent package, then the following message is displayed.

    Allocations do not equal the package net price.

Named Method 16

Use this user property to refresh the business component when the SetParentSplitFlag method is called.

Value

"SetParentSplitFlag", "INVOKE", "TNT SHM Quote Item", "RefreshBusComp"

Parent Object Type

TNT SHM Quote Item business component

Usage

Calls an internal service method to set the appropriate value for the Split Menu Flag of the parent menu, when the TNT Split Qty Flag field of an associated child menu item is updated. This user property works with the On Field Update Invoke user property.

Named Method 17

Use this user property to update the Quantity if Guaranteed/Projected/Expected Num changes in the Parent BC TNT SHM Function.

Value

"UpdateField", "SET", "Quantity Requested", [QuantityCalc]

Parent Object Type

TNT SHM Order Item business component

Usage

Updates the Quantity of TNT SHM Order Item if Guaranteed/Projected/Expected Num changes in the parent business component TNT SHM Function.

Named Method 17

Use this user property to call an internal service method to set the Split flag value for parent menu when TNT Split Qty Flag field of an associated child Menu Item is updated.

Value

"SetParentSplitFlag", "INVOKEALL", "TNT SHM Quote Item", "SetSplitValue"

Parent Object Type

TNT SHM Quote Item business component

Usage

Calls an internal service method to set the appropriate value for the Split Menu Flag of the parent menu, when the TNT Split Qty Flag field of an associated child menu item is updated. This user property works with the On Field Update Invoke user property.

Named Method 18

Use this user property to call the service method to validate the package price with the cumulative allocation of the child line items of the package.

Value

"ValidateAlloc", "INVOKESVC", "TNT SHM Order Item", "TNT Utility Service", "Validate Allocation Price"

Parent Object Type

TNT SHM Order Item business component

Usage

Calls the service method to validate the package price with the cumulative allocation of the child line items of the package.

  • If the cumulative sum of the child item allocations is equal to the price of the parent package, then the following message is displayed.

    Allocations equal the package net price.

  • If the cumulative sum of the child item allocations is not equal to the price of the parent package, then the following message is displayed.

    Allocations do not equal the package net price.

Named Method 19

Use this user property to call the service method to set the system allocation to the child line items of the appropriate package.

Value

"UseSysAlloc", "INVOKESVC", "TNT SHM Order Item", "TNT Utility Service", "Set System Allocation"

Parent Object Type

TNT SHM Order Item business component

Usage

Calls the service method to set the system allocation to the child line items of the appropriate package.

Named Method 21

Use this user property to refresh the business component when the SetParentSplitFlag method is called.

Value

"SetParentSplitFlag", "INVOKE", "TNT SHM Order Item", "RefreshBusComp"

Parent Object Type

TNT SHM Order Item business component

Usage

Calls an internal service method to set the appropriate value for the Split Menu Flag of the parent menu, when the TNT Split Qty Flag field of an associated child menu item is updated. This user property works with the On Field Update Invoke user property.

Named Method 22

Use this user property to call an internal service method to set the Split flag value for the parent menu when TNT Split Qty Flag field of an associated child Menu Item is updated.

Value

"SetParentSplitFlag", "INVOKEALL", "TNT SHM Order Item", "SetSplitValue"

Parent Object Type

TNT SHM Order Item business component

Usage

Calls an internal service method to set the appropriate value for the Split Menu Flag of the parent menu, when the TNT Split Qty Flag field of an associated child menu item is updated. This user property works with the On Field Update Invoke user property.

On Field Update Invoke

Use this user property to call the named methods to mark or unmark the split price for a parent menu when the split flag value of the child menu items changes.

Value

"TNT Split Qty Flag", "TNT SHM Invoice Order Item", "SetParentSplitFlag", "IIf([Type Calc]=""Menu Item"", ""Y"", ""N"")"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Sets the value of the TNT Split Qty Flag field for the parent menu in function line items when the split flag value of the child menu items changes; that is, when the value of the TNT Split Qty Flag field changes. This user property works with the Named Method 8 user property.

On Field Update Invoke

Use this user property to call the named methods to select or clear the Split Price field for a parent menu when the value of the TNT Split Qty Flag of an associated child menu item changes.

Value

"TNT Split Qty Flag", "TNT SHM Quote Item", "SetParentSplitFlag", "IIf([Type Calc]=""Menu Item"", ""Y"", ""N"")"

Parent Object Type

TNT SHM Quote Item business component

Usage

Sets the TNT Split Qty Flag for the parent menu in a function line item when the TNT Split Qty Flag value of an associated child menu item changes. This user property works with the Named Method 8 user property.

On Field Update Invoke

Use this user property to call the named methods to select or clear the Split Price field for a parent menu when the value of the TNT Split Qty Flag of an associated child menu item changes.

Value

"TNT Split Qty Flag", "TNT SHM Order Item", "SetParentSplitFlag", "IIf([Type Calc]=""Menu Item"", ""Y"", ""N"")"

Parent Object Type

TNT SHM Order Item business component

Usage

Sets the TNT Split Qty Flag for the parent menu in a function line item when the TNT Split Qty Flag value of an associated child menu item changes. This user property works with the Named Method 8 user property.

On Field Update Invoke

Use this user property to clear the System Allocation Flag of the parent package when a split menu or a package of the Package Item Price type is added to the package items.

Value

"Type", "TNT Product - ISS Admin", "UpdateSysFlag", "IIf([Type Calc] = ""Package Item Price"" OR ([Type Calc] = ""Menu Per Person"" AND [Split Menu Item Flag] =""Y""), ""Y"", ""N"")"

Parent Object Type

TNT Package Item business component

Usage

For a package, the System Allocation Flag must be set to False if the package items include either a split menu or a package of the Package Item Price type. When a split menu or a package of the Package Item Price type is associated with a parent package, the UpdateSysFlag custom method of the TNT Product - ISS Admin parent business component is called to clear the System Allocation Flag, if it is selected.

On Field Update Invoke 1

Use this user property to delegate the call to the TNT Package Items child business component to set the value of Per Person Allocation to empty, if the package type is Package Item Price.

Value

"Type", "TNT Product - ISS Admin", "UpdatePPA", "IIf([TNT Type LIC] = ""Package Item Price"", ""Y"", ""N"")"

Parent Object Type

TNT Product - ISS Admin business component

Usage

Delegates the call to the TNT Package Items child business component to set the value of Per Person Allocation to empty, if the package type is Package Item Price.

On Field Update Invoke 1

Use this user property to call a service method to set the system allocation for the child line items of the appropriate package.

Value

"TNT Use System Alloc Flag", "TNT SHM Invoice Order Item", "UseSysAlloc", "IIf([TNT Use System Alloc Flag], ""Y"", ""N"")"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Calls the System Allocation service method, if the value of the TNT Use System Alloc Flag field changes.

On Field Update Invoke 1

Use this user property to call the service method to set the system allocation to the child line items of the appropriate package, if the TNT Use System Allocation field of the parent or root package is set to True.

Value

"TNT Use System Alloc Flag", "TNT SHM Order Item", "UseSysAlloc", "IIf([TNT Use System Alloc Flag], ""Y"", ""N"")"

Parent Object Type

TNT SHM Order Item business component

Usage

Calls the service method to set the system allocation to the child line items of the appropriate package, if the TNT Use System Allocation field of the parent or root package is set to True.

On Field Update Invoke 1

Use this user property to call the service method to set the system allocation to the child line items of the appropriate package, if the TNT Use System Allocation field of the parent or root package is set to True.

Value

"TNT Use System Alloc Flag", "TNT SHM Invoice Order Item", "UseSysAlloc", "IIf([TNT Use System Alloc Flag], ""Y"", ""N"")"

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Calls the service method to set the system allocation to the child line items of the appropriate package, if the TNT Use System Allocation field of the parent or root package is set to True.

On Field Update Invoke 10

Use this user property to update the value of the Quantity Requested field in the child business component, if the value of the Guaranteed Num field changes.

Value

"Guaranteed Num", "TNT SHM Function", "UQItemQty", "IIf([TNT Is Quote Item BC] = ""Y"", ""Y"", ""N"")"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity Requested field in the child business component, if the value of the Guaranteed Num field changes.

On Field Update Invoke 11

Use this user property to update the value of the Quantity Requested field in the child business component, if the value of the Projected Num field changes.

Value

"Projected Num", "TNT SHM Function", "UQItemQty", "IIf(([Guaranteed Num] IS NULL AND [TNT Is Quote Item BC] = ""Y""), ""Y"", ""N"")"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity Requested field in the child business component, if the value of the Projected Num field changes.

On Field Update Invoke 12

Use this user property to update the value of the Quantity field in the child business component, if the value of the Expected Num field changes.

Value

"Expected Num", "TNT SHM Function", "UQItemQty", "IIf(([Guaranteed Num] IS NULL AND [Projected Num] IS NULL AND [TNT Is Quote Item BC] = ""Y""), ""Y"", ""N"")"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity field in the child business component, if the value of the Expected Num field changes.

On Field Update Invoke 13

Use this user property to call the service method to set the system allocation to the child line items of the appropriate package, if the TNT Use System Allocation field of the parent or root package is set to True.

Value

"TNT Use System Allocation", "TNT SHM Quote Item", "UseSysAlloc", "IIf([TNT Use System Allocation], ""Y"", ""N"")"

Parent Object Type

TNT SHM Quote Item business component

Usage

Calls the service method to set the system allocation to the child line items of the appropriate package, if the TNT Use System Allocation field of the parent or root package is set to True.

On Field Update Invoke 13

Use this user property to update the value of the Quantity field in the child business component, if the value of the Guaranteed Num field changes.

Value

"Guaranteed Num", "TNT SHM Function", "UOItemQty", "IIf([TNT Is Order Item BC] = ""Y"", ""Y"", ""N"")"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity field in the child business component, if the value of the Guaranteed Num field changes.

On Field Update Invoke 14

Use this user property to update the value of the Quantity Requested field in the child business component, if the value of the Projected Num field changes.

Value

"Projected Num", "TNT SHM Function", "UOItemQty", "IIf(([Guaranteed Num] IS NULL AND [TNT Is Order Item BC] = ""Y""), ""Y"", ""N"")"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity Requested field in the child business component, if the value of the Projected Num field changes.

On Field Update Invoke 15

Use this user property to update the value of the Quantity field in the child business component, if the value of the Expected Num field changes.

Value

"Expected Num", "TNT SHM Function", "UOItemQty", "IIf(([Guaranteed Num] IS NULL AND [Projected Num] IS NULL AND [TNT Is Order Item BC] = ""Y""), ""Y"", ""N"")"

Parent Object Type

TNT SHM Function business component

Usage

Updates the value of the Quantity field in the child business component, if the value of the Expected Num field changes.

On Field Update Set 10

Use this user property to reinitialize the Grouping Code field value, if the product type is modified.

Value

"Type", "Grouping Code", "", "[TNT EMMenuPkg View Flag] =Y"

Parent Object Type

TNT Product - ISS Admin business component

Usage

The Grouping Code can be different for each product. This user property reinitializes the Grouping Code, if any, when a product type is modified.

On Field Update Set 11

Use this user property to set the default value of the Unit Of Measure field. The product type determines the default value.

Value

"Type", "Unit of Measure", "IIF ([Calculated Type] = ""Package Each"" or [Calculated Type] = ""Package Item Price"", LookupValue(""UNIT_OF_MEASURE"",""Each""), IIF([Calculated Type] = ""Package Per Person"", LookupValue(""UNIT_OF_MEASURE"",""Person""), [Unit of Measure]))"

Parent Object Type

TNT Product - ISS Admin business component

Usage

Sets the default value of the Unit Of Measure field.

On Field Update Set 47

Use this user property to check that at any time either the Discount Amount field or the Discount Percentage field has a value, but not both fields.

Value

"Discount Amount", "Discount Percent", "IIf ([Discount Amount] IS NOT NULL, """", [Discount Percent])"

Parent Object Type

TNT SHM Quote Item business component

Usage

Checks that at any time either the Discount Amount field or the Discount Percentage field has a value, but not both fields.

On Field Update Set 48

Use this user property to check that at any time either the Discount Amount field or the Discount Percentage field has a value, but not both fields.

Value

"Discount Percent", "Discount Amount", "IIf ([Discount Percent] IS NOT NULL, """", [Discount Amount])"

Parent Object Type

TNT SHM Quote Item business component

Usage

Checks that at any time either the Discount Amount field or the Discount Percentage field has a value, but not both fields.

Package Item Field Map 3

Use this user property to carry over the value from Package Item administration to the function line item when a package is added to the function line items.

Value

"Quantity Requested", "Quantity"

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Carries over the value from Package Item administration to the function line item when a package is added to the function line items. In this case, Quantity Requested is a field in the parent object, and Quantity is a field in the TNT Package Item business component.

When a package is added to the function line items, the child package items are added along with the parent package. The value of the Split Price Flag field of the TNT Package Item business component is copied into the TNT Split Qty Flag field of the parent business component.

NOTE:  For examples, refer to the Package Item Field Map x (where x is equal to 1,2,3...) user properties in the same parent object.

Parent Item Product Type

Use this user property to get the Parent Item Product type. This user property is used in C++ code.

Value

Parent Order Item Product Type

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Gets the Parent Item Product type. Used in C++ code.

Parent Item Product Type

Use this user property to get the Parent Item Product type. This user property is used in C++ code.

Value

Parent Product Type

Parent Object Type

TNT SHM Quote Item business component

Usage

Gets the Parent Item Product type. Used in C++ code.

Parent Pick Field

The value of this user property is a business component field. Use this user property to get the picklist for the defined value and add the item to the function line items, using the Quick Add applet. This user property is used in C++ code.

Value

Product

Parent Object Type

Internal Product Popup, Quick Add business components

Usage

The Quick Add applet is the child of the Function Line Items applet. The value of this user property is the parent business components field. This user property is used in C++ code to get the picklist for the defined value and add the item to the function line items through the picklist.

Parent Product Type

Use this user property to get the Parent Item Product type. This user property is used in C++ code.

Value

Parent Product Type

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Gets the Parent Item Product type. Used in C++ code.

Parent Product Type

Use this user property to get the Parent Item Product type. This user property is used in C++ code.

Value

Parent Quote Item Product Type

Parent Object Type

TNT SHM Quote Item business components

Usage

Gets the Parent Item Product type. Used in C++ code.

Pick List SearchSpec:MenuEventItem

Use this user property to set the search specification for the static picklist in the Type field, if the TNT Product - ISS Admin business component is driven by the TNT Property Product Admin List Applet applet.

Value

[Order By] = 201 OR [Order By] = 202

Parent Object Type

Type Field in TNT Product - ISS Admin business component

Usage

The TNT Property Product Admin List Applet applet has the Default Aspect user property and a value of MenuEventItem. If the TNT Product - ISS Admin business component is driven by the TNT Property Product Admin List Applet applet, the search specification for the static picklist in the Type field is formed by the MenuEventItem value.

Pick List SearchSpec:Package

Use this user property to set the search specification for the static picklist of the Type field, if the TNT Product - ISS Admin business component is driven by the TNT Package Administration List Applet applet.

Value

[Order By] = 204 OR [Order By] = 205 OR [Order By] = 206

Parent Object Type

Type Field in TNT Product - ISS Admin business component

Usage

The TNT Package Administration List Applet applet has the Default Aspect user property and a value of Package. If the TNT Product - ISS Admin business component is driven by the TNT Package Administration List Applet applet, the search specification of the static picklist of the Type field is formed by the Package value.

Prefix For Custom Product

Use this user property to define the prefix for the custom-created menus and packages in function line items.

Value

Product Prefix

Parent Object Type

TNT Custom Menu/Package VBC business component

Usage

A menu or package does not have to be predefined in the product list. A menu or package can also be created at run time. The products listed in Table 137 are provided with Siebel Hospitality as seed data.

If a user renames items in the seed data, for example, WRITE-IN Menus Per Person instead of Write-in Menu Per Person, then the value of the Product Prefix calculated field must be modified accordingly.

NOTE:  Optionally, you can define a Display Name for each product with any value. The Product Name and Product Type must be the same for all the seed products as defined in Table 137.

Table 137. Seed Data Products
Product Name
Product Type

Write-in Menu Per Person

Menu Per Person

Write-in Menu Item

Menu Item

Write-in Package Per Person

Package Per Person

Write-in Package Each

Package Each

Write-in Package Item Price

Package Item Price

Write-in Event Order Item

Event Order Item

Product BC Name: TNT Function Line Item Quick Entry View

Use this user property to pass the Product business component name to the C++ code.

Value

Internal Product Popup

Parent Object Type

Internal Product Popup business component

Usage

Retrieves the business component instance in C++ code while adding items to the function line items through the Search Add applet. The second part of the user property name designates the view context. If the active view is the TNT Function Line Item Quick Entry view, then the Internal Product Popup business component instance evaluates defined search criteria and gets the items.

Product BC Name: TNT SHM Order Function Line Items View

Use this user property to retrieve the business component instance in C++ code to evaluate search criteria and get the items while adding items to the function line items through the Search or Quick Add applet.

Value

Internal Product Popup

Parent Object Type

Internal Product Popup business component

Usage

Retrieves the business component instance in C++ code while adding items to the function line items through the Search Add applet. The second part of the user property name designates the view context. If the active view is the TNT SHM Order Function Line Items view, then the Internal Product Popup business component instance evaluates defined search criteria and gets the items.

Product BC Name: TNT SHM Quote Function Line Items View

Use this user property to retrieve the business component instance in C++ code to evaluate search criteria and get the items while adding items to the function line items through the Search or Quick Add applet.

Value

Internal Product Popup

Parent Object Type

Internal Product Popup business component

Usage

Retrieves the business component instance in C++ code while adding items to the function line items through the Search Add applet. The second part of the user property name designates the view context. If the active view is the TNT SHM Quote Function Line Items view, then the Internal Product Popup business component instance evaluates defined search criteria and gets the items.

Recursive Link

Use this user property to permanently delete the child items of a menu or package that is deleted from the function line items.

Value

TNT SHM Invoice Order Item, TNT SHM Invoice Order Item - Deep

Parent Object Type

TNT SHM Invoice Order Item business component

Usage

Permanently deletes the child items of a menu or package that is deleted from the function line items.

Revenue Adjusted Price Field

Use this user property to pass the field name for revenue calculations.

Value

TNT Extended Revenue Estimate Line Total Adjusted - Display

Parent Object Type

TNT SHM Quote Item business component

Usage

Passes the field name for revenue calculations.

Template Copy Fields

Use this user property to specify the fields to be copied when a template is created using the Apply Template method.

Value

Product Id, Quantity Requested, Service Start, Description, Note, Outline Number

Parent Object Type

TNT SHM Quote Item business component

Usage

Specifies the fields to be copied when a template is created using the Apply Template method.

TNT Allocation Validation Diff

Use this user property to define the value of the difference that forms the basis for the validation between the unit net price of a parent package and the accumulated per person allocations of the child package items.

Value

0.01

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Specifies the value of the difference that forms the basis for the validation between the unit net price of a parent package and the accumulated per person allocations of the child package items.

TNT Extended Net Price Flag

Use this user property to pass the field name to the C++ code.

Value

TNT MP Extended Net Price Flag

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

TNT Item Price Field

Use this user property to get the price value of the line item, which is referenced during the distribution of a per person allocation in C++ code.

Value

Item Price - Display

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

Gets the price value of the line item, which will be referenced during the distribution of a per person allocation in C++ code.

TNT Manual Allocation Field

Use this user property to set the allocation for the defined field in the case of a per person allocation.

Value

TNT Per Person Allocation

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item business components

Usage

The value of this user property is a field, and the per person or system allocation value is set to this field. This user property is used in C++ code to set the appropriate allocation value for the child items of a package.

TNT MPType Flag

Use this user property to pass the field name to the C++ code.

Value

IsMPType

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

TNT No Display Flag

Use this user property to pass the field name to the C++ code.

Value

TNT Guest No Price Flag

Parent Object Type

TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

TNT SHM Line Item Total Field

Use this user property to pass the Line item Total field value to the C++ code for revenue estimate calculations.

Value

TNT Extended Revenue Estimate Line Total - Display

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the Line item Total field value to the C++ code for revenue estimate calculations.

TNT SHM Line Item Total Field

Use this user property to pass the field name to the C++ code.

Value

TNT Extended Revenue Estimate Line Total - Display

Parent Object Type

TNT SHM Quote Item, TNT SHM Invoice Order Item, TNT SHM Order Item, TNT SHM Order Item Copy business components

Usage

Passes the field name to the C++ code.

Siebel Hospitality Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.