Pricing Formula Examples and Variables : Formula Variables
  
Formula Variables
This is a list of all the variables that can be used in price sheet formulas. Not all variables are valid in all circumstances; for instance, requirements are not priced based on time (reservation) so none of the occurrence-specific variables are valid (and will yield a value of 0). The two types of variables are:
• Number variables
• Date/time variables
Number Variables
These variables represent the amount of something that can be expressed numerically. They always return an integer. See “Pricing Formula Examples” for examples of how these variables can be used.
 
Variable Name
Description
NumberOfOccurrences
Total number of reservation occurrences
Note: Use primarily for dividing the cost for an event type. Remember that all pricing is per occurrence, and that the formula is applied to each occurrence.
ExpHeadCount
Expected head count for the reservation
RegHeadCount
Registered head count for the reservation
ActHeadCount
Actual head count for each occurrence
Note: Only for locations
Quantity
Quantity assigned
Note: Only for resources and requirements
Capacity
Either capacity of layout or max capacity
Note: Only for locations
ReservationDuration
Total reserved duration, expressed as a numeral
(RSRV_START_DT - RSRV_END_DT)
Note: Includes any setup/takedown/pre/post times.
The value is expressed in terms of the number of days. One and a half days is 1.5. and six hours is 0.25.
EventDuration
Event duration, expressed as a numeral
(EV_END_DT - EV_START_DT)
Note: The value is expressed in terms of the number of days.
SetupDuration
Setup duration, expressed as a numeral
Note: The value is expressed in terms of the number of days.
PreEventTime
Pre-event duration, expressed as a numeral
Note: The value is expressed in terms of the number of days.
PostEventTime
Post-event duration, expressed as a numeral
Note: The value is expressed in terms of the number of days.
OccurrenceNumber
Which one in a number of repeating occurrences, expressed as an integer
FirstOccurrence
1 if processing the first occurrence, 0 otherwise
TakedownDuration
Takedown duration, expressed as a numeral
Note: The value is expressed in terms of the number of days.
OccurrenceDays
Number of days, or part of, in this occurrence
Note: Equivalent to OccurrenceDuration rounded up to the next whole number
For example:
a six hour event = 1
4 p.m. Fri - 2 p.m. Sat = 1
4 p.m. Fri- 6 p.m. Sat = 2
OccurrenceDuration
Length of the occurrence in days
Equal to ReservationDuration.
Note: Used to break occurrences into blocks of less than 24 hours
For example:
an event longer than 2 hours = OccurrenceDuration > 2 / 24
an event of 4 hours = OccurrenceDuration = 4 / 24
OccurrenceHours
Number of hours, or part of, in this occurrence
Note: Equivalent to (OccurrenceDuration * 24) rounded up to the next whole number
OccurrenceMinutes
Number of minutes in this occurrence
Note: Equivalent to (OccurrenceDuration * 1440)
OccurrenceNights
Number of midnights spanned by the occurrence, or 1 if doesn't span midnight
Note: Fri 6 p.m. - Sun 10 a.m. = 2
9 a.m. - 11 p.m. (same day) = 1
OccurrencePartDays
Number of days, or part of, that fall within the current breakpoint
OccurrencePartHours
Number of hours, or part of, that fall within the current breakpoint
For example:
Wed 9 a.m. - 2 p.m. OccurrenceHours = 5
for 0-3h, OccurrencePartHours = 3
for 4-8h, OccurrencePartHours = 2
for 0-10h, OccurrencePartHours = 5
OccurrencePartMinutes
Number of minutes, or part of, that fall within the current breakpoint
OccurrencePartDuration
Duration (in days) of the portion of the occurrence that falls within the current breakpoint
OccPartSunDuration, OccPartMonDuration, OccPartTueDuration, OccPartWedDuration, OccPartThuDuration, OccPartFriDuration, OccPartSatDuration
Durations of those portions of the occurrence that occur on the indicated days within this breakpoint
Note: These variables reflect just the portion of an occurrence that falls in the breakpoint period.
OccPartSunDays,
OccPartMonDays, OccPartTueDays,
OccPartWedDays,
OccPartThuDays,
OccPartFriDays,
OccPartSatDays
The total number of each day within the current breakpoint
Note: These variables reflect just the portion of an occurrence that falls in the breakpoint period.
OccPartSunHours,
OccPartMonHours, OccPartTueHours, OccPartWedHours, OccPartThuHours,
OccPartFriHours,
OccPartSatHours
The total number of hours on each day within the current breakpoint
OccPartSunMinutes,
OccPartMonMinutes, OccPartTueMinutes, OccPartWedMinutes, OccPartThuMinutes,
OccPartFriMinutes,
OccPartSatMinutes
The total number of minutes on each day within the current breakpoint
OnSun, OnMon, OnTue, OnWed, OnThu, OnFri, OnSat
Number of times the occurrence occurs on that day
Note: Several days could be set to 1 if the occurrence spans multiple days.
If the occurrence spans several weeks, each day is counted.
For example:
Mon the 3rd - Tue the 11th, OnMon=2, OnTue=2, OnWed=1
These variables reflect just the portion of an occurrence that falls in the breakpoint period.
In00Hour, In01Hour, .. In12Hour, In13Hour, .. In23Hour
Number of times the occurrence occurs in that hour
Note: Several hours could be set to 1 if the occurrence spans multiple hours.
If the occurrence spans multiple days, each hour is counted.
For example:
Mon 10:30 a.m. - 2:45 p.m.
In10Hour=1, ... In14Hour=1
These variables reflect just the portion of an occurrence that falls in the breakpoint period. Note that the variables use military time.
In01stHour, In02ndHour, In03rdHour...In21stHour, In22ndHour, In23rdHour
Note military time.
Indicator if the occurrence occurs in a part of that hour, relative to the occurrence start
Note: If the occurrence spans multiple days, the second day rolls over from 1 to 2, and so on. For example:
Monday 10:30 a.m. - 2:45 p.m.
In01stHour = 1
In02ndHour = 1
In03rdHour = 1
In04thHour = 1
In05thHour = 1
These variables reflect just the portion of an occurrence that falls in the breakpoint period.
Date/time variables
You can use these variables to compare dates and times, or to extract elements so that your formula determines whether an occurrence meets a certain condition, and is therefore priced a certain way. They can also be combined with date/time manipulation functions, such as conversion functions and extraction codes. Instead of returning an integer, these variables return a date or time.
For example, to determine if a reservation starts on Christmas Day (Dec. 25), you would specify the condition:
RsrvStartDate[M] = 12 & RsrvStartDate[D] = 25 ?
 
Variable Name
Description
RsrvStartDateTime
RsrvStartDate
RsrvStartTime
Use to specify the reservation start date, start time, or both
RsrvEndDateTime
RsrvEndDate
RsrvEndTime
Use to specify either the reservation ending date, ending time, or both
 
EventStartDateTime
EventStartDate
EventStartTime
Use to specify either the event start date, start time, or both
 
EventEndDateTime
EventEndDate
EventEndTime
Use to specify either the event ending date, ending time, or both
 
PreEventStartDateTime
PreEventStartDate
PreEventStartTime
Use to specify either the pre-event start date, start time, or both
 
PostEventEndDateTime
PostEventEndDate
PostEventEndTime
Use to specify either the post-event ending date, ending time, or both
 
OccStartDateTime
OccStartDate
OccStartTime
Use to specify either the occurrence start date, start time, or both
Note: An occurrence is defined as either an occurrence or an event, depending on how your system definition is set. The default is reservation.
OccEndDateTime
OccEndDate
OccEndTime
Use to specify either the occurrence ending date, ending time, or both
Note: An occurrence is defined as either an occurrence or an event, depending on how your system definition is set. The default is reservation.