ETP Maintenance Utility

The ETP Maintenance Utility provides you, the ETP Administrator, with screens and menus to:

  • Add, display, change and delete master and replicate file definitions;

  • Display and change a replicate or related confirmation file;

  • Display and delete entries in a master file's log file;

  • Stop/start replication tasks;

  • Change system and user profiles.

This document covers the following topics:


Starting the ETP Maintenance Utility

Utility functions can be performed on master or replicate files on all ETP nodes that are defined in the administration file. The link to the administration file is created when you install the maintenance utility; see Installing the Entire Transaction Propagator in the Installation for z/OS and Installation for z/VSE documentation. You can also maintain multiple administration files (which can be on different databases) from a single node with the maintenance utility.

There is more than one way you can start the maintenance utility. The choice of ways depends on whether or not Natural Security is installed:

Without Natural Security, one of the following:

  • Enter the command SYSETP on the command line;

  • Log on to the library SYSETP, and then enter the command MENU on the command line;

With Natural Security and MENU defined as startup command:

  • enter the command SYSETP on the command line;

  • Log on to library SYSETP.

With Natural Security and MENUnot defined as startup command:

  • Enter the command SYSETP on the command line;

  • Log on to the library SYSETP, and then enter the command MENU on the command line;

ETP then displays the ETP maintenance utility's main menu. Using its screens and menus, you can display and change ETP control information and perform maintenance tasks on the ETP file structure.

The ETP Maintenance Utility - Main Menu

23:59:59              ***** ENTIRE TRANSACTION PROPAGATOR *****       2000-12-24
                                          Menu




               MM  Maintain  master    file definitions           
               MR  Maintain  replicate file definitions           
               R   Replicate transactions                         
               CD  Control   execution of asynchronous tasks      
               CL  Clean up  Log file                             
               X   X-Ref     transactions                         
               S   Special   functions                            
               N   Execute   Natural system command or program    








Command ===>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help  Menu  Exit  Last        Flip              Tech              Canc   

Selecting and Performing Menu Tasks

The menus provide a choice of tasks that can be performed. Such tasks as those listed on the main menu can be performed by doing one of the following, and then pressing Enter:

  • Placing the cursor on the line of the task in the menu;

  • Overtyping the code in front of the task description - MM, for example - with any other letter;

  • Entering the code in front of the task description on the command line at the bottom of the menu.

Selecting a task with the cursor or entering a task code is possible only when the related menu is displayed. Using a direct command, however, you can select a task to perform regardless of which menu is currently displayed.

The tasks or screens you can select on the main menu are described later in this section.

Entering and Displaying Information

Screens that allow you to enter data designate the input fields with underscores (__...__). The command line of each screen is not underscored, although it also is an input field. Use the Tab key to move from input field to input field. When entering input in a field, the data is aligned according to the data type; numeric data is right-aligned, and alphanumeric data is left-aligned.

Example of a Displayed List:

 23:59:59          ***** ENTIRE TRANSACTION PROPAGATOR *****          2000-12-24
                        Display replicate file definition                       
                                                                                
          +----------------Replicate file definitions----------------+          
          !                                                          !          
          !    -- Replicate --   Conf   ---------- Master ---------- !          
          !      DBID      FNR    FNR     DBID      FNR  Key  Format !          
          !    _____*   _____*          _____*   _____*              !          
 Replicat !  _     10      155    152       10      154  AC   B4     !          
          !  _     10      156    152       10      135  AA   A10    !          
          !  _     10      157    152       10      136  AB   A80    !          
 Printer  !  _     10      158    152       10      138  AG   N4     !          
          !  _     10      159    162       10      139              !          
          !  _                                                       !          
          !  _                                                       !          
          !  _                                                       !          
          !  _                                                       !          
          !  _                                                       !          
          !                                                          !          
          +----------------------------------------------------------+          
                                                                                
 Command ===>                                                                   
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help  Menu  Last              Flip              Tech              Canc   

Selecting using Wild Card Entries

Screens with fields allowing wild card entries display the results of wild card searches in a window, as shown in Example of a Displayed List, above. Fields that allow wild card entries have an "*" as the last description character. See the following section, Entering Direct Commands for more information about wild card entries.

Those fields with an asterisk (*) as the last character of the description allow you to enter wild card characters. For example:

DISPLAY MASTER  *  *

- displays a window from which you can select one or more master files to in turn display their definitions, and:

MOD REPL * 20> 

- displays a window that enables you to select a single replicate file for modification from those replicate files on all ETP databases with file numbers 20 and above. Wild card entries can be combined with the PROCESS dialogue function (see Dialog Function Description below) to perform a task on a range of items (files or log file entries).

If you make a wild card selection that results in a window that allows you to select one or more items, select the item or items (see Example of a Displayed List) you want in either of the following ways:

  • place the cursor on the corresponding line;

  • enter any non-blank character in the input field ahead of the item or items.

If you make more than one selection on a screen that allows only one single selection, an error message occurs. When only one selection is allowed, a choice made with a non-blank character has priority over a choice made by placing the cursor.

When a window appears that permits more selections than can be held in the window itself, "+" and/or "-" appear to show the paging possibilities for displaying the additional items. Simply place the cursor on the appropriate symbol in the bottom left corner of the window and press Enter to display the additional items. This is the same as entering "+" or "-" dialogue functions (see Dialog Function Description below).

Specifying Ranges

When selecting items, you can enter an asterisk (*) in place of a value to select all related items. To select an "equal and greater" or "equal and less than" range of items, enter one of the following:

n<    (less than and equal to nn)
n>    (equal to and greater than nn)

If more than one input field defines the selection for a task, either or both of these selection criteria can be used. This enables the selection of, for example, all files with numbers 100 and above in databases 10 or below.

Priority of Command Input

The priority of menu/screen input and commands is as follows:

  1. Command line input or PF key (if both entered, an error occurs);

  2. Changing/entering a non-blank value in a menu selection input field;

  3. Placing the cursor in a menu selection input field.

Entering Direct Commands

As the example screen shows, the maintenance utility allows you to enter a command on the command line at the bottom of a screen. The so-called "direct commands"can be entered either fully (ADD MASTER, for example) or abbreviated (A MA for adding a new master file).

Most direct commands also allow you to specify a database ID (DBID) and/or physical file number; however, this is not required. If you enter no DBID or file number (or if neither is allowed), the function screen appears, just as when you select the function from a higher-level menu. If you enter the DBID and file number, the function screen appears, either with the value or values entered in the appropriate fields, or overlaid with the window showing the DBID/file number selection you made as if you had made the DBID and file number selection in the function screen.

Direct commands cannot be entered in the command line if a window is currently displayed.

The following table shows the ETP direct commands. Minimum command abbreviations are shown in bold type:

Direct command: Parameters allowed/required: Wildcards allowed?
DBID FNR
ADD MASTER x x No
ADD REPLICATE x x No
CHANGE ADMINISTRATION x x No
CHECK DEFINITIONS      
CLEANUP LOGFILE      
CONTROL TASKS      
DELETE MASTER x x Yes
DELETE REPLICATE x x Yes
DELETE TRANSACTIONS x x Yes
DISPLAY ERROR x x Yes
DISPLAY MASTER x x Yes
DISPLAY REPLICATE x x Yes
DISPLAY TRANSACTIONS x x Yes
MAINTAIN MASTER      
MAINTAIN REPLICATE      
MODIFY CONFIRMATION x x Yes
MODIFY MASTER x x Yes
MODIFY REPLICATE x x Yes
MODIFY SYSPROF      
MODIFY USERPROF      
NATURAL (command string)  
REPLICATE TRANSACTIONS      
RESET ERROR x x Yes
RESET IN-USE x x Yes
SPECIAL      
XREF TRANSACTIONS     Yes

Dialogue Functions

Dialogue functions are the screen control and general operation commands for operating the maintenance utility. The dialogue functions, which can be either entered on the screen's command line as direct commands or by pressing the appropriate PFn key, perform such tasks as:

  • Returning to the main menu from a specific task menu (MENU);

  • Saving the entries and status of the current screen (SAVE);

  • Performing a maintenance utility function on a range of files (PROCESS);

  • Exiting a task screen and returning to the next higher selection menu (EXIT).

To perform a dialogue function, press the appropriately labelled function key (PFn), which follow the common conventions for the general dialogue functions (PF1 for calling online help, PF3 for EXIT, and so on); otherwise, enter the dialogue function on the command line. Note, however, dialogue functions are most likely not valid for a particular screen if they are not already assigned to a function key. A Modify screen with confirmation window may look as shown below.

The dialogue functions and, where appropriate, their related function (PFn) keys are as follows:

A Modify Screen with Confirmation Window

 23:59:59          ***** ENTIRE TRANSACTION PROPAGATOR *****          2000-12-24
                          Modify master file definition                         
                                                                                
                                                                                
                   DBID      FNR    Verify FDT                                  
 Master file ..*     10      135     Y (Y/N)                                    
 Log    file ...             152     N (Y/N)                                    
                         +-----------Exit------------+                          
                         !                           !                          
 ADABAS field name of di ! _ save and exit           !
 NATURAL data format of  ! _ exit without save       !
                         ! _ resume current function !
 Call user exit before re!                           !                          
 Start program after ET .+---------------------------+                          
 
 
 
 
 
 
 
 Command ===> exit                                                              
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help  Menu  Exit  Last        Flip              Tech              Canc

Dialogue Function Description

BACKWARD (PF7) Displays the previous screen of data. Entering "-" is the same as entering BACKWARD.
BOTTOM (PF19) Displays the last screen of data. Entering "++" is the same as entering BOTTOM.
CANCEL (PF12) Leaves the current screen and returns to the higher-level menu. If entered in the ETP main menu, exit from ETP. If the current screen is a MODIFY or DELETE task, a window (Figure 11) appears requesting confirmation of the MODIFY/DELETE operation unless the confirmation window is disabled by the user's profile; otherwise, the operation is not performed.
EXECUTE Perform the current screen task, then leave the current screen and return to the higher-level menu. Unless disabled by the user's profile, a window appears requesting confirmation of the EXECUTE operation; otherwise, the operation is performed.
EXIT (PF3) Leaves the current screen and returns to the higher-level menu. If entered in the ETP main menu, exit from ETP. If the current screen is a MODIFY or DELETE task, a window appears requesting confirmation of the MODIFY/DELETE operation unless the confirmation window is disabled by the user's profile; otherwise, the operation is performed. Entering "." is the same as entering EXIT.
FLIP (PF6) Changes the function key display at the bottom of the screen between PF1-PF12 to PF13-PF24.
FORWARD (PF8) Displays the next screen of data. Entering "+" is the same as entering FORWARD.
LAST (PF4) Redisplays the direct command executed last in the command line, where it can be changed and/or re-executed. Entering LAST * on the command line shows the last 10 direct commands that were executed, in a window. Place the cursor on the corresponding line, or enter any non-blank character in the input field ahead of the command and press Enter to enter that command in the command line for changing/ re-executing.
MENU (PF2) Leaves the current screen and returns to the main menu. If the current screen is a MODIFY or DELETE task, a window (Figure 11) appears requesting confirmation of the MODIFY/DELETE operation unless the confirmation window is disabled by the user's profile; otherwise, the operation is performed.
PROCESS This command-line-only function performs the currently selected screen's function on all items that meet the criteria specified on the current window. PROCESS can be entered only in windows appearing in screens that require the DBID and/or FNR parameters, and is intended for use with "wild card" parameter specifications.
SAVE Saves the status of entries made in the current menu. A window appears requesting confirmation of the operation. If the user's profile disables the function, the confirmation window does not appear and the operation is performed. SAVE is intended for multiple updates; the current screen remains displayed.
TECH (PF9) Performs the function of the Natural TECH system command.
TOP (PF20) Displays the first screen of data. Entering "--" is the same as entering TOP.
* Displays all direct commands allowed for the current screen. The minimum abbreviations for the direct commands are displayed in capital (upper case) letters.
+ (PF8) Performs the FORWARD screen scrolling function.
++ (PF19) Performs the BOTTOM screen scrolling function.
-(PF7) Performs the BACKWARD screen scrolling function.
-- (PF20) Performs the TOP screen scrolling function.
. Performs the EXIT function.

Note:
The dialogue functions FLIP, LAST, LAST *, and * are processed before any other command input.

Errors and Warnings

If you enter an invalid command in the command line or invalid data in an input field, the ETP utility displays an error message in the message line at the bottom of the screen.

If you try to execute a task that might cause inconsistent data or if the change is not allowed, a window appears with a warning message.

If a severe processing error occurs, the utility displays a window containing the cause and location of the error. ETP attempts to recover from the error automatically by retrying the failing task. If the same error occurs three times within a short time interval, ETP issues a STOP for the application.

If a severe and persistent error occurs that might be inherent to ETP, proceed as described under Reporting ETP Errors.

Selecting Main Menu Tasks

To select one of the tasks listed on the ETP main menu, place the cursor next to the desired entry and press Enter.

When you select either the Maintain master or replicate file definitions option, a more detailed menu of tasks appears, as shown in the example below. The tasks you can select on these screens are described under the headings Master File Task Screens and Replicate File Task Screens.

The Master File Task Selection Menu

23:59:59           ***** ENTIRE TRANSACTION PROPAGATOR *****         2000-12-24
                        Master File Definition Maintenance






               AD  Add     master file definition                           
               MO  Modify  master file definition                     
               DI  Display master file definition                     
               DE  Delete  master file definition                           













Command ===>
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help  Menu  Exit  Last        Flip              Tech              Canc