|
Siebel Hospitality Guide > User Properties Reference for Siebel Hospitality > User Properties for Function Space Diary >
Business Component User Properties for Function Space Diary
This topic describes the following business component user properties:
Color Code Holiday Type
Use this user property to define the type of special day to which the Holiday color code type is mapped in the Function Space Diary.
Value |
Holiday |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Each color code type has a different color, and each color must be mapped to a particular special day type to identify those days in the Function Space Diary. The default value is Holiday, which is the LOV display value for Holiday in the Property Pricing Admin screen, Sell Notes view. The special day configurations for a property are defined in the Sell Notes view. In the Function Space Diary, the color coding is applied to the day columns, if they belong to any of the special days that are defined in the Sell Notes view. |
Color Code Sell Note Type
Use this user property to define the type of special day to which the Sell Note color code type is mapped in the Function Space Diary.
Value |
Sell Notes |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Each color code type has a different color, and each color must be mapped to a particular special day type to identify those days in the Function Space Diary. The default value is Sell Notes, which is the LOV display value for Sell Notes in the Property Pricing Admin screen, Sell Notes view. The special day configurations for a property are defined in the Sell Notes view. In the Function Space Diary, the color coding is applied to the day columns, if they belong to any of the special days that are defined in the Sell Notes view. |
Color Code Special Events Type
Use this user property to define the type of special day to which the Special Events color code type is mapped in the Function Space Diary.
Value |
Special Events |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Each color code type has a different color, and each color must be mapped to a particular special day type to identify those days in the Function Space Diary. The default value is Special Events, which is the LOV display value for Special Events in the Property Pricing Admin screen, Sell Notes view. The special day configurations for a property are defined in the Sell Notes view. In the Function Space Diary, the color coding is applied to the day columns, if they belong to any of the special days that are defined in the Sell Notes view. |
Diary User Preferences Fields
Use this user property to retrieve the user preferences defined in the User Preferences screen, Function Space Diary view. When a user navigates to Function Space Diary, the view is displayed with these predefined attributes.
Value |
Time Scale Text;Display Toggle - Query;Toggle TurnTime - Query;Configured Space Pattern |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Retrieves the user preferences defined in the User Preferences screen, Function Space Diary view. When a user navigates to the Function Space Diary, the view is displayed with these predefined attributes. The values correspond to the Time Scale, Display, Turn Time, and Config Space Pattern controls in the Function Space Diary view. For these controls, a user can enter values in the User Preferences view, which are set as the default values for the controls in the Function Space Diary view. These user preferences are captured through the Time Scale Text, Display Toggle - Query, Toggle TurnTime - Query, and Configured Space Pattern fields of the User Preferences business component. These fields are prefixed with Diary/, for example, Diary/Time Scale Text. |
Enable Single Button Toggle
Use this user property to enable or disable the toggle button click functionality.
Value |
Y |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Turns the toggle button click functionality on or off. If the value is Y, the dynamic applet of the toggle button can support toggle button functionality. |
Format Specifier Major
This user property is used to specify the date format on the major axis for each time scale. Use this user property to define the date formats for different time scales on the major axis of the Function Space Diary.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;MMMM YYYY;2;DDDD DD;4;DDDD DD;8;DDDD DD;16;DDDD DD;32;MMMM YYYYY;64;DDD;128;DDD DD;256;DDD DD |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;MMMM YYYY;2;MMMM DD YYYY;4;DDDD MMMM DD YYYY;8;DDDD MMMM DD YYYY;16;DDDD MMMM DD YYYY;32;MMMM YYYYY |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;MMMM YYYY;2;MMMM DD YYYY;4;DDDD MMMM DD YYYY;8;DDDD MMMM DD YYYY;16;DDDD MMMM DD YYYY;32;MMMM YYYYY |
Usage |
Multiple time scales are available for user selection. Each time scale is referenced by a code, as follows. Time Scale Code
Week/Day 1
Day/Day-Part 2
Day/Hour 4
Day/Half-Hour 8
Day/Quarter-Hour 16
Month/Day-of-Week 32
Month/Day 64
Week/Day/Day-Part 128
Month/Day-of-Week/Day-Part 256
This user property is used to specify the date format on the major axis for each time scale. This user property determines the date formats for the major axis of the Function Space Diary, for example, August 2008. The value is a set of name-value pairs. The first part of the delimiter represents the time scale, and the second part represents the format that applies to the time scale. |
Format Specifier Minor
This user property is used to specify the date format on the minor axis for each time scale. Use this user property to define the date formats for different time scales on the minor axis of the Function Space Diary.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;DDD DD;2;DD h:m p;4;h p;8;h:m p;16;h:m p;32;DDDD DD;64;DD;128;DD h:m p;256;DD h:m p |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;DDDD MMMM DD;2;DD h:m p;4;h p;8;h:m p;16;h:m p;32;DDDD DD |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;DDDD MMMM DD;2;DD h:m p;4;h p;8;h:m p;16;h:m p;32;DDDD DD |
Usage |
Multiple time scales are available for user selection. Each time scale is referenced by a code, as follows. Time Scale Code
Week/Day 1
Day/Day-Part 2
Day/Hour 4
Day/Half-Hour 8
Day/Quarter-Hour 16
Month/Day-of-Week 32
Month/Day 64
Week/Day/Day-Part 128
Month/Day-of-Week/Day-Part 256
This user property is used to specify the date format on the minor axis for each time scale. This user property determines the date formats for the minor axis of the Function Space Diary, for example, August 2008. The value is a set of name-value pairs. The first part of the delimiter represents the time scale, and the second part represents the format that applies to the time scale. |
Gantt Prefix
Use this user property to get an expression and set the expression as the named search specification for the TNT SHM Function Booking VBC business component.
Value |
GntAX Func Stat: |
Parent Object Type |
TNT SHM Gantt AX Admin Function Status Color business component |
Usage |
The value of this user property is used as a prefix along with Status value of the function. The concatenated value is stored in the system preferences under the Name column. This user property is also used in C++ code in conjunction with the Status Color Scheme LIC user property to identify the color coding needed to display bookings, as defined by the function booking color scheme selection in the Function Space Diary screen. |
Include End Time in Label Major
This user property is used to specify whether or not a time interval is displayed on the major axis, for each time scale.
Value |
1;Y;2;N;4;N;8;N;16;N;32;Y;64;N |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Usage |
This user property is used to specify whether or not a time interval is displayed on the major axis, for each time scale. An example time interval is January 2012 to February 2012. If a value is set to N, only the start date is displayed on the major axis. |
Method Name 1
Use this user property to call a method when a user clicks the custom toggle button in the applet that is based on the TNT SHM SR Inventory Dync business component.
Value |
WithoutTentative |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
This user property is used when a custom toggle button exists on an applet. This user property calls different methods. The methods called are based on the caption of the button. The value for this user property is a method name, which is called by default when a user clicks the custom toggle button on the applet. The method name becomes the caption for the button. The method name must be defined as a LOV value for the TNT_SHM_TOTAL_AVAILABILITY type. |
Parent Field 1
Use this user property to retrieve the required field values from the parent business component when a user double-clicks in the Function Space Diary.
Value |
Id |
Parent Object Type |
SHM Site business component |
Usage |
Defines the business component from which to retrieve the required field values when a user double-clicks in the Function Space Diary. The default value is SHM Site, which is the parent business component of the Function Space Diary. When a user double-clicks in the Function Space Diary, this user property and other details are sent to the service method, which is configured in the OnDoubleClick Invoke Service Method user property. |
Pivot 1 Type 0
In the applet that is based on the TNT SHM SR Inventory Dync business component, the exact quantity of blocked rooms is displayed under the Group Blocked heading.
Value |
Group Blocked;1;Exact Blocked;1 |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Displays the aggregate value of the blocked sleeping rooms under the Group Blocked heading. |
Pivot 1 Type 2
In the applet that is based on the TNT SHM SR Inventory Dync business component, the exact quantity of projected rooms is displayed under the Group Projected heading.
Value |
Group Projected;1;Exact Projected;1 |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Displays the aggregate value of the projected sleeping rooms under the Group Projected heading. |
Scale Unit Major
This user property is used to adjust the scaling factor on the major axis. Use this user property to define the scale unit of the major axis for different time scales in the Function Space Diary.
Value |
1;0.25;2;1;4;0.5;8;4;16;7;32;1;64;1 |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Usage |
This user property is used to adjust the scaling factor on the major axis. This user property determines the scale unit of the major axis for different time scales in the Function Space Diary. The value is a set of name-value pairs. The first part of the delimiter represents the time scale, and the second part represents the unit scale of the major axis. |
Scale Unit Minor
This user property is used to adjust the scaling factor on the minor axis. Use this user property to define the scale unit of the minor axis for different time scales in the Function Space Diary.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;1;2;1;4;.75;8;1;16;2;32;1;64;1;128;1;256;1 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;1.5;2;1;4;1;8;4;16;7;32;1 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;1.5;2;1;4;1;8;4;16;7;32;1 |
Usage |
This user property is used to adjust the scaling factor on the minor axis. This user property determines the scale unit of the minor axis for different time scales in the Function Space Diary. The value is a set of name-value pairs. The first part of the delimiter represents the time scale, and the second part represents the unit scale of the minor axis. |
Segments Per Page Major
This user property is used to specify the number of segments per page to be displayed on the major axis, for each time scale. Use this user property to define the segments per page of the major axis for different time scales in the Function Space Diary.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;1;2;1;4;1;8;1;16;1;32;2;64;30;128;8;256;8 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;1;2;1;4;1;8;1;16;1;32;1 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;1;2;1;4;1;8;1;16;1;32;1 |
Usage |
This user property is used to specify the number of segments per page to be displayed on the major axis, for each time scale. This user property determines the segments per page of the major axis for different time scales in the Function Space Diary. The value is a set of name-value pairs. The first part of the delimiter represents the time scale, and the second part represents the segments per page for the major axis. |
Segments Per Page Minor
This user property is used to specify the number of segments per page to be displayed on the minor axis, for each time scale. Use this user property to define the segments per page of the minor axis for different time scales in the Function Space Diary.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;8;2;1;4;24;8;24;16;48;32;8;64;30;128;8;256;8 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;7;2;1;4;24;8;48;16;96;32;4 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;7;2;1;4;24;8;48;16;96;32;4 |
Usage |
This user property is used to specify the number of segments per page to be displayed on the minor axis, for each time scale. This user property determines the segments per page of the minor axis for different time scales in the Function Space Diary. The value is a set of name-value pairs. The first part of the delimiter represents the time scale, and the second part represents the segments per page for the minor axis. |
Spl Date BC Description Field
Use this user property to retrieve the description for a special day and display the description in a tooltip in the Function Space Diary.
Value |
Description |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Retrieves the description value for a special day and displays the description in a tooltip in the Function Space Diary. The default value is Description, which is the field name of the TNT SHM Property Special Dates Action business component, which in turn is defined for the Special Date BC Name user property. The value can also be mapped to any field other than Description that acts as a descriptive field for the TNT SHM Property Special Dates Action business component. |
Spl Date BC End Date Field
Use this user property to retrieve the end date or expiration date for special days.
Value |
End Date |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Retrieves the end or expiration date value for defined special days. The Start Date and End Date of the special days are used in C++ code to determine whether or not the date column in the Function Space Diary lies within the date range of any special day. If it does, then the color code or icon of the special day is displayed on that date column in the Function Space Diary. The default value is End, which is the field name of the TNT SHM Property Special Dates Action business component, which in turn is defined for the Special Date BC Name user property. The value can also be mapped to any field other than End that acts as an expiration date for the TNT SHM Property Special Dates Action business component. |
Spl Date BC Start Date Field
Use this user property to retrieve the start date for special days.
Value |
Start Date |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Retrieves the Start Date value for defined special days. The Start Date and End Date of the special days are used in C++ code to determine whether or not the date column in the Function Space Diary lies within any special day range. If it does, then the color code or icon of the special day is displayed on that date column in the Function Space Diary. The default value is Start, which is the field name of the TNT SHM Property Special Dates Action business component, which in turn is defined for the Special Date BC Name user property. The value can also be mapped to any field other than Start that acts as an expiration date for the TNT SHM Property Special Dates Action business component. |
Spl Date BC Type Field
Use this user property to retrieve the types of special days.
Value |
Type |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
This user property is used to retrieve the special day type. This type determines the color code mechanism. The default value is Type, which is the field name of the TNT SHM Property Special Dates Action business component, which in turn is defined for the Special Date BC Name user property. The value can also be mapped to any field other than Type that acts as the type for the TNT SHM Property Special Dates Action business component. |
Status Color Scheme LIC
Use this user property to indicate the LIC of the status for which toggle color codes are configured in the Function Space Administration screen.
Value |
FUNCTION_STATUS |
Parent Object Type |
TNT SHM Gantt AX Admin Function Status Color business component |
Usage |
This user property is used in C++ code in conjunction with the Gantt Prefix user property to identify the color coding needed to display the bookings as defined by the function booking color scheme selection in the Function Space Diary screen. This is the LIC of the status in TNT_FSD_COLOR_SCHEMA. |
Time Part BC Minor 3
Use this user property to retrieve the time part details for a property in the Function Space Diary.
Value |
256;TNT SHM Property Day Part Pricing |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Usage of this user property is the same as Time Part BC Minor. |
Time Part BC Minor Property Field
Use this user property to retrieve the Property Id for which to retrieve the time part details from the TNT SHM Property Day Part Pricing business component.
Value |
Property Id |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Retrieves the Property Id for which to retrieve the time part details from the TNT SHM Property Day Part Pricing business component. The default value is Property ID, which is a field in the TNT SHM Property Day Part Pricing business component. |
Tool Tip Delimiter
Use this user property to specify the delimiter for the tooltip in the Function Space Diary.
Value |
: |
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC business component |
Usage |
Separates the attribute names and values in the tooltip in the Function Space Diary. The default value is a colon (:). |
Example |
If the attribute name is Function Type and value is Board Meeting, then the tooltip stores this information as Function Type:Board Meeting. |
Undo Method Name 1
Use this user property to call a method when a user clicks the custom toggle button in the applet that is based on the TNT SHM SR Inventory Dync business component.
Value |
WithTentative |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
This user property is used when a custom toggle button exists on an applet. The value of this user property represents the toggle method for the toggle button. When a user clicks the custom toggle button in the applet, the method that is configured for the Method Name 1 user property is called. Additionally, this method name WithTentative becomes the caption for the button. The method name must be defined as a LOV value for the TNT_SHM_TOTAL_AVAILABILITY type. When the user clicks the custom toggle button again, the method WithTentative is called. |
Units Per Segment Major
This user property is used to specify the number of units per segment on the major axis.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;7;2;1;4;1;8;0.5;16;0.25;32;28;64;1;128;1;256;7 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;7;2;1;4;1;8;1;16;1;32;28 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;7;2;1;4;1;8;1;16;1;32;28 |
Usage |
This user property is used to specify the number of units per segment on the major axis. |
Units Per Segment Minor
This user property is used to specify the number of units per segment on the minor axis.
Parent Object Type |
TNT SHM Gantt AX Date Time Interval PopUp VBC |
Value |
1;1;2;1;4;0.0416666666666666;8;0.020833333333333334;16;0.010416666666666666;32;7;64;1;128;1;256;7 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval For Order PopUp VBC |
Value |
1;1;2;1;4;0.0416666666666666;8;0.020833333333333333;16;0.010416666666666666;32;7 |
Parent Object Type |
TNT SHM Inventory Gantt AX Date Time Interval PopUp VBC |
Value |
1;1;2;1;4;0.0416666666666666;8;0.020833333333333333;16;0.010416666666666666;32;7 |
Usage |
This user property is used to specify the number of units per segment on the minor axis. |
WithoutTentative:Field Name
Use this user property to set the Boolean value of the field of the dependent TNT SHM Quote Room Block Line Items Aggr business component, to which the toggle method call is delegated.
Value |
Tentative Flag |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Sets the Boolean value of the field of the dependent TNT SHM Quote Room Block Line Items Aggr business component, to which the toggle method call will be delegated. The default value is Tentative Flag. When a user clicks the toggle button that displays a caption of Without Tentative, the Tentative Flag field of the TNT SHM Quote Room Block Line Items Aggr business component is set to True, and the aggregated records are prepared in the TNT SHM Quote Room Block Line Items Aggr business component. |
WithoutTentative:Status
Use this user property to remove the records associated with the referenced status (T1 and T2) when a user clicks the toggle button that displays a caption of Without Tentative.
Value |
T1;T2; |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Removes the records associated with the referenced status (T1 and T2) when a user clicks the toggle button that displays a caption of Without Tentative. The aggregate records are processed in the TNT SHM Quote Room Block Line Items Aggr business component. |
WithoutTentative:Undo Method Name
Use this user property to implement toggle functionality in a toggle button.
Value |
WithTentative |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Changes the caption of the toggle button when a user clicks the toggle button. The value is WithTentative. If a user clicks a toggle button with the caption WithoutTentative, the caption of the toggle button is replaced by WithoutTentative. |
WithTentative:Undo Method Name
Use this user property to implement toggle functionality in a toggle button.
Value |
WithoutTentative |
Parent Object Type |
TNT SHM SR Inventory Dync business component |
Usage |
Changes the caption of the toggle button when a user clicks the toggle button. The value is WithoutTentative. If a user clicks a toggle button with the caption WithTentative, the caption of the toggle button is replaced by WithoutTentative. |
|
