Calculated KBI functions

When building calculated KBIs in the Forecast Structure, you use a variety of preconfigured functions.

@ARRIVALSTTL

Computes total arrivals for the type of market segment chosen, for a specific day.

Syntax

  • @ARRIVALSTTL(Segment_type, Day_offset)

    • Segment_type.

      • ALL—Sums arrivals for all market segments.

      • CASINO—Sums arrivals for Casino market segments.

      • CONTRACT. Sums arrivals for Contract market segments.

      • GROUP—Sums arrivals for Group market segments.

      • TRANSIENT—Sums arrivals for Transient market segments.

    • Day_offset—Indicates the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Example

      • @ARRIVALSTTL(ALL,-1)

        • This formula would yield the total number of yesterday's arrivals for all market segments.

@AVG

Returns the average (arithmetic mean) of the arguments.

Syntax

  • @AVG(Value1, Value2...)

    • Value1, Value2, ...

      • Value—Unlimited number of arguments that you want to average. Each argument can be a complete formula.

Remarks

You must enter at least two values for this function to work, but you can enter as many values as space will allow.

  • Example 1

    • @AVG(##4052\[-1\], ##4053\[-1\])

      • This formula would give us the average between ACCENTS_AM_Shift and ACCENTS_PM_Shift.

  • Example 2

    • @AVG(#PAVG(4,##4052\[-1\]),@PAVG(6, #4052\[-1\]))

@CFGROOMS

Returns the total number of configured rooms for the property.

Syntax

  • @CFGROOMS( )

@DEPTSTTL

Returns the total number of departures for the day.

Syntax

  • @DEPTSTTL(Segment_type, Day_offset)

    • Segment_type

      • ALL—Sums arrivals for all market segments.

      • CASINO—Sums arrivals for Casino market segments.

      • CONTRACT—Sums arrivals for Contract market segments.

      • GROUP—Sums arrivals for Group market segments.

      • TRANSIENT—Sums arrivals for Transient market segments.

    • Day_offset—Denotes the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Example

      •  @DEPARTSTTL(CONTRACT, 0)

        • This formula would yield the total number of today's departures for the Contract market group.

@GUESTSTTL

Computes total number of guests for a specific day.

Syntax

  • @GUESTSTTL(Segment_type, Day_offset)

    • Segment_type.

      • ALL—Sums arrivals for all market segments.

      • CASINO—Sums arrivals for Casino market segments.

      • CONTRACT—Sums arrivals for Contract market segments.

      • GROUP—Sums arrivals for Group market segments.

      • TRANSIENT—Sums arrivals for Transient market segments.

    • Day_offset—Denotes the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Examples

      • @GUESTSTTL(TRANSIENT, 0)

        • This formula would yield the total number of today's guests for the Transient market group.

@MAX

Returns the maximum of two expressions.

Syntax

  • @MAX(Value1, Value2)

    • Value1, Value2, ...

      • Value—Argument for which you want to return the minimum number from two expressions. Only two arguments are allowed in this function. These VALUES may consist of any valid expression.

  • Example

    • @MAX(#TTLRMS\[-7\], TTLRMS\[-14\])

      • This formula takes the total of last week's rooms and the total rooms from two weeks ago and yields the maximum of those two numbers.

@MIN

Returns the minimum of two expressions.

Syntax

  • @MIN(Value1, Value2)

    • Value1, Value2, ...

      • Value—Argument for which you want to return the minimum number from two expressions. Only two arguments are allowed in this function. These VALUES may consist of any valid expression.

  • Example

    •  @MIN(#TTLRMS\[-7\], TTLRMS\[-14\])

      • This formula takes the total of last week's rooms and the total rooms from two weeks ago and yields the minimum of those two numbers.

@PAVG

Returns the average of past values.

Syntax

  • @PAVG(# Data_points,#KBICode\[Day_offset\])

    • # Data_points—Represents the number of values to be used in the calculation. Starting with the previous week's data, RMS will take the number you enter here and average that number of previous data values.

    • #KBICode—Represents the code of the KBI you choose to use in the calculation.

    • Day_offset—Indicates the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

Remarks

RMS will only use like data when gathering data for the # data points. If there is a season, event, or environment that influences the data during the time that RMS is trying to gather data, it will not be included unless your start date contains a season, event, or environment. For example, if you set the # data points at 4, and today's date is 9/15/2011, RMS will gather data from the following dates:  9/8/2011, 9/1/2011, 8/25/2011, and 8/18/2011. If 9/15/2011 contains a season, event, or environment RMS will look for other Mondays that contain seasons, events, or environments so your data collection dates might look more like this: 9/1/2011, 6/2/2011, 5/26/2011 and 2/17/2011.

  • Example

    •  @PAVG(4,##4052\[0\])

      • This formula would provide the average of 4 data points of data from ACCENTS_AM_Shift starting from today's date.

@READLABORKBI

Reads the value of a KBI.

Syntax

  • @READLABORKBI(#KBICode, Day_Offset, Data_Value)

    • #KBICode—Represents the code of the KBI you choose to use in the calculation.

    • Day_offset—Indicates the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Data_Value—Indicates which type of value should be read.

      • Actual—Represents actual data.

      • Adjusted—Represents data after manager's edits.

      • Estimated—Represents estimated data.

      • Forecast—Represents forecast data.

@REVTTL

Returns the total revenue centers or center units.

Syntax

  • @REVTTL(Revenue_center_value, Unit_type, day_offset)

    • Revenue_center_valueValue.

      • Represents the revenue centers you created when configuring Revenue Centers.

    • Unit_type.

      • Value—Represents the units you created when configuring Property.

    • Day_offset—Denotes the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Example

      • @REVTTL(Cafe, Covers, 0)*

        • This formula would yield the total covers for today in the Cafe.

@ROOMSTTL

Computes total number of rooms for a specific day.

Syntax

  • @ROOMSTTL(Segment_type, Day_offset)

    • Segment_type

      • ALL—Sums arrivals for all market segments.

      • CASINO—Sums arrivals for Casino market segments.

      • CONTRACT—Sums arrivals for Contract market segments.

      • GROUP—Sums arrivals for Group market segments.

      • TRANSIENT—Sums arrivals for Transient market segments.

    • Day_offset—Indicates the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Example

      • @ROOMSTTL(GROUP, 0)

        • This formula would yield the total number of today's rooms for the Group market group.

@SUM

Summarizes KBIs.

Syntax

  • @SUM(#KBICode \[Day_offset\], #KBICode \[Day_offset\], ...)

    • #KBICode—An infinite number of KBIs that you want to sum.

    •  Day_offset—Denotes the day from which you want the data to be read.

      • Today—Represented by 0.

      • Past—Represented by \-x.

    • Example

      • @SUM(##4052\[-7\], ##4053* [-7\])

        • This formula would yield the sum of last week's ACCENTS_AM_Shift and ACCENTS_PM_Shift.