calworkhours() Function

Function

calworkhours( start_datetime, end_datetime, calendar_name )

This returns the actual number of work hours between two given Date and Times (both inclusive), according to the calendar defined for the system.

Parameters

Keyword	Type	Description
start_datetime	Date and Time	The starting Date and Time.
end_datetime	Date and Time	The ending Date and Time.
calendar_name	Text	This optional parameter accepts the name of a system calendar; otherwise, the default calendar is used.

Returns

Integer

Usage considerations

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

See also: Process Calendar Settings

Examples

calworkhours(datetime(2011,12,20,12,0,0),datetime(2011,12,21,12,0,0)) returns 8

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Incompatible
Offline Mobile	Incompatible
Sync-Time Custom Record Fields	Compatible	Can be used to create a custom record field that only evaluates at sync time.
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Compatible
Process Events	Compatible

Feedback