Siebel Hospitality Guide > User Properties Reference for Siebel Hospitality > User Properties for Function Space Diary >

Applet User Properties for Function Space Diary


This topic describes the following applet user properties:

Abbreviation Fields | ABBR 0

Use this user property to get the abbreviated field values according to the field value selected in the Display drop-down list in the Function Space Diary.

Value

Function Type Abbr;Business Type Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Gets the combination of abbreviations of the actual fields from the TNT SHM Function Booking VBC business component. The name of the user property must end with ABBR x (where x indicates 0,1,2...), which matches the language independent code (LIC) of the selection in the Display drop-down list in the Function Space Diary.

Abbreviation Fields | ABBR 1

Use this user property to get the abbreviated field values according to the field value selected in the Display drop-down list in the Function Space Diary.

Value

Setup Style Abbr;Expected Num Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Abbreviation Fields | ABBR 0 user property.

Abbreviation Fields | ABBR 2

Use this user property to get the abbreviated field values according to the field value selected in the Display drop-down list in the Function Space Diary.

Value

Event Manager Abbr;Sales Manager Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Abbreviation Fields | ABBR 0 user property.

Abbreviation Fields | ABBR 3

Use this user property to get the abbreviated field values according to the field value selected in the Display drop-down list in the Function Space Diary.

Value

Quote Name Abbr;Function Name Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Abbreviation Fields | ABBR 0 user property.

Abbreviation Fields | ABBR 4

Use this user property to get the abbreviated field values according to the field value selected in the Display drop-down list in the Function Space Diary.

Value

Function Status Abbr;Meal Period Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Abbreviation Fields | ABBR 0 user property.

Actual and Abbreviation Field 1

Use this user property to define the actual field and the corresponding abbreviation in the Function Space Diary.

Value

Function Type;Function Type Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The TNT SHM Function Booking VBC business component has been configured in the Item Business Component applet user property for all the above parent object types.

The first part of the user property value represents the actual field value of the TNT SHM Function Booking VBC business component. The second part of the user property value represents the abbreviation of the corresponding actual field.

If the value is available, then the corresponding abbreviation is displayed in the label and tooltip in the Function Space Diary in place of the actual field value.

Actual and Abbreviation Field 2

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Business Type;Business Type Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 3

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Setup Style;Setup Style Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 4

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Expected Num;Expected Num Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary and TNT SHM Function Space Diary Total Availability Applet Applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 5

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Event Manager;Event Manager Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 6

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Sales Manager;Sales Manager Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 7

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Quote Name;Quote Name Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 8

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Function Name;Function Name Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 9

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Function Status;Function Status Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

Actual and Abbreviation Field 10

Use this user property to define the actual field and corresponding abbreviation in the Function Space Diary.

Value

Meal Period;Meal Period Abbr

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

The usage is the same as the Actual and Abbreviation Field 1 user property.

CanModifyLayout

Use this user property to allow users to modify the applet UI layout through the Columns Displayed option.

Value

N

Parent Object Type

TNT SHM Property Projected / Blocked List Applet applet

Usage

Controls the Columns Displayed option in the Siebel Business Applications standard applet menu. To enable the Columns Displayed applet menu item, change the value to Y.

Color Code Major Axis 1

Use this user property to specify the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary.

Value

2

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary. The value 2 represents the LIC value for the Day/Day-Part time scale.

Color Code Major Axis 2

Use this user property to specify the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary.

Value

4

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary. The value 4 represents the LIC value for the Day/Hour time scale.

Color Code Major Axis 3

Use this user property to specify the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary.

Value

8

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary. The value 8 represents the LIC value for the Day/Half-Hour time scale.

Color Code Major Axis 4

Use this user property to specify the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary.

Value

16

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary. The value 16 represents the LIC value for the Day/Quarter-Hour time scale.

Color Code Major Axis 5

Use this user property to specify the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary.

Value

128

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary. The value 128 represents the LIC value for the Week/Day/Day-Part time scale.

Color Code Major Axis 6

Use this user property to specify the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary.

Value

256

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the major axis of the Function Space Diary. The value 256 represents the LIC value for the Month/Day-of-week/Day Part time scale.

Color Code Minor Axis 1

Use this user property to specify the time scale for which the color coding and icons are displayed in the minor axis of the Function Space Diary.

Value

1

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the minor axis of the Function Space Diary. The value 1 represents the LIC value for the Week/Day time scale.

Color Code Minor Axis 2

Use this user property to specify the time scale for which the color coding and icons are displayed in the minor axis of the Function Space Diary.

Value

32

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale for which the color coding and icons are displayed in the minor axis of the Function Space Diary. The value 32 represents the LIC value for the Month/Day-of-week time scale.

Delimiter

Use this user property to specify the delimiter when a combination is selected in the Display LOV of the Function Space Diary.

Value

/

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Specifies the delimiter when a combination is selected in the Display LOV in the Function Space Diary.

Example

Board Meeting/Conference, if Function Name/Function Type is selected in the Display LOV of the Function Space Diary.

Enable Color Icon

Use this user property to enable or disable color coding in the Function Space Diary.

Value

Y

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Turns color coding on or off in the Function Space Diary. If the value is N, no color icons are displayed.

Icon Display Fields 0

Use this user property to associate an icon with specific special events.

Value

Holiday;301

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Associates an icon with specific special events. Icon identifier 301 is associated with Holiday and configured in the C++ code.

Icon Display Fields 1

Use this user property to associate an icon with specific special events.

Value

Special Day Event;302

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Associates an icon with specific special events. Icon identifier 302 is associated with Special Event and configured in the C++ code.

Icon Display Fields 2

Use this user property to associate an icon with specific special events.

Value

Sell Note;303

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary and TNT SHM Function Space Diary Total Availability Applet Applets

Usage

Associates an icon with specific special events. Icon identifier 303 is associated with Sell Note and configured in the C++ code.

Item Color Toggle Activate Fields

Use this user property to activate fields that are used in the function booking color scheme based on the Item Color Toggle Field user property value.

Value

Function Status;Quote Status

Parent Object Type

TNT SHM Function Space Diary Total Availability Applet, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary applets

Usage

This user property is used to activate all the fields that could be returned as the value of the Item Color Toggle Field user property.

Item Color Toggle BC Name

Use this user property to define business components for toggle colors.

Value

TNT SHM Gantt AX Admin Function Status Color

Parent Object Type

TNT SHM Function Space Diary Total Availability Applet, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary applets

Usage

This user property is used in C++ code to return the toggle color codes configured in the Function Space Administration screen, Function Status Color Schema applet.

Define similar user properties if any other toggle colors are available. For example, if you want to define toggle color codes for Quote Status, then define a similar user property such as Item Color Toggle BC Name 1 with a value of TNT SHM Gantt AX Admin Quote Status Color.

Item Color Toggle Field

The field name is defined in the TNT SHM Gantt AX Date Time Interval PopUp VBC business component. The value is the status field in the TNT SHM FSI Booking business component, based on the selected booking color scheme.

Value

Booking Color Toggle Field

Parent Object Type

TNT SHM Function Space Diary Total Availability Applet, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary applets

Usage

This user property is used to return the status for which a toggle color is defined.

Example

If the function color booking scheme is selected as Quote Status, then the Booking Color Toggle field returns a value of Quote Status. This value is the field name in the TNT SHM FSI Booking business component.

If the field does not exist, then you must configure the field in the TNT SHM FSI Booking business component. The value of the status field is returned in C++ code to identify the associated color code, if it is defined in the Function Space Administration screen, Quote Status Color Schema applet.

Item Time Display Toggle Time Label 9

Use this user property to display the Expected Number of Attendees field in the Booking Label when Expected Num is selected in the Display LOV of the Function Space Diary.

Value

Expected Num

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

If the value is available, the value of the Expected Num field is displayed in the Booking Label when Expected Num is selected in the Display LOV of the Function Space Diary. The name of this user property must end with x (where x indicates 0,1,2...).

Item Time Display Toggle Time Tooltip ABBR 0

Use this user property to get the abbreviated field values in the tooltip according to the field value selected in the Display LOV in the Function Space Diary.

Value

Booking Set Up Tip;Booking Tip - Abbreviation;Booking Tear Down Tip;Booking Tear Down Tip

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary and TNT SHM Function Space Diary Total Availability Applet Applets

Usage

Gets the combination of abbreviations of the actual fields from the TNT SHM Function Booking VBC business component and displays the resulting value in the tooltip. The name of the user property must end with ABBR x (where x indicates 0,1,2...), which matches the LIC of the selection in the Display LOV in the Function Space Diary.

Max X Pages

This user property is used to configure the number of horizontal pages for which Function Space Diary information is to be displayed.

Value

2

Parent Object Type

TNT SHM Compact Function Space Diary
TNT SHM Function Space Diary
TNT SHM Function Space Diary Total Availability Applet
TNT SHM Function Space Diary - Business Type
TNT SHM Function Space Diary - Function Type
TNT SHM Function Space Diary - Meal Period
TNT SHM Function Space Diary - Quote Name
TNT SHM Function Space Diary - Setup Style
TNT SHM Order Item Category Inventory Availability Gantt Chart Applet
TNT SHM Order Item Inventory Availability Gantt Chart Applet
TNT SHM Quote Item Category Inventory Availability Gantt Chart Applet
TNT SHM Quote Item Inventory Availability Gantt Chart Applet

Usage

This user property is used to configure the number of horizontal pages for which Function Space Diary information is to be displayed.

Max Y Rows Per Page

This user property is used to configure the number of visible function spaces for which Function Space Diary information is to be displayed.

Value

15

Parent Object Type

TNT SHM Compact Function Space Diary
TNT SHM Function Space Diary
TNT SHM Function Space Diary Total Availability Applet
TNT SHM Function Space Diary - Business Type
TNT SHM Function Space Diary - Function Type
TNT SHM Function Space Diary - Meal Period
TNT SHM Function Space Diary - Quote Name
TNT SHM Function Space Diary - Setup Style
TNT SHM Order Item Category Inventory Availability Gantt Chart Applet
TNT SHM Order Item Inventory Availability Gantt Chart Applet
TNT SHM Quote Item Category Inventory Availability Gantt Chart Applet
TNT SHM Quote Item Inventory Availability Gantt Chart Applet

Usage

This user property is used to configure the number of visible function spaces for which Function Space Diary information is to be displayed.

Month Day View

Use this user property to specify the time scale in which to display information for the whole month in the Function Space Diary.

Value

64

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scale in which to display information for the whole month in the Function Space Diary. The value 64 represents the LIC value for the Month/Day time scale.

OnDoubleClick Invoke BC

Use this user property to configure the business component to retrieve the double-click event details when a user double-clicks the Function Space Diary grid. When the double-click event occurs, Siebel Hospitality sends data, such as time, property, and function space, to a business service method, which is configured through the OnDoubleClick Invoke Service and OnDoubleClick Invoke Service Method user properties.

Value

TNT SHM Gantt AX Date Time Interval PopUp VBC

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Specifies the business component to get parameters, such as time and function space, from the business component when double-clicked in the Function Space Diary.

OnDoubleClick Invoke Service

Use this user property to configure the business component to retrieve the double-click event details when a user double-clicks the Function Space Diary grid. When the double-click event occurs, Siebel Hospitality sends data, such as time, property, and function space, to a business service method, which is configured through this user property and the OnDoubleClick Invoke Service Method user property.

Value

SHM Function Service

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Calls a business service to retrieve the double-click event details from the method defined in the OnDoubleClick Invoke Service Method user property.

OnDoubleClick Invoke Service Method

Use this user property to configure the business component to retrieve the double-click event details when a user double-clicks the Function Space Diary grid. When the double-click event occurs, Siebel Hospitality sends data such as time, property, and function space to a business service method, which is configured through the OnDoubleClick Invoke Service user property and this user property.

Value

OnDoubleClickFSDInfo

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the business service method that is called when double-clicked in the Function Space Diary. This business service method must be defined in the service that is configured in the OnDoubleClick Invoke Service user property.

Small Red Triangle Comment Icon

Use this user property to associate the bitmap identifier with the Small Red Triangle icon displayed in the Function Space Diary for special events.

Value

304

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Associates the bitmap identifier with the Small Red Triangle icon displayed in Function Space Diary for the Month/Day time scale. The value 304 represents the Small Red Triangle configured in C++ code.

Special Date BC Name

Use this user property to define the business component from which special day event details can be retrieved.

Value

TNT SHM Property Special Dates Action business component

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the business component from which special day event details can be retrieved. The special day data is retrieved from this business component and displayed in the respective Day columns in the Function Space Diary.

Special Day Description

Use this user property to retrieve the descriptions of special days, if any, in a tooltip in the Function Space Diary.

Value

Holiday Desc;Sell Note Desc;Special Event Desc

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Indicates whether or not to display special day descriptions in a Function Space Diary tooltip. By default, the values are descriptions for three special days and have one-to-one mappings with the values of the Special Day Type user property. The combination can be modified by removing or adding new entries in accordance with the value of the Special Day Type user property.

Example

Holiday Desc;Special Event Desc

Special Day Type

Use this user property to display the descriptions of special days, if any, in a tooltip in the Function Space Diary.

Value

Holiday;Sell Notes;Special Events

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Indicates whether or not to display special day descriptions in a Function Space Diary tooltip. By default, the values are three special day types. The combination can be modified by removing or adding new entries.

Example

Holiday;Special Events

Views Displaying Across The Months

Use this user property to calculate the End Date/Month information, which is used to display Y-Axis header information (Month and Year) in the Function Space Diary.

Value

256

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

In the Function Space Diary, on some time scales, it might not be possible to identify for which month and year the data is displayed. For such time scales, month and year information is displayed on the Y-Axis Header. By default, the value is 256, which is the LIC value for the Month/Day-of-week/Day Part time scale. To support other time scales, append each value with a semicolon (;) delimiter.

Example

256;64;128

Views Having No Y-Axis Header

Use this user property to hide the Y-Axis Header information in the Function Space Diary

Value

1;32

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

In the Function Space Diary, on some time scales, it might not be necessary to display information on the Y-Axis header. By default, the value is 1;32. These numbers are LIC values for certain time scales.

Views Having Space Crunch for Icons

Use this user property to define the time scales for which there is insufficient space to display more than two icons in the same column header in the Function Space Diary.

Value

1;128

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the time scales for which there is insufficient space to display more than two icons in the same column header. In this case, C++ code adjusts the space. Currently there is insufficient space for two time scales (Week/Day and Week/Day/Day Part) when there are more than two icons in the same column header. The values 1 and 128 represent LIC values for Week/Day and Week/Day/Day Part respectively.

Weekend Admin BC Name

Use this user property to define the business component from which to retrieve weekend details for a given property. The Function Space Diary uses these weekend details to decide whether a day is a weekday or a weekend day, to display the correct color and icon in date column headers.

Value

TNT SHM Weekend Admin

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Defines the business component from which weekend details can be retrieved. The weekend data is used to decide color and icon to display in day columns in the Function Space Diary.

Y-Axis Header Display Format

Use this user property to determine the format for the date to be displayed on the Y-Axis header in the Function Space Diary for some time scales.

Value

MMMM YYYY

Parent Object Type

TNT SHM Function Space Diary, TNT SHM Compact Function Space Diary, and TNT SHM Function Space Diary Total Availability Applet applets

Usage

Specifies the Y-Axis header display format in the Function Space Diary, for example, August 2008. This user property is applicable only if month and year are displayed on the Y-Axis header.

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