Provide information on SDF
Component: | SDF |
Functional area: | SDF control |
Domain: | SDF |
Privileges: | STD-PROCESSING |
Function
The HELP-SDF command displays information regarding SDF.
The information available is subdivided into sections that can be accessed via the individual operands of the command.
When the user enters HELP-SDF without operands or only with the preset operand values, a brief introduction to SDF is displayed (for a description see "HELP-SDF with preset operand values").
Entering /HELP-SDF? displays the operand form for the command (temporarily guided dialog), and the information required can be selected.
Format
HELP-SDF | Alias: HPSDF | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Operands
GUIDANCE-MODE = *NO / *YES
Type of dialog guidance (output see "HELP-SDF with GUIDANCE-MODE=*YES").
SDF-COMMANDS = *NO / *YES
SDF-specific commands (output see "HELP-SDF with SDF-COMMANDS=*YES").
ABBREVIATION-RULES = *NO / *YES
Abbreviation rules for the command syntax (output see "HELP-SDF with ABBREVIATION-RULES=*YES").
GUIDED-DIALOG = *YES(...) / *NO
Use of guided dialog (output see "HELP-SDF with GUIDED-DIALOG=*YES(SCREEN-STEPS=*YES)").
GUIDED-DIALOG = *YES(...)
The description of guided dialog is subdivided into 4 blocks of information which can be accessed individually as follows:
SCREEN-STEPS = *NO / *YES
Sequence and contents of the menus (application domain menu, command menu, operand form, subform; output see "HELP-SDF with GUIDED-DIALOG=*YES(SCREEN-STEPS=*YES)").
SPECIAL-FUNCTIONS = *NO / *YES
Special functions within the menu (output see "HELP-SDF with GUIDED-DIALOG=*YES(SPECIAL-FUNCTIONS=*YES)").
FUNCTION-KEYS = *NO / *YES
Function keys for menu control (output see "HELP-SDF with GUIDED-DIALOG=*YES(FUNCTION-KEYS=*YES)").
NEXT-FIELD = *NO / *YES
Input in the NEXT line for menu control (output see "HELP-SDF with GUIDED-DIALOG=*YES(NEXT-FIELD=*YES)").
UNGUIDED-DIALOG = *NO / *YES(...)
Use of unguided dialog (output see "HELP-SDF with UNGUIDED-DIALOG=*YES(SPECIAL-FUNCTIONS=*YES)").
UNGUIDED-DIALOG = *YES(...)
The description of unguided dialog is subdivided into 2 blocks of information which can be accessed individually as follows:
SPECIAL-FUNCTIONS = *NO / *YES
Special functions within the unguided dialog menu (output see "HELP-SDF with UNGUIDED-DIALOG=*YES(SPECIAL-FUNCTIONS=*YES)").
FUNCTION-KEYS = *NO / *YES
Function keys for controlling the unguided dialog menu (output see "HELP-SDF with UNGUIDED-DIALOG=*YES(FUNCTION-KEY=*YES)").
Return codes
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
0 | CMD0001 | Command executed | |
1 | 32 | CMD0500 | Syntax description in current syntax file invalid |
1 | 64 | CMD0810 | Error during execution. |
Information displayed with HELP-SDF:
HELP-SDF with preset operand values
% % Introduction % % SDF is a convenient command interpreter and dialogue manager % If the user desires, input can be entered as before. % But the user can also utilize the advantages of SDF: % - Abbreviation mechanism % - Block input % - Guided dialogue % - Command bufferization (history) % - Definition of task-specific default values % % In addition, a more comprehensible command language has % has been developed: % The names of commands, operands and constant operand % values were chosen so as to indicate clearly their function. % Similar features (for example, the name of a file) are % named accordingly similar naming rules (for example, FILE-NAME= % or FROM-FILE= or TO-FILE=). % Incorrect input is presented for correction along with % a message. % Commands which are part of the old commando language (ISP) % can be input in the form "<old cmd>?". The new SDF-command % is then displayed with its new syntax, i.e. a menu driven % dialog allows to set the appropriate operand values. % For further information, the user may enter "HELP-SDF?". % The operand form for the command will then be displayed. % Further information for an operand may then be obtained % by setting that operand to "YES". %
HELP-SDF with GUIDANCE-MODE=*YES
% % Types of dialogue: % % 1. Guided dialogue % Guided dialogue : supplies menus in the following order : % Domain menu, Command menu, Operand form menu, sub-form menu. % The extent of information offered in a menu can be controlled via % the GUIDANCE operand of the MODIFY-SDF-OPTIONS command : % - GUIDANCE=*MAXIMUM all operand values with options (limit % values etc.); help texts for commands % and operands % - GUIDANCE=*MEDIUM all operand values; % help texts only for commands % - GUIDANCE=*MINIMUM only default values for operands; % no options; no help texts. % % % 2. Unguided dialogue % Unguided dialogue : no menus. There are 2 types of unguided % dialogue, which can be controlled via the GUIDANCE operand % of the MODIFY-SDF-OPTIONS cmd : % - GUIDANCE=*NO: the system requests command input with % "%CMD:"; syntax error dialogue : correction % of incorrect input without repetition % of the entire command, detailed error % messages; grouped command input : % several commands, separated by logical % end-of-line characters (LZE), can be issued % at one time. % - GUIDANCE=*EXPERT: the system requests command input with "/", % no syntax error dialogue, detailed error % messages; grouped command input.ch. %
HELP-SDF with SDF-COMMANDS=*YES
% % SDF-specific commands: % % - HELP-SDF % Displays information about SDF. % - MODIFY-SDF-OPTIONS % Changes the task-specific SDF options. % - REMARK % Inserts remarks into the command files. % - RESET-INPUT-DEFAULTS % Deletes task-specific default values. % - RESTORE-SDF-INPUT % Reprompts a previous input. % - SHOW-CMD % Displays the syntax description of a command to SYSOUT/SYSLST. % - SHOW-SDF-OPTIONS % Displays the task-specific information for the SDF options. % - SHOW-INPUT-DEFAULTS % Outputs the task-specific default values. % - SHOW-INPUT-HISTORY % Displays the list of the latest inputs. % - SHOW-SYNTAX-VERSIONS % Displays information about the contents of the active % syntax files. % - WRITE-TEXT % Writes text to SYSOUT/SYSLST.
HELP-SDF with ABBREVIATION-RULES=*YES
% % Abbreviation rules for the command syntax: % % - Command name, operand name and constant operand values % (not basic data types) may be abbreviated as follows: % - Characters may be dropped from right to left % e.g.: TRANSFER-FILE abbreviated to TRANS % - Characters may be dropped from right to left % within the name elements. % e.g.: TRANSFER-FILE abbreviated to T-F % Restriction : Abbreviations must be unambiguous; % e.g.: CREATE as an abbreviation is ambiguous % between CREATE-FILE,CREATE-FILE-GENERATION, % CREATE-FILE-GROUP and CREATE-JV. % % - Operand values may also be specified without the % corresponding operand names (positional operands). % Here the following must be observed: % - A comma must be given for each omitted operand % preceding the positional operand. % - If, in the series of operands for a command, % an operand is specified completely (operand name and % operand value), subsequent operands may no longer be % specified as positional operands. % % - Guided dialogue: Operands for a structure need not be % in a sub-form, but may instead be entered in the operand % form. They must be enclosed in parentheses and must directly % follow the operand value introducing the structure. % % - Guided dialogue: In the NEXT line of the menu, complete % commands can also be entered. If a command name ends with % a question mark (<command>?), the operand form for the % specified command appears. It lists the operand values that % have already been specified (temporary guided dialogue). % If the specified command has no operands, the command help % text is displayed. % % - Ambiguity menus: entering a command name containing wildcards % and ending with a question mark causes SDF to display a menu % listing the commands which match the wildcard pattern. %
HELP-SDF with GUIDED-DIALOG=*YES(SCREEN-STEPS=*YES)
% % Guided dialogue: Order and content of the menus % % Domain menu : Lists all domains (commands are assigned % to particular domains according to their % function). A domain can be selected by % number or name. The domain *ALL-COMMANDS lists all % the commands. % Command menu : Lists all commands of the selected domain. % A command can be selected by number or name % A command followed by ! has no operands. % Operand form : Lists the operands of the selected command. % The operand values desired are to be % specified. % Sub-form : Lists the operands of a structure % If an operand value introducing a structure % is specified in an operand form, a sub-form % for the corresponding structure is % displayed. % Command menu : If a command has been executed or aborted, % the current command menu appears again. %
HELP-SDF with GUIDED-DIALOG=*YES(SPECIAL-FUNCTIONS=*YES)
% % ? as operand value: % Supplies help text and options (limit values, etc.) % for the operand; in addition, detailed error % messages in the case of incorrect input. % ?? as operand value: % calls up a help text, a display of the range of % values for the relevant operand and an help text % giving information about the data types associated % with the operand. % ! as operand value: % Enters the default value for the operand. % ( following an operand value introducing a structure: % Displays the sub-form for the structure associated % with the operand value. % () following an operand value introducing a structure: % Suppresses the sub-form and enters the default % values for the operands of the structure. % - as the last character in an input line: % A continuation line is displayed. % LZF key : % Deletes all characters in the input line, starting % at the cursor. %
HELP-SDF with GUIDED-DIALOG=*YES(FUNCTION-KEYS=*YES)
% % Guided dialogue: Function keys % % The effect of the function keys depends on the FUNCTION-KEYS % option (MODIFY-SDF-OPTIONS command/statement). % 2 modes are possible : the *OLD-MODE and the *STYLE-GUIDE-MODE % which offers a richer functionality. % % *OLD-MODE % % K1 EXIT function % Equivalent to *EXIT in NEXT line. % Equivalent to F3 in *STYLE-GUIDE-MODE (see below). % K2 INTERRUPT function. % Interrupts the program or procedure which is currently % running or interrupt of command output. % K3 REFRESH function % Screen refresh function. % Equivalent to *REFRESH in NEXT line. % Equivalent to F5 in *STYLE-GUIDE-MODE. % F1 EXIT-ALL function % Equivalent to *EXIT-ALL in NEXT line. % Equivalent to F6 in *STYLE-GUIDE-MODE (see below). % F2 TEST function % Checks inputs for syntax errors. Equivalent to *TEST in the % NEXT line. % F3 EXECUTE function % Executes the current operation. Equivalent to *EXECUTE in % the NEXT line. % Equivalent to F11 in *STYLE-GUIDE-MODE (see below). % % *STYLE-GUIDE-MODE % % K2 INTERRUPT function. % Interrupts the program or procedure which is currently % running or interrupt of command output. % F1 HELP function. % Causes the display of a guided screen. % Equivalent to entering "?" in the NEXT line. % F3 EXIT function. % Exits the current menu or form and switches to the % higher-ranking menu. % Equivalent to *EXIT in NEXT line. % Equivalent to K1 in *OLD-MODE. % F5 REFRESH % Screen refresh function. % Equivalent to *REFRESH in NEXT line. % Equivalent to K3 in *OLD-MODE. % F6 EXIT-ALL function % Exits the current menu or form and switches % to the highest-ranking menu. % Equivalent to *EXIT-ALL in NEXT line. % Equivalent to F1 in *OLD-MODE. % F7 BACKWARD paging function % Pages backward in the menu or form. % Equivalent to "-" in NEXT line. % F8 FORWARD paging function % Pages forward in the menu or form. % Equivalent to "+" in NEXT line. % F9 REST-SDF-IN function. % Causes the last command / statement to be restored. % Equivalent to RESTORE-SDF-INPUT. % F11 EXECUTE function % Executes the current operation. Equivalent to *EXECUTE in % the NEXT line. % Equivalent to F3 in *OLD-MODE. % F12 Cancel function. % Exits the current menu or form and switches %PLEASE ACKNOWLEDGE % to the higher-ranking menu or form. % Equivalent to *CANCEL in NEXT line. %
HELP-SDF with GUIDED-DIALOG=*YES(NEXT-FIELD=*YES)
% % Guided dialogue: NEXT line % % +,++,-,-- : Pages forward and back in the menu. % + and - equivalent to F8 and F7 respectively % in *STYLE-GUIDE-MODE. % *EXECUTE : Executes the current command. Equivalent % to the F3 key in *OLD-MODE and F11 in % *STYLE-GUIDE-MODE. % *CONTINUE : Combination of + or *EXECUTE depending of the % value given in the actual questionnaire. % *TEST : Checks input for syntax errors. Equivalent % to the F2 key in *OLD-MODE. % *EXIT : exits the current menu or form and switches % to the higher-ranking menu. Equivalent % to the K1 key in *OLD-MODE and F3 key in % *STYLE-GUIDE-MODE. % *EXIT-ALL : exits the current menu or form and switches % to the highest-ranking menu. Equivalent %PLEASE ACKNOWLEDGE % to the F1 key in *OLD-MODE and F6 key in % *STYLE-GUIDE-MODE. % *CANCEL : exits the current menu or form and switches % to the higher-ranking menu or form. Equivalent % to the F12 key in *STYLE-GUIDE-MODE. % *REFRESH : Repeats the last menu displayed. Equivalent % to the K3 key in *OLD-MODE and F5 in % *STYLE-GUIDE-MODE. % *DOM-MENU : Switches to the domain menu. % (<domain>) : Displays the command menu of the domain <domain>. % <command>? : Executes the current operation and displays % the operand form for the command <command>. % Operand values that have already been specified % are entered in the form. % <command> : Executes the current operation and then, % in addition, the specified command <command>. % !<command> : Executes the current operation and defines the % specified operand values as task-specific % default values of the command. When used in % combination with <command>? allows the default % values to be entered in the operand form. % *DOWN(<operand>) : Displays the sub-form for the operand % value <operand>. % *UP : Switches from the sub-form back to the % operand form. % ? : Increases the guidance level. % ?? : Further increases the guidance level. %
HELP-SDF with UNGUIDED-DIALOG=*YES(SPECIAL-FUNCTIONS=*YES)
% % Unguided dialogue: Special functions % % ? as operand value : % Supplies help text and options % (limit values, etc.) % ? as command : % Displays the domain menu. % (temporary guided dialogue) % ?? as operand value : % calls up a help text, a display of the range of % values for the relevant operand and an help text % giving information about the data types associated % with the operand. % <command>? as command : % Displays the operand form for the command % <command> (temporary guided dialogue). % Operand values that have already been % specified are filled in. % If there are no operands, the help text of the % command is displayed. % !<command> as command : % Defines the specified operand values as task-specific % default values of the command. When used in % combination with <command>? allows the default % values to be entered in temporarily unguided dialog. % ^ or *SECRET as operand value (only for passwords): % Causes the input field for the password to % be kept blank. % LZF key : % Deletes all characters in the input line, starting % at the cursor. % LZE key : enables blocked input. Several commands can be % given separated by LZEs and executed at the same time % by a terminating DUE %
HELP-SDF with UNGUIDED-DIALOG=*YES(FUNCTION-KEY=*YES)
% % Unguided dialogue: Function keys % % The effect of the function keys depends on the FUNCTION-KEYS % option (MODIFY-SDF-OPTIONS command/statement). % 2 modes are possible : the *OLD-MODE and the *STYLE-GUIDE-MODE % which offers a richer functionality. % % *OLD-MODE % % K1 EXIT function. % Terminates the program which is currently running. % A message is issued asking the user whether or not % he wants to terminate. % Equivalent to F3 in *STYLE-GUIDE-MODE. % K2 INTERRUPT function. % Interrupts the program or procedure which is currently % running or interrupts the command output. % F1 EXIT-ALL function. % Terminates the program which is currently running. % A message is issued asking the user whether or not % he wants to terminate. % Equivalent to F6 in *STYLE-GUIDE-MODE. % % *STYLE-GUIDE-MODE % % K2 INTERRUPT function. % Interrupts the program or procedure which is currently % running or interrupt of command output. % F1 HELP function. % Causes the display of a guided screen. % Equivalent to entering "?". % % % F3 EXIT function. % Terminates the program which is currently running. % A message is issued asking the user whether or not % he wants to terminate. % Equivalent to K1 in *OLD-MODE. % F6 EXIT-ALL function. % Terminates the program which is currently running. % A message is issued asking the user whether or not % he wants to terminate. % Equivalent to F1 in *OLD-MODE. % F9 RESTORE-SDF-INPUT function. % Causes the last command / statement to be restored. % Equivalent to RESTORE-SDF-INPUT. % F12 CANCEL function. % Terminates the program which is currently running. % A message is issued asking the user whether or not % he wants to terminate. %