caladddays() Function

Function

caladddays( start_datetime, number, calendar_name )

This function adds a given number of working days as designated on the process calendar to a Date and Time value, and returns a Date and Time value that falls within the work time defined in the process calendar.

Parameters

Keyword Type Description

start\_datetime

Date and Time

The starting Date and Time.

number

Integer

The number of net working days to be added to the Date and Time.

calendar\_name

Text

This optional parameter accepts the name of a system calendar; otherwise, the default calendar is used.

Returns

Date and Time

Usage considerations

This function correctly calculates results across daylight saving time boundaries.

When you pass a non-working day as the start_datetime it adds the desired number of days to the next working day defined on the calendar. Previously, the function would return the next working day, when one day was added to the start_datetime.

Passing a date value casts the parameter to a Date and Time with the value of 12:00 AM GMT for that date.

The number parameter is limited to one-year's worth of working days (263 days with a default working time setting in the process calendar). The maximum parameter value is 365.

Passing a calendar name allows you to calculate working days using an alternate system calendar, if you have multiple calendars configured.

See also: Process Calendar Settings

Examples

caladddays(datetime(2011,12,13,12,0,0),0) returns 12/13/2011 12:00 PM GMT +00:00

In this example, a Date and Time that falls into non-working time is adjusted to the next working time on the process calendar.

Open in Github Built: Wed, Aug 16, 2023 (04:37:39 PM)

On This Page

FEEDBACK