{"id":10275,"date":"2016-02-25T15:40:17","date_gmt":"2016-02-25T07:40:17","guid":{"rendered":"http:\/\/localhost\/help\/p2-server\/calculations\/time-periods\/calendar-periods\/"},"modified":"2024-07-04T16:01:11","modified_gmt":"2024-07-04T08:01:11","slug":"calendar-periods","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/calculations\/time-periods\/calendar-periods\/","title":{"rendered":"Calendar Periods"},"content":{"rendered":"\n

Format<\/span><\/h2>\n

IFS OI Server provides functions for calculating the time of specific calendar periods. The functions all require the same parameters and are used in the same way, but produce a result relevant to the function.\u00a0<\/p>\n

Functions<\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n
Format<\/strong><\/td>\nReturns<\/strong><\/td>\n<\/tr>\n
CalendarDayStart(Time [,TimeZone])<\/strong><\/td>\nThe time of midnight on the morning of the day of the provided Time.<\/td>\n<\/tr>\n
CalendarMonthEnd(Time [,TimeZone])<\/strong><\/td>\nThe time of the end of the calendar month, which started on or before the provided Time. That is, 23:59:59<\/strong> on the last day.<\/td>\n<\/tr>\n
CalendarMonthStart(Time [,TimeZone])<\/strong><\/td>\nThe time of the start of the calendar month, occurring on or before the provided Time.<\/td>\n<\/tr>\n
CalendarWeekEnd(Time [,TimeZone])<\/strong><\/td>\nThe time of midnight on the morning of the first day of the week occurring after the provided Time.\u00a0That is, the end of the week which started on or before the provided Time.\u00a0Assumes that the week starts on the day specified by the data value.<\/td>\n<\/tr>\n
CalendarWeekEnd2(Time [,TimeZone])<\/strong><\/td>\nThe time of midnight on the Sunday morning occurring after the provided Time.\u00a0That is, the end of the calendar week which started on or before the provided Time, assuming Sunday is the first day of the week.<\/td>\n<\/tr>\n
CalendarWeekStart(Time [,TimeZone])<\/strong><\/td>\nThe time of midnight on the morning of the first day of the week occurring on or before the provided Time.\u00a0Assumes that the week starts on the day specified by the data value.<\/td>\n<\/tr>\n
CalendarWeekStart2(Time [,TimeZone])<\/strong><\/td>\nThe time of midnight on the Sunday morning occurring on or before the provided Time.\u00a0That is, the start of the calendar week, assuming Sunday is the first day of the week.<\/td>\n<\/tr>\n
DaysInMonth(Time [,TimeZone])<\/strong><\/td>\nThe number of days in the month of the provided Time<\/em>.\u00a0<\/td>\n<\/tr>\n
Midnight(Time [,TimeZone])<\/strong><\/td>\nThe time of the midnight occurring on or before the provided Time<\/em>.\u00a0That is, the start of the day.\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Inputs<\/span><\/h2>\n

Time<\/strong>: The time from which to calculate the start of the calendar period.
\nBehaviour: Required
\nDimension: Collection, SingleValue, MultiCollection
\nValid data types: DateTime, Decimal, Integer, String<\/p>\n

Note: You can use the Time<\/a>() function to use a valid DateTime argument.<\/p>\n

TimeZone<\/strong>: The geographical or UTC offset\u00a0time zone (e.g. \"Australia\/Perth\" or \"UTC+08:00\"). If not supplied, it assumes the configured calendar time zone.\u00a0
\nBehaviour:\u00a0Optional
\nDimension: SingleValue
\nValid data types: String<\/p>\n

How to format data types<\/a><\/p>\n

Examples<\/span><\/h2>\n

Expression: Midnight({utc'2017-06-13 18:29'}, \"Australia\/Perth\")<\/span>
\nResult: 14\/06\/2017 12:00 AM<\/span><\/p>\n

Expression: Midnight(Time(), \"Australia\/Perth\")<\/span>
\nResult: The time at midnight in the specified time zone.
\nE.g. 14\/06\/2017 12:00 AM<\/span><\/p>\n

Release History<\/span><\/h2>\n