WolffPack Differences Report

*S*************************************************************************

*S***

*S*** WolffPack

*S***

*S*** Subprogram: WWEDITRN

*S*** System : FINANCIER

*S*** Title : Edit routine

*S*** Function : This subprogram browses the WW-DICTIONARY file

*S*** to verify valid values and/or ranges.

*S*** It also verifies that modified data conforms to

*S*** edit masks.

*S***

*S*************************************************************************

*S**DEFINE DATA

*S** GLOBAL USING WWGDA

*S** PARAMETER USING WWPDA /* Valid Value array

*S** PARAMETER USING WWVALLDA /* Valid Value array

*S***

*S** LOCAL USING WWDICTOD /* Passed to Object Subprogram WWDICTOO

*S** LOCAL USING WWDICTOR /* Passed to Object Subprogram WWDICTOO

*S** LOCAL USING WWEXTRID /* Passed to Object Subprogram WWEXTRIO

*S** LOCAL USING WWEXTRIR /* Passed to Object Subprogram WWEXTRIO

*S** LOCAL USING WWSTDNCD /* Passed to Object Subprogram WWSTDNCO

*S** LOCAL USING WWSTDNCR /* Passed to Object Subprogram WWSTDNCO

*S** LOCAL USING WFFUNDSD /* Passed to Object Subprogram WFFUNDSO

*S** LOCAL USING WFFUNDSR /* Passed to Object Subprogram WFFUNDSO

*S** LOCAL USING WWAOBJ /* Passed to Object Subprograms

*S***

*S** LOCAL USING WWCONST /* Constants LDA

*S** LOCAL USING WWDIALDA /* Used by dialog objects

*S** LOCAL USING WWFXREFD /* File/PDA Cross-Reference

*S** LOCAL

*S***

*S*** Miscellaneous variables.

*S** 01 #HEADER-REC(L)

*S** 01 #WITHIN-RANGE(L)

*S** 01 #ARRAY-LOADED(L)

*S** 01 #DICT-LOOKUP(L)

*S** 01 #EXT-LOOKUP(L)

*S***

*S** 01 #EXT-TYPE(A1)

*S** 01 #TEMP-VAR-IN(A15)

*S** 01 #TEMP-VAR-OUT(A15)

*S** 01 #MASK-VAR(A15)

*S** 01 #MASK-VAR-RIGHT(A15)

*S** 01 #DATA-VAR(A15)

*S** 01 #DATA-VAR-RIGHT(A15)

*S** 01 REDEFINE #DATA-VAR-RIGHT

*S** 02 #DATA-NUM-RIGHT(N15)

*S** 01 #DECIMAL-19(A19)

*S** 01 #DECIMAL-20(A20)

*S** 01 #EXTRA(A19)

*S** 01 #MASK-DEC-LEN(N2)

*S** 01 #DATA-DEC-LEN(N2)

*S** 01 #NUMERIC-MASK(L)

*S** 01 #PHONE-MASK(L)

*S** 01 #SSN-MASK(L)

*S** 01 #NEGATIVE-MASK(L)

*S** 01 #NEGATIVE-DATA(L)

*S** 01 #DECIMAL-MASK(L)

*S** 01 #DECIMAL-DATA(L)

*S** 01 #K(P3)

*S** 01 #L(P3)

*S** 01 #D(P3)

*S** 01 #M(P3)

*S** 01 #N(P3)

*S** 01 #P(P3)

*S** 01 #VALUE-1(A1)

*S** 01 #VALUE-2(A2)

*S** 01 #VALUE-3(A3)

*S** 01 #VALUE-4(A4)

*S** 01 #VALUE-5(A5)

*S** 01 #VALUE-6(A6)

*S** 01 #VALUE-7(A7)

*S** 01 #VALUE-8(A8)

*S** 01 #VALUE-9(A9)

*S** 01 #VALUE-10(A10)

*S** 01 #VALUE-11(A11)

*S** 01 #VALUE-12(A12)

*S** 01 #ASTERISK(P3)

*S** 01 #PERIOD(P3)

*S** 01 #CENTURY-BREAK(A2) INIT<'20'>

*S** 01 #DATE(A6)

*S** 01 REDEFINE #DATE

*S** 02 #DATE-A(A2)

*S** 02 #DATE-B(A2)

*S** 02 #DATE-C(A2)

*S** 01 #FIELD-FORMAT(A1)

*S** 01 #FIELD-LENGTH(N2)

*S** 01 #HOLD-FIELDS

*S** 02 #HOLD-FILE(A8)

*S** 02 #HOLD-FIELD(A20)

*S** 02 #HOLD-SAR(A3)

*S** 02 #HOLD-DSL(A3)

*S** 02 #HOLD-DPL(A3)

*S** 02 #HOLD-FED-VAL(A5)

*S** 02 #HOLD-UTILS

*S** 03 WW-UTIL-1(A1)

*S** 03 WW-UTIL-2(A1)

*S** 03 WW-UTIL-3(A1)

*S** 03 WW-UTIL-4(A1)

*S** 03 WW-UTIL-5(A1)

*S** 03 WW-UTIL-6(A1)

*S** 02 REDEFINE #HOLD-UTILS

*S** 03 #HOLD-UTIL(A1/6)

*S***

*S** 01 #VE-SUB(P3)

*S** 01 #VALUE-EMAIL(A50)

*S** 01 REDEFINE #VALUE-EMAIL

*S** 02 #VE(A1/50)

*S** 01 #COUNT-EMAIL(N2)

*S**END-DEFINE

*S***

*S*** Define Formats

*S**FORMAT KD=OFF

*S***

*S**PERFORM INITIALIZATIONS

*S***

*S*************************************************************************

*S***

*S**RESET INITIAL #VALID-VALUE #VALID-MASK #WITHIN-RANGE #BLANK-NUMERIC

*S***

*S**PERFORM MASK-VALIDATION

*S**IF #VALID-MASK /* Passed mask validation,

*S** PERFORM VALUE-VALIDATION /* perform value validation

*S**END-IF

*S***

*S**IF #MARK-FIELD = 0 /* Set first field in error

*S** IF NOT #VALID-VALUE OR /* to be used by MARK option

*S** NOT #VALID-MASK

*S** ASSIGN #MARK-FIELD = #FIELD-POS

*S** END-IF

*S**END-IF

*S***

*S**IF #VALID-VALUE AND /* If all edits passed, load

*S** #VALID-MASK /* Utility updates array

*S** PERFORM LOAD-UTIL-ARRAY

*S**END-IF

*S***

*S**MOVE BY POSITION WW-GDA TO WW-PDA

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE CALL-OBJECT

*S*************************************************************************

*S***

*S*** Call WW-DICTIONARY Object subprogram

*S** CALLNAT 'WWDICTOO' WW-GDA

*S** WWDICTOD

*S** WWDICTOD-ID

*S** WWDICTOR

*S** WWAOBJ

*S***

*S**END-SUBROUTINE /* CALL-OBJECT

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE CHECK-EXTERNAL-FILE

*S*************************************************************************

*S** /*

*S** /* Hard coded 'fields' with valid values contained in the

*S** /* WW-EXTERNAL file instead of the WW-DICTIONARY file

*S** PERFORM DETERMINE-DICT-LOOKUP WWDICTOD.WW-FILE

*S** WWDICTOD.WW-FIELD #DICT-LOOKUP #EXT-TYPE

*S** /*

*S** IF #DICT-LOOKUP

*S** /*

*S** /* Use WW-DICTIONARY value-validation

*S** ESCAPE ROUTINE

*S** END-IF

*S** /*

*S** DECIDE ON FIRST VALUE OF #EXT-TYPE

*S** VALUE 'D', 'E', 'G', 'I', 'L', 'O', 'P'

*S** /*

*S** /* D Fund donor

*S** /* E On-campus employer

*S** /* G Guarantee agency

*S** /* I Institution

*S** /* L Lender

*S** /* O Off-campus employer

*S** /* P Parent

*S** ASSIGN WWAOBJ.#FUNCTION = 'EXISTS'

*S** ASSIGN WWEXTRID.WW-EXTERNAL-ID = #VALUE

*S** ASSIGN WWEXTRID.WF-FAO = ##FAO-ID

*S** ASSIGN WWEXTRID.WW-RECORD-TYPE = #EXT-TYPE

*S** /*

*S** /* Call WW-EXTERNAL Object subprogram

*S** CALLNAT 'WWEXTRIO' WW-GDA

*S** WWEXTRID

*S** WWEXTRID-ID

*S** WWEXTRIR

*S** WWAOBJ

*S** VALUE 'S'

*S** /*

*S** /* S Student

*S** ASSIGN WWAOBJ.#FUNCTION = 'EXISTS'

*S** ASSIGN WWSTDNCD.WW-STUDENT-ID = #VALUE

*S** ASSIGN WWSTDNCD.WF-FAO = ##FAO-ID

*S** /*

*S** /* Call WW-STUDENT-CMP Object subprogram

*S** CALLNAT 'WWSTDNCO' WW-GDA

*S** WWSTDNCD

*S** WWSTDNCD-ID

*S** WWSTDNCR

*S** WWAOBJ

*S** VALUE 'F'

*S** /*

*S** /* F Fund

*S** ASSIGN WWAOBJ.#FUNCTION = 'EXISTS'

*S** ASSIGN WFFUNDSD.WF-FUND-ID = #VALUE

*S** ASSIGN WFFUNDSD.WF-FAO = ##FAO-ID

*S** ASSIGN WFFUNDSD.WW-FISCAL-YEAR = ##FISCAL-YEAR

*S** /*

*S** /* Call WW-FUND Object subprogram

*S** CALLNAT 'WFFUNDSO' WW-GDA

*S** WFFUNDSD

*S** WFFUNDSD-ID

*S** WFFUNDSR

*S** WWAOBJ

*S** NONE

*S** ASSIGN #FAIL-EDIT = TRUE

*S** END-DECIDE

*S** /*

*S** IF WWAOBJ.#EXISTS

*S** ASSIGN #VALID-VALUE = TRUE

*S** ELSE

*S** IF #VALUE = SPACE

*S** ASSIGN #VALID-VALUE = TRUE /* Allow spaces

*S** ELSE

*S** ASSIGN #FAIL-EDIT = TRUE

*S** END-IF

*S**END-SUBROUTINE /* CHECK-EXTERNAL-FILE

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE DATE-VERF

*S*************************************************************************

*S***

*S** EXAMINE #MASK-VAR 'M' GIVING POSITION #M

*S** EXAMINE #DATA-VAR 'Y' GIVING LENGTH #L

*S** EXAMINE #MASK-VAR 'Y' GIVING NUMBER #N

*S** EXAMINE #MASK-VAR 'Y' GIVING POSITION #P

*S** EXAMINE #MASK-VAR 'D' GIVING POSITION #D

*S** IF #M = 0 /* Mask passed is not date

*S** ESCAPE ROUTINE

*S** END-IF

*S** IF #DATA-VAR = SPACE /* Date blanked out

*S** DECIDE FOR FIRST CONDITION

*S** WHEN #MASK-VAR = 'MM/DD/YYYY' OR = 'MMDDYYYY'

*S** MOVE EDITED INIT-DATE(EM=MMDDYYYY) TO #DATA-VAR

*S** WHEN #MASK-VAR = 'YYYY/MM/DD' OR = 'YYYYMMDD'

*S** MOVE EDITED INIT-DATE(EM=YYYYMMDD) TO #DATA-VAR

*S** WHEN #MASK-VAR = 'MM/YYYY' OR = 'MMYYYY'

*S** MOVE EDITED INIT-DATE(EM=MMYYYY) TO #DATA-VAR

*S** WHEN #MASK-VAR = 'YYYY/MM' OR = 'YYYYMM'

*S** MOVE EDITED INIT-DATE(EM=YYYYMM) TO #DATA-VAR

*S** WHEN ANY

*S** MOVE LEFT #DATA-VAR TO #VALUE-MASK

*S** WHEN NONE

*S** IGNORE

*S** END-DECIDE

*S** ESCAPE ROUTINE

*S** END-IF

*S** IF #D = 0 /* Mask doesn't use days

*S** /*

*S** IF #L = 3 /* Input is only 3 bytes,

*S** /* assume month is

*S** /* zero suppressed

*S** /*

*S** IF #M = 1 /* Mask is MMyyyy or MMyy

*S** COMPRESS '0' #DATA-VAR INTO #DATA-VAR LEAVING NO

*S** ELSE /* Assume yyyyMM or yyMM

*S** MOVE #DATA-VAR TO #DATE

*S** MOVE SUBSTRING(#DATE,3,1) TO SUBSTRING(#DATE,4,1)

*S** MOVE '0' TO SUBSTRING(#DATE-B,1,1)

*S** MOVE #DATE TO #DATA-VAR

*S** END-IF

*S** ASSIGN #L = 4 /* Set length to 4 bytes

*S** END-IF

*S** IF #L = 5 /* Input is only 5 bytes,

*S** /* assume month is

*S** /* zero suppressed

*S** /*

*S** IF #M = 1 /* Mask is mmyyyy or mmyy

*S** COMPRESS '0' #DATA-VAR INTO #DATA-VAR LEAVING NO

*S** ELSE /* Assume yyyymm or yymm

*S** MOVE #DATA-VAR TO #DATE

*S** MOVE SUBSTRING(#DATE,5,1) TO SUBSTRING(#DATE,6,1)

*S** MOVE '0' TO SUBSTRING(#DATE-C,1,1)

*S** MOVE #DATE TO #DATA-VAR

*S** END-IF

*S** IF #N = 4 AND #L = 4 /* Mask uses century, but

*S** /* input isn't long enough

*S** /* for century (6 bytes)

*S** /*

*S** IF #P = 1 /* Mask is yyyymm

*S** MOVE SUBSTRING(#DATA-VAR,1,2) TO #DATE-A

*S** IF #DATE-A > #CENTURY-BREAK

*S** COMPRESS '19' #DATA-VAR INTO #DATA-VAR LEAVING NO

*S** ELSE

*S** COMPRESS '20' #DATA-VAR INTO #DATA-VAR LEAVING NO

*S** END-IF

*S** ELSE /* Assume mmYYYY

*S** MOVE #DATA-VAR TO #DATE

*S** IF #DATE-B > #CENTURY-BREAK

*S** COMPRESS #DATE-A '19' #DATE-B

*S** INTO #DATA-VAR LEAVING NO

*S** ELSE

*S** COMPRESS #DATE-A '20' #DATE-B

*S** INTO #DATA-VAR LEAVING NO

*S** END-IF

*S** ELSE /* Days used in mask

*S** /*

*S** IF #L = 4 /* Input is only 4 bytes,

*S** /* assume month and day

*S** /* are zero suppressed

*S** /*

*S** IF #M = 1 /* Mask mmddyyyy or mmddyy

*S** MOVE RIGHT JUSTIFIED #DATA-VAR TO #DATE

*S** MOVE '0' TO SUBSTRING(#DATE-A,1,1)

*S** MOVE SUBSTRING(#DATE,3,1) TO SUBSTRING(#DATE,2,1)

*S** MOVE '0' TO SUBSTRING(#DATE-B,1,1)

*S** MOVE #DATE TO #DATA-VAR

*S** ELSE /* Assume yyyymmdd or yymmdd

*S** MOVE #DATA-VAR TO #DATE

*S** MOVE SUBSTRING(#DATE,3,2) TO SUBSTRING(#DATE,5,2)

*S** MOVE SUBSTRING(#DATE,2,1) TO SUBSTRING(#DATE,4,1)

*S** MOVE '0' TO SUBSTRING(#DATE-A,1,1)

*S** MOVE '0' TO SUBSTRING(#DATE-B,1,1)

*S** MOVE #DATE TO #DATA-VAR

*S** END-IF

*S** EXAMINE #MASK-VAR 'Y' GIVING NUMBER #N

*S** EXAMINE #MASK-VAR 'Y' GIVING POSITION #P

*S** EXAMINE #MASK-VAR 'M' GIVING POSITION #M

*S** EXAMINE #DATA-VAR 'Y' GIVING LENGTH #L

*S** IF #N = 4 AND #L = 6 /* Mask uses century, but

*S** /* input isn't long enough

*S** /* for century (8 bytes)

*S** /*

*S** IF #P = 1 /* Mask is yyyymmdd

*S** MOVE SUBSTRING(#DATA-VAR,1,2) TO #DATE-A

*S** IF #DATE-A > #CENTURY-BREAK

*S** COMPRESS '19' #DATA-VAR INTO #DATA-VAR LEAVING NO

*S** ELSE

*S** COMPRESS '20' #DATA-VAR INTO #DATA-VAR LEAVING NO

*S** END-IF

*S** ELSE /* Assume mmddyyyy

*S** MOVE #DATA-VAR TO #DATE

*S** IF #DATE-C > #CENTURY-BREAK

*S** COMPRESS #DATE-A #DATE-B '19' #DATE-C

*S** INTO #DATA-VAR LEAVING NO

*S** ELSE

*S** COMPRESS #DATE-A #DATE-B '20' #DATE-C

*S** INTO #DATA-VAR LEAVING NO

*S** END-IF

*S** /*

*S** /* Verify century is only 19 or 20

*S** /* (Prevents Natural runtime error)

*S** EXAMINE SUBSTRING(#DATA-VAR,#P,2) FOR '19' GIVING NUMBER #L

*S** EXAMINE SUBSTRING(#DATA-VAR,#P,2) FOR '20' GIVING NUMBER #N

*S** IF #L = 0 AND

*S** #N = 0

*S** ASSIGN #FAIL-EDIT = TRUE

*S** END-IF

*S** IF NOT #FAIL-EDIT

*S** MOVE LEFT #DATA-VAR TO #VALUE-MASK

*S** END-IF

*S**END-SUBROUTINE /* DATE-VERF

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE HOLD-FLDS

*S*************************************************************************

*S***

*S** IF WWDICTOD.WW-SAR-FIELD-NO = '***'

*S** DECIDE FOR EVERY CONDITION

*S** WHEN ##AID-YEAR GE WW-SAR-YEAR-1 AND

*S** WW-SAR-YEAR-1 NE SPACE

*S** ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-1

*S** WHEN ##AID-YEAR GE WW-SAR-YEAR-2 AND

*S** WW-SAR-YEAR-2 NE SPACE

*S** ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-2

*S** WHEN ##AID-YEAR GE WW-SAR-YEAR-3 AND

*S** WW-SAR-YEAR-3 NE SPACE

*S** ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-3

*S** WHEN ##AID-YEAR GE WW-SAR-YEAR-4 AND

*S** WW-SAR-YEAR-4 NE SPACE

*S** ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-4

*S** WHEN NONE

*S** ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO

*S** END-DECIDE

*S** ELSE

*S** ASSIGN #HOLD-SAR = WWDICTOD.WW-SAR-FIELD-NO

*S** END-IF

*S** ASSIGN #HOLD-DSL = WWDICTOD.WW-DSL-FIELD-NO

*S** ASSIGN #HOLD-DPL = WWDICTOD.WW-DPL-FIELD-NO

*S** MOVE BY NAME WWDICTOD.WW-FIELD-UTILITIES TO

*S** #HOLD-UTILS

*S** ASSIGN #FIELD-FORMAT = WWDICTOD.WW-FORMAT

*S** ASSIGN #FIELD-LENGTH = WWDICTOD.WW-LENGTH

*S*** MOVE WWDICTOD.WW-FIELD TO #HOLD-FIELD

*S***

*S**END-SUBROUTINE /* HOLD-FLDS

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE INITIALIZATIONS

*S*************************************************************************

*S***

*S*** Populate WW-GDA from WW-PDA

*S**MOVE BY POSITION WW-PDA TO WW-GDA

*S***

*S*** Get File/PDA cross-reference

*S**PERFORM FILE-XREF-LOAD WWFXREFD

*S***

*S** EXAMINE WWVALLDA.#FILE-FIELD FOR '.' GIVING NUMBER #PERIOD

*S** IF #PERIOD > 0

*S** SEPARATE WWVALLDA.#FILE-FIELD INTO WWDICTOD.WW-FILE

*S** WWDICTOD.WW-FIELD WITH DELIMITER '.'

*S** ELSE

*S** MOVE WWVALLDA.#FILE-FIELD TO WWDICTOD.WW-FIELD

*S** EXAMINE WWVALLDA.#FILE-FIELD FOR '#' GIVING NUMBER #ASTERISK

*S** IF #ASTERISK = 2 /* GDA field

*S** EXAMINE WWDICTOD.WW-FIELD FOR '##' REPLACE WITH 'WW-GDA-'

*S** MOVE 'WWSYSVRD' TO WWDICTOD.WW-FILE

*S** ELSE

*S** IF #ASTERISK = 1 /* Program variable

*S** EXAMINE WWDICTOD.WW-FIELD FOR '#' REPLACE WITH 'WF-PGM-'

*S** MOVE 'WWSYSVRD' TO WWDICTOD.WW-FILE

*S** END-IF

*S** MOVE WWDICTOD.WW-FILE TO #HOLD-FILE

*S** MOVE WWDICTOD.WW-FIELD TO #HOLD-FIELD

*S** PERFORM TRANSLATE-USERVIEWS

*S**END-SUBROUTINE /* INITIALIZATIONS

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE LOAD-UTIL-ARRAY

*S*************************************************************************

*S***

*S** RESET #ARRAY-LOADED

*S** ASSIGN #N = 1

*S***

*S** REPEAT WHILE NOT #ARRAY-LOADED

*S** IF (#FILE(#N) = #HOLD-FILE AND #FIELD(#N) = #HOLD-FIELD) OR

*S** (#FILE(#N) = ' ' AND #FIELD(#N) = ' ')

*S** ASSIGN #SAR-FLD-NO(#N) = #HOLD-SAR /* Found match OR

*S** ASSIGN #DSL-FLD-NO(#N) = #HOLD-DSL /* not yet defined

*S** ASSIGN #DPL-FLD-NO(#N) = #HOLD-DPL

*S** ASSIGN #UTILITY-FLAG(#N,*) = #HOLD-UTIL(*)

*S** /*

*S** /* Load federal data from dictionary or,

*S** /* if correctable, numeric data

*S** /* (Allows #VALU to be masked in Z subroutines

*S** /* for auditing purposes)

*S** IF #HOLD-FED-VAL NE ' '

*S** ASSIGN #FEDERAL-VALUE(#N) = #HOLD-FED-VAL

*S** ELSE

*S** IF #NUMERIC-MASK AND

*S** (#HOLD-SAR NE ' ' OR

*S** #HOLD-DSL NE ' ' OR

*S** #HOLD-DPL NE ' ')

*S** ASSIGN #FEDERAL-VALUE(#N) = #VALUE

*S** IF #NEGATIVE-DATA

*S** COMPRESS #FEDERAL-VALUE(#N) '-' TO

*S** #FEDERAL-VALUE(#N) LEAVING NO

*S** END-IF

*S** IF #SSN-MASK

*S** ASSIGN #FEDERAL-VALUE(#N) = #VALUE

*S** RESET #SSN-MASK

*S** END-IF

*S** ASSIGN #VALU(#N) = #VALUE

*S** ASSIGN #VALU-SUB = #N

*S** ASSIGN #ARRAY-LOADED = TRUE

*S** IF #FILE(#N) = ' ' AND #FIELD(#N) = ' '

*S** ASSIGN #FILE(#N) = #HOLD-FILE

*S** ASSIGN #FIELD(#N) = #HOLD-FIELD

*S** END-IF

*S** ELSE

*S** IF #N > UTIL-UPDT-MAX

*S** ASSIGN ##MSG = 'Exceeded Utility Update maximum'

*S** END-IF

*S** ADD 1 TO #N

*S** END-REPEAT

*S***

*S**END-SUBROUTINE /* LOAD-UTIL-ARRAY

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE MASK-VALIDATION

*S*************************************************************************

*S***

*S** IF #EDIT-MASK = ' ' /* Check for edit mask definition

*S** ASSIGN #VALID-MASK = TRUE

*S** ESCAPE ROUTINE IMMEDIATE

*S** END-IF

*S*** /* Set up edit mask variable

*S** IF #EDIT-MASK = '(999)999-9999'

*S** ASSIGN #PHONE-MASK = TRUE

*S** END-IF

*S** MOVE #EDIT-MASK TO #TEMP-VAR-IN

*S** EXAMINE #TEMP-VAR-IN FOR '-' GIVING NUMBER #N

*S** IF #N > 0

*S** ASSIGN #NEGATIVE-MASK = TRUE

*S** END-IF

*S** EXAMINE #TEMP-VAR-IN FOR '.9' GIVING NUMBER #N

*S** IF #N > 0

*S** ASSIGN #DECIMAL-MASK = TRUE

*S** SEPARATE #TEMP-VAR-IN INTO #DECIMAL-19 #DECIMAL-20 WITH

*S** DELIMITER '.'

*S** EXAMINE #DECIMAL-20 FOR '9' GIVING NUMBER #MASK-DEC-LEN

*S** END-IF

*S** PERFORM SPECIAL-CHARACTERS

*S** EXAMINE #TEMP-VAR-OUT '9' REPLACE WITH 'N'

*S** EXAMINE #TEMP-VAR-OUT 'X' REPLACE WITH 'C'

*S** MOVE #TEMP-VAR-OUT TO #MASK-VAR

*S*** /* Set up data variable

*S** MOVE LEFT JUSTIFIED #VALUE TO #TEMP-VAR-IN

*S** EXAMINE #TEMP-VAR-IN FOR '.' GIVING NUMBER #N

*S** IF #N > 0

*S** ASSIGN #DECIMAL-DATA = TRUE

*S** SEPARATE #TEMP-VAR-IN INTO #DECIMAL-19 #DECIMAL-20 #EXTRA WITH

*S** DELIMITER '.'

*S** EXAMINE #DECIMAL-20 FOR '0' GIVING LENGTH #DATA-DEC-LEN

*S** EXAMINE #DECIMAL-20 FOR '-' GIVING NUMBER #N

*S** SUBTRACT #N FROM #DATA-DEC-LEN

*S** END-IF

*S** EXAMINE #TEMP-VAR-IN FOR '-' GIVING NUMBER #N

*S** IF #N > 0 AND

*S** NOT #PHONE-MASK

*S** ASSIGN #NEGATIVE-DATA = TRUE

*S** END-IF

*S***

*S*** Before stripping "/" out of dates, expand single-digit month and day

*S** EXAMINE #MASK-VAR 'M' GIVING NUMBER #M

*S** IF #M > 0

*S** IF SUBSTRING(#TEMP-VAR-IN,2,1) = '/' OR = '-'

*S** MOVE SUBSTRING(#TEMP-VAR-IN,1,14) TO #TEMP-VAR-OUT

*S** MOVE #TEMP-VAR-OUT TO SUBSTRING(#TEMP-VAR-IN,2,14)

*S** MOVE '0' TO SUBSTRING(#TEMP-VAR-IN,1,1)

*S** END-IF

*S** IF SUBSTRING(#TEMP-VAR-IN,5,1) = '/' OR = '-'

*S** MOVE SUBSTRING(#TEMP-VAR-IN,4,11) TO #TEMP-VAR-OUT

*S** MOVE #TEMP-VAR-OUT TO SUBSTRING(#TEMP-VAR-IN,5,11)

*S** MOVE '0' TO SUBSTRING(#TEMP-VAR-IN,4,1)

*S** END-IF

*S** PERFORM SPECIAL-CHARACTERS

*S** MOVE #TEMP-VAR-OUT TO #DATA-VAR

*S** PERFORM DATE-VERF

*S***

*S** PERFORM NUMERIC-VERF

*S***

*S** IF NOT #NUMERIC-MASK AND /* Alpha-numeric only

*S** NOT #FAIL-EDIT

*S** IF #EDIT-MASK = 'XXX-XX-XXXX'

*S** ASSIGN #SSN-MASK = TRUE

*S** END-IF

*S** IF NOT #SSN-MASK AND #DATA-VAR = SPACE

*S** ASSIGN #VALID-MASK = TRUE

*S** ELSE

*S** IF #DATA-VAR NOT = MASK #MASK-VAR

*S** IF #DATA-VAR NE SPACE

*S** ASSIGN #FAIL-EDIT = TRUE

*S** ELSE

*S** ASSIGN #VALID-MASK = TRUE

*S** END-IF

*S** ELSE

*S** EXAMINE #DATA-VAR 'Y' GIVING LENGTH #L

*S** EXAMINE #MASK-VAR 'Y' GIVING LENGTH #N

*S** IF #L NOT = #N

*S** ASSIGN #FAIL-EDIT = TRUE

*S** ELSE

*S** ASSIGN #VALUE = #DATA-VAR

*S** ASSIGN #VALID-MASK = TRUE

*S** END-IF

*S***

*S**END-SUBROUTINE /* MASK-VALIDATION

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE NUMERIC-VERF

*S*************************************************************************

*S***

*S** EXAMINE #MASK-VAR FOR 'Z' GIVING NUMBER #N

*S** EXAMINE #MASK-VAR FOR 'N' GIVING NUMBER #M

*S** EXAMINE #MASK-VAR FOR 'Y' GIVING LENGTH #L

*S** IF #L = (#N + #M)

*S** ASSIGN #NUMERIC-MASK = TRUE

*S** ELSE

*S** ESCAPE ROUTINE

*S** END-IF

*S** /*

*S** /* Verify length of data is not longer than edit mask length

*S** /* (edit mask length denotes field length)

*S** EXAMINE #DATA-VAR FOR 'Y' GIVING LENGTH #K

*S** IF #K > #L OR #DATA-DEC-LEN > #MASK-DEC-LEN

*S** OR (#NEGATIVE-DATA AND NOT #NEGATIVE-MASK)

*S** ASSIGN #FAIL-EDIT = TRUE

*S** ESCAPE ROUTINE

*S** END-IF

*S** /*

*S** /* Load preceding zeros to allow

*S** /* for edit mask examination

*S** MOVE RIGHT JUSTIFIED #DATA-VAR TO #DATA-VAR-RIGHT

*S** IF #DATA-VAR-RIGHT = ' ' AND

*S** #BLANK-SUB > 0

*S** ASSIGN #BLANK-NUMERIC = TRUE

*S** END-IF

*S** EXAMINE FULL #DATA-VAR-RIGHT FOR ' ' REPLACE WITH '0'

*S** IF #DECIMAL-MASK

*S** IF #MASK-DEC-LEN = 2

*S** IF NOT #DECIMAL-DATA

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,3,13) TO

*S** SUBSTRING(#DATA-VAR-RIGHT,1,13)

*S** MOVE '00' TO SUBSTRING(#DATA-VAR-RIGHT,14,2)

*S** ELSE

*S** IF #DATA-DEC-LEN = 0

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,3,13) TO

*S** SUBSTRING(#DATA-VAR-RIGHT,1,13)

*S** MOVE '00' TO SUBSTRING(#DATA-VAR-RIGHT,14,2)

*S** ELSE

*S** IF #DATA-DEC-LEN = 1

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,2,14) TO

*S** SUBSTRING(#DATA-VAR-RIGHT,1,14)

*S** MOVE '0' TO SUBSTRING(#DATA-VAR-RIGHT,15,1)

*S** END-IF

*S** ELSE

*S** IF #MASK-DEC-LEN = 3

*S** IF NOT #DECIMAL-DATA OR #DATA-DEC-LEN = 0

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,4,12) TO

*S** SUBSTRING(#DATA-VAR-RIGHT,1,12)

*S** MOVE '000' TO SUBSTRING(#DATA-VAR-RIGHT,13,3)

*S** ELSE

*S** IF #DATA-DEC-LEN = 1

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,3,13) TO

*S** SUBSTRING(#DATA-VAR-RIGHT,1,13)

*S** MOVE '00' TO SUBSTRING(#DATA-VAR-RIGHT,14,2)

*S** ELSE

*S** IF #DATA-DEC-LEN = 2

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,2,14) TO

*S** SUBSTRING(#DATA-VAR-RIGHT,1,14)

*S** MOVE '0' TO SUBSTRING(#DATA-VAR-RIGHT,15,1)

*S** END-IF

*S** COMPUTE #M = 15 - #L + 1

*S** MOVE SUBSTRING(#DATA-VAR-RIGHT,#M,#L) TO #DATA-VAR

*S** /*

*S** /* Replace 'Z' with 'N', 'Z' some alphanumeric

*S** /* checks (i.e. left-half of byte A-F and

*S** /* right-half 0-9)

*S** EXAMINE #MASK-VAR FOR 'Z' REPLACE WITH 'N'

*S** IF #DATA-VAR = MASK #MASK-VAR

*S** ASSIGN #VALID-MASK = TRUE

*S** MOVE #DATA-VAR TO #VALUE #VALUE-MASK

*S** COMPUTE #VALUE-TMP = VAL(#VALUE)

*S** IF #MASK-DEC-LEN = 3 /* #VALUE-TMP is N18.2

*S** COMPUTE #VALUE-TMP = VAL(#VALUE) * 10 /* Compensation needed

*S** END-IF /* for Nx.3 numbers

*S** MOVE RIGHT #DATA-VAR TO #DECIMAL-19

*S** IF #DECIMAL-MASK

*S** IF #MASK-DEC-LEN = 1

*S** MOVE EDITED #DECIMAL-19(EM=X(18).X) TO #DECIMAL-20

*S** COMPUTE #VALUE-TMP = #VALUE-TMP / 10

*S** ELSE

*S** IF #MASK-DEC-LEN = 2

*S** MOVE EDITED #DECIMAL-19(EM=X(17).XX) TO #DECIMAL-20

*S** COMPUTE #VALUE-TMP = #VALUE-TMP / 100

*S** ELSE

*S** IF #MASK-DEC-LEN = 3

*S** MOVE EDITED #DECIMAL-19(EM=X(16).XXX) TO #DECIMAL-20

*S** COMPUTE #VALUE-TMP = #VALUE-TMP / 1000

*S** END-IF

*S** MOVE LEFT #DECIMAL-20 TO #VALUE-MASK

*S** END-IF

*S** /*

*S** IF #NEGATIVE-DATA

*S** COMPUTE #VALUE-TMP = #VALUE-TMP * -1

*S** COMPRESS #VALUE-MASK '-' INTO #VALUE-MASK LEAVING NO

*S** END-IF

*S** /*

*S** IF #BLANK-NUMERIC

*S** MOVE LEFT '*' TO #HOLD-FED-VAL

*S** END-IF

*S** ELSE

*S** ASSIGN #FAIL-EDIT = TRUE

*S** END-IF

*S**END-SUBROUTINE /* NUMERIC-VERF

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE RANGE-VERF

*S*************************************************************************

*S***

*S** IF WWDICTOD.WW-RANGE-LO NOT = ' ' OR

*S** WWDICTOD.WW-RANGE-HI NOT = ' '

*S** IF #VALUE = WWDICTOD.WW-RANGE-LO THRU

*S** WWDICTOD.WW-RANGE-HI

*S** ASSIGN #WITHIN-RANGE = TRUE

*S** END-IF

*S**END-SUBROUTINE /* RANGE-VERF

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE READ-HEADER

*S*************************************************************************

*S***

*S** ASSIGN WWDICTOD.WW-RECORD-TYPE = DICT-HEADER-TYPE

*S** ASSIGN WWDICTOD.WW-VALUE = DICT-HEADER-LIT

*S** ASSIGN WWAOBJ.#FUNCTION = 'GET'

*S** PERFORM CALL-OBJECT

*S** IF WWAOBJ.#EXISTS /* Before check for reference, store

*S** PERFORM HOLD-FLDS /* Utility upd flds, format & length

*S** END-IF

*S** PERFORM REFERENCE-VERF /* Check for reference to other field

*S** IF #EXT-LOOKUP

*S** ESCAPE ROUTINE IMMEDIATE

*S** END-IF

*S** IF WWAOBJ.#EXISTS

*S** ASSIGN #HEADER-REC = TRUE

*S** END-IF

*S**END-SUBROUTINE /* READ-HEADER

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE REFERENCE-VERF

*S*************************************************************************

*S***

*S** DECIDE FOR EVERY CONDITION

*S** WHEN WWDICTOD.WW-REFER-FILE NE ' '

*S** ASSIGN WWDICTOD.WW-FILE = WWDICTOD.WW-REFER-FILE

*S** WHEN WWDICTOD.WW-REFER-FIELD NE ' '

*S** ASSIGN WWDICTOD.WW-FIELD = WWDICTOD.WW-REFER-FIELD

*S** WHEN ANY

*S** PERFORM CHECK-EXTERNAL-FILE /* Check to see if field validation

*S** /* should be from WW-EXTERNAL file

*S** /*

*S** IF NOT #DICT-LOOKUP

*S** /*

*S** /* Use WW-EXTERNAL value-validation

*S** ASSIGN #EXT-LOOKUP = TRUE

*S** ESCAPE ROUTINE IMMEDIATE

*S** ELSE

*S** PERFORM CALL-OBJECT

*S** END-IF

*S** WHEN NONE

*S** IGNORE

*S** END-DECIDE

*S**END-SUBROUTINE /* REFERENCE-VERF

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE SPECIAL-CHARACTERS

*S*************************************************************************

*S***

*S** EXAMINE #TEMP-VAR-IN '$' DELETE

*S** EXAMINE #TEMP-VAR-IN '?' DELETE

*S** EXAMINE #TEMP-VAR-IN '^' DELETE

*S** EXAMINE #TEMP-VAR-IN ',' DELETE

*S** EXAMINE #TEMP-VAR-IN '.' DELETE

*S** EXAMINE #TEMP-VAR-IN '/' DELETE

*S** EXAMINE #TEMP-VAR-IN '-' DELETE

*S** EXAMINE #TEMP-VAR-IN '(' DELETE

*S** EXAMINE #TEMP-VAR-IN ')' DELETE

*S** EXAMINE #TEMP-VAR-IN '"' DELETE

*S** EXAMINE #TEMP-VAR-IN '_' DELETE

*S** EXAMINE #TEMP-VAR-IN ' ' DELETE

*S** MOVE #TEMP-VAR-IN TO #TEMP-VAR-OUT

*S**END-SUBROUTINE /* SPECIAL-CHARACTERS

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE TRANSLATE-USERVIEWS

*S*************************************************************************

*S** /*

*S** /* Determine file PDA (Dictionary only uses file PDA's)

*S** /* (Allows use of userviews within maps)

*S** /*

*S** /* Lookup PDA id in PDA/File xref.

*S** IF WWDICTOD.WW-FILE = MASK(X......X) 'W......S'

*S** MOVE 'D' TO SUBSTRING(WWDICTOD.WW-FILE,8,1) /* Check for shadow

*S** MOVE 'D' TO SUBSTRING(#HOLD-FILE,8,1) /* definition, get

*S** END-IF /* data PDA definition

*S** /*

*S** FOR #PDA-SUB = 1 TO #PDA-MAX

*S** IF #PDA-ID(#PDA-SUB) = ' '

*S** ESCAPE BOTTOM

*S** END-IF

*S** IF #PDA-ID(#PDA-SUB) = #HOLD-FILE

*S** ASSIGN #PDA-FILE-NAME = #FILE-ID(#PDA-SUB)

*S** ESCAPE BOTTOM

*S** END-IF

*S** END-FOR

*S** /*

*S** /* Lookup first File id occurence (first is primary file definition)

*S** IF #PDA-FILE-NAME NE ' '

*S** FOR #PDA-SUB = 1 TO #PDA-MAX

*S** IF #FILE-ID(#PDA-SUB) = ' '

*S** ESCAPE BOTTOM

*S** END-IF

*S** IF #FILE-ID(#PDA-SUB) = #PDA-FILE-NAME

*S** ASSIGN #HOLD-FILE = #PDA-ID(#PDA-SUB)

*S** ASSIGN WWDICTOD.WW-FILE = #PDA-ID(#PDA-SUB)

*S** ESCAPE BOTTOM

*S** END-IF

*S** END-FOR

*S** END-IF

*S**END-SUBROUTINE /* TRANSLATE-USERVIEWS

*S***

*S*************************************************************************

*S**DEFINE SUBROUTINE VALUE-VALIDATION

*S*************************************************************************

*S** /*

*S** /* Remove underscores from data

*S** /* (Prevents 'arrowed over' spaces being stored as underscores)

*S** /* For e-mail addresses remove only leading/trailing underscores

*S** EXAMINE #FILE-FIELD FOR 'EMAIL' GIVING NUMBER #COUNT-EMAIL

*S** IF #COUNT-EMAIL = 0

*S** EXAMINE #VALUE FOR '_' REPLACE WITH SPACE

*S** ELSE

*S** MOVE #VALUE TO #VALUE-EMAIL

*S** FOR #VE-SUB = 1 TO 50

*S** IF #VE(#VE-SUB) NE SPACE AND #VE(#VE-SUB) NE '_'

*S** ESCAPE BOTTOM

*S** END-IF

*S** MOVE SPACE TO #VE(#VE-SUB)

*S** END-FOR

*S** FOR #VE-SUB = 50 TO 1 STEP -1

*S** IF #VE(#VE-SUB) NE SPACE AND #VE(#VE-SUB) NE '_'

*S** ESCAPE BOTTOM

*S** END-IF

*S** MOVE SPACE TO #VE(#VE-SUB)

*S** END-FOR

*S** MOVE #VALUE-EMAIL TO #VALUE

*S** END-IF

*S** /*

*S** PERFORM CHECK-EXTERNAL-FILE /* Check to see if field validation

*S** /* should occur from WW-EXTERNAL file

*S** /*

*S** IF NOT #DICT-LOOKUP

*S** /*

*S** /* Use WW-EXTERNAL value-validation

*S** ESCAPE ROUTINE IMMEDIATE

*S** END-IF

*S** /*

*S** PERFORM READ-HEADER /* Read header rec

*S** IF #EXT-LOOKUP

*S** ESCAPE ROUTINE IMMEDIATE

*S** END-IF

*S** /*

*S** IF #VALUE = SPACE AND /* Allow blank values

*S** (NOT #NUMERIC-MASK OR

*S** (#NUMERIC-MASK AND #BLANK-SUB > 0))

*S** MOVE LEFT '*' TO #HOLD-FED-VAL

*S** ASSIGN #VALID-VALUE = TRUE

*S** ESCAPE ROUTINE IMMEDIATE

*S** END-IF

*S** IF #HEADER-REC

*S** PERFORM RANGE-VERF /* Check for (min/max) value

*S** ELSE

*S** ASSIGN #VALID-VALUE = TRUE /* No header rec, therefore all

*S** ESCAPE ROUTINE IMMEDIATE /* values are valid

*S** END-IF

*S** /*

*S** IF #WITHIN-RANGE /* If value within range, exit subpgm

*S** ASSIGN #VALID-VALUE = TRUE

*S** ESCAPE ROUTINE IMMEDIATE

*S** ELSE /* If value not in range, check for

*S** /* valid value directly

*S** IF WWDICTOD.WW-VALUES-EXIST

*S** ASSIGN WWAOBJ.#FUNCTION = 'GET'

*S** ASSIGN WWDICTOD.WW-RECORD-TYPE = DICT-VALUE-TYPE

*S** ASSIGN WWDICTOD.WW-VALUE = #VALUE

*S** PERFORM CALL-OBJECT

*S** IF WWAOBJ.#EXISTS

*S** ASSIGN #VALID-VALUE = TRUE

*S** IF WWDICTOD.WW-FEDERAL-VALUE NE SPACE

*S** MOVE WWDICTOD.WW-FEDERAL-VALUE TO #HOLD-FED-VAL

*S** END-IF

*S** ELSE

*S** ASSIGN #FAIL-EDIT = TRUE

*S** END-IF

*S** ELSE /* If valid values don't exist, all

*S** /* values are valid

*S** ASSIGN #VALID-VALUE = TRUE

*S** END-IF

*S**END-SUBROUTINE /* VALUE-VALIDATION

*S**END

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

*S*************************************************************************
*S***
*S***                              WolffPack
*S***
*S*** Subprogram: WWEDITRN
*S*** System    : FINANCIER
*S*** Title     : Edit routine
*S*** Function  : This subprogram browses the WW-DICTIONARY file
*S***              to verify valid values and/or ranges.
*S***             It also verifies that modified data conforms to
*S***              edit masks.
*S***
*S***      Copyright 1995 - 2006 WolffPack, Inc.  All rights reserved.
*S***
*S*************************************************************************
*S**DEFINE DATA
*S**  GLOBAL USING WWGDA
*S**  PARAMETER USING WWPDA    /* Valid Value array
*S**  PARAMETER USING WWVALLDA /* Valid Value array
*S***
*S**  LOCAL USING WWDICTOD     /* Passed to Object Subprogram WWDICTOO
*S**  LOCAL USING WWDICTOR     /* Passed to Object Subprogram WWDICTOO
*S**  LOCAL USING WWEXTRID     /* Passed to Object Subprogram WWEXTRIO
*S**  LOCAL USING WWEXTRIR     /* Passed to Object Subprogram WWEXTRIO
*S**  LOCAL USING WWSTDNCD     /* Passed to Object Subprogram WWSTDNCO
*S**  LOCAL USING WWSTDNCR     /* Passed to Object Subprogram WWSTDNCO
*S**  LOCAL USING WFFUNDSD     /* Passed to Object Subprogram WFFUNDSO
*S**  LOCAL USING WFFUNDSR     /* Passed to Object Subprogram WFFUNDSO
*S**  LOCAL USING WWAOBJ       /* Passed to Object Subprograms
*S***
*S**  LOCAL USING WWCONST      /* Constants LDA
*S**  LOCAL USING WWDIALDA     /* Used by dialog objects
*S**  LOCAL USING WWFXREFD     /* File/PDA Cross-Reference
*S**  LOCAL
*S***
*S*** Miscellaneous variables.
*S**  01 #HEADER-REC(L)
*S**  01 #WITHIN-RANGE(L)
*S**  01 #ARRAY-LOADED(L)
*S**  01 #DICT-LOOKUP(L)
*S**  01 #EXT-LOOKUP(L)
*S***
*S**  01 #EXT-TYPE(A1)
*S**  01 #TEMP-VAR-IN(A15)
*S**  01 #TEMP-VAR-OUT(A15)
*S**  01 #MASK-VAR(A15)
*S**  01 #MASK-VAR-RIGHT(A15)
*S**  01 #DATA-VAR(A15)
*S**  01 #DATA-VAR-RIGHT(A15)
*S**  01 REDEFINE #DATA-VAR-RIGHT
*S**    02 #DATA-NUM-RIGHT(N15)
*S**  01 #DECIMAL-19(A19)
*S**  01 #DECIMAL-20(A20)
*S**  01 #EXTRA(A19)
*S**  01 #MASK-DEC-LEN(N2)
*S**  01 #DATA-DEC-LEN(N2)
*S**  01 #NUMERIC-MASK(L)
*S**  01 #PHONE-MASK(L)
*S**  01 #SSN-MASK(L)
*S**  01 #NEGATIVE-MASK(L)
*S**  01 #NEGATIVE-DATA(L)
*S**  01 #DECIMAL-MASK(L)
*S**  01 #DECIMAL-DATA(L)
*S**  01 #K(P3)
*S**  01 #L(P3)
*S**  01 #D(P3)
*S**  01 #M(P3)
*S**  01 #N(P3)
*S**  01 #P(P3)
*S**  01 #VALUE-1(A1)
*S**  01 #VALUE-2(A2)
*S**  01 #VALUE-3(A3)
*S**  01 #VALUE-4(A4)
*S**  01 #VALUE-5(A5)
*S**  01 #VALUE-6(A6)
*S**  01 #VALUE-7(A7)
*S**  01 #VALUE-8(A8)
*S**  01 #VALUE-9(A9)
*S**  01 #VALUE-10(A10)
*S**  01 #VALUE-11(A11)
*S**  01 #VALUE-12(A12)
*S**  01 #ASTERISK(P3)
*S**  01 #PERIOD(P3)
*S**  01 #CENTURY-BREAK(A2) INIT<'20'>
*S**  01 #DATE(A6)
*S**  01 REDEFINE #DATE
*S**    02 #DATE-A(A2)
*S**    02 #DATE-B(A2)
*S**    02 #DATE-C(A2)
*S**  01 #FIELD-FORMAT(A1)
*S**  01 #FIELD-LENGTH(N2)
*S**  01 #HOLD-FIELDS
*S**    02 #HOLD-FILE(A8)
*S**    02 #HOLD-FIELD(A20)
*S**    02 #HOLD-SAR(A3)
*S**    02 #HOLD-DSL(A3)
*S**    02 #HOLD-DPL(A3)
*S**    02 #HOLD-FED-VAL(A5)
*S**    02 #HOLD-UTILS
*S**      03 WW-UTIL-1(A1)
*S**      03 WW-UTIL-2(A1)
*S**      03 WW-UTIL-3(A1)
*S**      03 WW-UTIL-4(A1)
*S**      03 WW-UTIL-5(A1)
*S**      03 WW-UTIL-6(A1)
*S**    02 REDEFINE #HOLD-UTILS
*S**      03 #HOLD-UTIL(A1/6)
*S***
*S**  01 #VE-SUB(P3)
*S**  01 #VALUE-EMAIL(A50)
*S**  01 REDEFINE #VALUE-EMAIL
*S**    02 #VE(A1/50)
*S**  01 #COUNT-EMAIL(N2)
*S**END-DEFINE
*S***
*S*** Define Formats
*S**FORMAT KD=OFF
*S***
*S**PERFORM INITIALIZATIONS
*S***
*S***
*S*************************************************************************
*S***
*S**RESET INITIAL #VALID-VALUE #VALID-MASK #WITHIN-RANGE #BLANK-NUMERIC
*S***
*S**PERFORM MASK-VALIDATION
*S**IF #VALID-MASK                        /* Passed mask validation,
*S**  PERFORM VALUE-VALIDATION            /*  perform value validation
*S**END-IF
*S***
*S**IF #MARK-FIELD = 0                    /* Set first field in error
*S**  IF NOT #VALID-VALUE OR              /*  to be used by MARK option
*S**     NOT #VALID-MASK
*S**    ASSIGN #MARK-FIELD = #FIELD-POS
*S**  END-IF
*S**END-IF
*S***
*S**IF #VALID-VALUE AND                       /* If all edits passed, load
*S**  #VALID-MASK                             /*  Utility updates array
*S** PERFORM LOAD-UTIL-ARRAY
*S**END-IF
*S***
*S**MOVE BY POSITION WW-GDA TO WW-PDA
*S***
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE CALL-OBJECT
*S*************************************************************************
*S***
*S*** Call WW-DICTIONARY Object subprogram
*S**  CALLNAT 'WWDICTOO' WW-GDA
*S**           WWDICTOD
*S**           WWDICTOD-ID
*S**           WWDICTOR
*S**           WWAOBJ
*S***
*S**END-SUBROUTINE /* CALL-OBJECT
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE CHECK-EXTERNAL-FILE
*S*************************************************************************
*S**  /*
*S**  /* Hard coded 'fields' with valid values contained in the
*S**  /*  WW-EXTERNAL file instead of the WW-DICTIONARY file
*S**  PERFORM DETERMINE-DICT-LOOKUP WWDICTOD.WW-FILE
*S**           WWDICTOD.WW-FIELD #DICT-LOOKUP #EXT-TYPE
*S**  /*
*S**  IF #DICT-LOOKUP
*S**    /*
*S**    /* Use WW-DICTIONARY value-validation
*S**    ESCAPE ROUTINE
*S**  END-IF
*S**  /*
*S**  DECIDE ON FIRST VALUE OF #EXT-TYPE
*S**    VALUE 'D', 'E', 'G', 'I', 'L', 'O', 'P'
*S**        /*
*S**        /*  D          Fund donor
*S**        /*  E          On-campus employer
*S**        /*  G          Guarantee agency
*S**        /*  I          Institution
*S**        /*  L          Lender
*S**        /*  O          Off-campus employer
*S**        /*  P          Parent
*S**      ASSIGN WWAOBJ.#FUNCTION = 'EXISTS'
*S**      ASSIGN WWEXTRID.WW-EXTERNAL-ID = #VALUE
*S**      ASSIGN WWEXTRID.WF-FAO = ##FAO-ID
*S**      ASSIGN WWEXTRID.WW-RECORD-TYPE = #EXT-TYPE
*S**      /*
*S**      /* Call WW-EXTERNAL Object subprogram
*S**      CALLNAT 'WWEXTRIO' WW-GDA
*S**               WWEXTRID
*S**               WWEXTRID-ID
*S**               WWEXTRIR
*S**               WWAOBJ
*S**    VALUE 'S'
*S**        /*
*S**        /*  S          Student
*S**      ASSIGN WWAOBJ.#FUNCTION = 'EXISTS'
*S**      ASSIGN WWSTDNCD.WW-STUDENT-ID = #VALUE
*S**      ASSIGN WWSTDNCD.WF-FAO = ##FAO-ID
*S**      /*
*S**      /* Call WW-STUDENT-CMP Object subprogram
*S**      CALLNAT 'WWSTDNCO' WW-GDA
*S**               WWSTDNCD
*S**               WWSTDNCD-ID
*S**               WWSTDNCR
*S**               WWAOBJ
*S**    VALUE 'F'
*S**        /*
*S**        /*  F          Fund
*S**      ASSIGN WWAOBJ.#FUNCTION = 'EXISTS'
*S**      ASSIGN WFFUNDSD.WF-FUND-ID = #VALUE
*S**      ASSIGN WFFUNDSD.WF-FAO = ##FAO-ID
*S**      ASSIGN WFFUNDSD.WW-FISCAL-YEAR = ##FISCAL-YEAR
*S**      /*
*S**      /* Call WW-FUND Object subprogram
*S**      CALLNAT 'WFFUNDSO' WW-GDA
*S**               WFFUNDSD
*S**               WFFUNDSD-ID
*S**               WFFUNDSR
*S**               WWAOBJ
*S**    NONE
*S**      ASSIGN #FAIL-EDIT = TRUE
*S**  END-DECIDE
*S**  /*
*S**  IF WWAOBJ.#EXISTS
*S**    ASSIGN #VALID-VALUE = TRUE
*S**  ELSE
*S**    IF #VALUE = SPACE
*S**      ASSIGN #VALID-VALUE = TRUE                 /* Allow spaces
*S**    ELSE
*S**      ASSIGN #FAIL-EDIT = TRUE
*S**    END-IF
*S**  END-IF
*S**END-SUBROUTINE /* CHECK-EXTERNAL-FILE
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE DATE-VERF
*S*************************************************************************
*S***
*S**  EXAMINE #MASK-VAR 'M' GIVING POSITION #M
*S**  EXAMINE #DATA-VAR 'Y' GIVING LENGTH #L
*S**  EXAMINE #MASK-VAR 'Y' GIVING NUMBER #N
*S**  EXAMINE #MASK-VAR 'Y' GIVING POSITION #P
*S**  EXAMINE #MASK-VAR 'D' GIVING POSITION #D
*S**  IF #M = 0                                 /* Mask passed is not date
*S**    ESCAPE ROUTINE
*S**  END-IF
*S**  IF #DATA-VAR = SPACE                      /* Date blanked out
*S**    DECIDE FOR FIRST CONDITION
*S**      WHEN #MASK-VAR = 'MM/DD/YYYY' OR = 'MMDDYYYY'
*S**        MOVE EDITED INIT-DATE(EM=MMDDYYYY) TO #DATA-VAR
*S**      WHEN #MASK-VAR = 'YYYY/MM/DD' OR = 'YYYYMMDD'
*S**        MOVE EDITED INIT-DATE(EM=YYYYMMDD) TO #DATA-VAR
*S**      WHEN #MASK-VAR = 'MM/YYYY' OR = 'MMYYYY'
*S**        MOVE EDITED INIT-DATE(EM=MMYYYY) TO #DATA-VAR
*S**      WHEN #MASK-VAR = 'YYYY/MM' OR = 'YYYYMM'
*S**        MOVE EDITED INIT-DATE(EM=YYYYMM) TO #DATA-VAR
*S**      WHEN ANY
*S**        MOVE LEFT #DATA-VAR TO #VALUE-MASK
*S**      WHEN NONE
*S**        IGNORE
*S**    END-DECIDE
*S**    ESCAPE ROUTINE
*S**  END-IF
*S**  IF #D = 0                                 /* Mask doesn't use days
*S**    /*
*S**    IF #L = 3                               /* Input is only 3 bytes,
*S**                                            /*  assume month is
*S**                                            /*  zero suppressed
*S**      /*
*S**      IF #M = 1                             /* Mask is MMyyyy or MMyy
*S**        COMPRESS '0' #DATA-VAR INTO #DATA-VAR LEAVING NO
*S**      ELSE                                  /* Assume yyyyMM or yyMM
*S**        MOVE #DATA-VAR TO #DATE
*S**        MOVE SUBSTRING(#DATE,3,1) TO SUBSTRING(#DATE,4,1)
*S**        MOVE '0' TO SUBSTRING(#DATE-B,1,1)
*S**        MOVE #DATE TO #DATA-VAR
*S**      END-IF
*S**      ASSIGN #L = 4                         /* Set length to 4 bytes
*S**    END-IF
*S**    IF #L = 5                               /* Input is only 5 bytes,
*S**                                            /*  assume month is
*S**                                            /*  zero suppressed
*S**      /*
*S**      IF #M = 1                             /* Mask is mmyyyy or mmyy
*S**        COMPRESS '0' #DATA-VAR INTO #DATA-VAR LEAVING NO
*S**      ELSE                                  /* Assume yyyymm or yymm
*S**        MOVE #DATA-VAR TO #DATE
*S**        MOVE SUBSTRING(#DATE,5,1) TO SUBSTRING(#DATE,6,1)
*S**        MOVE '0' TO SUBSTRING(#DATE-C,1,1)
*S**        MOVE #DATE TO #DATA-VAR
*S**      END-IF
*S**    END-IF
*S**    IF #N = 4 AND #L = 4                    /* Mask uses century, but
*S**                                            /*  input isn't long enough
*S**                                            /*  for century (6 bytes)
*S**                                            /*
*S**      IF #P = 1                             /* Mask is yyyymm
*S**        MOVE SUBSTRING(#DATA-VAR,1,2) TO #DATE-A
*S**        IF #DATE-A > #CENTURY-BREAK
*S**          COMPRESS '19' #DATA-VAR INTO #DATA-VAR LEAVING NO
*S**        ELSE
*S**          COMPRESS '20' #DATA-VAR INTO #DATA-VAR LEAVING NO
*S**        END-IF
*S**      ELSE                                  /* Assume mmYYYY
*S**        MOVE #DATA-VAR TO #DATE
*S**        IF #DATE-B > #CENTURY-BREAK
*S**          COMPRESS #DATE-A '19' #DATE-B
*S**            INTO #DATA-VAR LEAVING NO
*S**        ELSE
*S**          COMPRESS #DATE-A '20' #DATE-B
*S**            INTO #DATA-VAR LEAVING NO
*S**        END-IF
*S**      END-IF
*S**    END-IF
*S**  ELSE                                      /* Days used in mask
*S**    /*
*S**    IF #L = 4                               /* Input is only 4 bytes,
*S**                                            /*  assume month and day
*S**                                            /*  are zero suppressed
*S**                                            /*
*S**      IF #M = 1                             /* Mask mmddyyyy or mmddyy
*S**        MOVE RIGHT JUSTIFIED #DATA-VAR TO #DATE
*S**        MOVE '0' TO SUBSTRING(#DATE-A,1,1)
*S**        MOVE SUBSTRING(#DATE,3,1) TO SUBSTRING(#DATE,2,1)
*S**        MOVE '0' TO SUBSTRING(#DATE-B,1,1)
*S**        MOVE #DATE TO #DATA-VAR
*S**      ELSE                                  /* Assume yyyymmdd or yymmdd
*S**        MOVE #DATA-VAR TO #DATE
*S**        MOVE SUBSTRING(#DATE,3,2) TO SUBSTRING(#DATE,5,2)
*S**        MOVE SUBSTRING(#DATE,2,1) TO SUBSTRING(#DATE,4,1)
*S**        MOVE '0' TO SUBSTRING(#DATE-A,1,1)
*S**        MOVE '0' TO SUBSTRING(#DATE-B,1,1)
*S**        MOVE #DATE TO #DATA-VAR
*S**      END-IF
*S**    END-IF
*S**    EXAMINE #MASK-VAR 'Y' GIVING NUMBER #N
*S**    EXAMINE #MASK-VAR 'Y' GIVING POSITION #P
*S**    EXAMINE #MASK-VAR 'M' GIVING POSITION #M
*S**    EXAMINE #DATA-VAR 'Y' GIVING LENGTH #L
*S**    IF #N = 4 AND #L = 6                    /* Mask uses century, but
*S**                                            /*  input isn't long enough
*S**                                            /*  for century (8 bytes)
*S**                                            /*
*S**      IF #P = 1                             /* Mask is yyyymmdd
*S**        MOVE SUBSTRING(#DATA-VAR,1,2) TO #DATE-A
*S**        IF #DATE-A > #CENTURY-BREAK
*S**          COMPRESS '19' #DATA-VAR INTO #DATA-VAR LEAVING NO
*S**        ELSE
*S**          COMPRESS '20' #DATA-VAR INTO #DATA-VAR LEAVING NO
*S**        END-IF
*S**      ELSE                                  /* Assume mmddyyyy
*S**        MOVE #DATA-VAR TO #DATE
*S**        IF #DATE-C > #CENTURY-BREAK
*S**          COMPRESS #DATE-A #DATE-B '19' #DATE-C
*S**            INTO #DATA-VAR LEAVING NO
*S**        ELSE
*S**          COMPRESS #DATE-A #DATE-B '20' #DATE-C
*S**            INTO #DATA-VAR LEAVING NO
*S**        END-IF
*S**      END-IF
*S**    END-IF
*S**  END-IF
*S**  /*
*S**  /* Verify century is only 19 or 20
*S**  /*   (Prevents Natural runtime error)
*S**  EXAMINE SUBSTRING(#DATA-VAR,#P,2) FOR '19' GIVING NUMBER #L
*S**  EXAMINE SUBSTRING(#DATA-VAR,#P,2) FOR '20' GIVING NUMBER #N
*S**  IF #L = 0 AND
*S**     #N = 0
*S**    ASSIGN #FAIL-EDIT = TRUE
*S**  END-IF
*S**  IF NOT #FAIL-EDIT
*S**    MOVE LEFT #DATA-VAR TO #VALUE-MASK
*S**  END-IF
*S**END-SUBROUTINE /* DATE-VERF
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE HOLD-FLDS
*S*************************************************************************
*S***
*S**  IF WWDICTOD.WW-SAR-FIELD-NO = '***'
*S**    DECIDE FOR EVERY CONDITION
*S**      WHEN ##AID-YEAR GE WW-SAR-YEAR-1 AND
*S**           WW-SAR-YEAR-1 NE SPACE
*S**        ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-1
*S**      WHEN ##AID-YEAR GE WW-SAR-YEAR-2 AND
*S**           WW-SAR-YEAR-2 NE SPACE
*S**        ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-2
*S**      WHEN ##AID-YEAR GE WW-SAR-YEAR-3 AND
*S**           WW-SAR-YEAR-3 NE SPACE
*S**        ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-3
*S**      WHEN ##AID-YEAR GE WW-SAR-YEAR-4 AND
*S**           WW-SAR-YEAR-4 NE SPACE
*S**        ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO-4
*S**      WHEN NONE
*S**        ASSIGN #HOLD-SAR = WW-SAR-FIELD-NO
*S**    END-DECIDE
*S**  ELSE
*S**    ASSIGN #HOLD-SAR = WWDICTOD.WW-SAR-FIELD-NO
*S**  END-IF
*S**  ASSIGN #HOLD-DSL = WWDICTOD.WW-DSL-FIELD-NO
*S**  ASSIGN #HOLD-DPL = WWDICTOD.WW-DPL-FIELD-NO
*S**  MOVE BY NAME WWDICTOD.WW-FIELD-UTILITIES TO
*S**                   #HOLD-UTILS
*S**  ASSIGN #FIELD-FORMAT = WWDICTOD.WW-FORMAT
*S**  ASSIGN #FIELD-LENGTH = WWDICTOD.WW-LENGTH
*S*** MOVE WWDICTOD.WW-FIELD TO #HOLD-FIELD
*S***
*S**END-SUBROUTINE /* HOLD-FLDS
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE INITIALIZATIONS
*S*************************************************************************
*S***
*S*** Populate WW-GDA from WW-PDA
*S**MOVE BY POSITION WW-PDA TO WW-GDA
*S***
*S*** Get File/PDA cross-reference
*S**PERFORM FILE-XREF-LOAD WWFXREFD
*S***
*S**  EXAMINE WWVALLDA.#FILE-FIELD FOR '.' GIVING NUMBER #PERIOD
*S**  IF #PERIOD > 0
*S**    SEPARATE WWVALLDA.#FILE-FIELD INTO WWDICTOD.WW-FILE
*S**       WWDICTOD.WW-FIELD WITH DELIMITER '.'
*S**  ELSE
*S**    MOVE WWVALLDA.#FILE-FIELD TO WWDICTOD.WW-FIELD
*S**    EXAMINE WWVALLDA.#FILE-FIELD FOR '#' GIVING NUMBER #ASTERISK
*S**    IF #ASTERISK = 2                     /* GDA field
*S**      EXAMINE WWDICTOD.WW-FIELD FOR '##' REPLACE WITH 'WW-GDA-'
*S**      MOVE 'WWSYSVRD' TO WWDICTOD.WW-FILE
*S**    ELSE
*S**      IF #ASTERISK = 1                   /* Program variable
*S**        EXAMINE WWDICTOD.WW-FIELD FOR '#' REPLACE WITH 'WF-PGM-'
*S**        MOVE 'WWSYSVRD' TO WWDICTOD.WW-FILE
*S**      END-IF
*S**    END-IF
*S**  END-IF
*S**  MOVE WWDICTOD.WW-FILE TO #HOLD-FILE
*S**  MOVE WWDICTOD.WW-FIELD TO #HOLD-FIELD
*S**  PERFORM TRANSLATE-USERVIEWS
*S**END-SUBROUTINE /* INITIALIZATIONS
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE LOAD-UTIL-ARRAY
*S*************************************************************************
*S***
*S**  RESET #ARRAY-LOADED
*S**  ASSIGN #N = 1
*S***
*S**  REPEAT WHILE NOT #ARRAY-LOADED
*S**   IF (#FILE(#N) = #HOLD-FILE AND #FIELD(#N) = #HOLD-FIELD) OR
*S**      (#FILE(#N) = ' ' AND #FIELD(#N) = ' ')
*S**     ASSIGN #SAR-FLD-NO(#N) = #HOLD-SAR          /* Found match OR
*S**     ASSIGN #DSL-FLD-NO(#N) = #HOLD-DSL          /*  not yet defined
*S**     ASSIGN #DPL-FLD-NO(#N) = #HOLD-DPL
*S**     ASSIGN #UTILITY-FLAG(#N,*) = #HOLD-UTIL(*)
*S**     /*
*S**     /*  Load federal data from dictionary or,
*S**     /*   if correctable, numeric data
*S**     /*    (Allows #VALU to be masked in Z subroutines
*S**     /*      for auditing purposes)
*S**     IF #HOLD-FED-VAL NE ' '
*S**       ASSIGN #FEDERAL-VALUE(#N) = #HOLD-FED-VAL
*S**     ELSE
*S**       IF #NUMERIC-MASK AND
*S**          (#HOLD-SAR NE ' ' OR
*S**           #HOLD-DSL NE ' ' OR
*S**           #HOLD-DPL NE ' ')
*S**         ASSIGN #FEDERAL-VALUE(#N) = #VALUE
*S**         IF #NEGATIVE-DATA
*S**           COMPRESS #FEDERAL-VALUE(#N) '-' TO
*S**             #FEDERAL-VALUE(#N) LEAVING NO
*S**         END-IF
*S**       END-IF
*S**     END-IF
*S**     IF #SSN-MASK
*S**       ASSIGN #FEDERAL-VALUE(#N) = #VALUE
*S**       RESET #SSN-MASK
*S**     END-IF
*S**     ASSIGN #VALU(#N) = #VALUE
*S**     ASSIGN #VALU-SUB = #N
*S**     ASSIGN #ARRAY-LOADED = TRUE
*S**     IF #FILE(#N) = ' ' AND #FIELD(#N) = ' '
*S**       ASSIGN #FILE(#N) = #HOLD-FILE
*S**       ASSIGN #FIELD(#N) = #HOLD-FIELD
*S**     END-IF
*S**   ELSE
*S**     IF #N > UTIL-UPDT-MAX
*S**       ASSIGN ##MSG = 'Exceeded Utility Update maximum'
*S**     END-IF
*S**   END-IF
*S**   ADD 1 TO #N
*S**  END-REPEAT
*S***
*S**END-SUBROUTINE /* LOAD-UTIL-ARRAY
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE MASK-VALIDATION
*S*************************************************************************
*S***
*S**  IF #EDIT-MASK = ' '             /* Check for edit mask definition
*S**    ASSIGN #VALID-MASK = TRUE
*S**    ESCAPE ROUTINE IMMEDIATE
*S**  END-IF
*S***                                 /* Set up edit mask variable
*S**  IF #EDIT-MASK = '(999)999-9999'
*S**    ASSIGN #PHONE-MASK = TRUE
*S**  END-IF
*S**  MOVE RIGHT JUSTIFIED #EDIT-MASK TO #TEMP-VAR-IN
*S**  EXAMINE #TEMP-VAR-IN FOR '-' GIVING NUMBER #N
*S**  IF #N > 0
*S**    ASSIGN #NEGATIVE-MASK = TRUE
*S**  END-IF
*S**  EXAMINE #TEMP-VAR-IN FOR '.9' GIVING NUMBER #N
*S**  IF #N > 0
*S**    ASSIGN #DECIMAL-MASK = TRUE
*S**    SEPARATE #TEMP-VAR-IN INTO #DECIMAL-19 #DECIMAL-20 WITH
*S**      DELIMITER '.'
*S**    EXAMINE #DECIMAL-20 FOR '9' GIVING NUMBER #MASK-DEC-LEN
*S**  END-IF
*S**  PERFORM SPECIAL-CHARACTERS
*S**  EXAMINE #TEMP-VAR-OUT '9' REPLACE WITH 'N'
*S**  EXAMINE #TEMP-VAR-OUT 'X' REPLACE WITH 'C'
*S**  MOVE #TEMP-VAR-OUT TO #MASK-VAR
*S***                                  /* Set up data variable
*S**  MOVE LEFT JUSTIFIED #VALUE TO #TEMP-VAR-IN
*S**  EXAMINE #TEMP-VAR-IN FOR '.' GIVING NUMBER #N
*S**  IF #N > 0
*S**    ASSIGN #DECIMAL-DATA = TRUE
*S**    SEPARATE #TEMP-VAR-IN INTO #DECIMAL-19 #DECIMAL-20 #EXTRA WITH
*S**      DELIMITER '.'
*S**    EXAMINE #DECIMAL-20 FOR '0' GIVING LENGTH #DATA-DEC-LEN
*S**    EXAMINE #DECIMAL-20 FOR '-' GIVING NUMBER #N
*S**    SUBTRACT #N FROM #DATA-DEC-LEN
*S**  END-IF
*S**  EXAMINE #TEMP-VAR-IN FOR '-' GIVING NUMBER #N
*S**  IF #N > 0 AND
*S**     NOT #PHONE-MASK
*S**    ASSIGN #NEGATIVE-DATA = TRUE
*S**  END-IF
*S***
*S*** Before stripping "/" out of dates, expand single-digit month and day
*S**  EXAMINE #MASK-VAR 'M' GIVING NUMBER #M
*S**  IF #M > 0
*S**    IF SUBSTRING(#TEMP-VAR-IN,2,1) = '/' OR = '-'
*S**      MOVE SUBSTRING(#TEMP-VAR-IN,1,14) TO #TEMP-VAR-OUT
*S**      MOVE #TEMP-VAR-OUT TO SUBSTRING(#TEMP-VAR-IN,2,14)
*S**      MOVE '0' TO SUBSTRING(#TEMP-VAR-IN,1,1)
*S**    END-IF
*S**    IF SUBSTRING(#TEMP-VAR-IN,5,1) = '/' OR = '-'
*S**      MOVE SUBSTRING(#TEMP-VAR-IN,4,11) TO #TEMP-VAR-OUT
*S**      MOVE #TEMP-VAR-OUT TO SUBSTRING(#TEMP-VAR-IN,5,11)
*S**      MOVE '0' TO SUBSTRING(#TEMP-VAR-IN,4,1)
*S**    END-IF
*S**  END-IF
*S**  PERFORM SPECIAL-CHARACTERS
*S**  MOVE #TEMP-VAR-OUT TO #DATA-VAR
*S**  PERFORM DATE-VERF
*S***
*S**  PERFORM NUMERIC-VERF
*S***
*S**  IF NOT #NUMERIC-MASK AND                  /* Alpha-numeric only
*S**     NOT #FAIL-EDIT
*S**    IF #EDIT-MASK = 'XXX-XX-XXXX'
*S**      ASSIGN #SSN-MASK = TRUE
*S**    END-IF
*S**    IF NOT #SSN-MASK AND #DATA-VAR = SPACE
*S**      ASSIGN #VALID-MASK = TRUE
*S**    ELSE
*S**    IF #DATA-VAR NOT = MASK #MASK-VAR
*S**      IF #DATA-VAR NE SPACE
*S**        ASSIGN #FAIL-EDIT = TRUE
*S**      ELSE
*S**        ASSIGN #VALID-MASK = TRUE
*S**      END-IF
*S**    ELSE
*S**      EXAMINE #DATA-VAR 'Y' GIVING LENGTH #L
*S**      EXAMINE #MASK-VAR 'Y' GIVING LENGTH #N
*S**      IF #L NOT = #N
*S**        ASSIGN #FAIL-EDIT = TRUE
*S**      ELSE
*S**        ASSIGN #VALUE = #DATA-VAR
*S**        ASSIGN #VALID-MASK = TRUE
*S**      END-IF
*S**    END-IF
*S**    END-IF
*S**  END-IF
*S***
*S**END-SUBROUTINE /* MASK-VALIDATION
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE NUMERIC-VERF
*S*************************************************************************
*S***
*S**  EXAMINE #MASK-VAR FOR 'Z' GIVING NUMBER #N
*S**  EXAMINE #MASK-VAR FOR 'N' GIVING NUMBER #M
*S**  EXAMINE #MASK-VAR FOR 'Y' GIVING LENGTH #L
*S**  IF #L = (#N + #M)
*S**    ASSIGN #NUMERIC-MASK = TRUE
*S**  ELSE
*S**    ESCAPE ROUTINE
*S**  END-IF
*S**  /*
*S**  /* Verify length of data is not longer than edit mask length
*S**  /*  (edit mask length denotes field length)
*S**  EXAMINE #DATA-VAR FOR 'Y' GIVING LENGTH #K
*S**  IF #K > #L OR #DATA-DEC-LEN > #MASK-DEC-LEN
*S**             OR (#NEGATIVE-DATA AND NOT #NEGATIVE-MASK)
*S**    ASSIGN #FAIL-EDIT = TRUE
*S**    ESCAPE ROUTINE
*S**  END-IF
*S**  /*
*S**  /* Load preceding zeros to allow
*S**  /*  for edit mask examination
*S**  MOVE RIGHT JUSTIFIED #DATA-VAR TO #DATA-VAR-RIGHT
*S**  IF #DATA-VAR-RIGHT = ' ' AND
*S**     #BLANK-SUB > 0
*S**    ASSIGN #BLANK-NUMERIC = TRUE
*S**  END-IF
*S**  EXAMINE FULL #DATA-VAR-RIGHT FOR ' ' REPLACE WITH '0'
*S**  IF #DECIMAL-MASK
*S**   IF #MASK-DEC-LEN = 2
*S**    IF NOT #DECIMAL-DATA
*S**      MOVE SUBSTRING(#DATA-VAR-RIGHT,3,13) TO
*S**           SUBSTRING(#DATA-VAR-RIGHT,1,13)
*S**      MOVE '00' TO SUBSTRING(#DATA-VAR-RIGHT,14,2)
*S**    ELSE
*S**      IF #DATA-DEC-LEN = 0
*S**        MOVE SUBSTRING(#DATA-VAR-RIGHT,3,13) TO
*S**             SUBSTRING(#DATA-VAR-RIGHT,1,13)
*S**        MOVE '00' TO SUBSTRING(#DATA-VAR-RIGHT,14,2)
*S**      ELSE
*S**        IF #DATA-DEC-LEN = 1
*S**          MOVE SUBSTRING(#DATA-VAR-RIGHT,2,14) TO
*S**               SUBSTRING(#DATA-VAR-RIGHT,1,14)
*S**          MOVE '0' TO SUBSTRING(#DATA-VAR-RIGHT,15,1)
*S**        END-IF
*S**      END-IF
*S**    END-IF
*S**   ELSE
*S**    IF #MASK-DEC-LEN = 3
*S**      IF NOT #DECIMAL-DATA OR #DATA-DEC-LEN = 0
*S**        MOVE SUBSTRING(#DATA-VAR-RIGHT,4,12) TO
*S**             SUBSTRING(#DATA-VAR-RIGHT,1,12)
*S**        MOVE '000' TO SUBSTRING(#DATA-VAR-RIGHT,13,3)
*S**      ELSE
*S**        IF #DATA-DEC-LEN = 1
*S**          MOVE SUBSTRING(#DATA-VAR-RIGHT,3,13) TO
*S**               SUBSTRING(#DATA-VAR-RIGHT,1,13)
*S**          MOVE '00' TO SUBSTRING(#DATA-VAR-RIGHT,14,2)
*S**        ELSE
*S**          IF #DATA-DEC-LEN = 2
*S**            MOVE SUBSTRING(#DATA-VAR-RIGHT,2,14) TO
*S**                 SUBSTRING(#DATA-VAR-RIGHT,1,14)
*S**            MOVE '0' TO SUBSTRING(#DATA-VAR-RIGHT,15,1)
*S**          END-IF
*S**        END-IF
*S**      END-IF
*S**    END-IF
*S**   END-IF
*S**  END-IF
*S**  COMPUTE #M = 15 - #L + 1
*S**  MOVE SUBSTRING(#DATA-VAR-RIGHT,#M,#L) TO #DATA-VAR
*S**  /*
*S**  /* Replace 'Z' with 'N', 'Z' some alphanumeric
*S**  /*  checks (i.e. left-half of byte A-F and
*S**  /*   right-half 0-9)
*S**  EXAMINE #MASK-VAR FOR 'Z' REPLACE WITH 'N'
*S**  IF #DATA-VAR = MASK #MASK-VAR
*S**    ASSIGN #VALID-MASK = TRUE
*S**    MOVE #DATA-VAR TO #VALUE #VALUE-MASK
*S**    COMPUTE #VALUE-TMP = VAL(#VALUE)
*S**    IF #MASK-DEC-LEN = 3                      /* #VALUE-TMP is N18.2
*S**      COMPUTE #VALUE-TMP = VAL(#VALUE) * 10   /*  Compensation needed
*S**    END-IF                                    /*   for Nx.3 numbers
*S**    MOVE RIGHT #DATA-VAR TO #DECIMAL-19
*S**    IF #DECIMAL-MASK
*S**      IF #MASK-DEC-LEN = 1
*S**        MOVE EDITED #DECIMAL-19(EM=X(18).X) TO #DECIMAL-20
*S**        COMPUTE #VALUE-TMP = #VALUE-TMP / 10
*S**      ELSE
*S**        IF #MASK-DEC-LEN = 2
*S**          MOVE EDITED #DECIMAL-19(EM=X(17).XX) TO #DECIMAL-20
*S**          COMPUTE #VALUE-TMP = #VALUE-TMP / 100
*S**        ELSE
*S**          IF #MASK-DEC-LEN = 3
*S**            MOVE EDITED #DECIMAL-19(EM=X(16).XXX) TO #DECIMAL-20
*S**            COMPUTE #VALUE-TMP = #VALUE-TMP / 1000
*S**          END-IF
*S**        END-IF
*S**      END-IF
*S**      MOVE LEFT #DECIMAL-20 TO #VALUE-MASK
*S**    END-IF
*S**    /*
*S**    IF #NEGATIVE-DATA
*S**      COMPUTE #VALUE-TMP = #VALUE-TMP * -1
*S**      COMPRESS #VALUE-MASK '-' INTO #VALUE-MASK LEAVING NO
*S**    END-IF
*S**    /*
*S**    IF #BLANK-NUMERIC
*S**      MOVE LEFT '*' TO #HOLD-FED-VAL
*S**    END-IF
*S**  ELSE
*S**    ASSIGN #FAIL-EDIT = TRUE
*S**  END-IF
*S**END-SUBROUTINE /* NUMERIC-VERF
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE RANGE-VERF
*S*************************************************************************
*S***
*S**  IF WWDICTOD.WW-RANGE-LO NOT = ' ' OR
*S**     WWDICTOD.WW-RANGE-HI NOT = ' '
*S**    IF #VALUE = WWDICTOD.WW-RANGE-LO THRU
*S**                WWDICTOD.WW-RANGE-HI
*S**      ASSIGN #WITHIN-RANGE = TRUE
*S**    END-IF
*S**  END-IF
*S**END-SUBROUTINE /* RANGE-VERF
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE READ-HEADER
*S*************************************************************************
*S***
*S**  ASSIGN WWDICTOD.WW-RECORD-TYPE = DICT-HEADER-TYPE
*S**  ASSIGN WWDICTOD.WW-VALUE = DICT-HEADER-LIT
*S**  ASSIGN WWAOBJ.#FUNCTION = 'GET'
*S**  PERFORM CALL-OBJECT
*S**  IF WWAOBJ.#EXISTS             /* Before check for reference, store
*S**    PERFORM HOLD-FLDS           /* Utility upd flds, format & length
*S**  END-IF
*S**  PERFORM REFERENCE-VERF        /* Check for reference to other field
*S**  IF #EXT-LOOKUP
*S**    ESCAPE ROUTINE IMMEDIATE
*S**  END-IF
*S**  IF WWAOBJ.#EXISTS
*S**    ASSIGN #HEADER-REC = TRUE
*S**  END-IF
*S**END-SUBROUTINE /* READ-HEADER
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE REFERENCE-VERF
*S*************************************************************************
*S***
*S**  DECIDE FOR EVERY CONDITION
*S**    WHEN WWDICTOD.WW-REFER-FILE NE ' '
*S**      ASSIGN WWDICTOD.WW-FILE = WWDICTOD.WW-REFER-FILE
*S**    WHEN WWDICTOD.WW-REFER-FIELD NE ' '
*S**      ASSIGN WWDICTOD.WW-FIELD = WWDICTOD.WW-REFER-FIELD
*S**    WHEN ANY
*S**      PERFORM CHECK-EXTERNAL-FILE /* Check to see if field validation
*S**                                  /*  should be from WW-EXTERNAL file
*S**      /*
*S**      IF NOT #DICT-LOOKUP
*S**        /*
*S**        /* Use WW-EXTERNAL value-validation
*S**        ASSIGN #EXT-LOOKUP = TRUE
*S**        ESCAPE ROUTINE IMMEDIATE
*S**      ELSE
*S**        PERFORM CALL-OBJECT
*S**      END-IF
*S**    WHEN NONE
*S**      IGNORE
*S**  END-DECIDE
*S**END-SUBROUTINE /* REFERENCE-VERF
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE SPECIAL-CHARACTERS
*S*************************************************************************
*S***
*S**  EXAMINE #TEMP-VAR-IN '$' DELETE
*S**  EXAMINE #TEMP-VAR-IN '?' DELETE
*S**  EXAMINE #TEMP-VAR-IN '^' DELETE
*S**  EXAMINE #TEMP-VAR-IN ',' DELETE
*S**  EXAMINE #TEMP-VAR-IN '.' DELETE
*S**  EXAMINE #TEMP-VAR-IN '/' DELETE
*S**  EXAMINE #TEMP-VAR-IN '-' DELETE
*S**  EXAMINE #TEMP-VAR-IN '(' DELETE
*S**  EXAMINE #TEMP-VAR-IN ')' DELETE
*S**  EXAMINE #TEMP-VAR-IN '"' DELETE
*S**  EXAMINE #TEMP-VAR-IN '_' DELETE
*S**  EXAMINE #TEMP-VAR-IN ' ' DELETE
*S**  MOVE #TEMP-VAR-IN TO #TEMP-VAR-OUT
*S**END-SUBROUTINE /* SPECIAL-CHARACTERS
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE TRANSLATE-USERVIEWS
*S*************************************************************************
*S**  /*
*S**  /* Determine file PDA (Dictionary only uses file PDA's)
*S**  /*  (Allows use of userviews within maps)
*S**  /*
*S**  /* Lookup PDA id in PDA/File xref.
*S**  IF WWDICTOD.WW-FILE = MASK(X......X) 'W......S'
*S**    MOVE 'D' TO SUBSTRING(WWDICTOD.WW-FILE,8,1)  /* Check for shadow
*S**    MOVE 'D' TO SUBSTRING(#HOLD-FILE,8,1)        /*  definition, get
*S**  END-IF                                         /*  data PDA definition
*S**  /*
*S**  FOR #PDA-SUB = 1 TO #PDA-MAX
*S**    IF #PDA-ID(#PDA-SUB) = ' '
*S**      ESCAPE BOTTOM
*S**    END-IF
*S**    IF #PDA-ID(#PDA-SUB) = #HOLD-FILE
*S**      ASSIGN #PDA-FILE-NAME = #FILE-ID(#PDA-SUB)
*S**      ESCAPE BOTTOM
*S**    END-IF
*S**  END-FOR
*S**  /*
*S**  /* Lookup first File id occurence  (first is primary file definition)
*S**  IF #PDA-FILE-NAME NE ' '
*S**    FOR #PDA-SUB = 1 TO #PDA-MAX
*S**      IF #FILE-ID(#PDA-SUB) = ' '
*S**        ESCAPE BOTTOM
*S**      END-IF
*S**      IF #FILE-ID(#PDA-SUB) = #PDA-FILE-NAME
*S**        ASSIGN #HOLD-FILE = #PDA-ID(#PDA-SUB)
*S**        ASSIGN WWDICTOD.WW-FILE = #PDA-ID(#PDA-SUB)
*S**        ESCAPE BOTTOM
*S**      END-IF
*S**    END-FOR
*S**  END-IF
*S**END-SUBROUTINE /* TRANSLATE-USERVIEWS
*S***
*S*************************************************************************
*S**DEFINE SUBROUTINE VALUE-VALIDATION
*S*************************************************************************
*S**    /*
*S**    /* Remove underscores from data
*S**    /*  (Prevents 'arrowed over' spaces being stored as underscores)
*S**    /* For e-mail addresses remove only leading/trailing underscores
*S**    EXAMINE #FILE-FIELD FOR 'EMAIL' GIVING NUMBER #COUNT-EMAIL
*S**    IF #COUNT-EMAIL = 0
*S**      EXAMINE #VALUE FOR '_' REPLACE WITH SPACE
*S**    ELSE
*S**      MOVE #VALUE TO #VALUE-EMAIL
*S**      FOR #VE-SUB = 1 TO 50
*S**        IF #VE(#VE-SUB) NE SPACE AND #VE(#VE-SUB) NE '_'
*S**          ESCAPE BOTTOM
*S**        END-IF
*S**        MOVE SPACE TO #VE(#VE-SUB)
*S**      END-FOR
*S**      FOR #VE-SUB = 50 TO 1 STEP -1
*S**        IF #VE(#VE-SUB) NE SPACE AND #VE(#VE-SUB) NE '_'
*S**          ESCAPE BOTTOM
*S**        END-IF
*S**        MOVE SPACE TO #VE(#VE-SUB)
*S**      END-FOR
*S**      MOVE #VALUE-EMAIL TO #VALUE
*S**    END-IF
*S**    /*
*S**    PERFORM CHECK-EXTERNAL-FILE  /* Check to see if field validation
*S**                                 /*  should occur from WW-EXTERNAL file
*S**    /*
*S**    IF NOT #DICT-LOOKUP
*S**      /*
*S**      /* Use WW-EXTERNAL value-validation
*S**      ESCAPE ROUTINE IMMEDIATE
*S**    END-IF
*S**    /*
*S**    PERFORM READ-HEADER          /* Read header rec
*S**    IF #EXT-LOOKUP
*S**      ESCAPE ROUTINE IMMEDIATE
*S**    END-IF
*S**    /*
*S**    IF #VALUE = SPACE AND        /* Allow blank values
*S**       (NOT #NUMERIC-MASK OR
*S**        (#NUMERIC-MASK AND #BLANK-SUB > 0))
*S**      MOVE LEFT '*' TO #HOLD-FED-VAL
*S**      ASSIGN #VALID-VALUE = TRUE
*S**      ESCAPE ROUTINE IMMEDIATE
*S**    END-IF
*S**    IF #HEADER-REC
*S**      PERFORM RANGE-VERF         /* Check for (min/max) value
*S**    ELSE
*S**      ASSIGN #VALID-VALUE = TRUE /* No header rec, therefore all
*S**      ESCAPE ROUTINE IMMEDIATE   /*  values are valid
*S**    END-IF
*S**    /*
*S**    IF #WITHIN-RANGE             /* If value within range, exit subpgm
*S**      ASSIGN #VALID-VALUE = TRUE
*S**      ESCAPE ROUTINE IMMEDIATE
*S**    ELSE                         /* If value not in range, check for
*S**                                 /*  valid value directly
*S**      IF WWDICTOD.WW-VALUES-EXIST
*S**        ASSIGN WWAOBJ.#FUNCTION = 'GET'
*S**        ASSIGN WWDICTOD.WW-RECORD-TYPE = DICT-VALUE-TYPE
*S**        ASSIGN WWDICTOD.WW-VALUE = #VALUE
*S**        PERFORM CALL-OBJECT
*S**        IF WWAOBJ.#EXISTS
*S**          ASSIGN #VALID-VALUE = TRUE
*S**          IF WWDICTOD.WW-FEDERAL-VALUE NE SPACE
*S**            MOVE WWDICTOD.WW-FEDERAL-VALUE TO #HOLD-FED-VAL
*S**          END-IF
*S**        ELSE
*S**          ASSIGN #FAIL-EDIT = TRUE
*S**        END-IF
*S**      ELSE                       /* If valid values don't exist, all
*S**                                 /*  values are valid
*S**        ASSIGN #VALID-VALUE = TRUE
*S**      END-IF
*S**    END-IF
*S**END-SUBROUTINE /* VALUE-VALIDATION
*S**END