Kernel APIs: ^XUWORKDY (Obsolete)

^XUWORKDY: Workday Calculation (Obsolete)

NOTE: Calling the XUWORKDY routine from the top is obsolete. The ^XUWORKDY API was replaced by the $$EN^XUWORKDY API. This API is dependent on the HOLIDAY (#40.5) file being updated by the sites.

Reference Type: Supported, Category: Miscellaneous, ICR#: 10046

Description

To use the ^XUWORKDY APIs, you must make sure that the HOLIDAY (#40.5) file is populated with each year's holidays for the workday calculation to work correctly. If it is not populated, you need to populate it yourself (Kernel distributes this file without data). Only enter holidays that fall on weekdays, however.

You can call the ^XUWORKDY routine to calculate the number of workdays between two dates (X, X1). It returns a positive value if X<X1 and a negative value if X>X1. If either date is imprecisely specified, or if the HOLIDAY global is empty, then ^XUWORKDY returns a NULL string.

The first FOR loop in ^XUWORKDY checks the HOLIDAY global and sets %H equal to the number of holidays between the two dates. It is assumed that the HOLIDAY global contains only weekday holidays.
The second FOR loop (F %J=%J:1 ... ) steps forward from the earliest date and stops at the first Sunday or at the ending date (whichever comes first) counting the number of workdays.
The third FOR loop (F %K=%K:-1 ... ) steps backward from the latest date and stops at the first Sunday or at the beginning date (whichever comes first), counting the workdays.
Then %I is set equal to the number of days between the two Sundays.
Finally, X is set equal to the total counted days minus the number of weekend days between the two Sundays ( -(%I\7*2) ).

Format

  ^XUWORKDY

Input Variables

X:	(required) Starting date in VA FileMan internal format (e.g., 2850420).
X1:	(required) Ending date in VA FileMan internal format (e.g., 2850707).

Output Variables

X:	The number of workdays in the interval.

Example

>S X=2850420,X1=2850707 D ^XUWORKDY W X
55