This section describes the user exits supplied for the Natural Construct administration models. The administration models generate the model subprograms used by all models.
This section covers the following topics:
User exits insert customized or specialized processing into a model subprogram, which is preserved when the module is regenerated. Natural Construct provides a wide variety of user exits for the administration models. The exits vary depending on the type of subprogram generated. Some exits contain sample code or subroutines, while others generate the DEFINE EXIT…END-EXIT lines only — and you provide the code.
You can modify any user exit code generated into the edit buffer. If multiple user exits are generated with the same name, Natural Construct merges them into a single exit.
User exits are provided for the following administration models:
CST-Clear
CST-Read
CST-Save
CST-Modify and CST-Modify-332
CST-Pregen
CST-Postgen
CST-Frame
CST-Document
CST-Validate
CST-Stream
CST-Shell
If you specify a new model name on the Generation main menu (M function) and the source buffer contains code, you can retain the code and use it with the model you are creating. This functionality saves time and effort when creating models that use the same code.
If the source buffer contains code when you specify a new model name, the following window is displayed:
Natural Construct CSGNEW0
CLEAR Source Area
Mark if you wish to clear the source area _ |
To retain the code in the source buffer for use with the new
module:
Press Enter.
The first specification panel for the new model is displayed and Natural Construct retains the user exit code for use with the new module.
To clear the code in the source buffer (and not save it for the new
module):
Select Mark if you wish to clear the source area.
Press Enter.
The source buffer is cleared and the first specification panel for the specified model is displayed.
You can invoke the User Exit editor from the Generation main menu or from the last specification panel for a model that supports user exits.
To invoke the User Exit editor from the Generation main menu, see User Exit Editor, Natural Construct Generation.
To invoke the User Exit editor from the model specification panels, press PF11 (userX) on the last specification panel for a model that supports user exits.
If user exits are defined for the specified module, the existing user exit code is displayed in the User Exit editor. If no exits are defined, a list of the exits available for that model is displayed.
Tip:
To select additional exits, enter "SAMPLE"
at the > prompt.
Note:
The SAMPLE command is performed automatically when you invoke the
User Exit editor and no user exits are defined for the specified module.
The User Exits panel is similar for all models. The following example shows the User Exits panel for the CST-Clear model:
CSGSAMPL CST-Clear Subprogram CSGSM0
Aug 17 User Exits 1 of 1
User Exits Exists Sample Required Conditional
-------------------------------- -------- ---------- -------- ----------
_ CHANGE-HISTORY Subprogram
_ PARAMETER-DATA
_ LOCAL-DATA
_ PROVIDE-DEFAULT-VALUES Subprogram
_ BEFORE-CHECK-ERROR Example
_ ADDITIONAL-INITIALIZATIONS Example
_ END-OF-PROGRAM |
The fields on this panel are:
| Field | Description |
|---|---|
| User Exits | Names of the user exits available for this model. If a user exit is required and not conditional (its existence is not based on condition codes in the code frames), it is marked by default. |
| Exists | Indicates whether the corresponding user exit
is defined.
|
| Sample | Indicates the contents of the user exit.
|
| Required | Indicates whether the user exit is required.
|
| Conditional | Indicates whether the user exit is conditional
(its existence is based on condition codes in the code frames).
|
To select a user exit displayed on the User Exits panel:
Type "X" in the input field to the left of each user exit you want to use.
Press Enter.
The selected user exits are displayed in the User Exit editor.
Note:
Fully qualify all references to database fields with the file
name.
Tip:
You can also define user exits in the User Exit editor without using
the SAMPLE command.
The code specified within a user exit depends on the type of module generated and the user exit used. However, all Natural Construct user exits have the following format:
0010 DEFINE EXIT user-exit-name 0020 user exit code 0030 END-EXIT user-exit-name
Note:
Do not insert comments or Natural code on the DEFINE EXIT and
END-EXIT lines.
This section describes the user exits supplied for the Natural Construct administration models. The user exits are listed in alphabetical order. For many exits, one or more examples are included.
The supplied user exits are:
This user exit generates the framework for any additional initializations performed in the INITIALIZATIONS subroutine.
** SAG DEFINE EXIT ADDITIONAL-INITIALIZATIONS * * Assign parameters for help routine CD-HELPR MOVE 'CU' TO #MAJOR-COMPONENT MOVE *PROGRAM TO #MINOR-COMPONENT * **SAG END-EXIT * END-SUBROUTINE /* INITIALIZATIONS
This user exit is used in combination with the LOCAL-DATA user exit. It generates STACK statements for code frame parameters that do not have a corresponding variable in the model PDA.
DEFINE EXIT ADDITIONAL-SUBSTITUTION-VALUES
*
* Substitution for frame parameters not defined in model PDA
STACK TOP DATA FORMATTED '&CENTERED-HEADER1'
#CENTERED-HEADER1
STACK TOP DATA FORMATTED '&CENTERED-HEADER2'
#CENTERED-HEADER2
STACK TOP DATA FORMATTED '&DATE-EM'
#DATE-EM
STACK TOP DATA FORMATTED '&EOD-TABT'
#EOD-TABT
STACK TOP DATA FORMATTED '&EXPORT-DELIMITER'
#EXPORT-DELIMITER
STACK TOP DATA FORMATTED '>-LT'
#GT-LT
STACK TOP DATA FORMATTED '&HEAD1-LEN'
#HEAD1-LEN
STACK TOP DATA FORMATTED '&HEAD2-LEN'
#HEAD2-LEN
STACK TOP DATA FORMATTED '&INPUT-LINES'
#INPUT-LINES
STACK TOP DATA FORMATTED '&KEY-PREFIX'
#KEY-PREFIX
STACK TOP DATA FORMATTED '<-GT'
#LT-GT
STACK TOP DATA FORMATTED '&PARM-NAT-FORMAT'
#PARM-NAT-FORMAT
STACK TOP DATA FORMATTED '&PREFIX-NAT-FORMAT'
#PREFIX-NAT-FORMAT
STACK TOP DATA FORMATTED '&SEL-TBL-SIZE'
#SEL-TBL-SIZE
STACK TOP DATA FORMATTED '&TIME-EM'
#TIME-EM
STACK TOP DATA FORMATTED '&UQ'
#UQ
STACK TOP DATA FORMATTED '&UQ-FOUND'
#UQ-FOUND
STACK TOP DATA FORMATTED '&VALUE-UQ'
#VALUE-UQ
STACK TOP DATA FORMATTED '&VAR-UQ'
#VAR-UQ
STACK TOP DATA FORMATTED '&VIEW-LDA'
#VIEW-LDA
STACK TOP DATA FORMATTED '&WINDOW-WIDTH'
#WINDOW-WIDTH
STACK TOP DATA FORMATTED '&WITH-BLOCK'
#WITH-BLOCK
END-EXIT ADDITIONAL-SUBSTITUTION-VALUES
This user exit generates the framework for additional translations performed in the GET-PROMPT-TEXT subroutine.
3070 **SAG DEFINE EXIT ADDITIONAL-TRANSLATIONS 3080 * 3090 IF #FIRST-TRANSLATION OR CU--PDA.#PDA-PHASE = CSLPHASE.#TRANSLATE 3100 THEN 3110 PERFORM SET-MODIFY-HEADER3 3120 /* 3130 /* Set completed message 3140 RESET CNAMSG.INPUT-OUTPUTS 3150 ASSIGN CNAMSG.MSG-DATA(1) = #PDA-FRAME-PARM 3160 ASSIGN CNAMSG.MSG = CUBASRPL.#RETURN-MESSAGE 3170 PERFORM GET-MESSAGE-TEXT 3180 ASSIGN CUBASRPL.#RETURN-MESSAGE = CNAMSG.MSG 3190 RESET CNAMSG.INPUT-OUTPUTS 3200 /* 3210 /* Assign available keys 3220 ASSIGN CU--PDA.#PDA-AVAILABLE1-NAME = #AVAILABLE1-NAME 3230 ASSIGN CU--PDA.#PDA-AVAILABLE2-NAME = #AVAILABLE2-NAME 3240 ASSIGN CU--PDA.#PDA-AVAILABLE3-NAME = #AVAILABLE3-NAME 3250 RESET #FIRST-TRANSLATION 3260 /* 3270 /* Override pfkey settings 3280 RESET #LOCAL-PFKEYS-REQUIRED 3290 /* 3300 /* Set all PF-keys named off 3310 INCLUDE CU--SOFF 3320 /* 3330 /* Set Help and Return keys 3340 SET KEY DYNAMIC CU--PDA.#PDA-PF-HELP = HELP 3350 NAMED CU--PDA.#PDA-HELP-NAME 3360 SET KEY DYNAMIC CU--PDA.#PDA-PF-RETURN 3370 NAMED CU--PDA.#PDA-RETURN-NAME 3380 END-IF 3390 **SAG END-EXIT
The code in this exit is executed immediately after each input panel is displayed and the standard keys and direct commands are processed (AT END OF PAGE section). You can use this exit to:
Define validity edits for user-defined fields
Add non-standard PF-key processing to a module
For example, when you add a non-standard PF-key, you can set the #SCROLLING variable to True so the generated module does not trap the PF-key as invalid. After processing the non-standard key, include the PERFORM NEW-SCREEN code to return to the main panel (main INPUT statement) for the module. If you do not include the PERFORM NEW-SCREEN code and continue with execution after processing this exit, an Invalid PF-key message is displayed.
2730 **SAG DEFINE EXIT AFTER-INPUT 2740 IF #FORMAT-HELP 2750 RESET #FORMAT-HELP 2760 ASSIGN CU--FHL.#TEXT-REQUIRED = TRUE 2770 PERFORM GET-PROMPT-TEXT 2780 INPUT WINDOW = 'FRMT' USING MAP 'CU--FH0' 2790 ASSIGN CSAMARK.ERROR-POS = POS(#PDAX-VARIABLE-FORMAT) 2800 ESCAPE BOTTOM (NEW-SCREEN.) 2810 END-IF 2820 * 2830 **SAG END-EXIT
This user exit generates the framework for any processing performed after subpanels are invoked.
0100 DEFINE EXIT AFTER-INVOKE-SUBPANELS 0110 PERFORM SET-MORE-INDICATORS 0120 END-EXIT
This user exit generates initialization statements for all #PDA variables in the model PDA. The variables are assigned null default values. You can modify the generated code as desired.
Tip:
If you add specification parameters to the model PDA, you can get
sample statements for the new parameters by regenerating this exit.
Regeneration adds the new variables, but does not modify code from the previous
generation.
DEFINE EXIT ASSIGN-DERIVED-VALUES * * Initialize '#PDA-' parameters in PDA. ASSIGN #PDA-FIELD-TYPE = ' ' ASSIGN #PDA-FIELD-REDEFINED = FALSE ASSIGN #PDA-LEVEL-NUMBER = 0 ASSIGN #PDA-FIELD-FORMAT = ' ' ASSIGN #PDA-FIELD-LENGTH = 0 ASSIGN #PDA-UNITS = 0 ASSIGN #PDA-DECIMALS = 0 ASSIGN #PDA-FROM-INDEX(*) = 0 ASSIGN #PDA-THRU-INDEX(*) = 0 ASSIGN #PDA-FIELD-RANK = 0 ASSIGN #PDA-FILE-CODE = 0 ASSIGN #PDA-MAX-LINES = 0 ASSIGN #PDA-WFRAME = ' ' ASSIGN #PDA-WLENGTH = ' ' ASSIGN #PDA-WCOLUMN = ' ' ASSIGN #PDA-WBASE = ' ' END-EXIT ASSIGN-DERIVED-VALUES
This user exit generates the framework for any processing performed before a standard error check. When an error condition occurs, the END-OF-PROGRAM user exit is bypassed. If a model subprogram requires processing before leaving the program, use this user exit to specify the processing.
1320 **SAG DEFINE EXIT BEFORE-CHECK-ERROR 1330 * 1340 * Use this user exit for specific error checking 1350 IF CSASTD.RETURN-CODE = CSLRCODE.#INTERRUPT(*) 1360 ASSIGN C--PDA.#PDA-PHASE = #SAVE-PHASE 1370 END-IF 1380 **SAG END-EXIT
The code in this exit is executed immediately before the INPUT statement is processed in the AT END OF PAGE section. You can use this exit to:
Look up a code table (to display a description, as well as a code value)
Issue SET CONTROL statements
Capture or default map variables prior to displaying each panel
0160 DEFINE EXIT BEFORE-INPUT 0170 * 0180 * Assign external value 0190 FOR #I = 1 TO 7 0200 IF #PDAX-BACKGROUND-COLOUR = #CD(#I) THEN 0210 ASSIGN #REVERSED-CD(#I) = TRUE 0220 ESCAPE BOTTOM 0230 END-IF 0240 END-FOR 0250 END-EXIT
This user exit generates the framework for any processing performed before subpanels are invoked.
0680 DEFINE EXIT BEFORE-INVOKE-SUBPANELS 0690 IF CU--PDA.#PDA-PHASE NE CSLPHASE.#TRANSLATE THEN 0700 PERFORM VALIDATE-FILE-INFO 0710 END-IF 0720 END-EXIT
The code in this user exit allows you to interrogate the message codes and override the display logic for the generated messages. For example, if the logic specifies that a message is ignored, you can display the message. If the logic specifies that the program is interrupted, you can terminate the program.
0010 END-SUBROUTINE /* INPUT-SCREEN 0020 * 0030 * DEFINE SUBROUTINE REINPUT-MESSAGE 0040 * 0050 **SAG DEFINE EXIT BEFORE-REINPUT-MESSAGE 0060 IF CSASTD.RETURN-CODE = CSLRCODE.#COMMUNICATION THEN 0070 ESCAPE BOTTOM(PROG.) IMMEDIATE 0080 END-IF 0090 **SAG END-EXIT 0100 DECIDE FOR FIRST CONDITION 0110 WHEN CSASTD.RETURN-CODE = CSLRCODE.#CONTINUE(*) 0120 IGNORE 0130 WHEN CSASTD.RETURN-CODE = CSLRCODE.#INTERRUPT(*) 0140 ESCAPE BOTTOM(NEW-SCREEN) 0150 WHEN NONE 0160 IGNORE 0170 END-DECIDE
The code in this user exit checks any additional PF-keys defined for a maintenance subprogram or prepares for standard PF-key validations.
DEFINE EXIT BEFORE-STANDARD-KEY-CHECK * * Use this user exit to check additional PF-keys or prepare for the * standard PF-key check. END-EXIT BEFORE-STANDARD-KEY-CHECK
This user exit keeps a record of changes to the generated module. It generates comment lines indicating the date, the user ID of the user who created or modified the module, and a description of any change.
DEFINE EXIT CHANGE-HISTORY * Changed on Aug 17,07 by SAG for release ____ * > * > * > END-EXIT CHANGE-HISTORY
This user exit contains statements that document specification parameter values (#PDAX variables) in the model PDA. For example, if you are documenting a menu program, this user exit contains the menu function codes and descriptions.
DEFINE EXIT DESCRIBE-INPUTS * * Enter other model parameters to be documented. * Use WRITE statements of the following format: * WRITE(SRC) NOTITLE LDA.#Variable-name #PDAX-variable-name END-EXIT DESCRIBE-INPUTS
The code in this exit is executed once before the module is terminated. You can use this exit for any cleanup required (such as assigning a termination message or resetting windows) before exiting the module. You can also use this exit to assign the current key value to a global variable so it is carried into other modules that use the same key.
Note:
If an error condition occurs, this user exit will not be executed.
Use the BEFORE-CHECK-ERROR user exit
if processing is required before leaving the program.
3310 **SAG DEFINE EXIT END-OF-PROGRAM 3320 * 3330 * Actions to be performed before program exit. 3340 IF #PDAX-GDA NE ' ' AND #PDA-PHASE = 'M' THEN 3350 ASSIGN CNAEXIST.#OBJECT-SOURCE = 'O' 3360 ASSIGN CNAEXIST.#LIBRARY-NAME = *LIBRARY-ID 3370 ASSIGN CNAEXIST.#INCLUDE-STEPLIB-SEARCH = TRUE 3380 ASSIGN CNAEXIST.#OBJECT-NAME = #PDAX-GDA 3390 CALLNAT 'CNUEXIST' CNAEXIST 3400 CSASTD 3410 PERFORM CHECK-ERROR 3420 IF NOT CNAEXIST.#OBJECT-EXISTS THEN 3430 ASSIGN CNAMSG.RETURN-CODE = CSLRCODE.#WARNING 3440 ASSIGN CNAMSG.MSG-DATA(1) = CU--MAL.#GDA 3450 ASSIGN CNAMSG.MSG-DATA(2) = #PDAX-GDA 3460 INCLUDE CU--GMSG '2128' 3470 ''':1::2::3:not in current library or STEPLIBs''' 3480 END-IF 3490 END-IF 3500 **SAG END-EXIT
This user exit generates the framework for any code generated by a model subprogram.
DEFINE EXIT GENERATE-CODE
*
RESET CSASELFV CSASELFV.GENERAL-INFORMATION
CSASELFV.FIELD-SPECIFICATION(*)
MOVE CUMPPDA.#PDAX-VIEW-LPDA-STRUCT-NAME(*) TO
CSASELFV.#VIEW-LPDA-STRUCT-NAME(*)
MOVE CUMPPDA.#PDAX-FIELD-NAME(*) TO CSASELFV.FIELD-NAME(*)
MOVE CUMPPDA.#PDAX-FIELD-FORMAT(*) TO CSASELFV.FIELD-FORMAT(*)
MOVE CUMPPDA.#PDAX-FIELD-LENGTH(*) TO CSASELFV.FIELD-LENGTH(*)
FOR #I = 1 TO #MAX-FLDS
MOVE CUMPPDA.#PDAX-MAX-OCCURS(#I) TO
CSASELFV.FIELD-OCCURRENCES(#I,1)
END-FOR
MOVE CUMPPDA.#PDAX-STRUCTURE-NUMBER(*) TO
CSASELFV.#STRUCTURE-NUMBER(*)
MOVE CUMPPDA.#PDAX-FIELD-PROMPT-OR-TEXT(*) TO
CSASELFV.FIELD-HEADINGS(*)
ASSIGN CSASELFV.#ARRAY-RANK-SELECTED = 1
CALLNAT 'CSUSELFV' CSASELFV
CU--PDA
CSASTD
ASSIGN CSASTD.ERROR-FIELD-INDEX1 = CSASELFV.#ERROR-FIELD-INDEX
PERFORM CHECK-ERROR
RESET CSASTD.ERROR-FIELD-INDEX1
MOVE CSASELFV.FIELD-NAME(*) TO CUMPPDA.#PDAX-FIELD-NAME(*)
MOVE CSASELFV.FIELD-FORMAT(*) TO CUMPPDA.#PDAX-FIELD-FORMAT(*)
MOVE CSASELFV.FIELD-LENGTH(*) TO CUMPPDA.#PDAX-FIELD-LENGTH(*)
MOVE CSASELFV.#STRUCTURE-NUMBER(*) TO
CUMPPDA.#PDAX-STRUCTURE-NUMBER(*)
MOVE CSASELFV.FIELD-HEADINGS(*) TO
CUMPPDA.#PDAX-FIELD-PROMPT-OR-TEXT(*)
MOVE CSASELFV.#VIEW-LPDA-STRUCT-NAME(*) TO
CUMPPDA.#PDAX-VIEW-LPDA-STRUCT-NAME(*)
FOR #I = 1 TO #MAX-FLDS
MOVE CSASELFV.FIELD-OCCURRENCES(#I,1)
TO CUMPPDA.#PDAX-MAX-OCCURS(#I)
EXAMINE CUMPPDA.#PDAX-FIELD-PROMPT-OR-TEXT(#I) FOR '/'
REPLACE WITH ' '
END-FOR
END-EXIT GENERATE-CODE
This user exit generates the framework for validations performed by the model validation subprogram. It is used in conjunction with the GENERATE-VALIDATIONS user exit and is available for modules generated using the CST-Validate model.
Code validations as subroutines in this user exit. For each #PDAX-FIELD-NAME field you want to validate, create a subroutine called V-field-name to perform the validations. Whenever a validation error is found, the V-field-name subroutine must:
Assign CSASTD.RETURN-CODE = ‘E’
Assign the error message in CSASTD.MSG
Perform an ESCAPE-ROUTINE to bypass subsequent checks
Tip:
To retrieve SYSERR messages, use the CU--VERR copycode.
Tip:
To return a warning message, rather than an error, use the CU--VWAR
copycode.
For more information about coding validations, see CST-Validate Model.
For information about validating array fields, see Validate Array Fields.
This user exit generates the framework for validations performed by the model validation subprogram. It is used in conjunction with the GENERATE-SUBROUTINES user exit and is available for modules generated using the CST-Validate model.
Note:
For more information, see CST-Validate Model.
This user exit contains an INPUT statement to read parameters that are not automatically included in a read subprogram.
DEFINE EXIT INPUT-ADDITIONAL-PARAMETERS * * Input all other parameters.. * * /* Input parameter SAMPLE * WHEN #LINE = 'SAMPLE:' * INPUT CXMYPDA.#PDAX-SAMPLE END-EXIT INPUT-ADDITIONAL-PARAMETERS
This user exit generates code to input screens (maps) for a maintenance subprogram.
DEFINE EXIT INPUT-SCREEN
IF CSASTD.RETURN-CODE = CSLERROR.#OK OR = CSLERROR.#WARNING
INPUT WITH TEXT CSASTD.MSG
MARK POSITION CSAMARK.ERROR-COLUMN IN CSAMARK.ERROR-POS
USING MAP 'map'
ELSE
INPUT WITH TEXT CSASTD.MSG
MARK POSITION CSAMARK.ERROR-COLUMN IN CSAMARK.ERROR-POS
ALARM
USING MAP 'map'
END-IF
END-EXIT INPUT-SCREEN
The code in this exit defines additional local variables used in conjunction with other user exits.
0480 **SAG DEFINE EXIT LOCAL-DATA 0490 01 #HELPR(A8) INIT<'CD-HELPR'> 0500 LOCAL USING CNAEXIST 0510 **SAG END-EXIT
This user exit generates the framework for any additional subroutines used by a maintenance subprogram.
DEFINE EXIT MISCELLANEOUS-SUBROUTINES ** ********************************************************************** DEFINE SUBROUTINE subroutine-name ********************************************************************** ** ESCAPE ROUTINE IMMEDIATE END-SUBROUTINE /* subroutine-name END-EXIT MISCELLANEOUS-SUBROUTINES
This user exit generates code to write the field and prompt values to Predict. To generate the correct code, translation LDAs must adhere to the following naming standards:
| Field | Prompt |
|---|---|
| #PDA-GEN-PROGRAM | CUMNMAL.#GEN-PROGRAM |
| #PDAX-TITLE | CUMNMAL.#TITLE |
0010 DEFINE EXIT MISCELLANEOUS-VARIABLES 0020 ***************************************************************** 0030 DEFINE SUBROUTINE MISCELLANEOUS 0040 ***************************************************************** 0050 * 0060 WRITE(SRC) NOTITLE 20T CU--DOCL.#MISC-SPECIFICATIONS 0070 WRITE(SRC) NOTITLE CU--PDA.#PDA-UNDERSCORE-LINE (AL=70) 0080 WRITE(SRC) NOTITLE ' ' 0090 END-SUBROUTINE /* MISCELLANEOUS 0100 END-EXIT
This user exit generates the framework to process any additional parameters used in conjunction with other programs.
DEFINE EXIT PARAMETER-DATA ** PARAMETER USING PDAname ** PARAMETER ** 01 #Additional-parameter1 ** 01 #Additional-parameter2 END-EXIT PARAMETER-DATA
This user exit documents information about PF-keys supported by a generated subprogram to the Predict data dictionary.
To document information about PF-keys:
Select the PF-KEYS user exit.
Press Enter.
A window is displayed, in which you can specify the supported PF-keys. Descriptions of the keys are added to Predict.
0090 * Translate pfkey functions 0100 PERFORM GET-CDKEYFL-TEXT 0110 * 0120 * Write pfkey names and functions 0130 PRINT(SRC) NOTITLE / 20T CU--DOCL.#PFKEY-SUPPORT 0140 / ' ' 0150 / 3T CU--DOCL.#PFKEY 14T CU--DOCL.#FUNCTION 0160 / 3T CU--PDA.#PDA-UNDERSCORE-LINE (AL=10) 0170 CU--PDA.#PDA-UNDERSCORE-LINE (AL=60) 0180 / 3T CDKEYLDA.#KEY-NAME(2) 0190 14T CDKEYFL.#KEY-FUNCTION(2) 0200 END-SUBROUTINE /* PF-KEYS 0210 END-EXIT 0220 DEFINE EXIT PF-KEYS 0230 ***************************************************************** 0240 DEFINE SUBROUTINE PF-KEYS 0250 ***************************************************************** 0260 * 0270 * Translate pfkey names 0280 INCLUDE CU--DOC 0290 * 0300 * Translate pfkey functions 0310 PERFORM GET-CDKEYFL-TEXT 0320 * 0330 * Write pfkey names and functions 0340 PRINT(SRC) NOTITLE / 20T CU--DOCL.#PFKEY-SUPPORT 0350 / ' ' 0360 / 3T CU--DOCL.#PFKEY 14T CU--DOCL.#FUNCTION 0370 / 3T CU--PDA.#PDA-UNDERSCORE-LINE (AL=10) 0380 CU--PDA.#PDA-UNDERSCORE-LINE (AL=60) 0390 / 3T CDKEYLDA.#KEY-NAME(3) 0400 14T CDKEYFL.#KEY-FUNCTION(3) 0410 END-SUBROUTINE /* PF-KEYS 0420 END-EXIT
This user exit is required for the CST-Modify-332 model if the maintenance subprogram supports special PF-keys (all keys other than Enter and help, return, quit, right, and left PF-keys).
Note:
Define the special PF-keys on the Maintain Subprograms panel. For
information, see Maintain
Subprograms Function.
After defining the keys and generating the model, this exit contains code you can use as a starting point for processing the keys.
DEFINE EXIT PROCESS-SPECIAL-KEYS
ASSIGN #PF-KEY = *PF-KEY
DECIDE ON FIRST VALUE OF *PF-KEY
VALUE #PF-*0039
/*
/* Perform *0039 processing
ASSIGN CSASTD.MSG = '*0039 processing completed successfully'
ESCAPE TOP
NONE VALUE
IF *PF-KEY NE 'ENTR'
REINPUT 'Invalid key:1:entered',#PF-KEY
END-IF
END-DECIDE
END-EXIT PROCESS-SPECIAL-KEYS
This user exit provides a list of default values for model parameters. If desired, it can also supply values for other parameters you want to initialize. Natural Construct provides default values for the #PDAX variables in the model PDA.
Tip:
To specify default values for additional parameters in a model PDA,
regenerate this user exit. This adds the new variables but does not modify the
code from the previous generation.
DEFINE EXIT PROVIDE-DEFAULT-VALUES ASSIGN CXMNPDA.#PDAX-DESCS(*) = ' ' ASSIGN CXMNPDA.#PDAX-USE-MSG-NR = FALSE ASSIGN CXMNPDA.#PDAX-PDA = ' ' ASSIGN CXMNPDA.#PDAX-FILE-NAME = ' ' ASSIGN CXMNPDA.#PDAX-FIELD-NAME = ' ' ASSIGN CXMNPDA.#PDAX-MAP-NAME = ' ' ASSIGN CXMNPDA.#PDAX-LINES-PER-SCREEN = 0 ASSIGN CXMNPDA.#PDAX-WINDOW-BASE = ' ' ASSIGN CXMNPDA.#PDAX-WINDOW-BASE-LINE = 0 ASSIGN CXMNPDA.#PDAX-WINDOW-BASE-COLUMN = 0 ASSIGN CXMNPDA.#PDAX-WINDOW-SIZE = ' ' ASSIGN CXMNPDA.#PDAX-WINDOW-LINE-LENGTH = 0 ASSIGN CXMNPDA.#PDAX-WINDOW-COLUMN-LENGTH = 0 ASSIGN CXMNPDA.#PDAX-WINDOW-FRAME = FALSE END-EXIT PROVIDE-DEFAULT-VALUES
This user exit is required for the CST-Save model. It generates a WRITE statement for each specification parameter (#PDAX variable) in the model PDA. Elements of array variables are written individually, including the number of array occurrences. The WRITE statement has the following format:
WRITE(SRC) NOTITLE '=' #PDAX-variable-name
Natural Construct transforms these lines as follows:
**SAG variable name: variable contents
and writes them at the beginning of Natural Construct-generated modules.
Tip:
If you add specification parameters to a model PDA, regenerate this
user exit to generate the WRITE statements for the new parameters. Regeneration
adds the new variables, but does not modify code from the previous
generation.
DEFINE EXIT SAVE-PARAMETERS
FOR #I = 1 TO 4
IF #PDAX-DESCS(#I) NE ' ' THEN
COMPRESS '#PDAX-DESCS(' #I '):' INTO #TEXT
LEAVING NO
PRINT(SRC) NOTITLE #TEXT #PDAX-DESCS(#I)
END-IF
END-FOR
WRITE(SRC) NOTITLE '=' #PDAX-USE-MSG-NR
/ '=' #PDAX-PDA
/ '=' #PDAX-FILE-NAME
/ '=' #PDAX-FIELD-NAME
/ '=' #PDAX-MAP-NAME
/ '=' #PDAX-LINES-PER-SCREEN
/ '=' #PDAX-WINDOW-BASE
/ '=' #PDAX-WINDOW-BASE-LINE
/ '=' #PDAX-WINDOW-BASE-COLUMN
/ '=' #PDAX-WINDOW-SIZE
/ '=' #PDAX-WINDOW-LINE-LENGTH
/ '=' #PDAX-WINDOW-COLUMN-LENGTH
/ '=' #PDAX-WINDOW-FRAME
END-EXIT SAVE-PARAMETERS
This user exit is required for the CST-Pregen model. It generates initialization statements for all conditions (#PDAC variables) in the model PDA. You can modify the generated code as desired.
A condition is set to True when a variable corresponding to the condition exists in the model PDA and has a non-null value. The variables and conditions are linked through their names; the #PDAX-name variable corresponds to the #PDAC-name or #PDAC-name-SPECIFIED condition.
For example, if the model PDA contains:
#PDAX-USE-MSG-NR(L) variable
#PDAC-USE-MSG-NR(L) condition
This user exit generates the following code:
WHEN #PDAX-USE-MSG-NR NE FALSE #PDAC-USE-MSG-NR = TRUE
If the model PDA contains:
#PDAX-GDA(A8) variable
#PDAC-GDA-SPECIFIED(L) condition
This user exit generates the following code:
WHEN #PDAX-GDA NE ' ' #PDAC-GDA-SPECIFIED = TRUE
The WHEN clause is blank for all conditions that have no corresponding variable in the model PDA.
Code for the conditions currently existing in this user exit is not generated. When you regenerate this user exit, only the code for new conditions (that were added to the model PDA since the previous generation) is added.
DEFINE EXIT SET-CONDITION-CODES
*
* Set conditions in PDA.
DECIDE FOR EVERY CONDITION
WHEN #PDAX-USE-MSG-NR NE FALSE
ASSIGN #PDAC-USE-MSG-NR = TRUE
WHEN #PDAX-FILE-NAME NE ' '
ASSIGN #PDAC-FILE-NAME-SPECIFIED = TRUE
WHEN #PDAX-FIELD-NAME NE ' '
ASSIGN #PDAC-FIELD-NAME-SPECIFIED = TRUE
WHEN #PDAX-PDA NE ' '
ASSIGN #PDAC-PDA-SPECIFIED = TRUE
WHEN NONE
IGNORE
END-DECIDE
END-EXIT
The code in this user exit is executed once at the beginning of the generated subprogram after all standard initial values are assigned. You can use this exit to do any initial setup required. For example:
Initialize input values from globals
Set window or page sizes
Capture security information for a restricted data area
This user exit is used by the CST-Postgen model, which generates the post-generation subprogram for a model. The post-generation subprogram generates STACK statements for substitution variables in the model PDA. To generate STACK statements for any substitution variables that are not in the model PDA, select the SUBSTITUTION-VALUES or ADDITIONAL-SUBSTITUTION-VALUES user exit (see below for a comparison).
If you select the SUBSTITUTION-VALUES user exit, STACK statements for all substitution variables are generated in the exit — those in the model PDA, as well as any additional variables. You can modify these variables as desired.
Which user exit you select depends on whether you want the model to stack substitution parameters in the code frame or in a user exit, thereby overriding the default substitution parameter handling.
If you use the SUBSTITUTION-VALUES user exit, you must code all substitution values in the exit since default code will not be generated.
If you use the ADDITIONAL-SUBSTITUTION-VALUES user exit (or no user exit), the model automatically stacks any model PDA variables that match the &SUBSTITUTION values in the code frame. For example:
STACK TOP DATA FORMATTED '&PRIME-FILE' #PDAX-PRIME-FILE
Note:
Use either the SUBSTITUTION-VALUES user exit or the
ADDITIONAL-SUBSTITUTION-VALUES user exit, but not both.
The code in this user exit performs edit checks on each parameter on a maintenance map (specified in the Map name field on the Standard Parameters panel). This section contains examples of user exit code for the CST-Modify and CST-Modify-332 model. The CST-Modify model supports dynamic multilingual specification panels and messages using SYSERR references and substitution variables. The code generated in this exit contains SYSERR numbers and substitution values.
0010 DEFINE EXIT VALIDATE-DATA 0020 DECIDE FOR EVERY CONDITION 0030 WHEN #HEADER1 = ' ' 0040 ASSIGN CNAMSG.MSG-DATA(1) = #HEADER1 0050 INCLUDE CU--RMSG '2001' 0060 ''':1::2::3:is required''' 0070 '#HEADER1' 0080 WHEN #HEADER2 = ' ' 0090 ASSIGN CNAMSG.MSG-DATA(1) = #HEADER2 0100 INCLUDE CU--RMSG '2001' 0110 ''':1::2::3:is required''' 0120 '#HEADER2' 0130 WHEN #PDA-GEN-PROGRAM = ' ' 0140 ASSIGN CNAMSG.MSG-DATA(1) = #GEN-PROGRAM 0150 INCLUDE CU--RMSG '2001' 0160 ''':1::2::3:is required''' 0170 '#PDA-GEN-PROGRAM' 0180 WHEN #PDA-SYSTEM = ' ' 0190 ASSIGN CNAMSG.MSG-DATA(1) = #SYSTEM 0200 INCLUDE CU--RMSG '2001' 0210 ''':1::2::3:is required''' 0220 '#PDA-SYSTEM' 0230 WHEN #PDA-TITLE = ' ' 0240 ASSIGN CNAMSG.MSG-DATA(1) = #TITLE 0250 INCLUDE CU--RMSG '2001' 0260 ''':1::2::3:is required''' 0270 '#PDA-TITLE' 0280 WHEN CUBAPDA.#PDAX-DESCS = ' ' 0290 ASSIGN CNAMSG.MSG-DATA(1) = #DESCS 0300 INCLUDE CU--RMSG '2001' 0310 ''':1::2::3:is required''' 0320 'CUBAPDA.#PDAX-DESCS' 0330 WHEN CUBAPDA.#PDAX-GDA = ' ' 0340 ASSIGN CNAMSG.MSG-DATA(1) = #GDA 0350 INCLUDE CU--RMSG '2001' 0360 ''':1::2::3:is required''' 0370 'CUBAPDA.#PDAX-GDA' 0380 WHEN CUBAPDA.#PDAX-GDA-BLOCK = ' ' 0390 ASSIGN CNAMSG.MSG-DATA(1) = #GDA-BLOCK 0400 INCLUDE CU--RMSG '2001' 0410 ''':1::2::3:is required''' 0420 'CUBAPDA.#PDAX-GDA-BLOCK' 0430 WHEN CUBAMAL.#DESCRIPTION = ' ' 0440 ASSIGN CNAMSG.MSG-DATA(1) = #DESCRIPTION 0450 INCLUDE CU--RMSG '2001' 0460 ''':1::2::3:is required''' 0470 'CUBAMAL.#DESCRIPTION' 0480 WHEN CUBAMAL.#GDA = ' ' 0490 ASSIGN CNAMSG.MSG-DATA(1) = #GDA 0500 INCLUDE CU--RMSG '2001' 0510 ''':1::2::3:is required''' 0520 'CUBAMAL.#GDA' 0530 WHEN CUBAMAL.#GDA-BLOCK = ' ' 0540 ASSIGN CNAMSG.MSG-DATA(1) = #GDA-BLOCK 0550 INCLUDE CU--RMSG '2001' 0560 ''':1::2::3:is required''' 0570 'CUBAMAL.#GDA-BLOCK' 0580 WHEN CUBAMAL.#GEN-PROGRAM = ' ' 0590 ASSIGN CNAMSG.MSG-DATA(1) = #GEN-PROGRAM 0600 INCLUDE CU--RMSG '2001' 0610 ''':1::2::3:is required''' 0620 'CUBAMAL.#GEN-PROGRAM' 0630 WHEN CUBAMAL.#SYSTEM = ' ' 0640 ASSIGN CNAMSG.MSG-DATA(1) = #SYSTEM 0650 INCLUDE CU--RMSG '2001' 0660 ''':1::2::3:is required''' 0670 'CUBAMAL.#SYSTEM' 0680 WHEN CUBAMAL.#TITLE = ' ' 0690 ASSIGN CNAMSG.MSG-DATA(1) = #TITLE 0700 INCLUDE CU--RMSG '2001' 0710 ''':1::2::3:is required''' 0720 'CUBAMAL.#TITLE' 0730 END-EXIT
DEFINE EXIT VALIDATE-DATA
*
* Edit checks on map parameters.
DECIDE FOR EVERY CONDITION
WHEN #HEADER1 = ' '
REINPUT 'Header1 is required'
MARK *#HEADER1 ALARM
WHEN #HEADER2 = ' '
REINPUT 'Header2 is required'
MARK *#HEADER2 ALARM
WHEN CDDIALDA.#PROGRAM = ' '
REINPUT 'Program is required'
MARK *CDDIALDA.#PROGRAM ALARM
WHEN CDGETDCA.#DIRECT-COMMAND = ' '
REINPUT 'Direct Command is required'
MARK *CDGETDCA.#DIRECT-COMMAND ALARM
WHEN NONE IGNORE
END-DECIDE
END-EXIT VALIDATE-DATA
The basic structure of this user exit is supplied in the above format. You can edit the supplied code as required.
Tip:
If you add specification parameters to the model PDA, you can
generate sample statements for the new parameters by regenerating this user
exit. Regeneration adds the new variables, but does not modify code from the
previous generation.