Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

$$WORKPLUS^XUWORKDY: Workday Offset Calculation

NOTE: 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.

The $$WORKPLUS^XUWORKDY extrinsic function returns the date that is n working days (i.e., offset) +/- of the input date. If the date is imprecisely specified, or if the HOLIDAY global is empty, then $$WORKPLUS^XUWORKDY returns a NULL string.

Format

  $$WORKPLUS^XUWORKDY(date,offset)

Input Parameters

date: (required) Date in VA FileMan internal format (e.g., 2850420).
offset: (required) The number of days to offset.

Output

returns:

Returns the VA FileMan internal date that is n working days (i.e., offset) +/- of the input date.

Example

>W $$WORKPLUS^XUWORKDY(3090108,3)
3090113