1. Calculation functions
  2. All Functions
  3. Time and Date Functions
  4. INPERIOD

Tests whether a date falls within the period specified on the time dimension or falls within a time period (result is Boolean-formatted).

  • Single date parameter - Returns TRUE, if the date falls in the time period with reference to the timescale, otherwise FALSE.
  • Date and time period parameter - Returns TRUE, if the date falls in the time period, otherwise FALSE.

Syntax

INPERIOD(x)

where:

  • x: date to test.
INPERIOD(x,y)

where:

  • x: Date to test
  • y: (optional) Time period to use as range

Back to Top

Format

Input Format Output Format

x: date parameter

y: time period

Boolean

Arguments

The function uses the following arguments:

INPERIOD(x)
  • x: time period: date-formatted line item
INPERIOD(x,y)
  • x: time period: date-formatted line item
  • y: time period: time period-formatted line item or hard-coded time period

Constraints

The function has the following constraints:

  • First parameter must be date-formatted.
  • Second parameter must be time period-formatted or hard-coded making reference to the timescale.
  • Result must be Boolean-formatted.
  • If time period is blank, returns FALSE.

Excel equivalent

  • No Excel equivalent

Back to Top

Example

  • The module is set up with the Time dimension as columns; The rows are the Product Launch Date 2014, configured as March 25 2014 using a single date-formatted parameter, and the Date In Month as a Boolean check box.
  • The Date in Month row has the formula below. The module month containing the launch date is indicated by a marked check box.
INPERIOD('Product Launch Date 2014')

Line item Date in Month formula is:

TRUE = INPERIOD(Date, Month Period) 

where result is Boolean-formatted, Date line item is date-formatted with Feb 12 2015 selected, and Month Period is time period-formatted for months with Feb 15 selected:

Line item Is in Period formula is:

INPERIOD(Date, Month Period)

FALSE = INPERIOD(Date, Month Period) 

where result is Boolean-formatted, Date line item is date-formatted with Jun 3 2015 selected, and Month Period is time period-formatted for months with Apr 15 selected:

Line item Is in Period Abs formula is

TRUE = INPERIOD(Date, TIME.'Jun 15') 

where result Is in Period Abs is Boolean-formatted, Date line item is date-formatted with Jun 15 selected, and timescale includes Jun 15:

Back to Top

Similar functions