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. In a portal, this parameter is ignored.

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

Autoscaled process models and application performance

Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

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	Compatible
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
Process Autoscaling	Partially compatible	Using this function in a process model with autoscale enabled may result in degraded site or application performance.

Feedback