SYSPARM Utility

The SYSPARM utility is used to create and maintain a set of Natural profile parameters as an individual parameter profile that can be used for each Natural session.

When invoking Natural with dynamic profile parameters, you can specify individual parameters each time you invoke Natural. More comfortably, however, you can specify a set of parameters once in SYSPARM, store this set under a parameter profile name, and then invoke Natural with only one dynamic parameter: PROFILE=profile-name. The parameters defined in this parameter profile are then passed to Natural as dynamic parameters and must therefore comply with the syntax of PROFILE described in the Parameter Reference documentation.

For descriptions of the individual profile parameters that can be defined in a parameter profile, refer to the Parameter Reference documentation.

The parameter profiles are stored under user-defined names in the specified FNAT or FUSER Natural system file.

You can restrict the use of a parameter profile to specific users by setting the profile parameter USER as described in the Parameter Reference documentation.

The SYSPARM Utility documentation covers the following topics:

• Invoking SYSPARM

• List Profiles

• Display Profile

• Add New Profile

• Modify Profile

• Editing Profiles

• Copy Profile

• Delete Profile

• Direct Commands and Batch Processing

• Maintaining Profiles in Different Environments

• Invoking Help on Parameters from the Command Line

Related Topics

• Parameter Reference

Invoking SYSPARM

To invoke the SYSPARM utility

• Issue the following Natural system command:

  SYSPARM

  The Menu of the SYSPARM utility is displayed which provides the following functions and fields:

  Field/Function	Explanation
  List Profiles	Displays a list of all parameter profiles. From the list, you can select one or more profiles for display, modification or deletion.
  Display Profile	Displays a specific parameter profile.
  Add New Profile	Creates a new parameter profile.
  Modify Profile	Changes an existing parameter profile.
  Copy Profile	Creates a new parameter profile by copying an existing one.
  Delete Profile	Deletes an existing parameter profile.
  Profile	Selects the specified parameter profile. Enter a valid profile name or use asterisk (*) notation to select a range of profiles. Use asterisk (*) or leave this field blank to select all profiles available.
  Copy to	Copies the specified parameter profile.
  DBID	Selects the database ID (DBID) of the Natural system file where the parameter profile is stored. Default is the current FNAT.
  FNR	Selects the file number (FNR) of the Natural system file where the parameter profile is stored. Default is the current FNAT.
  Password	Specifies the password (8 characters) of the Adabas file where the parameter profile is stored.
  Cipher	Specifies the cipher code (8 digits) of the Adabas file where the parameter profile is stored.

  The SYSPARM functions listed above are described in the remainder of this documentation.

List Profiles

This function is used to list all parameter profiles contained in the specified Natural system file. From the parameter profile list, you can view, modify or delete one or more profiles. You can also display a property such as the code page of a parameter profile or when and by whom it has been modified at last.

To list parameter profiles

• In the SYSPARM Menu, enter function code L and, in the Profile field, enter the name of a parameter profile or specify a range of names:

  • Enter an asterisk (*) or leave the field blank to list all parameter profiles.

  • Use asterisk (*) notation to list all parameter profiles with names that start with a specified value, where value is any combination of one or more characters, for example: ABC*

  • Use the greater than (>) sign to list all parameter profiles with names greater than or equal to a specified value, for example: ABC>

  • Use the less than (<) sign to list all parameter profiles with names less than a specified value, for example: ABC<.

  The List Profiles screen is displayed with a list of all parameter profiles of the specified name range.

  You can press PF7 and PF8 to scroll up or down one page in the list. You can also press PF11 (>/<) to toggle properties of the profile, such as when (Date, Time) and by whom (User ID) the profile has been modified at last, the Natural version (Version) that was current when the file has been modified and the code page of the profile (Code Page).

  Note:
  If an entry for Code Page contains more than 17 characters, it is truncated. You can recognize a truncated entry from the trailing greater than sign (>). By pressing PF11 (>) once more, the code page's full name is displayed.

To view, modify or delete a single parameter profile

• Place the cursor anywhere in the Sel. or Profile column of the parameter profile you want to process and press one of the following PF keys:

  PF Key	Line Command	Function
  PF4	D	Invokes the Display Profile function.
  PF5	M	Invokes the Modify Profile function.
  PF6	X	Invokes the Delete Profile function.

  Or:
  In the Sel. column, next to the parameter profile you want to process, enter one of the line commands listed above and press ENTER.

  Depending on the key pressed or line command entered, the selected parameter profile is either displayed on the screen or a delete confirmation window opens for this profile.

To view, modify or delete multiple parameter profiles

1. In the Sel. column, next to the parameter profiles you want to process, enter one of the line commands listed in the table above.

   You can use PF7 or PF8 to scroll up or down in the list of parameter profiles to go to the required items.

2. Press ENTER when you have finished entering all line commands for all parameter profiles.

   Depending on the line command entered, the first parameter profile selected is either displayed on the screen or a delete confirmation window opens for this profile.

3. When finished with the first parameter profile, press PF3 or PF12 to process the next parameter profile. PF3 also saves the current parameter profile, if modified.

Display Profile

This function is used to display a parameter profile.

To display a parameter profile

• In the SYSPARM Menu, enter function code D and the name of an existing parameter profile.

  Or:
  From the List Profiles screen, select one or more parameter profiles as described in the relevant section.

  A Display Profile screen similar to the example below appears with the parameter definitions of the specified parameter profile:

  14:30:54 ***** NATURAL SYSPARM UTILITY ***** 2009-02-11 - Display Profile TESTPROF (10,2410) - > /* This is a test profile. */ < > AUTO=ON FNAT = (102,110,PASSWORD) FUSER=(1099,1100,PASSWORD,12345678) < > RPC=(RPCSIZE=80,SRVNAME=MYSERV,SERVER=ON,DFS=(SRV2,NODE1,,ACI)) < > PRINT=((2,12,18),AM=STD,DEST='PRINT**',OPEN=INITOBJ,CLOSE=CMD) < > PRINT=((1,3,6-11,15),AM=NAF) < > ESIZE=90 < > < > < > < > < > < > < > < > < > < > < > < > < Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit Modif Canc

  The screen title indicates the name of the parameter profile (here: TESTPROF) and the database ID and file number (here: 10,2410) where the parameter profile is stored.

Add New Profile

This function is used to create a new parameter profile.

To create a parameter profile

• In the SYSPARM Menu, enter function code A and the name of the parameter profile you want to create, and press ENTER.

  A blank edit screen appears. For instructions on entering the parameters you want to specify in the new parameter profile, see Editing Profiles.

Modify Profile

This function is used to change the parameter specifications of a parameter profile.

To modify a parameter profile

• In the SYSPARM Menu, enter function code M and the name of an existing parameter profile, and press ENTER.

  Or:
  Invoke the Display Profile screen for an existing parameter profile and press PF5.

  Or:
  Invoke the List Profiles screen and select one or more parameter profiles as described in the relevant section.

  An edit screen with the parameter definitions of the specified parameter profile appears. For instructions on using this screen to add or modify definitions, see Editing Profiles.

Editing Profiles

The edit screen of the SYSPARM utility appears when executing the Add New Profile or the Modify Profile function. This screen is used to enter the parameter specifications you want to include in a parameter profile. For detailed information about the profile parameters available, refer to the Parameter Reference documentation or use the HELP * command, see Invoking Help on Parameters from the Command Line.

The edit screen looks similar to the example below:

15:13:44             ***** NATURAL SYSPARM UTILITY *****            2009-02-11
 >  /* This is a test profile. */                                             <
 >  AUTO=ON FNAT = (102,110,PASSWORD) FUSER=(1099,1100,PASSWORD,12345678)     <
 >  RPC=(RPCSIZE=80,SRVNAME=MYSERV,SERVER=ON,DFS=(SRV2,NODE1,,ACI))           <
 >  PRINT=((2,12,18),AM=STD,DEST='PRINT**',OPEN=INITOBJ,CLOSE=CMD)            <
 >  PRINT=((1,3,6-11,15),AM=NAF)                                              <
 >  ESIZE=90                                                                  <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
 >                                                                            <
Help with parameters .. _______                        (Profile name: TESTPROF)
                                                                               
Command ===>                                                                   
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help        Exit  Check Save                    Insrt Del   Copy  Canc

The edit screen contains 18 input lines (marked with >) with a maximum length of 72 characters each. The individual parameters entered must be separated from one another by (one or more) blanks or commas. You can spread the specifications of the parameters over as many lines as you like.

You can enter a commentary text in each input line, or spread a comment over as many lines as you like. Comments must be preceded by /* and followed by */ as indicated in the example above.

If you need additional space for editing or want to combine different parameter profiles or group parameter profiles by categories, concatenate multiple parameter profiles by entering the PROFILE profile parameter as the last entry in the profile(s) concerned. The first parameter profile then evaluates the parameter strings specified in the second parameter profile as part of the string of the first parameter profile.

Example:

PROFILE=P2 entered at the end in parameter profile P1, and PROFILE=P3 entered at the end in parameter profile P2, firstly invokes P1 and then P2 followed by P3.

For detailed information on the PROFILE profile parameter, see the relevant section in the Parameter Reference documentation.

This section covers the following topics:

• PF Keys

• Help with Parameters

PF Keys

The following PF keys are available on the edit screen:

Help with Parameters

The Help with parameters field on the edit screen can be used to obtain help information on valid parameter specifications and incorporate new specifications into the current parameter profile.

To view online help and include new parameters

1. In the Help with parameters field, enter one of the following:

   • The name of the required parameter.

   • One or more characters with asterisk (*) notation (for example, PR*) for all parameters whose names start with the specified character(s).

   • An asterisk (*) for all parameters available.

2. Do not press ENTER yet if you want to insert a new parameter specification into an existing parameter profile and proceed with the following step.

   Mark the input line below which you want to insert the new parameter specification(s) by placing the cursor on this line, and then press ENTER.

   Or:
   Press ENTER if you want to append a new parameter specification to the end of the parameter profile.

3. After performing the previous step, depending on the parameter value entered earlier, one of the following appears:

   • If you entered a full name, a help screen (see below) appears.

   • If you specified a name range using the asterisk (*), a window opens with a list of all parameters of the specified range.

     From this list, select the required parameter by entering any character in the input field next to the required parameter and pressing ENTER.

   The help screen looks similar to the example below:

   13:08:21 ***** NATURAL SYSPARM UTILITY ***** 2009-02-11 The parameter AUTO is used to cause an automatic logon at the start of the Natural session. AUTO=ON An automatic logon is executed at the start of the Natural session. The value contained in the Natural system variable *INIT-USER is used as the user ID for the logon. AUTO=OFF No automatic logon is performed. Enter your parameter specification: More Help: (+,-) > > > > > Command==> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit Check Canc

   The upper screen section contains help text on the specified parameter (in the example above, AUTO). If the text contains more than one page, you can enter a plus (+) sign before the More Help field to display the next page. Enter a minus (-) sign to return to the previous screen or enter a period (.) to terminate the help function and return to the edit screen.

   The lower section contains five input lines (marked with >).

4. Press ENTER.

5. In the input lines, enter the required parameter specifications.

   You can press PF4 to check the specifications.

6. Press PF3 to terminate the help function.

   The edit screen appears with the new parameter specifications either appended to the end of the parameter profile or inserted below the input line marked with the cursor in Step 3.

Note:
See Invoking Help on Parameters from the Command Line for invoking help on parameters and subparameters from the command line.

Copy Profile

This function is used to copy parameter profiles.

To copy a parameter profile

1. In the SYSPARM Menu, enter the following:

   • Function code C.

   • In the Profile field, the name of the parameter profile from which you want to copy the new parameter profile.

   • In the Copy to field, the name of the new parameter profile.

2. Press ENTER.

   A message appears indicating successful completion of the copy operation.

Delete Profile

This function is used to delete an existing parameter profile.

To delete a parameter profile

1. In the SYSPARM Menu, enter function code X and the name of the parameter profile you want to delete, and press ENTER.

   Or:
   Invoke the List Profiles screen and select one or more parameter profiles as described in the relevant section.

   A Delete a Profile window opens with the name of the parameter profile you want to delete.

2. Confirm the deletion by entering the name of the parameter profile in the input field and pressing ENTER.

   You can cancel a delete operation by pressing PF3 or leaving the input field blank and pressing ENTER.

   A message appears indicating either successful completion or cancellation of the delete operation.

Direct Commands and Batch Processing

The SYSPARM utility functions described earlier can also be executed by using corresponding SYSPARM commands in batch or online mode.

In addition to the functions provided on the SYSPARM utility screens, in batch mode, options are provided for specifying commentary text, the input delimiter and the input assign character.

The symbols used in the syntax diagrams shown in this section are explained in System Command Syntax in the System Commands documentation.

This section covers the following topics:

• Basic Command Syntax

• where-clause

• with-clause

• Batch Processing

• Example of SYSPARM in Batch

Basic Command Syntax

Displayed below is the basic syntax that applies when processing SYSPARM commands.

The keywords, the variable values to be supplied with the keywords, and the optional clauses indicated in the basic command syntax of SYSPARM are described in the following table:

where-clause

The where-clause is optional and applies to the commands ADD, MODIFY, DISPLAY, LIST, DELETE and COPY. Its syntax is as follows:

The keywords of the where-clause and the variable value that must be supplied with each keyword are explained in the following table:

with-clause

The with-clause is optional and applies to the commands ADD, MODIFY, DISPLAY and LIST. Its syntax is as follows:

Note:
In the syntax diagram above, the following only applies to the ADD command: [WITH] parm-name=parm-value [parm-name=parm-value]...

The keywords of the with-clause and the variable value that must be supplied with each keyword are explained in the following table:

Batch Processing

When processing SYSPARM in batch mode, consider the following:

• To terminate SYSPARM, in a separate line, enter a period (.) or FIN, where FIN ends the Natural session.

• To execute more than one SYSPARM function, specify each function in a separate line.

• To extend a function over two lines, enter the character defined with the session parameter CF (default is %) anywhere in the first line. This indicates continuation on the next line.

See also Example of SYSPARM in Batch.

Related Topics:

Natural in Batch Mode (Operations documentation)
Using the INPUT Statement in Non-Screen Modes (Statements documentation)
Using the INPUT Statement in Batch Mode (Statements documentation)

Example of SYSPARM in Batch

The examples shown in this section demonstrate the use of SYSPARM commands and the result of parameter profile modifications executed in batch:

• Example Profile TESTPROF - Before Job Submission
• Example Input
• Example Parameter Profile TESTPROF - After Job Execution
• Example Parameter Profile TESTPRO1 - After Job Execution

Example Profile TESTPROF - Before Job Submission

/* This is a test profile. */                                     
AUTO=ON FNAT = (102,110,PASSWORD) FUSER=(1099,1100,PASSWORD,12345678)
RPC=(RPCSIZE=80,SRVNAME=MYSERV,SERVER=ON,DFS=(SRV2,NODE1,,ACI))   
PRINT=((2,12,18),AM=STD,DEST='PRINT**',OPEN=INITOBJ,CLOSE=CMD)    
PRINT=((1,3,6-11,15),AM=NAF)                                      
ESIZE=90

Note:
If your current input assign or delimiter character is part of the input, you need to change this input character (see ASSIGN or DELIMITER in Direct Commands and Batch Processing). This can be done by adding an appropriate ASSIGN or DELIMITER assignment before the statement that would otherwise cause a runtime error. See the Example Input below.

Example Input

/*JCL
.
.
.
*/
SYSPARM                                               
COPY TEST1 TO TESTPROF WHERE DBID 10 FNR 32                   
DISP   TESTPROF                                            
COMMENT ON /* TESTUSER 29.Jan.2009 */                      
MODIFY TESTPROF with REM DFS                               
   REPLACE ;test profile;test profile for SYSPARM in batch;
   NEW BPSIZE 4096                                         
   UPDATE ESIZE  ADD  20  MAX 100                           
   FIRST PARM INHOUSE                                      
   DELIMITER $                                             
   UPDATE FUSER (,6)                                       
   ASSIGN :                                                
   LINE IM=D, INTENS=1, AUTO=T, MT=0, MADIO=0              
   .                                                       
DISP   TESTPROF                                            
ADD TESTPRO1 WITH /* 106,210 */                            
    FNAT=(106,210,PASSWORD),FUSER=(,211)                   
    .                                                      
DISPLAY TESTPRO1                                           
DELETE  TESTPRO2 WHERE DBID 10 FNR 32              
X TESTPRO3   WHERE DBID 10 FNR 32                  
.                                                          
FIN

Example Parameter Profile TESTPROF - After Job Execution

/* This is a test profile for SYSPARM in batch. */                
PARM=INHOUSE /* TESTUSER 29.Jan.2009 */                           
AUTO=ON FNAT = (102,110,PASSWORD) FUSER=(,6) /* TESTUSER 29.Jan.2009 */  
RPC=(RPCSIZE=80,SRVNAME=MYSERV,SERVER=ON, )                       
PRINT=((2,12,18),AM=STD,DEST='PRINT**',OPEN=INITOBJ,CLOSE=CMD)    
PRINT=((1,3,6-11,15),AM=NAF)                                      
ESIZE=100 /* TESTUSER 29.Jan.2009 */ BPSIZE=4096 /* TESTUSER 29.Jan.2009
 */                                                               
IM=D, INTENS=1, AUTO=T, MT=0, MADIO=0 /* TESTUSER 29.Jan.2009 */

Example Parameter Profile TESTPRO1 - After Job Execution

/* 106,210 */       
FNAT=(106,210,PASSWORD),FUSER=(,211)

Maintaining Profiles in Different Environments

The SYSPARM utility is used to maintain parameter profiles within the same FNAT or FUSER system file.

To transfer parameter profiles (for example, copy or move) between different FNAT and/or FUSER system files, and to perform a parameter profile operation (for example, delete or find) in a different environment, you can use the SYSMAIN utility. For details, see Processing Profiles in the SYSMAIN Utility documentation.

Invoking Help on Parameters from the Command Line

With the system command HELP you can get online help on a parameter or a subparameter. The following commands are available:

For further instructions on how to use a help screen invoked this way, see Help with Parameters.