XUWORKDY ICR (10046)

Name

Value

NUMBER

10046

IA #

10046

DATE CREATED

2018/04/05

CUSTODIAL PACKAGE

KERNEL

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XUWORKDY

NAME

XUWORKDY

ORIGINAL NUMBER

10046

GENERAL DESCRIPTION

Several extrinsic functions for workdays.  To use any
of the XUWORKDY extrinsic functions, you must make sure that the HOLIDAY file
(#40.5) is populated with each year's holidays.  This file is distributed
without data.  Only enter holidays that fall on weekdays.

STATUS

Active

KEYWORDS

WORKDAY

DURATION

Till Otherwise Agreed

XUWORKDY

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$EN

Extrinsic function that calculates the number of
workdays between two given dates (date1, date2).  It returns a positive value
if date1<date2 and a negative value if date1>date2.

VARIABLES	TYPE	VARIABLES DESCRIPTION
date1	Input	Starting date in VA FileMan internal format (e.g. 3180405).
date2	Input	Ending date in VA FileMan internal format (e.g. 3180412).
return	Output	Returns the number of workdays in the interval.

$$WORKDAY

Extrinsic function that checks the given date is a
workday.  Returns 1 if true and 0 if false.

VARIABLES	TYPE	VARIABLES DESCRIPTION
date	Input	Date to check in VA FileMan internal format (e.g. 3180412).
return	Output	Returns 1 if date is a workday and 0 if date is not a workday.

$$WORKPLUS

Extrinsic function that returns the date that is the
number of working days (offset) from the given date.  The offset can be a
positive or negative number.

VARIABLES

TYPE

VARIABLES DESCRIPTION

date

Input

Starting date in VA FileMan internal format (e.g.
3180412).

offset

Input

The number of days to offset.  If a positive number,
will search forward in time.  If a negative number, will search in the past.

return

Output

Returns the date in VA FileMan internal format.

XUWORKDY

Calling the routine XUWORKDY from the top is
obsolete.  The extrinsic function, $$EN^XUWORKDY(date1,date2), replaces this
call.
DATE ACTIVATED: APR 09, 2018