Browsing an Active Report with the Software AG Editor

#### Search Results

Search

# Browsing an Active Report with the Software AG Editor

The Software AG Editor allows you to:

- scroll within the display of an active report;

- search for text;

- modify the layout of the active report;

- print all or part of the active report;

- export all or part of an active report to a PC file.

The corresponding functions are described in the following sections:

- Invoking the Software AG Editor

- PF Keys

- Commands

- Scrolling an Active Report

- Searching for a Character String

- Modifying the Layout of an Active Report

- Printing an Active Report

- Exporting an Active Report to a PC File

For further information on the Software AG Editor, see the Natural documentation

## Invoking the Software AG Editor

To invoke the Software AG Editor:

- On the Active Report List screen, enter `BR` in the command field preceding the report to be browsed.

  The selected active report is displayed on the Software AG Editor screen:

        14:29:52             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
       Report UEX-INSL-ADDP(21086)      L 000000 T 000232 -----------Columns 001 072
       ====>                                                         SCROLL===> CSR
       ****** ****************************** top of data *****************************
       000001  Page:   1                     Employee List sorted by Department
       000002
       000003                                 EMPLOYEES
       000004  DEPARTMENT         NAME              FIRST-NAME      PERSONNEL   DATE
       000005     CODE                                                 ID        OF
       000006                                                                  BIRTH
       000007  ---------- -------------------- -------------------- --------- --------
       000008  FINA01     ANTLIFF              JANET                30021001  53/10/12
       000009  FINA01     ANTLIFF              JANET                30021001  53/10/12
       000010  FINA01     EAVES                TREVOR               30034544  48/09/23
       000011  FINA01     GOMEZ                ISABEL               60000544  58/10/23
       000012  FINA01     GOMEZ                MARIO                60000012  45/12/12
       000013  FINA01     JAMES                SHARON               30034217  63/05/26
       000014  FINA01     JAMES                SHARON               30034217  63/05/26
       000015  FINA01     JAMIESON             SUSAN                30000217  64/02/29
       000016  FINA01     JOHNSON              HELEN                30000544  58/10/23
       000017  FINA01     JOHNSTON             JOHN                 30016001  35/10/12
       000018  FINA01     JOUSSELIN            DANIEL               50003800  49/02/28
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help  Notes End   Layot Rfind Fi:C   -     +           <     >    Menu

  Various functions can be invoked via PF keys and commands, as described below.

## PF Keys

Key | Name | Function
--- | --- | ---
PF2 | Notes | Invoke the user exit NOMEX008, if active, to allow user-defined processing to be integrated with active report browsing. See the section NOM User Exits for a description of NOMEX008.
PF3 | Exit | Return to previous screen.
PF4 | Layou | Modify active report layout.
PF5 | Rfind | Find a string again.
PF6 | Fi:C | Find character string at cursor.
PF7 | Up | Scroll up.
PF8 | Down | Scroll down.
PF10 | Left | Scroll to the left.
PF11 | Right | Scroll to the right.

## Commands

- Commands for Scrolling

- Other Editor Commands

- Line Commands

### Commands for Scrolling

See Scrolling an Active Report below.

### Other Editor Commands

You can enter the following commands in the command line ====> at the top left of the Editor screen:

Command | Function
--- | ---
`BNDS column-number column-number` | Sets the boundaries for the `FIND` command: the search will only be done within the range of columns specified.
`BNDS` | Cancels the effect of the above command so as to include all columns in the search.
`CANCEL` or `END` or `QUIT` | Return to previous screen.
`COLS ON/OFF` | Displays a line at the top of the editing section showing column positions, or switches this display off.
`CONTROL ON/OFF` | Shows or hides the display of the escape characters in the first column.
`HEX ON/OFF` | Switches hexadecimal display mode on or off.
`EXCLUDE string` or `EXC string` or `X string` | Excludes lines containing the specified character string from being displayed.
`FIND string` | Searches for a character string.
`INCLUDE` or `INC` | Cancels the effect of the `EXCLUDE` command.
`KEYS ON/OFF` | Shows or hides the PF-key lines.
`LABEL .label` | Marks the top line being displayed with the specified label, which can then be used with the `LOCATE` command (see below). A label must begin with a period (.), followed by 1 to 4 characters.
`LIMIT nnnn` | Limits the number of lines to be searched with the `FIND` command: the search will comprise only nnnn lines, starting with the top line being displayed.
`LOCATE .label` or `LOC .label` or `L .label` | Searches for lines containing the specified label.
`PREFIX ON/OFF` | Shows or hides the line numbers.
`PROTECT ON/OFF` | Switches write protection of the line numbers on or off
`RESET` | Resets all pending line commands and line markings.

### Line Commands

You can enter the following line commands at the beginning of a line of the active report:

Line Command | Function
--- | ---
`.label` | Marks this line with a label to be used with the `LOCATE` command (see above). A label must begin with a period (.), followed by 1 to 4 characters.
C | Marks the line as a line to be exported.
CC | Marks the first and last line of a block of lines to be exported.
COLS | Displays the column positions in this line.
P | Marks the line as a line to be printed.
PP | Marks the first and last line of a block of lines to be printed.
T | Scolls this line to the top of the display.
X | Excludes this line from being displayed.
XX | Marks the first and last line of a block of lines to be excluded from being displayed.

## Scrolling an Active Report

- PF Keys for Scrolling

- Settings for the SCROLL Field

- Commands for Scrolling

### PF Keys for Scrolling

On the Editor screen, you can use the keys PF7, PF8, PF10, PF11 (see above) to scroll an active report.

### Settings for the SCROLL Field

In the SCROLL field at the top right of the Editor screen, you can enter scroll settings. These are used to set the scroll amount for the PF keys listed above and some of the scrolling commands described below.

Possible settings for the SCROLL field are:

Value | Explanation
--- | ---
number | Scroll up or down a specified number of lines. Scroll to the right or left.
`CSR` (default) | Scroll down to cursor position, if cursor is on a line of text. Cursor line becomes first line of text. When scrolling up, cursor line becomes last line of text. Scroll a page length if cursor is in command line. Scroll right to cursor position.
`DATA` | Scroll a page length minus one line. When scrolling down, the last line of text becomes the first line. When scrolling up, the first line of text becomes the last line.
`HALF` | Scroll up or down or left or right half a page.
`MAX` | Scroll to the top or bottom of data. Scroll to the leftmost or rightmost column.
`PAGE` | Scroll up or down a page length. Scroll left or right a page width.

#### Example:

If the SCROLL setting is `HALF` and you press PF8 (Down), the next half page of the active report is displayed.

### Commands for Scrolling

The following commands are available for vertical and horizontal scrolling. You enter these commands in the command line ====> at the top left of the Editor screen:

Scrolling Command | Function
--- | ---
`BOTTOM` or `BOT` or `B` or `++` | Scrolls down to the last page of data.
`TOP` or `T` or `--` | Scrolls up to the first page of data.
`DOWN` or `+` | Scrolls down by the amount specified in the SCROLL field.
`DOWN n` or `+n` | Scolls down n lines.
`UP` or `-` | Scrolls up by the amount specified in the SCROLL field.
`UP n` or `-n` | Scrolls up n lines.
`LEFT` | Scrolls left by the amount specified in the SCROLL field.
`LEFT n` | Scrolls left n columns.
`RIGHT` | Scrolls right by the amount specified in the SCROLL field.
`RIGHT n` | Scrolls right n columns.
`BL` | Block commands, which can be used under UNIX, where a report is organized in blocks of 10,000 lines. The following command options are available: `BL TOP` or `BL --` scrolls to the beginning of the current block. `BL BOT` or `BL ++` scrolls to the end of the current block. `BL +` scrolls to the next block. `BL -` scrolls to the previous block. `BL nnnnn` scrolls to block number nnnnn.
`FIX n` | Fixes the first n number of columns to display when scrolling left or right.

## Searching for a Character String

To search for a character string:

1. Either enter the command `FIND string` in the command line ====> at the top left of the Editor screen.

   Or, if the string is already shown on the part of the active report being displayed, place the cursor on the string and press PF6 (Fi:C).

   The search begins at the top of the report.

2. The string, when found, will be highlighted, and the cursor placed on the first character of the string.

3. To search for the same string again, press PF5 (Rfind).

   A message indicates whether the string was found, or whether the bottom of the data was reached.

## Modifying the Layout of an Active Report

With the Software AG Editor you can change the column layout of an active report.

Our example active report appears as follows:

      15:29:52             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
     Report UEX-INSL-ADDP(21086)      L 000000 T 000232 -----------Columns 001 072
     ====>                                                         SCROLL===> CSR
     ****** ****************************** top of data *****************************
     000001  Page:   1                     Employee List sorted by Department
     000002
     000003                                 EMPLOYEES
     000004  DEPARTMENT         NAME              FIRST-NAME      PERSONNEL   DATE
     000005     CODE                                                 ID        OF
     000006                                                                  BIRTH
     000007  ---------- -------------------- -------------------- --------- --------
     000008  FINA01     ANTLIFF              JANET                30021001  53/10/12
     000009  FINA01     ANTLIFF              JANET                30021001  53/10/12
     000010  FINA01     EAVES                TREVOR               30034544  48/09/23
     000011  FINA01     GOMEZ                ISABEL               60000544  58/10/23
     000012  FINA01     GOMEZ                MARIO                60000012  45/12/12
     000013  FINA01     JAMES                SHARON               30034217  63/05/26
     000014  FINA01     JAMES                SHARON               30034217  63/05/26
     000015  FINA01     JAMIESON             SUSAN                30000217  64/02/29
     000016  FINA01     JOHNSON              HELEN                30000544  58/10/23
     000017  FINA01     JOHNSTON             JOHN                 30016001  35/10/12
     000018  FINA01     JOUSSELIN            DANIEL               50003800  49/02/28
     Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
           Help        End   Layou Rfind Fi:C   -     +           <     >    Menu

To select the columns to be displayed and their order on the screen:

1. Place the cursor on a line of data and press PF4 (Layou). The selected line (here Line 8) is displayed in a layout window:

         15:31:37             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !      1 ----+----1----+----2----+----3----+----4----+----5----+----6----+  !*
         ! Layout                                                                    !
         !        FINA01     ANTLIFF              JANET                30021001  53  !
         !                                                                           !
         !       PF3 = Exit            PF4  = Define Layout    PF5  = Delete Layout  !
         !       PF6 = Saved Layout    PF10 = Left             PF11 = Right          !
         +---------------------------------------------------------------------------+
        000007  ---------- -------------------- -------------------- --------- --------
        000008  FINA01     ANTLIFF              JANET                30021001  53/10/12

To define the layout:

1. In the Layout line, enter an `X` in each column that is to appear in the report.

   Columns 1 to 65 are displayed. For example:

         15:34:41             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !      1 ----+----1----+----2----+----3----+----4----+----5----+----6----+  !*
         ! Layout           XXXXXXXXXXXXXX       XXXXXXXXXXXXXXX      XXXXXXXXXX XX  !
         !        FINA01     ANTLIFF              JANET                30021001  53  !
         !                                                                           !
         !       PF3 = Exit            PF4  = Define Layout    PF5  = Delete Layout  !
         !       PF6 = Saved Layout    PF10 = Left             PF11 = Right          !
         +---------------------------------------------------------------------------+
        000007  ---------- -------------------- -------------------- --------- --------
        000008  FINA01     ANTLIFF              JANET                30021001  53/10/12

2. Press PF11 (Right) to view the rest of the data on the right. Columns 66 to 130 are displayed:

         15:34:41             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !     66 ----7----+----8----+----9----+----0----+----1----+----2----+----3  !*
         ! Layout                                                                    !
         !        /10/12 BCH 472X        MORRIS               MINOR 1000             !
         !                                                                           !
         !       PF3 = Exit            PF4  = Define Layout    PF5  = Delete Layout  !
         !       PF6 = Saved Layout    PF10 = Left             PF11 = Right          !
         +---------------------------------------------------------------------------+
        000007  ---------- -------------------- -------------------- --------- --------
        000008  FINA01     ANTLIFF              JANET                30021001  53/10/12

3. Enter `X` in the Layout line in each column that is to appear in the report.

   For example:

         15:34:41             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !     66 ----7----+----8----+----9----+----0----+----1----+----2----+----3  !*
         ! Layout XXXXXXX                                                            !
         !        /10/12 BCH 472X        MORRIS               MINOR 1000             !
         !                                                                           !
         !       PF3 = Exit            PF4  = Define Layout    PF5  = Delete Layout  !
         !       PF6 = Saved Layout    PF10 = Left             PF11 = Right          !
         +---------------------------------------------------------------------------+
        000007  ---------- -------------------- -------------------- --------- --------
        000008  FINA01     ANTLIFF              JANET                30021001  53/10/12

4. Press PF10 (Left) and PF4 (Define Layout).

   The Define Report Layout window is displayed:

         15:34:41             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !      1 ----+----1----+----2----+----3----+----4----+----5----+----6----+  !*
         ! Layout           XXXX +--------------------------------+   XXXXXXXXXX XX  !
         !        FINA01     ANT !                                !    30021001  53  !
         !                       !      Define Report Layout      !                  !
         !       PF3 = Exit      !                                ! = Delete Layout  !
         !       PF6 = Saved Lay !     From-Column To-Column      ! = Right          !
         +---------------------- !  1_  11_         24_           !------------------+
        000007  ---------- ----- !  2_  32_         47_           !- --------- --------
        000008  FINA01     ANTLI !  3_  53_         62_           !  30021001  53/10/12
        000009  FINA01     ANTLI !  4_  64_         72_           !  30021001  53/10/12
        000010  FINA01     EAVES !  __  ___         ___           !  30034544  48/09/23
        000011  FINA01     GOMEZ !  __  ___         ___           !  60000544  58/10/23
        000012  FINA01     GOMEZ !  __  ___         ___           !  60000012  45/12/12
        000013  FINA01     JAMES !  __  ___         ___           !  30034217  63/05/26
        000014  FINA01     JAMES !  __  ___         ___           !  30034217  63/05/26
        000015  FINA01     JAMIE !  __  ___         ___           !  30000217  64/02/29
        000016  FINA01     JOHNS !                                !  30000544  58/10/23
        000017  FINA01     JOHNS !    Header Lines  3__           !  30016001  35/10/12
        000018  FINA01     JOUSS !                                !  50003800  49/02/28
        Enter-PF1---PF2---PF3--- !  PF1 Help  PF3 Exit PF4 Save   !-PF10--PF11--PF12---
              Help        End    +--------------------------------+  <     >    Menu

   It lists the columns you have marked in the order they appear on the screen.

   The number you enter for Header Lines determines the number of lines from the top of the report which are excluded from your layout. In our example, above, we have entered "3" to exclude the first 3 lines of the report from the layout.

   You can change the order of the columns you have marked by entering a new sequence. In our example, below, we have changed the order of the first two column groups:

         15:34:41             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !      1 ----+----1----+----2----+----3----+----4----+----5----+----6----+  !*
         ! Layout           XXXX +--------------------------------+   XXXXXXXXXX XX  !
         !        FINA01     ANT !                                !    30021001  53  !
         !                       !      Define Report Layout      !                  !
         !       PF3 = Exit      !                                ! = Delete Layout  !
         !       PF6 = Saved Lay !     From-Column To-Column      ! = Right          !
         +---------------------- !  2_  11_         24_           !------------------+
        000007  ---------- ----- !  1_  32_         47_           !- --------- --------
        000008  FINA01     ANTLI !  3_  53_         62_           !  30021001  53/10/12
        000009  FINA01     ANTLI !  4_  64_         72_           !  30021001  53/10/12
        000010  FINA01     EAVES !  __  ___         ___           !  30034544  48/09/23
        000011  FINA01     GOMEZ !  __  ___         ___           !  60000544  58/10/23

5. Press ENTER.

   Columns 32 to 47 now appear first, followed by columns 11 to 24, etc.:

         15:34:41             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
         +---------------------------------------------------------------------------+
         !                                                                           !
         !      1 ----+----1----+----2----+----3----+----4----+----5----+----6----+  !*
         ! Layout           XXXX +--------------------------------+   XXXXXXXXXX XX  !
         !        FINA01     ANT !                                !    30021001  53  !
         !                       !      Define Report Layout      !                  !
         !       PF3 = Exit      !                                ! = Delete Layout  !
         !       PF6 = Saved Lay !     From-Column To-Column      ! = Right          !
         +---------------------- !  1_  32_         47_           !------------------+
        000007  ---------- ----- !  2_  11_         24_           !- --------- --------
        000008  FINA01     ANTLI !  3_  53_         62_           !  30021001  53/10/12
        000009  FINA01     ANTLI !  4_  64_         72_           !  30021001  53/10/12
        000010  FINA01     EAVES !  __  ___         ___           !  30034544  48/09/23
        000011  FINA01     GOMEZ !  __  ___         ___           !  60000544  58/10/23

6. Press PF4 (Save) and PF3 (Exit).

   The report now appears as follows:

         15:38:20             **** ENTIRE OUTPUT MANAGEMENT ****            2024-09-09
        Report UEX-INSL-ADDP(21086)      L 000000 T 000232 -----------Columns 001 072
        ====>                                                         SCROLL===> CSR
        ****** ****************************** top of data *****************************
        000001  Page:   1                     Employee List sorted by Department
        000002
        000003                                 EMPLOYEES
        000004        FIRST-NAME          NAME   PERSONNEL   DATE
        000005                                      ID        OF
        000006                                              BIRTH
        000007   ---------------  -------------  --------- --------
        000008   JANET            ANTLIFF        30021001  53/10/12
        000009   JANET            ANTLIFF        30021001  53/10/12
        000010   TREVOR           EAVES          30034544  48/09/23
        000011   ISABEL           GOMEZ          60000544  58/10/23
        000012   MARIO            GOMEZ          60000012  45/12/12
        000013   SHARON           JAMES          30034217  63/05/26
        000014   SHARON           JAMES          30034217  63/05/26
        000015   SUSAN            JAMIESON       30000217  64/02/29
        000016   HELEN            JOHNSON        30000544  58/10/23
        000017   JOHN             JOHNSTON       30016001  35/10/12
        000018   DANIEL           JOUSSELIN      50003800  49/02/28
        Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
              Help        End   Layou Rfind Fi:C   -     +           <     >    Menu

## Printing an Active Report

You can print an entire active report or a part of it.

To print an entire active report:

1. Enter the command `PRINT` in the command line ====> at the top left of the Editor screen.

   A printer selection list is displayed.

   With PF7 (Up) and PF8 (Down), you can scroll the list.

2. Optional: If you wish to keep the printout in the printout queue, enter "Y" in the Hold Printout field below the list.

3. Select a printer from the list by marking it with any character.

   The entire report is printed on the selected printer with the layout displayed on the Editor screen. A corresponding confirmation message will be displayed.

To print a block of lines from an active report:

1. Type over the line number of the first line to be printed with `PP`:

         18:07:54             **** ENTIRE OUTPUT MANAGEMENT ****            2024-08-08
        Report UEX-INSL-ADDP(21086)      L 000008 T 000232 ----------Block is pending
        ====>                                                         SCROLL===> CSR
        PP       JANET            ANTLIFF        30021001  53/10/12
        000009   JANET            ANTLIFF        30021001  53/10/12
        000010   TREVOR           EAVES          30034544  48/09/23
        000011   ISABEL           GOMEZ          60000544  58/10/23
        000012   MARIO            GOMEZ          60000012  45/12/12
        000013   SHARON           JAMES          30034217  63/05/26

2. Scroll to the last line to be printed, and type over the line number with another `PP`.

   A printer selection list is displayed.

3. Optional: If you wish to keep the printout in the printout queue, enter "Y" in the Hold Printout field below the list.

4. Select a printer from the list by marking it with any character.

   The block of lines is printed on the selected printer with the layout displayed on the Editor screen. A corresponding confirmation message will be displayed.

## Exporting an Active Report to a PC File

This function is only available if Entire Connection is installed.

You can export an active report, or a part of it, to a PC file.

To export an entire active report:

1. Enter the command `EXPORT PC` in the command line ====> at the top left of the Editor screen.

2. A window is displayed. Enter the name of the file to which the active report is to be written.

   The active report is downloaded to the file on the PC.

To export a block of lines from an active report:

1. Type over the line number of the first line to be exported with `CC`:

         18:07:54             **** ENTIRE OUTPUT MANAGEMENT ****            2024-08-08
        Report UEX-INSL-ADDP(21086)      L 000008 T 000232 ----------Block is pending
        ====>                                                         SCROLL===> CSR
        CC       JANET            ANTLIFF        30021001  53/10/12
        000009   JANET            ANTLIFF        30021001  53/10/12
        000010   TREVOR           EAVES          30034544  48/09/23
        000011   ISABEL           GOMEZ          60000544  58/10/23
        000012   MARIO            GOMEZ          60000012  45/12/12
        000013   SHARON           JAMES          30034217  63/05/26

2. Scroll to the last line to be exported, and type over the line number with another `CC`.

3. Enter the command `EXPORT PC` in the command line ====> at the top left of the Editor screen.

4. A window is displayed. Enter the name of the file to which the block of lines is to be written.

   The block of lines is downloaded to the file on the PC.

### On this page

- Invoking the Software AG Editor
- PF Keys
- Commands
- Scrolling an Active Report
- Searching for a Character String
- Modifying the Layout of an Active Report
- Printing an Active Report
- Exporting an Active Report to a PC File